Block tags typically define a separate block of information, such as a paragraph or a list.
The following subset of block tags are common for all DTDs in
the DocBuilder DTD suite:
Forces a newline. Example:
Eat yourself<br/>senseless!
results in:
Eat yourself
senseless!
The
Highlight code examples. Example:
<code> sum([H|T]) -> H + sum(T); sum([]) -> 0. </code>
results in:
sum([H|T]) ->
H + sum(T);
sum([]) ->
0.
There is an attribute
No tags are allowed within the tag and no
Include external code snippets. The attribute
<codeinclude file="gazonk" tag="%% Erlang example"/>
results in:
provided there is a file named
...
%% Erlang example
-module(gazonk).
start() ->
{error,"Pid required!"}.
start(Pid) ->
spawn(fun() -> init(Pid) end).
%% Erlang example
...
If the
There is also an attribute
Include the result from evaluating an Erlang expression. Example:
]]>
results in:
Note the '.' and space after the expression.
The attribute
Lists contains list items, tag
<list type="ordered"> <item>Askosal: <list> <item>Nullalisis</item> <item>Facilisis</item> </list> </item> <item>Ankara</item> </list>
results in:
Askosal:
Used as an anchor for hypertext references. The
Paragraphs contain plain text and
<p>I call specific attention to the authority given by the <em>21st Amendment</em> to the Constitution to prohibit transportation or importation of intoxicating liquors into any State in violation of the laws of such State.</p>
results in:
I call specific attention to the authority given by the 21st Amendment to the Constitution to prohibit transportation or importation of intoxicating liquors into any State in violation of the laws of such State.
Highlights a note. Can contain block tags except
<note> <p>This function is mainly intended for debugging.</p> </note>
results in:
This function is mainly intended for debugging.
Used for documentation of system interaction. Can contain text,
The
<pre> $ <input>erl</input> Erlang (BEAM) emulator version 5.5.3 [async-threads:0] [hipe] [kernel-poll:false] Eshell V5.5.3 (abort with ^G) 1> <input>pwd().</input> /home/user 2> <input>halt().</input> </pre>
results in:
$ erl Erlang (BEAM) emulator version 5.5.3 [async-threads:0] [hipe] [kernel-poll:false] Eshell V5.5.3 (abort with ^G) 1> pwd(). /home/user 2> halt().
All
Highlight quotations from other works, or dialog spoken by
characters in a narrative. Contains one or more
<p>Whereas Section 217(a) of the Act of Congress entitled "An Act ..." approved June 16, 1933, provides as follows:</p> <quote> <p>Section 217(a) The President shall proclaim the law.</p> </quote>
results in:
Whereas Section 217(a) of the Act of Congress entitled "An Act ..." approved June 16, 1933, provides as follows:
Section 217(a) The President shall proclaim the law.
Definition lists contains pairs of tags,
<taglist> <tag><c>eacces</c></tag> <item>Permission denied.</item> <tag><c>enoent</c></tag> <item>No such file or directory.</item> </taglist>
results in:
Highlights a warning. Can contain block tags except
<warning> <p>This function might be removed in a future version without prior warning.</p> </warning>
results in:
This function might be removed in a future version without prior warning.
Graphics is imported using the
<image file="man"> <icaption>A Silly Man</icaption> </image>
results in:
This assumes that
The table format is similar to how tables are described in HTML
3.2. A table contains one or more rows,
Each row contains one or more cells,
Each cell contains plain text and
|
Boys | Girls | |
Juda | Susy | |
Anders | Victoria | A table caption ]]>
results in: