Difference between revisions of "Generating Tadpoles and Preparing Texts for Encoding"

From Digital Scholarship Group
Jump to navigation Jump to search
m (nicer quotation marks)
Line 1: Line 1:
 
==Review and Confirm OT==
 
==Review and Confirm OT==
*Look at the record in FMP's WWP_Transcription database in the "Main OT Info" layout
+
*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
+
**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
 
**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 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 "Digital" box is checked in the "OT Information" section in FMP
+
**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
+
**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 the WWP server, following the convention: ot.authorlastname.wordfromtitle.pdf
+
**Make sure that the file is saved in the “Office_Texts” folder on the WWP server, following the convention: ot.authorlastname.wordfromtitle.pdf
 
***for example: ot.cavendish.letters.pdf
 
***for example: ot.cavendish.letters.pdf
***these should match the XML files, apart from the "ot." prefix and the file extension
+
***these should match the XML files, apart from the “ot.prefix and the file extension
 
**Save a copy of any new digital OTs on the failsafe flashdrive
 
**Save a copy of any new digital OTs on the failsafe flashdrive
  
 
==Export Tadpole in FMP==
 
==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
+
*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 Tadpole button  
*Make sure you're looking at the text you want to create a tadpole for and double-check that everything looks good
+
*Make sure you’re looking at the text you want to create a tadpole for and double-check that everything looks good
 
*Fill in the genre information
 
*Fill in the genre information
 
*Hit the Export Tadpole button
 
*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 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
+
*Choose grammar “FMPXMLRESULT” and hit Continue
 
*Hit Export
 
*Hit Export
  
Line 26: Line 26:
 
*In Oxygen, open the file you just created from wherever you saved it
 
*In Oxygen, open the file you just created from wherever you saved it
 
*Click on the Configure Transformation Scenarios button (the one with the wrench and the red triangle)
 
*Click on the Configure Transformation Scenarios button (the one with the wrench and the red triangle)
*If this is the first time you're configuring the transformation:
+
*If this is the first time you’re configuring the transformation:
**Hit New and select "XML Transformation with XSLT"
+
**Hit New and select “XML Transformation with XSLT”
 
**Choose a name for your transformation so you can select it easily in the future
 
**Choose a name for your transformation so you can select it easily in the future
 
**The XML URL field should default to your current file
 
**The XML URL field should default to your current file
Line 33: Line 33:
 
**In the Transformer dropdown box, select “Saxon-HE”
 
**In the Transformer dropdown box, select “Saxon-HE”
 
**Click the Parameters button
 
**Click the Parameters button
***Double-click the row with the name "userKey"
+
***Double-click the row with the name “userKey”
***In the Value field, type in your personography key (e.g. "urfriend.tei")
+
***In the Value field, type in your personography key (e.g. “urfriend.tei”)
***Click "OK".
+
***Click “OK”.
***Click "OK".
+
***Click “OK”.
**Navigate to the Output screen and select "Prompt for File" and "Open in Editor"
+
**Navigate to the Output screen and select “Prompt for File” and “Open in Editor”
 
*Once you have the transformation set up, select it and hit the Apply Associated button
 
*Once you have the transformation set up, select it and hit the Apply Associated button
 
*Save your file in the under_construction directory
 
*Save your file in the under_construction directory
Line 45: Line 45:
 
*Open the SVN client in Oxygen
 
*Open the SVN client in 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 "Add to Version Control"
+
*Control-click on the file and select “Add to Version Control”
 
*Hit Add
 
*Hit Add
*You don't need to commit this yet, because the next step will also need to be committed
+
*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 "Show SVN Properties"
+
*Control-click on the file and choose “Show SVN Properties”
 
*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 "svn:keywords" from the "Name" drop-down list
+
*Select “svn:keywords” from the “Name” drop-down list
*Put "ID" in the "Current Value" field and hit Ok
+
*Put “ID” in the “Current Value” field and hit Ok
 
*Now you can commit both changes
 
*Now you can commit both changes
  
 
==Add to Trello==
 
==Add to Trello==
*In the Unencoded Texts list, select "Add a Card"
+
*In the Unencoded Texts list, select “Add a Card”
*Use the file name for the card's name
+
*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
 
*If this is a digital OT, make a note in the description
 
*If this is a digital OT, make a note in the description
 
*Add the green, unassigned, label
 
*Add the green, unassigned, label

Revision as of 08:39, 26 June 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 the WWP server, 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
    • 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 text you want to create a tadpole for 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
  • Click on the Configure Transformation Scenarios button (the one with the wrench and the red triangle)
  • If this is the first time you’re configuring the transformation:
    • Hit New and select “XML Transformation with XSLT”
    • Choose a name for your transformation so you can select it easily in the future
    • The XML URL field should default to your current file
    • 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
    • In the Transformer dropdown box, select “Saxon-HE”
    • 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”.
    • Navigate to the Output screen and select “Prompt for File” and “Open in Editor”
  • Once you have the transformation set up, select it and hit the Apply Associated button
  • Save your file in the under_construction directory
  • Make sure the new file looks okay; if so, delete the untransformed version

Add to Version Control

  • Open the SVN client in Oxygen
  • Refresh and your new file should show up with a question mark
  • Control-click on the file and select “Add to Version Control”
  • 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”
  • 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, unassigned, label