Generating Tadpoles and Preparing Texts for Encoding

From Digital Scholarship Group
Jump to navigation Jump to search

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
    • 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 Oxygen v16 configure transform scenario button.png,
      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
      1. 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
      2. 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 the Output 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 Apply Transformation Scenario(s) button Oxygen v16 run transform scenario button.png,
    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