2 <!DOCTYPE chapter SYSTEM "../doc.dtd">
3 <?xml-stylesheet type="text/xsl" href="../html.xsl"?>
6 XML documentation system
7 Original author : Arjen Baart - arjen@andromeda.nl
8 Version : $Revision: 1.3 $
12 <heading><label name='inline'/>Type styles and special characters</heading>
14 There are six type styles:
17 <item><code>emph</code> : <emph>Emphasized text</emph></item>
18 <item><code>strong</code> : <strong>Usually bold face</strong></item>
19 <item><code>code</code> : <code>For literal coding names</code></item>
20 <item><code>remark</code> : <remark>For highlighted remarks</remark></item>
21 <item><code>sub</code> : For <sub>subscript</sub> text.</item>
22 <item><code>sup</code> : For <sup>superscript</sup> text.</item>
26 <heading><label name='color'/>Color and size</heading>
28 Normally, if not redefined by additional style sheets, the text is
29 printed in black on a white background.
30 You can create text in other colors with the <strong>color</strong> element.
31 Which color the output text should become is specified in the
32 <strong>colorname</strong> attribute, for example:
36 <color colorname='red'>Red text</color>
40 It is not possible to create any color; there are just a few predefined
42 <color colorname='red'>red</color>,
43 <color colorname='green'>green</color>,
44 <color colorname='blue'>blue</color>,
45 <color colorname='cyan'>cyan</color>,
46 <color colorname='magenta'>magenta</color>,
47 <color colorname='yellow'>yellow</color>,
48 <color colorname='orange'>orange</color>,
49 <color colorname='violet'>violet</color>,
50 <color colorname='purple'>purple</color>,
51 <color colorname='brown'>brown</color>,
52 <color colorname='pink'>pink</color>,
53 <color colorname='olive'>olive</color>,
54 <color colorname='black'>black</color>,
55 <color colorname='darkgray'>darkgray</color>,
56 <color colorname='gray'>gray</color>,
57 <color colorname='lightgray'>lightgray</color> and
58 <color colorname='white'>white</color>.
59 The last, color (white) is probably invisible :-).
63 NOTE: To make colored text work with LaTeX, you probably need to install
64 the <emph>latex-xcolor</emph> package.
67 Apart from the normal font size, there are two other sizes available:
68 <strong>big</strong>and <strong>small</strong>.
69 These element will make the text slightly bigger or smaller, like this:
72 Here is <small>some small text</small> and <big>a big phrase</big>.
75 Here is <small>some small text</small> and <big>a big phrase</big>.
80 <heading><label name='break'/>Line and page breaking</heading>
83 You can force the start of a new line of output with the empty
84 <code>newline</code> element.
85 This element has no attributes and no content.
86 Starting a new page with the <code>newpage</code> element is only
87 usefull when you create LaTeX output.
93 <heading><label name='escape'/>Output escapes</heading>
96 You can insert eny piece of text into a specific output target by using
97 an escape element. An escape element is an element with the name of the
98 output format and a single <code>command</code> attribute.
99 For example, the <code>LaTeX</code> is used to put arbitrary text into
100 the output of <code>xml2latex</code>.
101 The content of its <code>command</code> attribute is copied literally
103 One of the applications of the <code>LaTeX</code> escape element is to
104 control the first line indent of a paragraph in LaTeX:
108 <LaTeX command='\setlength{\parindent}{0cm}'/>
112 Note that it is not possible to create HTML tags in this manner.
118 <heading>Special characters</heading>
121 LaTeX special characters: #, $, %, &, ~, _, ^, \, { and }
125 You can include special characters, such as accented letters, Greek letter and
126 mathematical symbols with the <code>&<emph>symbol</emph>;</code> syntax,
128 The special characters defined in the XMLDoc's DTD are listed in the following tables.
133 <heading>Special characters from the Latin-1 set</heading>
137 <col>code</col><col>symbol</col>
138 <col>Description</col>
141 <col>iexcl</col><col>¡</col><col>Inverted exclamation mark</col>
144 <col>cent</col><col>¢</col><col>Cent sign</col>
147 <col>pound</col><col>£</col><col>Pound sign</col>
150 <col>curren</col><col>¤</col><col>Currency sign</col>
153 <col>yen</col><col>¥</col><col>Yen sign</col>
156 <col>brvbar</col><col>¦</col><col>Broken vertical bar</col>
159 <col>sect</col><col>§</col><col>Section sign</col>
162 <col>uml</col><col>¨</col><col>Spacing diaeresis</col>
165 <col>copy</col><col>©</col><col>Copyright sign</col>
168 <col>ordf</col><col>ª</col><col>Feminine oridinal indicator</col>
171 <col>laquo</col><col>«</col><col>Left pointing double angle quotation</col>
174 <col>not</col><col>¬</col><col>Not sign</col>
177 <col>shy</col><col>­</col><col>Soft hyphen</col>
180 <col>reg</col><col>®</col><col>Registered sign</col>
183 <col>macr</col><col>¯</col><col>Spacing macron</col>
186 <col>deg</col><col>°</col><col>Degree sign</col>
189 <col>plusmn</col><col>±</col><col>Plus-minus sign</col>
192 <col>sup2</col><col>²</col><col>Superscript digit 2</col>
195 <col>sup3</col><col>³</col><col>Superscript digit 3</col>
198 <col>acute</col><col>´</col><col>Spacing acute accent</col>
201 <col>micro</col><col>µ</col><col>Micro sign</col>
204 <col>para</col><col>¶</col><col>Paragraph sign</col>
207 <col>middot</col><col>·</col><col>Middot sign</col>
210 <col>cedil</col><col>¸</col><col>Spacing cedilla</col>
213 <col>sup1</col><col>¹</col><col>Superscript digit 1</col>
216 <col>ordm</col><col>º</col><col>Masculine ordinal indicator</col>
219 <col>raquo</col><col>»</col><col>Right pointing double angle quotation</col>
222 <col>frac14</col><col>¼</col><col>Vulgar fraction one quarter</col>
225 <col>frac12</col><col>½</col><col>Vulgar fraction one half</col>
228 <col>frac34</col><col>¾</col><col>Vulgar fraction three quarters</col>
231 <col>iquest</col><col>¿</col><col>Inverted question mark</col>
234 <col>AElig</col><col>Æ</col><col>Capital ligature AE</col>
237 <col>aelig</col><col>æ</col><col>Small ligature ae</col>
240 <col>OElig</col><col>Œ</col><col>Capital ligature OE</col>
243 <col>oelig</col><col>œ</col><col>Small ligature oe</col>
246 <col>szlig</col><col>ß</col><col>Small letter sharp s</col>
249 <col>ETH</col><col>Ð</col><col>Capital letter ETH</col>
252 <col>THORN</col><col>Þ</col><col>Capital letter THORN</col>
255 <col>eth</col><col>ð</col><col>Small letter eth</col>
258 <col>thorn</col><col>þ</col><col>Small letter thorn</col>
261 <col>times</col><col>×</col><col>Multiplication sign</col>
264 <col>divide</col><col>÷</col><col>Division sign</col>
270 <heading>Accented letters</heading>
274 <col><strong>code</strong></col><col><strong>symbol</strong></col>
275 <col><strong>Description</strong></col>
278 <col>Agrave</col><col>À</col><col>Capital letter A with grave</col>
281 <col>Aacute</col><col>Á</col><col>Capital letter A with acute</col>
284 <col>Acirc</col><col>Â</col><col>Capital letter A with circumflex</col>
287 <col>Atilde</col><col>Ã</col><col>Capital letter A with tilde</col>
290 <col>Auml</col><col>Ä</col><col>Capital letter A with diaeresis</col>
293 <col>Aring</col><col>Å</col><col>Capital letter A with ring above</col>
296 <col>Ccedil</col><col>Ç</col><col>Capital letter C with cedilla</col>
299 <col>Egrave</col><col>È</col><col>Capital letter E with grave</col>
302 <col>Eacute</col><col>É</col><col>Capital letter E with acute</col>
305 <col>Ecirc</col><col>Ê</col><col>Capital letter E with circumflex</col>
308 <col>Euml</col><col>Ë</col><col>Capital letter E with diaeresis</col>
311 <col>Igrave</col><col>Ì</col><col>Capital letter I with grave</col>
314 <col>Iacute</col><col>Í</col><col>Capital letter I with acute</col>
317 <col>Icirc</col><col>Î</col><col>Capital letter I with circumflex</col>
320 <col>Iuml</col><col>Ï</col><col>Capital letter I with diaeresis</col>
323 <col>Ntilde</col><col>Ñ</col><col>Capital letter N with tilde</col>
326 <col>Ograve</col><col>Ò</col><col>Capital letter O with grave</col>
329 <col>Oacute</col><col>Ó</col><col>Capital letter O with acute</col>
332 <col>Ocirc</col><col>Ô</col><col>Capital letter O with circumflex</col>
335 <col>Otilde</col><col>Õ</col><col>Capital letter O with tilde</col>
338 <col>Ouml</col><col>Ö</col><col>Capital letter O with diaeresis</col>
341 <col>Oslash</col><col>Ø</col><col>Capital letter O with stroke</col>
344 <col>Ugrave</col><col>Ù</col><col>Capital letter U with grave</col>
347 <col>Uacute</col><col>Ú</col><col>Capital letter U with acute</col>
350 <col>Ucirc</col><col>Û</col><col>Capital letter U with circumflex</col>
353 <col>Uuml</col><col>Ü</col><col>Capital letter U with diaeresis</col>
356 <col>Yacute</col><col>Ý</col><col>Capital letter Y with acute</col>
359 <col>Yuml</col><col>Ÿ</col><col>Capital letter Y with diaeresis</col>
362 <col>agrave</col><col>à</col><col>Small letter a with grave</col>
365 <col>aacute</col><col>á</col><col>Small letter a with acute</col>
368 <col>acirc</col><col>â</col><col>Small letter a with circumflex</col>
371 <col>atilde</col><col>ã</col><col>Small letter a with tilde</col>
374 <col>auml</col><col>ä</col><col>Small letter a with diaeresis</col>
377 <col>aring</col><col>å</col><col>Small letter a with ring above</col>
380 <col>ccedil</col><col>ç</col><col>Small letter c with cedilla</col>
383 <col>egrave</col><col>è</col><col>Small letter e with grave</col>
386 <col>eacute</col><col>é</col><col>Small letter e with acute</col>
389 <col>ecirc</col><col>ê</col><col>Small letter e with circumflex</col>
392 <col>euml</col><col>ë</col><col>Small letter e with diaeresis</col>
395 <col>igrave</col><col>ì</col><col>Small letter i with grave</col>
398 <col>iacute</col><col>í</col><col>Small letter i with acute</col>
401 <col>icirc</col><col>î</col><col>Small letter i with circumflex</col>
404 <col>iuml</col><col>ï</col><col>Small letter i with diaeresis</col>
410 <col><strong>code</strong></col><col><strong>symbol</strong></col>
411 <col><strong>Description</strong></col>
414 <col>ntilde</col><col>ñ</col><col>Small letter n with tilde</col>
417 <col>ograve</col><col>ò</col><col>Small letter o with grave</col>
420 <col>oacute</col><col>ó</col><col>Small letter o with acute</col>
423 <col>ocirc</col><col>ô</col><col>Small letter o with circumflex</col>
426 <col>otilde</col><col>õ</col><col>Small letter o with tilde</col>
429 <col>ouml</col><col>ö</col><col>Small letter o with diaeresis</col>
432 <col>oslash</col><col>ø</col><col>Capital letter o with stroke</col>
435 <col>ugrave</col><col>ù</col><col>Small letter u with grave</col>
438 <col>uacute</col><col>ú</col><col>Small letter u with acute</col>
441 <col>ucirc</col><col>û</col><col>Small letter u with circumflex</col>
444 <col>uuml</col><col>ü</col><col>Small letter u with diaeresis</col>
447 <col>yacute</col><col>ý</col><col>Small letter y with acute</col>
450 <col>yuml</col><col>ÿ</col><col>Small letter y with diaeresis</col>
453 <col>Scaron</col><col>Š</col><col>Capital letter S with caron</col>
456 <col>scaron</col><col>š</col><col>Small letter s with caron</col>
462 <heading>Greek Letters</heading>
466 <col><strong>code</strong></col><col><strong>symbol</strong></col>
467 <col><strong>Description</strong></col>
470 <col>Alpha</col><col>Α</col><col>Greek capital letter Alpha</col>
473 <col>Beta</col><col>Β</col><col>Greek capital letter Beta</col>
476 <col>Gamma</col><col>Γ</col><col>Greek capital letter Gamma</col>
479 <col>Delta</col><col>Δ</col><col>Greek capital letter Delta</col>
482 <col>Epsilon</col><col>Ε</col><col>Greek capital letter Epsilon</col>
485 <col>Zeta</col><col>Ζ</col><col>Greek capital letter Zeta</col>
488 <col>Eta</col><col>Η</col><col>Greek capital letter Eta</col>
491 <col>Theta</col><col>Θ</col><col>Greek capital letter Theta</col>
494 <col>Iota</col><col>Ι</col><col>Greek capital letter Iota</col>
497 <col>Kappa</col><col>Κ</col><col>Greek capital letter Kappa</col>
500 <col>Lambda</col><col>Λ</col><col>Greek capital letter Lambda</col>
503 <col>Mu</col><col>Μ</col><col>Greek capital letter Mu</col>
506 <col>Nu</col><col>Ν</col><col>Greek capital letter Nu</col>
509 <col>Xi</col><col>Ξ</col><col>Greek capital letter Xi</col>
512 <col>Omicron</col><col>Ο</col><col>Greek capital letter Omicron</col>
515 <col>Pi</col><col>Π</col><col>Greek capital letter Pi</col>
518 <col>Rho</col><col>Ρ</col><col>Greek capital letter Rho</col>
521 <col>Sigma</col><col>Σ</col><col>Greek capital letter Sigma</col>
524 <col>Tau</col><col>Τ</col><col>Greek capital letter Tau</col>
527 <col>Upsilon</col><col>Υ</col><col>Greek capital letter Upsilon</col>
530 <col>Phi</col><col>Φ</col><col>Greek capital letter Phi</col>
533 <col>Chi</col><col>Χ</col><col>Greek capital letter Chi</col>
536 <col>Psi</col><col>Ψ</col><col>Greek capital letter Psi</col>
539 <col>Omega</col><col>Ω</col><col>Greek capital letter Omega</col>
542 <col>alpha</col><col>α</col><col>Greek small letter alpha</col>
545 <col>beta</col><col>β</col><col>Greek small letter beta</col>
548 <col>gamma</col><col>γ</col><col>Greek small letter gamma</col>
551 <col>delta</col><col>δ</col><col>Greek small letter delta</col>
554 <col>epsilon</col><col>ε</col><col>Greek small letter epsilon</col>
557 <col>zeta</col><col>ζ</col><col>Greek small letter zeta</col>
560 <col>eta</col><col>η</col><col>Greek small letter eta</col>
563 <col>theta</col><col>θ</col><col>Greek small letter theta</col>
566 <col>iota</col><col>ι</col><col>Greek small letter iota</col>
569 <col>kappa</col><col>κ</col><col>Greek small letter kappa</col>
572 <col>lambda</col><col>λ</col><col>Greek small letter lambda</col>
575 <col>mu</col><col>μ</col><col>Greek small letter mu</col>
578 <col>nu</col><col>ν</col><col>Greek small letter nu</col>
581 <col>xi</col><col>ξ</col><col>Greek small letter xi</col>
584 <col>omicron</col><col>ο</col><col>Greek small letter omicron</col>
587 <col>pi</col><col>π</col><col>Greek small letter pi</col>
590 <col>rho</col><col>ρ</col><col>Greek small letter rho</col>
593 <col>sigmaf</col><col>ς</col><col>Greek small letter final sigma</col>
596 <col>sigma</col><col>σ</col><col>Greek small letter sigma</col>
599 <col>tau</col><col>τ</col><col>Greek small letter tau</col>
602 <col>upsilon</col><col>υ</col><col>Greek small letter upsilon</col>
605 <col>phi</col><col>φ</col><col>Greek small letter phi</col>
608 <col>chi</col><col>χ</col><col>Greek small letter chi</col>
611 <col>psi</col><col>ψ</col><col>Greek small letter psi</col>
614 <col>omega</col><col>ω</col><col>Greek small letter omega</col>
620 <heading>Special Symbols</heading>
624 <col><strong>code</strong></col><col><strong>symbol</strong></col>
625 <col><strong>Description</strong></col>
628 <col>euro</col><col>€</col><col>Euro symbol</col>
631 <col>dagger</col><col>†</col><col>Dagger</col>
634 <col>Dagger</col><col>‡</col><col>Double dagger</col>
637 <col>bull</col><col>•</col><col>Bullet</col>
640 <col>hellip</col><col>…</col><col>Horizontal ellipsis</col>
643 <col>prime</col><col>′</col><col>Prime</col>
646 <col>Prime</col><col>″</col><col>Double prime</col>
649 <col>oline</col><col>‾</col><col>Overline</col>
652 <col>weierp</col><col>℘</col><col>Power set</col>
655 <col>image</col><col>ℑ</col><col>Imaginary part</col>
658 <col>real</col><col>ℜ</col><col>Real part</col>
661 <col>trade</col><col>™</col><col>Trade mark sign</col>
664 <col>alefsym</col><col>ℵ</col><col>First transfinite cardinal</col>
667 <col>larr</col><col>←</col><col>Leftwards arrow</col>
670 <col>uarr</col><col>↑</col><col>Upwards arrow</col>
673 <col>rarr</col><col>→</col><col>Rightwards arrow</col>
676 <col>darr</col><col>↓</col><col>Downwards arrow</col>
679 <col>harr</col><col>↔</col><col>Left right arrow</col>
682 <col>crarr</col><col>↵</col><col>Carriage return</col>
685 <col>lArr</col><col>⇐</col><col>Leftwards double arrow</col>
688 <col>uArr</col><col>⇑</col><col>Upwards double arrow</col>
691 <col>rArr</col><col>⇒</col><col>Rightwards double arrow</col>
694 <col>dArr</col><col>⇓</col><col>Downwards double arrow</col>
697 <col>hArr</col><col>⇔</col><col>Left right double arrow</col>
700 <col>loz</col><col>◊</col><col>Lozenge</col>
703 <col>spades</col><col>♠</col><col>Spade suit</col>
706 <col>clubs</col><col>♣</col><col>Club suit</col>
709 <col>hearts</col><col>♥</col><col>Heart suit</col>
712 <col>diams</col><col>♦</col><col>Diamond suit</col>
718 <heading>Mathematical Symbols</heading>
722 <col><strong>code</strong></col><col><strong>symbol</strong></col>
723 <col><strong>Description</strong></col>
726 <col>forall</col><col>∀</col><col>For all</col>
729 <col>part</col><col>∂</col><col>Partial differential</col>
732 <col>exist</col><col>∃</col><col>There exists</col>
735 <col>empty</col><col>∅</col><col>Empty set</col>
738 <col>nabla</col><col>∇</col><col>Nabla, backward difference</col>
741 <col>isin</col><col>∈</col><col>Element of</col>
744 <col>notin</col><col>∉</col><col>Not an element of</col>
747 <col>ni</col><col>∋</col><col>Contains as member</col>
750 <col>prod</col><col>∏</col><col>Product sign</col>
753 <col>sum</col><col>∑</col><col>Summation sign</col>
756 <col>minus</col><col>−</col><col>Minus sign</col>
759 <col>lowast</col><col>∗</col><col>Asterisk operator</col>
762 <col>radic</col><col>√</col><col>Square root</col>
765 <col>prop</col><col>∝</col><col>Proportional to</col>
768 <col>infin</col><col>∞</col><col>Infinity</col>
771 <col>ang</col><col>∠</col><col>Angle</col>
774 <col>and</col><col>∧</col><col>Logical AND</col>
777 <col>or</col><col>∨</col><col>Logical OR</col>
780 <col>cap</col><col>∩</col><col>Intersection</col>
783 <col>cup</col><col>∪</col><col>Union</col>
786 <col>int</col><col>∫</col><col>Integral</col>
789 <col>there4</col><col>∴</col><col>Therefore</col>
792 <col>sim</col><col>∼</col><col>Similar to</col>
795 <col>cong</col><col>≅</col><col>Approximately equal to</col>
798 <col>asymp</col><col>≈</col><col>Asymptotic to</col>
801 <col>ne</col><col>≠</col><col>Not equal to</col>
804 <col>equiv</col><col>≡</col><col>Equivalent to</col>
807 <col>le</col><col>≤</col><col>Less than or equal to</col>
810 <col>ge</col><col>≥</col><col>Greater than or equal to</col>
813 <col>sub</col><col>⊂</col><col>Subset of</col>
816 <col>sup</col><col>⊃</col><col>Superset of</col>
819 <col>nsub</col><col>⊄</col><col>Not a subset of</col>
822 <col>sube</col><col>⊆</col><col>Subset of or equal to</col>
825 <col>supe</col><col>⊇</col><col>Superset of or equal to</col>
828 <col>oplus</col><col>⊕</col><col>Direct sum</col>
831 <col>otimes</col><col>⊗</col><col>Vector product</col>
834 <col>perp</col><col>⊥</col><col>Perpendicular to</col>
837 <col>sdot</col><col>⋅</col><col>Dot operator</col>
840 <col>lceil</col><col>⌈</col><col>Left ceiling</col>
843 <col>rceil</col><col>⌉</col><col>Right ceiling</col>
846 <col>lfloor</col><col>⌊</col><col>Left floor</col>
849 <col>rfloor</col><col>⌋</col><col>Right floor</col>
852 <col>lang</col><col>⟨</col><col>Left pointing angle bracket</col>
855 <col>rang</col><col>⟩</col><col>Right pointing angle bracket</col>
861 Note that some symbols are not available in LaTeX.