Instant Reverse - Visual Paradigm
Instant Reverse - Visual Paradigm Instant Reverse - Visual Paradigm
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
- Page 115 and 116: SDE-VS User’s Guide (Part 1) Chap
- Page 117 and 118: SDE-VS User’s Guide (Part 1) Chap
- Page 119 and 120: SDE-VS User’s Guide (Part 1) Chap
- Page 121 and 122: SDE-VS User’s Guide (Part 1) Chap
- Page 123 and 124: SDE-VS User’s Guide (Part 1) Chap
- Page 125 and 126: SDE-VS User’s Guide (Part 1) Chap
- Page 127 and 128: SDE-VS User’s Guide (Part 1) Chap
- Page 129 and 130: SDE-VS User’s Guide (Part 1) Chap
- Page 131 and 132: SDE-VS User’s Guide (Part 1) Chap
- Page 133 and 134: SDE-VS User’s Guide (Part 1) Chap
- Page 135 and 136: SDE-VS User’s Guide (Part 1) Chap
- Page 137 and 138: SDE-VS User’s Guide (Part 1) Chap
- Page 139 and 140: SDE-VS User’s Guide (Part 1) Chap
- Page 141 and 142: SDE-VS User’s Guide (Part 1) Chap
- Page 143 and 144: SDE-VS User’s Guide (Part 1) Chap
- Page 145 and 146: SDE-VS User’s Guide (Part 1) Chap
- Page 147 and 148: SDE-VS User’s Guide (Part 1) Chap
- Page 149 and 150: SDE-VS User’s Guide (Part 1) Chap
- Page 151 and 152: SDE-VS User’s Guide (Part 1) Chap
- Page 153 and 154: SDE-VS User’s Guide (Part 1) Chap
- Page 155 and 156: SDE-VS User’s Guide (Part 1) Chap
- Page 157 and 158: SDE-VS User’s Guide (Part 1) Chap
- Page 159 and 160: SDE-VS User’s Guide (Part 1) Chap
- Page 161 and 162: SDE-VS User’s Guide (Part 1) Chap
- Page 163 and 164: SDE-VS User’s Guide (Part 1) Chap
- Page 165: SDE-VS User’s Guide (Part 1) Chap
- Page 169 and 170: SDE-VS User’s Guide (Part 1) Chap
- Page 171 and 172: SDE-VS User’s Guide (Part 1) Chap
- Page 173 and 174: SDE-VS User’s Guide (Part 1) Chap
- Page 175 and 176: SDE-VS User’s Guide (Part 1) Chap
- Page 177 and 178: SDE-VS User’s Guide (Part 1) Chap
- Page 179 and 180: SDE-VS User’s Guide (Part 1) Chap
- Page 181 and 182: SDE-VS User’s Guide (Part 1) Chap
- Page 183 and 184: SDE-VS User’s Guide (Part 1) Chap
- Page 185 and 186: SDE-VS User’s Guide (Part 1) Chap
- Page 187 and 188: SDE-VS User’s Guide (Part 1) Chap
- Page 189 and 190: SDE-VS User’s Guide (Part 1) Chap
- Page 191 and 192: SDE-VS User’s Guide (Part 1) Chap
- Page 193 and 194: SDE-VS User’s Guide (Part 1) Chap
- Page 195 and 196: SDE-VS User’s Guide (Part 1) Chap
- Page 197 and 198: SDE-VS User’s Guide (Part 1) Chap
- Page 199 and 200: SDE-VS User’s Guide (Part 1) Chap
- Page 201 and 202: SDE-VS User’s Guide (Part 1) 4. T
- Page 203 and 204: SDE-VS User’s Guide (Part 1) Chap
- Page 205 and 206: SDE-VS User’s Guide (Part 1) Chap
- Page 207 and 208: SDE-VS User’s Guide (Part 1) Chap
- Page 209 and 210: SDE-VS User’s Guide (Part 1) Chap
- Page 211 and 212: SDE-VS User’s Guide (Part 1) Chap
- Page 213 and 214: SDE-VS User’s Guide (Part 1) Chap
- Page 215 and 216: SDE-VS User’s Guide (Part 1) Chap
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