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

From Digital Scholarship Group
Jump to navigation Jump to search
Line 1: Line 1:
 
==Review and Confirm OT==
 
==Review and Confirm OT==
 
*Look at the record in the FMP WWP_Transcription database
 
*Look at the record in the FMP WWP_Transcription database
**Check the Queries and Comments fields for any red flags
+
**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 the information 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 (the one we want to encode and not some later or undesirable version)
 
**If this an OT you are adding to the system, make sure that you have the correct version of the text (the 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 in the WWP server, using the same naming convention as for TEI files (does this make sense?)  
 
**Make sure that the file is saved in the "Office_Texts" folder in the WWP server, using the same naming convention as for TEI files (does this make sense?)  
 
**Make a backup (where? how?)
 
**Make a backup (where? how?)
  
 
==Export Tadpole in FMP==
 
==Export Tadpole in FMP==
*In the Main OT Info view, 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" view, 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  
 
*Perform a find to get text you want to create a tadpole for
 
*Perform a find to get text you want to create a tadpole for
Line 18: Line 18:
 
*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, then hit Save
 
*Choose to save as XML, fill in the appropriate file name and pick the location you want the file, then hit Save
*Choose grammar FMPXMLRESULT and hit Continue
+
*Choose grammar "FMPXMLRESULT" and hit Continue
 
*Hit Export
 
*Hit Export
  
Line 24: Line 24:
 
*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
 
**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 XSL URL field, hit the folder icon to navigate to the generate_tadpole stylesheet, currently in the Web repository: /utils/stylesheets/generate_tadpole
**Select Saxon-PE 9.5.1.7 for the transformer
+
**Select "Saxon-PE 9.5.1.7" for the transformer
**Navigate to Output and chose Prompt for File
+
**Navigate to the Output screen and chose "Prompt for File"
 
*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 under_construction
 
*Save your file in under_construction
Line 39: Line 39:
 
*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
  
Line 54: Line 54:
 
*Use the filename for the Card Name
 
*Use the filename for the Card 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
 
*Add the green, unassigned, label
 
*Add the green, unassigned, label

Revision as of 12:39, 16 June 2015

Review and Confirm OT

  • Look at the record in the FMP WWP_Transcription database
    • Check the "Queries and Comments" fields for any red flags
    • Make sure that the information 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 (the 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 in the WWP server, using the same naming convention as for TEI files (does this make sense?)
    • Make a backup (where? how?)

Export Tadpole in FMP

  • In the "Main OT Info" view, 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
  • Perform a find to get text you want to create a tadpole for
  • 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, 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
    • Select "Saxon-PE 9.5.1.7" for the transformer
    • Navigate to the Output screen and chose "Prompt for File"
  • Once you have the transformation set up, select it and hit the Apply Associated button
  • Save your file in under_construction
  • Then open the file and make sure it looks okay; if so, delete the untransformed version
  • You'll also have to update the first change log entry to include your own key

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, hit Add a Card
  • Use the filename for the Card 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