natas_hw
/
UMLGraph
mirror of https://github.com/dspinellis/UMLGraph
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix XHTML validity errors.

This commit is contained in:
Diomidis Spinellis 2006-01-04 22:40:37 +00:00
parent 6ed807ff6b
commit 6230ff6762
2 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/faq.xml
View File

@ -4,26 +4,26 @@
<!--
To update the table of contents execute the following vim command from a register
/^<h2>Contents jjma/ul> kmb/^$ "qyy:g/^<a name/s,<a name="\([^>]*\)><h2>\(.*\)</h2></a>,<li> <a href="\#\1>\2</a>,|y Q|u 'ad'b"qP
/^<h2>Contents jjma/ul> kmb/^$ "qyy:g/^<h2><a name/s,<h2><a name="\([^>]*\)>\(.*\)</a></h2>,<li> <a href="\#\1>\2</a></li>,|y Q|u 'ad'b"qP
-->
<h2>Contents</h2>
<ul>
<li> <a href="#utfsvg">Why are the SVG diagrams dot generates malformed?</a>
<li> <a href="#antialias">How can I improve the quality of the bitmap images I generate?</a>
<li> <a href="#layout">How can I improve the layout of my class diagrams?</a>
<li> <a href="#mclass">A class appears multiple times in a class diagram. Why?</a>
<li> <a href="#static">Shouldn't static fields appear underlined?</a>
<li> <a href="#winpic">Where can I find a <em>pic2plot</em> executable for Windows?</a>
<li> <a href="#cr">Under Windows the output of <em>pic2plot</em> appears empty. Why?</a>
<li> <a href="#maven">I have a problem with Maven's Dotuml plugin. Can you help me?</a>
<li> <a href="#autopic">How can I make the UMLGraph doclet generate sequence diagrams?</a>
<li> <a href="#packname">Why the vanity package name? Why not name the package org.umlgraph?</a>
<li> <a href="#unnamed">Why do the options specified in the <code>UMLOptions</code> class stop working, when I pass the <code>packagenames</code> option to <em>javadoc</em>?</a>
<li> <a href="#utfsvg">Why are the SVG diagrams dot generates malformed?</a></li>
<li> <a href="#antialias">How can I improve the quality of the bitmap images I generate?</a></li>
<li> <a href="#layout">How can I improve the layout of my class diagrams?</a></li>
<li> <a href="#mclass">A class appears multiple times in a class diagram. Why?</a></li>
<li> <a href="#static">Shouldn't static fields appear underlined?</a></li>
<li> <a href="#winpic">Where can I find a <em>pic2plot</em> executable for Windows?</a></li>
<li> <a href="#cr">Under Windows the output of <em>pic2plot</em> appears empty. Why?</a></li>
<li> <a href="#maven">I have a problem with Maven's Dotuml plugin. Can you help me?</a></li>
<li> <a href="#autopic">How can I make the UMLGraph doclet generate sequence diagrams?</a></li>
<li> <a href="#packname">Why the vanity package name? Why not name the package org.umlgraph?</a></li>
<li> <a href="#unnamed">Why do the options specified in the <code>UMLOptions</code> class stop working, when I pass the <code>packagenames</code> option to <em>javadoc</em>?</a></li>
</ul>
<a name="utfsvg"><h2>Why are the SVG diagrams dot generates malformed?</h2></a>
<h2><a name="utfsvg">Why are the SVG diagrams dot generates malformed?</a></h2>
UMLGraph uses guillemot characters for representing the angle brackets around
stereotypes, as in «interface».
By default these are encoded as ISO-8859-1 characters, which are illegal
@ -31,7 +31,7 @@ in the UTF-8 output that dot generates for SVG.
When using dot to generate SVG output, you should also specify
<code>-outputencoding utf8</code> to UMLGraph.
<a name="antialias"><h2>How can I improve the quality of the bitmap images I generate?</h2></a>
<h2><a name="antialias">How can I improve the quality of the bitmap images I generate?</a></h2>
Both
<em>dot</em> and
@ -66,7 +66,7 @@ convert the Postscript into encapsulated Postscript.
Of course, <em>groff</em> users will just use the <em>pic</em>
program as part of their processing pipeline.
<a name="layout"><h2>How can I improve the layout of my class diagrams?</h2></a>
<h2><a name="layout">How can I improve the layout of my class diagrams?</a></h2>
Try manipulating the <em>dot</em> parameters ratio, minlen, ranksep, and
nodesep.
For example, Arnaud Rogues recommends running <em>dot</em> with
@ -75,7 +75,7 @@ command-line arguments as follows.
dot -Gratio=0.7 -Eminlen=2
</fmtcode>
<a name="mclass"><h2>A class appears multiple times in a class diagram. Why?</h2></a>
<h2><a name="mclass">A class appears multiple times in a class diagram. Why?</a></h2>
Most probably your class diagram uses packages, and you are not
qualifying the classes with the respective package names in the
tags you use.
@ -107,20 +107,20 @@ class InnerNode extends AbstractNode {}
class Leaf extends AbstractNode {}
</fmtcode>
<a name="static"><h2>Shouldn't static fields appear underlined?</h2></a>
<h2><a name="static">Shouldn't static fields appear underlined?</a></h2>
Yes they should.
Unfortunately, <em>dot</em> does not (yet) support a way to underline
single labels, and thus <em>UMLGraph</em> can not show the static fields
underlined.
<a name="winpic"><h2>Where can I find a <em>pic2plot</em> executable for Windows?</h2></a>
<h2><a name="winpic">Where can I find a <em>pic2plot</em> executable for Windows?</a></h2>
A port of <em>pic2plot</em> for Windows can be found in
GNU PlotUtils, which is part of the
<a href="http://gnuwin32.sourceforge.net/packages.html">GnuWin32</a>
project.
<a name="cr"><h2>Under Windows the output of <em>pic2plot</em> appears empty. Why?</h2></a>
<h2><a name="cr">Under Windows the output of <em>pic2plot</em> appears empty. Why?</a></h2>
On Windows platforms note that the current version of
<em>pic2plot</em> appears to be very picky about carriage return (CR - \r)
characters (by default, CR is part of the platform's end of line sequence)
@ -142,16 +142,16 @@ Apparently, some Windows editors may leave the last line unterminated,
so if your editor is in this category it may be safer to add a blank line
in the end.
<a name="maven"><h2>I have a problem with Maven's Dotuml plugin. Can you help me?</h2></a>
<h2><a name="maven">I have a problem with Maven's Dotuml plugin. Can you help me?</a></h2>
Sorry, I did not develop this plugin, and therefore can not offer help.
Have a look at the project's documentation and mailing lists available through
<a href="http://maven-plugins.sourceforge.net/maven-dotuml-plugin/">plugin web page</a>.
<a name="autopic"><h2>How can I make the UMLGraph doclet generate sequence diagrams?</h2></a>
<h2><a name="autopic">How can I make the UMLGraph doclet generate sequence diagrams?</a></h2>
You can't.
You have to write the <em>pic</em> code for the sequence diagrams by hand.
<a name="packname"><h2>Why the vanity package name? Why not name the package org.umlgraph?</h2></a>
<h2><a name="packname">Why the vanity package name? Why not name the package org.umlgraph?</a></h2>
The package names are supposed to be unique.
If everybody names their project under the org.* namespace there's
no mechanism for ensuring that the name will be unique,
@ -159,7 +159,7 @@ unless the developer also registers the corresponding domain name.
Registering a different domain name for each project is not practical,
therefore I name the packages I develop using the domain name I own.
<a name="unnamed"><h2>Why do the options specified in the <code>UMLOptions</code> class stop working, when I pass the <code>packagenames</code> option to <em>javadoc</em>?</h2></a>
<h2><a name="unnamed">Why do the options specified in the <code>UMLOptions</code> class stop working, when I pass the <code>packagenames</code> option to <em>javadoc</em>?</a></h2>
When you pass the <code>packagenames</code> option to
<em>javadoc</em>, the default (unnamed) package (and the
<code>UMLOptions</code> class

1
doc/ver.xml
View File

@ -23,6 +23,7 @@ parameters -d, -view, -views (Andrea Aime)</li>
<li> Centralized option handling in the Option class (even for command line
arguments) (Andrea Aime).</li>
</ul>
</dd>
<dt>Version 4.1 2005/11/15</dt><dd>
<ul>