gitdox_workflow
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
gitdox_workflow [2017/06/28 10:44] – Updated gitdox URL amirzeldes | gitdox_workflow [2020/08/03 17:49] (current) – [Tips for working with the online spreadsheet] admin | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | GitDox is an online XML and spreadsheet editor which uses GitHub for data storage. | + | GitDox is an online XML and spreadsheet editor which uses GitHub for data storage. |
- | + | ||
- | GitDox | + | |
- | + | ||
- | GitDox | + | |
===== GitDox and GitHub ===== | ===== 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:// | 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:// | ||
- | 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 | + | 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 |
===== Creating an account ===== | ===== Creating an account ===== | ||
- | Contact us at contact@copticscriptorium.org to get an account. | + | Contact us at contact@copticscriptorium.org to get GitDox |
- | 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. | + | Your GitDox account is linked to your GitHub account. If you change your password on GitHub, please be sure to update your GitHub |
===== Navigating the document list ===== | ===== 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 | + | 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. | 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. | + | The mode column lets you know whether the document is currently in transcription (</>) or spreadsheet (table icon) mode. |
+ | |||
+ | The document list features live validation | ||
===== Creating a new document ===== | ===== Creating a new document ===== | ||
Scroll to the bottom of the current document list and select the " | Scroll to the bottom of the current document list and select the " | ||
- | 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. | + | 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. |
===== Saving and committing ===== | ===== Saving and committing ===== | ||
- | 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 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, |
- | Be sure to commit your changes to GitHub at the end of each day by entering a commit message in the text box by the commit button 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 on the repo. | + | Be sure to commit your changes to GitHub at the end of each day or any time you've made substantial changes |
===== Transcribing ===== | ===== Transcribing ===== | ||
- | Follow our [[https:// | + | Follow our [[https:// |
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 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 | + | ===== Validation |
- | Use the button at the bottom of the page to add metadata. | + | GitDox features validation for xml and spreadsheet modes as well as for metadata. |
- | + | ||
- | After you click submit, the metadata will appear in a chart on the bottom | + | |
===== Tokenizing ===== | ===== Tokenizing ===== | ||
- | Click the NLP button under the transcription box to automatically tokenize your transcribed text. Correct | + | If you wish to tokenize your text, you may click the tokenize |
+ | //Note to veteran GitDox users: As of 2020 you no longer need to check tokenization before running the rest of the NLP tools. | ||
===== Processing using the NLP ===== | ===== Processing using the NLP ===== | ||
- | We expect an automated link between the XML editor, the NLP, and the online spreadsheet to be available in summer 2017. However, as of May 2017, the following steps are necessary to move transcribed texts from the XML editor through the NLP and into the online spreadsheet. | + | After validating your text transcription in GitDox, click the NLP button |
- | * After checking tokenization and committing the final text to GitHub, copy the text from GitDox and paste it into the online | + | |
- | * Process | + | |
- | * In your file on GitDox, use the mode drop-down menu to change | + | |
- | * Scroll to the bottom of the page and use the upload function to upload the file you saved on your computer. The spreadsheet should be populated with the information from your file. | + | |
===== Editing annotations in the online spreadsheet ===== | ===== Editing annotations in the online spreadsheet ===== | ||
Follow the steps in the [[basic_annotation_workflow|Basic Annotation Workflow]] starting at " | Follow the steps in the [[basic_annotation_workflow|Basic Annotation Workflow]] starting at " | ||
- | |||
- | ===== Tips for working with the online spreadsheet ===== | ||
- | |||
- | In progress | ||
+ | ===== Adding metadata ===== | ||
+ | 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 [[annotation_layer_names# | ||
+ | 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|corpus metadata]] page for information on fields and values. |
gitdox_workflow.1498668242.txt.gz · Last modified: 2017/06/28 10:44 by amirzeldes