Workflow for Tag Library and transformations - SAA-SDT/TS-EAS-subteam-notes GitHub Wiki

Workflow for Tag Library and transformations

  • All TEI documents and transformation documents are placed in GitHub.
  • When a transformation is being done you need a copy of the repository locally and something that can run your transformation.
  • The transformation engine needs to have have a FO processor to be able to create the PDF.
  • The transformation and guidelines are the same regardless of Tag Library. This means that design changes made for the purpose of one Tag Library affect all Tag Libraries. If major design changes are made all Tag Libraries needs to be re-transformed and submitted to all recipients.
  • Everything done needs to work for all Tag Libraries and affect all Tag Libraries

Greek letters

Karin Bredenberg has been using oXygen. For transformation of text written in Greek it might be needed to do this to get it to work:

  1. For the Apache FOP to handle Greek, the files in this folder needs to be accessible in your PC.
  2. In font map fonts with filenames pala.tff and Arialuni.ttf must exist
  3. In file ttfConvert.bat line 11 must point to your font map. Then run the file. The file must be in the oXygen directory. The resulting XML files needs to be in the same directory.
  4. In FOP.properties line 11 and 16 must point to the right folder for fonts
  5. In Oxygen-Options-Preferences-XML-"XSLT-FO-XQUERY"-FP Processors Set configuration file to point at FOP.properties
  6. Run your transformation as usual.

Github

For Github follow these guidelines: Ruth Tillman's GitHub guideline

Folder structure for Tag Libraries

For the Tag Libraries, the folder structure are like the picture shown below.

Image!!!!

Description of content of the folders:

  • adjustments_to_oxygen_for_handling_greek: Contains all the information regarding how to add the Greek alphabet to oXygen.
  • html: Currently not used.
  • images: All images used in the different Tag Libraries.
  • schema: The schemas for the Tag Libraries.
  • tei: All the TEI documents. In the folder you can find the starting document for the Tag Library. In EAD3 case the whole Tag Library is in the same document, in EAC-CPF case the main text and appendixes are in this start document and the elements and attributes is found in its folder.
  • templates: Templates for how the different parts of the Tag Library is encoded.
  • transformations: All the transformations.

Workflow for creating a TL

  • Decide if the Tag Library should be one document or a document with the elements and attributes in their own documents. Use EAD3 and EAC-CPF as guide.
  • Make copies of the templates and work can begin
  • When having it all in one document the element and attribute templates needs to be copied into the main document and placed as guided in the main document template.
  1. Create the main document and its content
  2. Create elements
  3. Create attributes
  4. Save all images in the folder named images (all images regardless of Tag Library are in the same folder)
  5. Make a “commit” to GitHub and the SchemaTeam will make the accept and add it to the repository and make the transformations needed for the resulting documents.

Workflow for translation of a Tag Library

  1. Translate the main document and its content
  2. Translate elements
  3. Translate attributes
  4. Save all the images in the folder named images (all images regardless of Tag Library are in the same folder)
  5. Make a “commit” to GitHub and the Documentation Team will make the accept and add it to the repository and make the transformations needed for the resulting documents

Workflow for updating a Tag Library

  • Follow the instructions for Github Ruth Tillman's GitHub guideline
  • When adding new elements and/or attributes new files or new
    elements needs to be created. Follow the instructions in the section named “Workflow for creating a Tag Library”.
  • Placeholder for text regarding how the updated is pointed out!
  • The pdf and html stored in GitHub will be renamed by the schema team and saved as the old version. The XML-documents will have all changes in them.
    1. Update the main document and its content
    2. Update elements
    3. Update attributes
    4. Save all new images in the folder named images (all images regardless of Tag Library are in the same folder)
    5. Make a “commit” to Github and the Documentation Team will make the accept and add the updates to the repository and make the transformations needed for the documents.

    Workflow for transformation

    • All transformations is found in the folder transformation.
    • It is important to not move files around, let them stay in the folder they are!
    • All namespaces used for examples needs to be in the header of the transformations to work. Add the namespace and also the namespace prefix in the exclude-result-prefixes of the stylesheet header.
    • Karin has being using Oxygen for the transformations. For the transformation the built in FOP-processor has been used in combination with Saxon 6.5.5.
    1. For creating the resulting documents you need to have the whole Tag Library in one document. This can be created by running the transformation named, “CreateOneFile.xsl”. You save the result in the tei-folder and use this document as the document you run the transformations on.
    2. For creating the PDF, run the transformation named “Taglibrary2pdf.xsl” and save the result.
    3. For creating the HTML, run the transformation named “tagLibrary2html.xsl” and save the result.
    4. Placeholder for info regarding markdown For creating the mark-down, run the transformation named “???.xls” and save the result.
    5. The resulting PDF and HTML is sent to the Web liaisons by the for the standard responsible team. For the HTML, you also need to make sure that the “tagLibrary.css” is included as well as the image-folder.
⚠️ **GitHub.com Fallback** ⚠️