Difference between revisions of "Generating Tadpoles and Preparing Texts for Encoding"
Jump to navigation
Jump to search
(30 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
==Review and Confirm OT== | ==Review and Confirm OT== | ||
− | *Look at the record in | + | *Look at the record in FMP’s <tt>WWP_Transcription</tt> database in the “Main OT Info” layout |
− | **Check the | + | **Check the “Queries and Comments” fields for any red flags |
− | **Make sure that the information is complete and consistent with the office text itself | + | **Make sure that all the information in the record is complete and consistent with the office text itself |
− | **If this an OT you are adding to the system, make sure that you have the correct version of the text ( | + | **If this is an OT you are adding to the system, make sure that you have the correct version of the text (one we want to encode and not some later or undesirable version) |
*If this is a digital OT | *If this is a digital OT | ||
− | **Make sure that the | + | **Make sure that the “Digital” box is checked in the “OT Information” section in FMP |
− | **Fill in online source information (Google Books, EEBO, etc.) in the | + | **Fill in online source information (Google Books, EEBO, etc.) in the “OT Notes” field in FMP |
− | **Make sure that the file is saved in the | + | **Make sure that the file is saved in the <tt>Office_Texts/</tt> folder on <tt>data.dsg.neu.edu</tt>, following the convention: ot.''authorlastname.wordfromtitle''.pdf |
− | ** | + | ***for example: <code>ot.cavendish.letters.pdf</code> |
+ | ***these should match the XML files, apart from the “<tt>ot.</tt>” prefix and the file extension | ||
+ | **Save a copy of any new digital OTs on the failsafe flashdrive | ||
==Export Tadpole in FMP== | ==Export Tadpole in FMP== | ||
− | *In the | + | *In the “Main OT Info” layout, fill in the “filename” and “Transcription ID” fields in the “OT Information” section, making sure that we don’t already have the same filename for a different text |
− | *Hit the Tadpole button | + | *Hit the <code>Tadpole</code> button |
− | * | + | *Make sure you’re looking at the record for the text for which you want to create a tadpole, and double-check that everything looks good |
*Fill in the genre information | *Fill in the genre information | ||
− | *Hit the Export Tadpole button | + | *Hit the <code>Export Tadpole</code> button |
− | *Choose to save as XML, fill in the file name | + | *Choose to save as XML, fill in the appropriate file name and pick the location you want the file to go, then hit <code>Save</code> |
− | *Choose grammar | + | *Choose grammar “FMPXMLRESULT” and hit <code>Continue</code> |
− | *Hit Export | + | *Hit <code>Export</code> |
==Transform Tadpole== | ==Transform Tadpole== | ||
− | *In | + | *In oXygen, open the file you just created from wherever you saved it |
− | *Click on the Configure Transformation | + | *If this is the first time you’re running this transformation: |
− | * | + | **Click on the Configure Transformation Scenario(s) button [[file:Oxygen_v16_configure_transform_scenario_button.png]], |
− | **Hit New and select | + | **:or choose “Document ➤ Transformation ➤ Configure Transformation Scenario(s)…”, |
− | **Choose a name for your transformation | + | **:or press <code>⌘-⇧-C</code> |
− | **The XML URL field should default to your current file | + | **Hit <code>New</code> and select “XML Transformation with XSLT” |
− | **In the XSL URL field, hit the folder icon to navigate to the generate_tadpole stylesheet, currently in the Web repository: /utils/stylesheets/generate_tadpole | + | **Choose a name for your transformation so you can select it easily in the future, e.g. <tt>FMP2tadpole</tt> |
− | ** | + | **Check "Global Options" in "Storage" |
− | ** | + | **The XML URL field should default to your current file, i.e. <tt>${currentFileURL}</tt> |
− | * | + | **In the XSL URL field, either |
− | *Save | + | **#hit the folder icon to navigate to the <tt>generate_tadpole.xslt</tt> stylesheet, currently in the Web repository; e.g., <tt>/Users/urfriend/Documents/WWP-web/utils/stylesheets/generate_tadpole.xslt</tt>, OR |
− | * | + | **#enter <tt>http://www.wwp.neu.edu/utils/stylesheets/generate_tadpole.xslt</tt> |
− | + | **In the dropdown box labeled “Transformer”, select “Saxon-HE 9.6.0.5” (or whatever the version number of Saxon-HE is) | |
+ | **Click the <code>Parameters</code> button | ||
+ | ***Double-click the row with the name “userKey” | ||
+ | ***In the Value field, type in your personography key (e.g. “urfriend.tei”) | ||
+ | ***Click <code>OK</code> | ||
+ | ***Click <code>OK</code> | ||
+ | **Still in the “New scenario” dialog box, switch from the <code>XSLT</code> tab to the <code>Output</code> tab. Select “Prompt for File” and check “Open in Editor” | ||
+ | **You probably want to ensure that ''neither'' the “Open in Browser/System Application” ''nor'' any of the “Show in results view as” boxes are checked (they’re annoying) | ||
+ | **Click <code>OK</code> | ||
+ | **Click <code>Save and close</code> | ||
+ | *Click on the Apply Transformation Scenario(s) button [[file:Oxygen_v16_run_transform_scenario_button.png]], | ||
+ | *:or choose “Document ➤ Transformation ➤ Apply Transformation Scenario(s)”, | ||
+ | *:or press <code>⌘-⇧-T</code> | ||
+ | *If oXygen is unsure which transformation to run, it will put up the “Transform with” dialog box; choose the transformation you made earlier, e.g. <tt>FMP2tadpole</tt> | ||
+ | *Save the output file in the <tt>under_construction/</tt> directory with the appropriate name (i.e., <tt>''authorlastname.wordfromtitle''.xml</tt>) | ||
+ | *Make sure the new file looks okay; if so, delete the untransformed version | ||
==Add to Version Control== | ==Add to Version Control== | ||
− | *Open the SVN client | + | *Open the SVN client from within oXygen |
*Refresh and your new file should show up with a question mark | *Refresh and your new file should show up with a question mark | ||
− | *Control-click on the file and select | + | *Control-click on the file and select “Add to Version Control” (which is near the bottom) |
− | *Hit Add | + | *Hit <code>Add</code> |
− | *You | + | *You don’t need to commit this yet, because the next step will also need to be committed |
==Set Properties== | ==Set Properties== | ||
− | *Control-click on the file and choose | + | *Control-click on the file and choose “Show SVN Properties” (which is near the bottom) |
*Click on the blue plus sign icon near the top left of the Properties mini-window | *Click on the blue plus sign icon near the top left of the Properties mini-window | ||
− | *Select | + | *Select “svn:keywords” from the “Name” drop-down list |
− | *Put | + | *Put “Id” in the “Current Value” field and hit <code>Ok</code> |
*Now you can commit both changes | *Now you can commit both changes | ||
==Add to Trello== | ==Add to Trello== | ||
− | *In the Unencoded Texts list, | + | *In the Unencoded Texts list, select “Add a Card” |
− | *Use the | + | *Use the file name for the card’s name |
*Fill in the text title, author, OT, and topics in the description | *Fill in the text title, author, OT, and topics in the description | ||
− | *Add the green, unassigned | + | *If this is a digital OT, make a note in the description |
+ | *Add the green (i.e,, unassigned) label |
Latest revision as of 11:32, 9 July 2015
Review and Confirm OT
- Look at the record in FMP’s WWP_Transcription database in the “Main OT Info” layout
- Check the “Queries and Comments” fields for any red flags
- Make sure that all the information in the record is complete and consistent with the office text itself
- If this is an OT you are adding to the system, make sure that you have the correct version of the text (one we want to encode and not some later or undesirable version)
- If this is a digital OT
- Make sure that the “Digital” box is checked in the “OT Information” section in FMP
- Fill in online source information (Google Books, EEBO, etc.) in the “OT Notes” field in FMP
- Make sure that the file is saved in the Office_Texts/ folder on data.dsg.neu.edu, following the convention: ot.authorlastname.wordfromtitle.pdf
- for example:
ot.cavendish.letters.pdf
- these should match the XML files, apart from the “ot.” prefix and the file extension
- for example:
- Save a copy of any new digital OTs on the failsafe flashdrive
Export Tadpole in FMP
- In the “Main OT Info” layout, fill in the “filename” and “Transcription ID” fields in the “OT Information” section, making sure that we don’t already have the same filename for a different text
- Hit the
Tadpole
button - Make sure you’re looking at the record for the text for which you want to create a tadpole, and double-check that everything looks good
- Fill in the genre information
- Hit the
Export Tadpole
button - Choose to save as XML, fill in the appropriate file name and pick the location you want the file to go, then hit
Save
- Choose grammar “FMPXMLRESULT” and hit
Continue
- Hit
Export
Transform Tadpole
- In oXygen, open the file you just created from wherever you saved it
- If this is the first time you’re running this transformation:
- Click on the Configure Transformation Scenario(s) button ,
- or choose “Document ➤ Transformation ➤ Configure Transformation Scenario(s)…”,
- or press
⌘-⇧-C
- Hit
New
and select “XML Transformation with XSLT” - Choose a name for your transformation so you can select it easily in the future, e.g. FMP2tadpole
- Check "Global Options" in "Storage"
- The XML URL field should default to your current file, i.e. ${currentFileURL}
- In the XSL URL field, either
- hit the folder icon to navigate to the generate_tadpole.xslt stylesheet, currently in the Web repository; e.g., /Users/urfriend/Documents/WWP-web/utils/stylesheets/generate_tadpole.xslt, OR
- enter http://www.wwp.neu.edu/utils/stylesheets/generate_tadpole.xslt
- In the dropdown box labeled “Transformer”, select “Saxon-HE 9.6.0.5” (or whatever the version number of Saxon-HE is)
- Click the
Parameters
button- Double-click the row with the name “userKey”
- In the Value field, type in your personography key (e.g. “urfriend.tei”)
- Click
OK
- Click
OK
- Still in the “New scenario” dialog box, switch from the
XSLT
tab to theOutput
tab. Select “Prompt for File” and check “Open in Editor” - You probably want to ensure that neither the “Open in Browser/System Application” nor any of the “Show in results view as” boxes are checked (they’re annoying)
- Click
OK
- Click
Save and close
- Click on the Configure Transformation Scenario(s) button ,
- Click on the Apply Transformation Scenario(s) button ,
- or choose “Document ➤ Transformation ➤ Apply Transformation Scenario(s)”,
- or press
⌘-⇧-T
- If oXygen is unsure which transformation to run, it will put up the “Transform with” dialog box; choose the transformation you made earlier, e.g. FMP2tadpole
- Save the output file in the under_construction/ directory with the appropriate name (i.e., authorlastname.wordfromtitle.xml)
- Make sure the new file looks okay; if so, delete the untransformed version
Add to Version Control
- Open the SVN client from within oXygen
- Refresh and your new file should show up with a question mark
- Control-click on the file and select “Add to Version Control” (which is near the bottom)
- Hit
Add
- You don’t need to commit this yet, because the next step will also need to be committed
Set Properties
- Control-click on the file and choose “Show SVN Properties” (which is near the bottom)
- Click on the blue plus sign icon near the top left of the Properties mini-window
- Select “svn:keywords” from the “Name” drop-down list
- Put “Id” in the “Current Value” field and hit
Ok
- Now you can commit both changes
Add to Trello
- In the Unencoded Texts list, select “Add a Card”
- Use the file name for the card’s name
- Fill in the text title, author, OT, and topics in the description
- If this is a digital OT, make a note in the description
- Add the green (i.e,, unassigned) label