format.wwfmt
format.wwfmt files are located in the specific format directories.
Explanation
The format.wwfmt file defines all of the steps necessary to create output, and the relationships that each of these steps has to one another. These steps, called “stages” are grouped in “pipelines” of related stages. When every stage of every pipeline has been executed, the ePublisher Designer engine output is complete. There is no preconceived order in which pipelines fire; the ePublisher Designer engine calculates at run time the order in which each pipeline will fire. Users may create or delete pipelines, add or delete stages, or insert a <Depends /> element that will dictates when a stage or pipeline is executed.
Components
The root element of format.wwfmt is <Format />. The child elements are <Pipelines> and <Capabilities>. See example 3 for sample code.
<Pipelines>
The <Pipelines> element is a container element for the <Pipeline> elements that define the steps needed to generate the format. The only child element of the <Pipelines> element is <Pipeline>.
<Pipeline>:
The <Pipeline> element is a container element for the <Depends> and <Stage> elements which comprise a given segment of output files needed to generate a format. This element requires a name attribute so that it can be identified by <Depends> elements within other <Pipeline> elements. The <Pipeline> element contains the following child elements:
<Depends>:
This element specifies which other <Pipeline> elements the current <Pipeline> requires to complete its task. Including a <Depends> elemen t in a pipeline is the only way to ensure a Pipeline does not execute before another Pipeline on which it depends. The ePublisher Designer engine calculates at run time the order in which each Pipeline will run.
<Stage>:
This element identifies an action to perform and specifies a configuration for the action. The action is identified via the type and action attributes, usually an XSL stylesheet, and the configuration is defined with <Parameter> elements. These <parameter> elements define what is to be worked on, what will be created, and what else should be done with the result.
Note: With the exception of Global Files and GlobalProject, all parameters passed to XSL transforms are strings. Global Files and Global Project are node-sets which have already been loaded.
<Capabilities>
The <Capabilities> element contains only the child element <Capability> which defines information regarding what types of technologies or features a format supports.
<Capabilities>
<Capability name="merge-context" value="false" />
...
</Capabilities>
<Pipelines>
<Pipeline name="CompanyInfo">
<Stage type="xsl" action="wwtransform:common/companyinfo/companyinfo.xsl">
<!-- Pull in Company Info .fti file -->
<!-- -->
</Stage>
</Pipeline>
<Pipeline name="DocumentBehaviors">
<Stage type="xsl" action="wwtransform:common/behaviors/document.xsl">
<Parameter name="ParameterDropDowns" value="false" />
<Parameter name="ParameterPopups" value="false" />
...
</Stage>
<Stage type="xsl" action="wwtransform:common/behaviors/pullup.xsl">
<Parameter name="ParameterDropDowns" value="false" />
<Parameter name="ParameterPopups" value="false" />
...
</Stage>
</Pipeline>
</Pipelines>
Example 3: Sample Code Illustrating Child Elements, Attributes, and Values in the format.wwfmt file
Relationships
The locations of files generated by the action elements in the stages of the format.wwfmt file are stored in files.info. The format.wwfmt draws the same information from files.info as needed.
Was this helpful?
Last modified date: 08/16/2017