Difference between revisions of "Getting started with encoding"
Jump to navigation
Jump to search
(Created page with "==Helpful Links== *[http://www.wwp.neu.edu/research/publications/documentation/internal/ WWP Internal Documentation] *[http://www.wwp.neu.edu/research/publications/documentati...") |
|||
| Line 11: | Line 11: | ||
*[http://www.wwp.neu.edu/research/publications/documentation/training/subversion.html Subversion Crib Sheet] | *[http://www.wwp.neu.edu/research/publications/documentation/training/subversion.html Subversion Crib Sheet] | ||
*[http://www.wwp.neu.edu/outreach/seminars/_current/handouts/elementList.xhtml List of Commonly Used Elements] | *[http://www.wwp.neu.edu/outreach/seminars/_current/handouts/elementList.xhtml List of Commonly Used Elements] | ||
| + | |||
| + | ==The Encoding Process== | ||
| + | *[http://www.wwp.northeastern.edu/research/publications/documentation/training/document_analysis.html Document Analysis] should be the first thing you do | ||
| + | *Encoding Steps | ||
| + | **Update your working directory in Subversion: | ||
| + | ***launch Oxygen | ||
| + | ***in the Tools menu, choose “SVN Client” | ||
| + | ***Control-click on the WWPtextbase/ directory and choose “Update” from the menu that pops up | ||
| + | ***It should either say “no incoming changes” or “Operation successful”. | ||
| + | **Find your tadpole | ||
| + | ***navigate to your ~/Documents/WWPtextbase/ folder | ||
| + | ***n the under_construction/ directory, locate your tadpole | ||
| + | ***open it in Oxygen (if your system is set up to open XML files in oXygen, you can just double-click the file) | ||
| + | **Encode the basic document structure: | ||
| + | ***if your text doesn’t have any front or back matter, delete <front> and <back> | ||
| + | ***enter the <div>s and other major structural elements inside the <front>, <body>, and <back> elements as appropriate | ||
| + | **Start transcribing | ||
| + | ***omit the title page and table of contents for now | ||
| + | ***enter paragraphs and container elements like <quote> or <lg> before typing in their contents | ||
| + | ***fix any validation errors as soon as you see them | ||
| + | ***save often | ||
| + | **Commit your changes | ||
| + | ***at the end of your session, go back into the SVN client | ||
| + | ***navigate to your tadpole file | ||
| + | ***control-click on it and choose “Refresh” (⌘-R); you should see a little star appear next to your file | ||
| + | ***control-click on your file again and choose “Commit” (⌘-M); enter a message that has at least your personal key if not a useful message, and then approve the dialog box. | ||
Revision as of 12:26, 25 May 2015
Helpful Links
- WWP Internal Documentation
- WWP Training Materials
- Document Analysis
- Oxygen Crib Sheet
- Validation and Error Messages Quick Guide
- New Texts
- Listserv
- Wiki on Encoding Meetings
- Sample Text
- Subversion Crib Sheet
- List of Commonly Used Elements
The Encoding Process
- Document Analysis should be the first thing you do
- Encoding Steps
- Update your working directory in Subversion:
- launch Oxygen
- in the Tools menu, choose “SVN Client”
- Control-click on the WWPtextbase/ directory and choose “Update” from the menu that pops up
- It should either say “no incoming changes” or “Operation successful”.
- Find your tadpole
- navigate to your ~/Documents/WWPtextbase/ folder
- n the under_construction/ directory, locate your tadpole
- open it in Oxygen (if your system is set up to open XML files in oXygen, you can just double-click the file)
- Encode the basic document structure:
- if your text doesn’t have any front or back matter, delete <front> and <back>
- enter the s and other major structural elements inside the <front>, <body>, and <back> elements as appropriate
- Start transcribing
- omit the title page and table of contents for now
- enter paragraphs and container elements like <quote> or <lg> before typing in their contents
- fix any validation errors as soon as you see them
- save often
- Commit your changes
- at the end of your session, go back into the SVN client
- navigate to your tadpole file
- control-click on it and choose “Refresh” (⌘-R); you should see a little star appear next to your file
- control-click on your file again and choose “Commit” (⌘-M); enter a message that has at least your personal key if not a useful message, and then approve the dialog box.
- Update your working directory in Subversion: