Difference between revisions of "Documentation/DevGuide/AppendixB/Useful XHTML Tags"
Line 14: | Line 14: | ||
{{Warn|Do not use <nowiki><br/></nowiki> or CR/LF for marking paragraphs. CR and LF are ignored, except within <nowiki><pre>...</pre></nowiki> and <nowiki><listing>...</listing></nowiki> areas. The <nowiki><br/></nowiki> tag is only for rare cases of explicit linebreaks. | {{Warn|Do not use <nowiki><br/></nowiki> or CR/LF for marking paragraphs. CR and LF are ignored, except within <nowiki><pre>...</pre></nowiki> and <nowiki><listing>...</listing></nowiki> areas. The <nowiki><br/></nowiki> tag is only for rare cases of explicit linebreaks. | ||
− | < | + | <syntaxhighlight lang="cpp"> |
/** does this and that. | /** does this and that. | ||
Line 23: | Line 23: | ||
As this sentence is as well! | As this sentence is as well! | ||
*/ | */ | ||
− | </ | + | </syntaxhighlight> |
Consider using <tt>&lt;</tt> for <tt><</tt> and <tt>&gt;</tt> for <tt>></tt>, as shown in the example above.}} | Consider using <tt>&lt;</tt> for <tt><</tt> and <tt>&gt;</tt> for <tt>></tt>, as shown in the example above.}} | ||
Line 36: | Line 36: | ||
Example: | Example: | ||
− | + | <syntaxhighlight lang="html4strict"><ul> | |
<li>the first item </li> | <li>the first item </li> | ||
<li>the second item </li> | <li>the second item </li> | ||
<li>the third item </li> | <li>the third item </li> | ||
− | </ul></ | + | </ul></syntaxhighlight> |
results in a list similar to: | results in a list similar to: | ||
Line 54: | Line 54: | ||
Example: | Example: | ||
− | + | <syntaxhighlight lang="html4strict"><ol> | |
<li>the first item </li> | <li>the first item </li> | ||
<li>the second item </li> | <li>the second item </li> | ||
<li>the third item </li> | <li>the third item </li> | ||
− | </ol></ | + | </ol></syntaxhighlight> |
results in a list similar to: | results in a list similar to: | ||
Line 74: | Line 74: | ||
Example: | Example: | ||
− | + | <syntaxhighlight lang="html4strict"><dl> | |
<dt>the first item</dt> | <dt>the first item</dt> | ||
<dd>asfd asdf asdf asdf asdf</dd> | <dd>asfd asdf asdf asdf asdf</dd> | ||
Line 83: | Line 83: | ||
<dt>the third item</dt> | <dt>the third item</dt> | ||
<dd>asfd asdf asdf asdf asdf</dd> | <dd>asfd asdf asdf asdf asdf</dd> | ||
− | </dl></ | + | </dl></syntaxhighlight> |
results in a list similar to: | results in a list similar to: |
Latest revision as of 14:17, 22 December 2020
Only a few XHTML tags are required for writing the documentation in idl files. The most important ones are listed in this section.
Paragraph: <p> ... </p>
This tag marks a normal paragraph. Consider that line breaks and empty lines in the idl file do not cause a line break or a paragraph break in the layout version. Explicit paragraph break markups, are necessary.
Line Break: <br/>
This tag marks up a line break within the same paragraph. Consider line breaks and empty lines in the idl file do not cause a line break or a paragraph break when presented by the HTML browser. Explicit paragraph break markups are necessary.
Unordered List: <ul><li> ... </li>... </ul>
These tags mark the beginning and end of an unordered list, as list items.
Example:
<ul> <li>the first item </li> <li>the second item </li> <li>the third item </li> </ul>
results in a list similar to:
- the first item
- the second item
- the third item
Ordered List: <ol><li> ... </li>... </ol>
These tags mark the beginning and end of an ordered list, as list items.
Example:
<ol> <li>the first item </li> <li>the second item </li> <li>the third item </li> </ol>
results in a list similar to:
1.the first item
2.the second item
3.the third item
Definition List: <dl><dt> ... </dt><dd> ... </dd>... </dl>
These tags mark the beginning and end of a definition list, the definition tags and the definition data.
Example:
<dl> <dt>the first item</dt> <dd>asfd asdf asdf asdf asdf</dd> <dt>the second item</dt> <dd>asfd asdf asdf asdf asdf</dd> <dt>the third item</dt> <dd>asfd asdf asdf asdf asdf</dd> </dl>
results in a list similar to:
the first item
- asfd asdf asdf asdf asdf
the second item
- asfd asdf asdf asdf asdf
the third item
- asfd asdf asdf asdf asdf
Table: <table><tr><td>...</td>...</tr>...</table>
Defines a table with rows (tr) and columns (td).
Strong Emphasis: <strong> ... </strong>
These tags present a piece of text that is emphasized. In most cases this is bold, but the HTML-client defines what it actually is.
Slight Emphasis: <em> ... </em>
These tags present a piece of text emphasized slightly. In most cases this is italic, but the HTML-client defines what it actually is .
Anchor: <a href="..."> ... </a>
These tags specify a link to external documentation. The first "..." specifies the URL.
Content on this page is licensed under the Public Documentation License (PDL). |