Coptic SCRIPTORIUM Wiki

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 us at contact@copticscriptorium.org to get access to our GitHub development repositories.

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 using GitDox to avoid overwriting data!

Contact us at contact@copticscriptorium.org to get GitDox account. To avoid confusion, we suggest you use the same username, and password if you choose, for both GitHub and GitDox.

Your GitDox account is linked to your GitHub account. If you change your password on GitHub, please be sure to update your GitHub password on GitDox by logging in and choosing admin. GitDox supports two-factor authentication for GitHub accounts.

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 text box at the top of each column to filter results.

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.

The document list features live validation of xml/spreadsheets and metadata (the tag icon), as noted in the seventh column. Green icons indicate valid data; red icons indicate validation issues. Hover over the icon to see more information about validation errors.

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. Assign the document to yourself. Note that you may later rename the document if necessary, but it result in a second document being saved in GitHub.

The transcription mode of GitDox has two options for saving work: save and commit. The save button saves changes within GitDox but does not commit those changes to GitHub. The commit button commits changes to GitHub. Because GitDox depends on an internet connection, it's a good idea to save your work frequently while you're working using the save button. The spreadsheet mode of GitDox saves data automatically, and more than one editor can work in the spreadsheet at a time.

Be sure to commit your changes to GitHub at the end of each day or any time you've made substantial changes by entering a commit message in the text box by the commit button, entering your code in the 2-factor box if necessary, and clicking the commit button. You should get a red message at the bottom of the page saying your commit was successful, and you can also check GitHub to see that your commit is in the repo.

Follow our diplomatic transcription guidelines. Enter text in a unicode Coptic character set (SCRIPTORIUM uses the Antinoou font and keyboard.) Be sure there is a space or an underscore between each Coptic bound group. You do not need to segment all the morphemes. We follow Layton's conventions for segmenting bound groups. For example ⲁϥⲟⲩⲱϣⲃ ⲛⲁϥ, not ⲁ ϥ ⲟⲩⲱϣⲃ ⲛⲁ ϥ, nor ⲁϥⲟⲩⲱϣⲃⲛⲁϥ. Carriage returns result in line breaks in transcribed texts, though the schema also allows line break tags.

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.

GitDox features validation for xml and spreadsheet modes as well as for metadata. Click the validate button on the upper right, and validation errors will appear in the text box below. For errors where the cell or value does not match the pattern, hover over the text of the error message to get more information about the expected pattern. Be sure to validate the xml before processing your text using the NLP to avoid errors.

If you wish to tokenize your text, you may click the tokenize button under the transcription box to automatically tokenize your transcribed text. You can then correct the tokenization in GitDox. Remember to commit your changes.

Note to veteran GitDox users: As of 2020 you no longer need to check tokenization before running the rest of the NLP tools. Run the whole tool suite together.

After validating your text transcription in GitDox, click the NLP button under the transcription box to automatically process your text and send it to the spreadsheet editor.

Follow the steps in the Basic Annotation Workflow starting at “Rename existing layers….” The online spreadsheet automatically saves all work.

Use the button at the bottom of the page to add metadata. A new window will open. You may select metadata fields from the drop-down menu by hovering the mouse over the meta key text box and clicking on the arrow. Note that this drop-down menu will not work in Safari. You can also begin to type the name the metadata you want to enter in the meta key text box, which will bring up a set of suggestions. Enter the value into the meta value text box.

Please reference our documentation on metadata fields when entering metadata in GitDox.

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.

Corpus metadata can be added or edited in any document in the corpus; changes will affect all documents. See the corpus metadata page for information on fields and values.