FlexDoc.XYZ - Formatting Features

Output formats

Output documents can be generated in HTML or RTF formats with the maximum support of formatting techniques provided in the both formats.

At the same time, the architecture of FlexDoc and its templates allows designing templates independently on a particular destination format. The necessary format is selected just when starting the generator. All instructions and settings contained in the template will be rendered with the appropriate features of the selected output format. So, once the template has been created, it can be used to produce the best quality output documents in any format supported by the latest version of FlexDoc.

The current version of FlexDoc SDK supports generation output in the following formats:

TXT is a plain text output without any formatting features. It can be found useful in some applications as well. In the next version, it is planned to support the XSL-FO output generation.

Text formatting

Paragraphs

Formatting Styles

Borders  (of text / paragraph / table / image)

Tables

Lists

Document fields  (RTF)

Page formatting  (RTF)

Image formatting

Rendering of embedded HTML

FlexDoc allows to render HTML tags inserted within the text data (for instance, the HTML formatting used in Java source comments).

When such a rendering is specified, while generating of an HTML output, the HTML tags are passed as is. However, in other formats, the embedded HTML tags need to be parsed and rendered with the appropriate features supported in the given output format.

FlexDoc is able to do this in the way that the output markup produced by the rendering of the embedded HTML tags is smoothly integrated with that resulted from interpreting of the formatting directly specified in template components.

This is implemented in some universal way for all possible non-HTML output formats. Almost all HTML tags practically usable in doc-comments are supported now. Here's the list of the supported tags:

Text <b>, <strong>, <i>, <em>, <code>, <tt>, <u>, <s>, <strike>, <sub>, <sup>, <font>, <br>
Paragraphs <p>, <center>, <div>, <pre>, <h1>, <h2>, <h3>, <h4>, <h5>, <h6>, <blockquote>
Lists <ul>, <ol>, <li>, <dl>, <dt>, <dd>
Table <table>, <tr>, <td>, <th>
Other <hr>, <img>, <a>...</a>

See FlexDoc/Javadoc | JavadocClassic | Demo | RTF demo for an example result produced by the rendering of embedded HTML.