Instant Reverse - Visual Paradigm

Instant Reverse - Visual Paradigm Instant Reverse - Visual Paradigm

media.visual.paradigm.com
from media.visual.paradigm.com More from this publisher
21.07.2013 Views

SDE-VS User’s Guide (Part 1) Chapter 6 – Generating Documentation The Generate HTML Dialog Box The Generate HTML dialog box provides a set of options for changing the report style. To display the dialog box, perform one of the following actions: • Select Modeling > Report > Generate HTML Report...from main menu. Output path Launch viewer Figure 6.24 - Generate HTML dialog Field Description To select the destination file for the generated report. You can type in the path in the text field or you can browse the location by clicking on the ... button. If this option is selected, the default browser of the system will be open automatically to show the generated report. Generate table of contents If this option is selected, table of contents 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. 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. Generate reference (file/URL) link Generate models/diagrams link Select to generate links for referenced files/URLs defined in models. Select to generate links for navigating to related models and diagrams. Copy reference files Select to copy referenced files defined in models to the report output directory. Shape type style Sort element by Details Icon - using Icon to represent the type of shape and diagram elements Text - using text to represent the type of shape and diagram elements Automatic - sorting elements by listing them in the most logical order, following most readers’ understanding of that kind of diagram Follow tree - sorting elements by following the sort order of the diagram tree in the tool id or name - sorting elements by their id or names You can refer to the section 'Sorting Elements in Report' near the bottom of this chapter. Children Select to generate children of model. Members Select to generate members of model. 6-15

SDE-VS User’s Guide (Part 1) Chapter 6 – Generating Documentation Properties Select to generate properties of model. Relationships Select to generate relationships of model. References Select to generate references of model. Sub-diagrams Select to generate sub-diagrams of model. Tagged values Select to generate tagged values of model. Comments Select to generate comments of model. Anti-aliasing Graphics To enable/disable the graphic anti-aliasing of the diagram images. Text To enable/disable the text anti-aliasing of the diagram images. Print Diagrams To select which diagram will be generated in the report. Generating an HTML Report To generate an HTML Report: 6-16 Table 6.9 1. Open the Generate HTML dialog box. 2. Specify the destination location of the report in the Output path field. 3. Configure the report properties, such as Generate diagrams, Generate reference (file/URL) link, etc...if necessary. 4. Select the template of the report that will be generated. 5. Select the diagram's image quality if Generate diagrams is selected. 6. Define advanced report information such as Front Page and Document Info if necessary. 7. Select the diagram to generate in the report. 8. Click Generate to start generating the report. Figure 6.25 - Generating HTML report Figure 6.26 - The generated HTML report Configuring Image Quality There are two image quality options for the HTML Report: graphics and text anti-aliasing. To enable/disable the anti-aliasing options, check/uncheck the anti-aliasing options checkbox. The below two images show the difference in graphics with antialiasing enabled (left) and graphics with anti-aliasing disabled (right). Figure 6.27 - Images with anti-aliasing Figure 6.28 - Images without anti-aliasing

SDE-VS User’s Guide (Part 1) Chapter 6 – Generating Documentation<br />

Properties Select to generate properties of model.<br />

Relationships Select to generate relationships of model.<br />

References Select to generate references of model.<br />

Sub-diagrams Select to generate sub-diagrams of model.<br />

Tagged values Select to generate tagged values of model.<br />

Comments Select to generate comments of model.<br />

Anti-aliasing<br />

Graphics To enable/disable the graphic anti-aliasing of the diagram images.<br />

Text To enable/disable the text anti-aliasing of the diagram images.<br />

Print Diagrams To select which diagram will be generated in the report.<br />

Generating an HTML Report<br />

To generate an HTML Report:<br />

6-16<br />

Table 6.9<br />

1. Open the Generate HTML dialog box.<br />

2. Specify the destination location of the report in the Output path field.<br />

3. Configure the report properties, such as Generate diagrams, Generate reference (file/URL) link, etc...if necessary.<br />

4. Select the template of the report that will be generated.<br />

5. Select the diagram's image quality if Generate diagrams is selected.<br />

6. Define advanced report information such as Front Page and Document Info if necessary.<br />

7. Select the diagram to generate in the report.<br />

8. Click Generate to start generating the report.<br />

Figure 6.25 - Generating HTML report Figure 6.26 - The generated HTML report<br />

Configuring Image Quality<br />

There are two image quality options for the HTML Report: graphics and text anti-aliasing. To enable/disable the anti-aliasing<br />

options, check/uncheck the anti-aliasing options checkbox. The below two images show the difference in graphics with antialiasing<br />

enabled (left) and graphics with anti-aliasing disabled (right).<br />

Figure 6.27 - Images with anti-aliasing Figure 6.28 - Images without anti-aliasing

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!