This is an old revision of the document!
Table of Contents
GitDox is an online XML and spreadsheet editor which uses GitHub for data storage. Coptic SCRIPTORIUM is currently using GitDox to transcribe texts. We will soon begin to use GitDox for editing spreadsheets as well.
GitDox is located at https://corpling.uis.georgetown.edu/gitdox/
GitDox and GitHub
GitDox uses GitHub for file storage and versioning. In order to use GitDox, you must first have a GitHub account. You can set up an account at https://github.com/. Contact NN to get access to Coptic SCRIPTORIUM repositories on GitHub.
As described below, users commit changes in GitDox directly to GitHub, but the link between GitDox and GitHub is a one-way street: changes from GitDox get committed to GitHub, but no changes made to files on GitHub are reflected in GitDox. Please only edit files created in GitDox on GitDox!
Creating an account
Contact NN to get an account. We suggest you use your GitHub username and password for GitDox as well.
Your GitDox account is linked to your GitHub account. If you change your password on GitHub, please be sure to update your password on GitDox by logging in and choosing admin.
Navigating the document list
When you log in to GitDox, you see a list of current documents. Use the dropdown menu above the list to display only documents from a certain corpus. You can also use the arrows to the right of each column name to sort by that column.
Documents are assigned to users (as noted in the fifth column). Please only edit documents assigned to you. If you believe a document should be assigned to you but isn't, please contact the person to whom it is currently assigned to confirm that you should be assigned the document before editing it.
The mode column lets you know whether the document is currently in transcription (</>) or spreadsheet (table icon) mode. As of now, we are only using GitDox for transcription.
Creating a new document
Scroll to the bottom of the current document list and select the “new” button.
Enter the name of your file and corpus as well as the repository on GitHub where you want your file to be saved. Please use the main repository for your corpus and not a fork; once we migrate to GitHub, we will no longer use forks. Assign the document to yourself.
Saving and committing
The transcription mode of GitDox has two options for saving work: save and commit. Save your work regularly using the save button
Transcribing
Follow the diplomatic transcription guidelines. GitDox features syntax highlighting and suggestions. When you open an angle bracket, GitDox suggests tags that are currently available. GitDox will also suggest attributes for tags. Improperly closed tags and other errors are highlighted in red.
Adding metadata
Use the button at the bottom of the page to add metadata. Select metadata fields from the drop-down menu and enter the value. After you click submit, the metadata will appear in a chart on the bottom of the page. You can't edit metadata you've already submitted, but you can delete the entry from the list and re-enter the correct field and information.