Using the Curriculum Graphics and Editing production hotfolders

What is a “hotfolder?”

Hotfolders are watched folders. When a file of the correct type is placed in a watched folder, server-side scripts that “watch” that folder automatically process the file in some way. Two types of hotfolders are used by the Curriculum Department: production and validation hotfolders; and Curriculum/Translation document transfer hotfolders.

Error messages

If the file you placed in a hotfolder generates an error (see Error handling for each hotfolder, below), an error message file, with a .log extension, is generated.

Double-click the .log file to open it in a text editor.

Once opened, the relevant error message text is found at the end of the .log file. You may have to scroll to the bottom to find it.

Production and validation hotfolders

These hotfolders are used by all Curriculum Department editorial and design/production teams that handle xml. They are located at:

cur-fs.ldschurch.org/HOT FOLDERS/XML/

Extracting xml from desktop publishing layout files

The hotfolders in this group export xml from desktop publishing layout files and route the xml to an appropriate post-production collection volume. Currently, only one export process is implemented, which handles xml export from InDesign.

Hotfolder location: InDesignToXML/Input_FilesToBeConverted/
Input hotfolder name	Input file format	Operation	Error handling
To_English_Editing	InDesign (*.indd) document containing imported xml	Exports xml from the InDesign Performs transformations on the exported xml to convert its markup to ldsXML Places the exported and transformed xml document in InDesignToXML/Output_FilesConverted Deletes the InDesign document	Error messages are saved in InDesignToXML/Errors_FilesThatFailedConversion. Common errors
To_Translation_Editing	InDesign (*.indd) document containing imported xml	Exports xml from the InDesign Performs transformations on the exported xml to convert its markup to ldsXML Routes the exported and transformed xml document to a post-production collection volume for further processing by language editors Deletes the InDesign document Note: Use this hotfolder only for extracting xml from completed non-english InDesign jobs.

Sequencing ldsXML elements

Hotfolder Location: Validation/SequenceNumbering/Input_FilesToBeConverted/
Input hotfolder name	Input file format	Operation	Error handling
Master_Replaces_All	An ldsXML document	Generates sequenced fileID attributes on each publication-type element in the input document. (Elements magazine and book are sequenced as “000.”) Generates sequenced id attributes on each paragraph-type element in the input document. Places the sequenced xml document in Validation/SequenceNumbering/Output_FilesConverted.	Error messages are saved in Validation/SequenceNumbering/ Errors_FilesThatFailedConversion. Error messages from sequencing hotfolders are rare.
Para-type_Elements_Only	An ldsXML document	Generates sequenced id attributes on each paragraph-type element in the input document. Places the sequenced xml document in Validation/SequenceNumbering/Output_FilesConverted

Validating ldsXML documents

Hotfolder Location: Validation/SSRValidation/

Input hotfolder name

Input file format

Operation

Error handling

Input_FilesToBeConverted

An ldsXML document

Runs a series of quality checks and procedures on the input ldsXML document:

Validation against the appropriate ldsXML schema
Validation against “Schematron” schemas governing business-rule xml quality
Check for illegal or out-of-range Unicode characters
Check for illegal character sequences (ellipses, breaking whitespace before nb elements, etc.)
Normalization of character data

Places validated ldsXML documents in Validation/SSRValidation/Output_FilesConverted

Error messages are saved in Validation/SSRValidation/
Errors_FilesThatFailedConversion.

Common errors

Converting word processing files to ldsXML

The hotfolders in this group convert xml from word processing files. Currently, only conversions from Word have been implemented.

Hotfolder Location: wordProcessorToXML/WordToXML/
Input hotfolder name	Input file format	Operation	Error handling
Input_FilesToBeConverted	Microsoft Word file based on a Word/ldsXML stylesheet template	Converts Word files to ldsXML documents Places the ldsXML document in WordToXML/Output_FilesConverted Deletes the Word file	Error messages are saved in InDesignToXML/Errors_FilesThatFailedConversion.

Hotfolder Location: wordProcessorToXML/WordToFreeFormXML/
Input hotfolder name	Input file format	Operation	Error handling
Input_FilesToBeConverted	Microsoft Word file based on a Word/freeform-xml stylesheet template	Converts Word files to freeform xml documents Places the freeform xml document in WordToFreeFormXML/Output_FilesConverted Deletes the Word file	Error messages are saved in WordToFreeFormXML/Errors_FilesThatFailedConversion.

Running “custom” transformations on xml documents

The hotfolders in this group execute transformations on xml documents using user-supplied transformation rule documents. Currently, only XSLT transformations are implemented.

Hotfolder location: XMLcustomJobTransform/TransformWithLocalXSLTs/

Input hotfolder name

Input file format

Operation

Error handling

Input_FilesToBeConverted

A folder containing:

the xml document(s) to be transformed
the XSLT document(s) needed to run the transformation

Executes transformation(s) on each xml document, in file order, using each XSLT document in file order. If multiple XSLT documents are supplied, the result of the first document’s transformation becomes the input for the second transformation, and so on. This process is repeated for each xml document.
Places the folder containing the resulting xml document(s), the XSLT documents(s), and a log file, in TransformWithLocalXSLTs/Output_FilesConverted

Error messages are saved in TransformWithLocalXSLTs/Errors_FilesThatFailedConversion.

Converting ldsXML documents to “InDesign” xml

The hotfolders in this group prepare ldsXML documents to be imported into InDesign for design and production. In general, three tasks are performed:

All text nodes containing only whitespace characters are deleted. This rids the document of whitespace used only for formatting and indenting in an xml editing application such as Oxygen.
Elements are re-named to reflect their position and context within the document. For example, a title element within a first-level topic would be re-named “TOPIC-1_title.”
Typographic whitespace characters, such as hard returns and tabs, are added where they might most commonly be needed.

Hotfolder location: XMLToIndesign/generalBookMagazineTransform/Input_FilesToBeConverted
Input hotfolder name	Input file format	Operation	Error handling
All_Non_Specific_Files	ldsXML document	Transforms input ldsXML document to InDesign markup Places the transformed xml document in generalBookMagazineTransform/Output_FilesConverted	Error messages are saved in generalBookMagazineTransform/ Errors_FilesThatFailedConversion.
General_Publications_toGR-XML	ldsXML document	Transforms input ldsXML document to InDesign markup Places the transformed xml document in cur-fs.ldschurch.org/GRAPHICS/GRAPHICS/GR-XML/XML Text