Printable Reports
Version |
Date |
Changes |
1.1 |
2007-12-06 |
Works. |
1.0 |
2007-11-30 |
Initial version. |
Supported Versions
Product |
Supported |
ePublisher 9.3 |
Yes |
NOTE: Printable reports were included in the 2008.1 release.
WWEP2572 Integrate Printable Reports into mainline build
Description
A set of ePublisher overrides which enable printable reports on the ePublisher platform.
Goal
Users have requested printable reports in ePublisher products. This is useful for:
- Hard-copy
- Supplying to other groups (such as Dev team reviewing topic IDs)
The current XML form of these reports are buried in the "Data" folder and are not easily
readable.
Requirements
The delivered solution should:
- Create a "Reports" folder in the project area.
- Copy XML reports to this new folder.
- Create an XSL stylesheet to pretty-print the existing XML reports.
This approach requires development of an XSL stylesheet and a stage to create the new
"Reports" folder.
Implementation
The implementation requires the following files:
XSL stylesheets added to the Shared transforms folder:
<project> Formats Shared reports printable.xsl printable_browser.xsl
Updated format definition files, format.wwfmt, which define processing stages for printable.xsl
<project> Formats Dynamic HTML format.wwfmt Microsoft HTML Help 1.x format.wwfmt Microsoft Reader format.wwfmt Oracle Help format.wwfmt Palm Reader format.wwfmt PDF format.wwfmt Simple HTML format.wwfmt Sun JavaHelp 1.1.3 format.wwfmt Sun JavaHelp 2.0 format.wwfmt WebWorks Help 5.0 format.wwfmt WinHelp format.wwfmt XML+XSL format.wwfmt
Custom Formats
A format.wwfmt file require two additional stages for each report type. One stage handles document level reports. The other stage handles group level reports. These actions must be performed for all defined report types.
For example, using the Dynamic HTML format.wwfmt as an example, pipeline Report-Styles transforms from:
<Pipeline name="Report-Styles">
<Depends pipeline="Locale" />
<Depends pipeline="Links" />
<Stage type="xsl" action="wwtransform:reports/styles/document.xsl">
<Parameter name="ParameterDependsType" value="engine:wif" />
<Parameter name="ParameterLinksType" value="links:project" />
<Parameter name="ParameterType" value="reports:styles:document" />
<Parameter name="ParameterUILocaleType" value="uilocale:project" />
<Parameter name="ParameterCategory" value="report" />
<Parameter name="ParameterUse" value="external" />
<Parameter name="ParameterDeploy" value="false" />
</Stage>
<Stage type="xsl" action="wwtransform:reports/group.xsl">
<Parameter name="ParameterDependsType" value="reports:styles:document" />
<Parameter name="ParameterType" value="reports:styles:group" />
<Parameter name="ParameterUILocaleType" value="uilocale:project" />
<Parameter name="ParameterCategory" value="report" />
<Parameter name="ParameterUse" value="external" />
<Parameter name="ParameterDeploy" value="false" />
</Stage>to:
<Pipeline name="Report-Styles">
<Depends pipeline="Locale" />
<Depends pipeline="Links" />
<Stage type="xsl" action="wwtransform:reports/styles/document.xsl">
<Parameter name="ParameterDependsType" value="engine:wif" />
<Parameter name="ParameterLinksType" value="links:project" />
<Parameter name="ParameterType" value="reports:styles:document" />
<Parameter name="ParameterUILocaleType" value="uilocale:project" />
<Parameter name="ParameterCategory" value="report" />
<Parameter name="ParameterUse" value="external" />
<Parameter name="ParameterDeploy" value="false" />
</Stage>
<Stage type="xsl" action="wwtransform:reports/group.xsl">
<Parameter name="ParameterDependsType" value="reports:styles:document" />
<Parameter name="ParameterType" value="reports:styles:group" />
<Parameter name="ParameterUILocaleType" value="uilocale:project" />
<Parameter name="ParameterCategory" value="report" />
<Parameter name="ParameterUse" value="external" />
<Parameter name="ParameterDeploy" value="false" />
</Stage>
<!-- Printable -->
<!-- -->
<Stage type="xsl" action="wwtransform:reports/printable.xsl">
<Parameter name="ParameterDependsType" value="reports:styles:document" />
<Parameter name="ParameterType" value="reports:styles:document:printable" />
<Parameter name="ParameterBrowserXSLType" value="reports:printable:xsl" />
<Parameter name="ParameterCategory" value="pages" />
<Parameter name="ParameterUse" value="external" />
<Parameter name="ParameterDeploy" value="false" />
</Stage>
<Stage type="xsl" action="wwtransform:reports/printable.xsl">
<Parameter name="ParameterDependsType" value="reports:styles:group" />
<Parameter name="ParameterType" value="reports:styles:group:printable" />
<Parameter name="ParameterBrowserXSLType" value="reports:printable:xsl" />
<Parameter name="ParameterCategory" value="navigation" />
<Parameter name="ParameterUse" value="external" />
<Parameter name="ParameterDeploy" value="false" />
</Stage>
</Pipeline>