The official documentation is at: http://docs.alfresco.com
The HTML rendering engine is designed to generate accessible HTML from textual contents. As of 3.4, only Word (.docx) is supported as an input format, however the framework is capable of supporting additional formats in the future as demand requires.
The HTML rendering engine is designed to support uses cases covering simple extraction of content from documents into HTML. This removes the need for cutting and pasting and the associated issues with importing in-accessible mark-up.
The HTML rendering engine is not designed to import and map identical style information from a document ready for automatic publication, moreover provides a time saving facility for a content author to extract content ready for editorial activity.
An example of where the HTML rendering engine may be used is within the Web Quick Start.
Like all rendering engines, the HTML Rendering Engine generates one (HTML) rendition node from a given source node. However, it is also able to extract embedded images from the source node's binary content if present (eg inline images in the text), and place them in a similar location to the HTML rendition node. The exact location of these extracted embedded images is controlled by the rendition parameters.
In addition to all the standard rendition definition parameters, there are two specific parameters for the rendering engine
- PARAM_BODY_CONTENTS_ONLY: (boolean) By default, the rendition is a full HTML document, including header and body. For some WCM use cases, the rendition content is to be used inside an existing HTML document, and so the header and body tags are not required. Setting this to true will mean the rendition holds only the contents of the HTML body tag, excluding the body tag itself.
- PARAM_IMAGES_SAME_FOLDER: (boolean) By default, any embedded images are placed into a new folder that will be a sibling of the rendition node. If this is set to true, instead the embedded images will be created as direct siblings of the rendition.
Word (.docx) Supported Features
- Normal header styles are mapped to HTML h# tags
- Custom header styles are mapped to HTML h# tags, and a class of the style name is applied
- Custom paragraph styles are mapped to a class applied to the paragraph
- Bold and Italic
- Tables (including nested tables)
- Page Headers and Footers as paragraphs with an appropriate style