Configuring report

Report generation can be configured to make the output more close to your expectation. Common configuration options include whether to generate table of contents/figure or not, whether to generate shape/diagram type as icon or text, and whether to generate a particular type of detail such as children. Besides configuration options, you can also adjust the page setup, design the cover page and define header/footer. In this chapter, we will go through all the options one by one.

Options

Options

Option	Description
Generate table of contents	If this option is selected, table of content for this document will be generated to the report
Generate table of figures	If this option is selected, table of figures for this document will be generated to the report
Generate diagrams	If this option is selected, the image of the selected diagrams will be generated to the report. For PDF report, you can select the type of diagram. Here are the possible selections: PNG - Images will look exactly the same as the diagrams in your project, but not scalable against zooming. SVG - Due to its scalable nature, image content will remain clear regardless of the level of zooming. However, image may look a bit different from the original diagram as there is a conversion re-construction from raster graphic data to SVG image. SVG (text as shape) - Base on SVG, this option makes any text on diagram become text object, making it possible to select them in report content.
Generate diagram properties	If this option is selected, the properties of the selected diagrams will be generated to the report.
Generate diagram summary	If the option is selected, the summary of the selected diagrams will be generated to the report.
Include extra details	If the option is selected, information like ID and stereotypes will be generated to the summary table of report.
Suppress element with blank documentation in summary table	If the option is selected, diagram elements without documentation defined will not be generated to summary table.
Generate reference (file/URL) link	Select to generate links for referenced files/URLs defined in models.
Generate model elements/diagrams link	Select to generate links for navigating to related models and diagrams.
Skip heading for empty model element section	If this option is selected, heading for empty model element section will be skipped.
Convert multiline model heading to single line	If this option is selected, multiline model heading will be converted to single line.
Show multiline model name	If this option is selected, non heading multiline model name will remain in multiline, instead of being converted to single line.
Treat HTML content as HTML source	If this option is selected, HTML content will be treat as HTML source.
Suppress details if duplicated	If this option is selected, duplicated details will be suppressed.
Table cell keep together with page	If this option is selected, table cell will try to show on a page completely instead of breaking into separate pages.
Shape type style	Icon - using Icon to represent the type of shape and diagram elements Text - using text to represent the type of shape and diagram elements
RTF content appearance	Preserve formatting - using original formatting for RTF content Make font size consistent with the rest of the report - using same font size for RTF content in whole report Display in plain text - using plain text for RTF content
Copy reference files	If this option is selected, referenced files will be copy to output folder of report. With this option, you can copy the whole report folder to another machine and read there, without having broken file linkage for references.
Details	Select a kinds of content to generate it. Children - Everything a shape is containing. When selected, you can further select Model-based or Diagram-based for controlling the scope of children. Model-based consider all children the model of view contained. Diagram-based only consider the view in generating diagram. Let say if you have a package containing several classes. By selecting Model-based, all classes will be considered. By selecting Diagram-based, only the classes that are contained by the package in the generating diagram will be considered. Members - Attributes and operations are example of members. Properties - Name, documentation, abstract, leaf are example of properties. Relationships - Association, dependency are example of relationships References - File, diagram, folder, URL, shape are possible kinds of reference References documentation - Determine whether to generate the referenced shape/diagram's documentation in reference table Sub-diagrams - Sub-diagrams of a shape Comments - Comments of shape Tagged values - Tagged values of shape ORM Class Details - ORM class details specialized for ORM Persistable class Use Case Details - Use case details of use case
Anti-aliasing	Determine the quality of report content. Graphics - To enable/disable the graphic anti-aliasing of the diagram images. Text - To enable/disable the text anti-aliasing of the diagram images.
Font	Determines the font family of report content. This option is only available to PDF report.
Encoding	Determines the encoding of HTML file to be generated. This option is only available to HTML report.

A description of general options

Page Setup

Page setup controls the layout of report. You can adjust a report size, page orientation and margin.

Page setup

Option	Description
Page size	To select the paper size of the generated report.
Page orientation	This option is used to select the orientation of the report (portrait/landscape). This option is only available to PDF and MS Word report.
Page margin	To specify the page margins of the report. This option is only available to PDF and MS Word report.

A description of options of page setup

Cover Page (Front Page for HTML report generation)

Cover page is the first page of report. You can add your company logo there, and enter the report title, organization namd and author name. Notice that in HTML report generation, the tab Cover Page is named as Front Page.

Cover page

Option	Description
Generate cover page (PDF and MS Word) Generate front page (HTML)	If this option is selected, there will be a cover page generated to the report.
Logo image path	An image that appear at the report. You are expected to supply the file path of the image file. The drop down menu at the right hand side is for controlling the position of image.
Logo scale	Control the scale of logo image. This option is only available to PDF and MS Word report.
Title	The title text
Organization name	The organization name text
Author name	The author name text

A description of options of cover page

Header/Footer

Header and footer refers to the content that appear in the top and bottom of every page in report. For MS Word report, there are two text boxes for you to edit the header and footer. For PDF report, there are six boxes, three for each of header and footer. Each of the text box represent a region in header/footer, such as the top left text box refers to the left region of header, while the bottom right text box refers to the right region of footer.

Instead of typing in the content of header/footer, there are a set of variables for you to apply with. The following table provides you with description with each of the variable.

Header/Footer

Variable	Name	Description
	Selection font	Font settings of selected content
	Align to left	Align content to the left of header/footer. This option is available only to MS Word report.
	Align to center	Align content to the center of header/footer. This option is available only to MS Word report.
	Align to right	Align content to the right of header/footer. This option is available only to MS Word report.
	Add image	Insert an image to the position where the text cursor is placing.
	Insert page number	Insert page number to the position where the text cursor is placing.
	Insert page count	Insert page count to the position where the text cursor is placing.
	Insert date	Insert the date of when the report is generated to the position where the text cursor is placing.
	Insert time	Insert the time of when the report is generated to the position where the text cursor is placing.
	Insert project name	Insert the project name to the position where the text cursor is placing.
	Insert report file name	Insert the name of report file to the position where the text cursor is placing.
	Insert user name	Insert the name of the user logging into the system to the position where the text cursor is placing.

A description of variables that can be used in header and footer

Document Info

For HTML report, document info refers to the meta information of HTML document. For PDF and MS Word report, document info refers to the possible document properties that can be defined.

Document info

Option	Description
Title	The title of report.
Author	The author of the report. This option is only available to PDF report.
Subject	The subject of the report.
Keywords	The keywords of the report.
Info header	The info header of the report. This option is only available to PDF report.
Info header content	The info header content of the report. This option is only available to PDF report.
Allow modify	Select to allow modification on the report. This option is only available to PDF report.

A description of document info