19972011
Ericsson AB. All Rights Reserved.
The contents of this file are subject to the Erlang Public License,
Version 1.1, (the "License"); you may not use this file except in
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
Inline Tags
inline_tags.xml
Inline tags are typically used within block tags, for example to
highlight a word within a paragraph.
<br> - Line Break
Forces a newline. The ]]> tag is both a
block- and an inline tag and is described in
the Block Tags
section.
<c> - Code
Highlights things like variables and file names in a text flow.
Can contain plain text only. Newlines and tabs are ignored as
opposed to the code
tag. All character
entities are expanded. Example:
<p>Returns <c>true</c> if <c>Term</c> is an integer.</p>
results in:
Returns true if Term is an integer.
<em> - Emphasis
Highlights words which are important within a text flow. Example:
<p>The application <em>must</em> be up and running.</p>
results in:
The application must be up and running.
Contains plain text or a
<c> tag.
<marker> - Marker
Used as an anchor for hypertext references. The id
attribute defines the name of the marker. Example:
<marker id="marker_example"/>
The <seealso> tag
is used to refer to the marker.
The ]]> tag is both a block- and an
inline tag.
<path> - Path
Highlights file paths. The attributes unix and
windows makes it possible to specify different paths for
different file path notations. Default for both are "".
Example:
<p>Look at the <path unix=".profile" windows="win.ini">start-up file</path>
if you intend to alter the initial behavior.</p>
If no ptype option is specified when calling
docb_transform:file/1,2,
this simply results in:
"Look at the start-up file
if you intend to alter the initial behavior."
If both the options {ptype,unix} and
{ptype,windows} are specified, the example instead results
in:
"Look at the start-up file
if you intend to alter the initial behavior."
<seealso> - Local Cross Reference
A cross reference (hypertext link) to a marker in the same file,
a marker in another file, or (the top of) another file, given by
the marker attribute. Must contain plain text. Examples:
marker example
]]>
results in:
marker example
(a hypertext link to the marker example above).
marker tag
]]>
results in:
marker tag
(a hypertext link to the marker section in the Block Tags
chapter).
Overview
]]>
results in:
Overview
(a hypertext link to the Overview chapter).
Note the use of "#" before the name of the marker. Note also
that the filename extension .html is omitted. This is
because the default behavior of DocBuilder is to translate
text]]>
to text]]>.
The default behaviour can be modified by using the callback
module option to docb_transform:file/1,2 and defining a
callback function
Module:seealso/1.
This possibility is for example used in OTP to resolve cross
references between applications.
<url> - Non-Local Cross Reference
A reference to a file outside the documentation, a web address or
similar, given by the href attribute. Must contain plain
text. Example:
erlang.org
]]>
results in: erlang.org
<term>, <termdef> - Glossary
Used to highlight a term with a local (for this document only) or
global definition. The identity of the term is given by
the id attribute.
For a locally defined term, the tag contains a
<termdef>, which in turn contains an explanation of
the term as plain text. Example:
Hyper-Text Markup Language
]]>
For a globally defined term, the tag is empty. Example:
]]>
Global definitions are given to DocBuilder in a file, using the
docb_transform:file/1,2
option term_defs. The file should contain a list of tuples,
one for each term definition, on the format
{Id,Name,Definition,Owner}. The Owner part is just
for administration, if there are several people contributing to a
term definition file. Example:
[...,
{"HTML", "HTML", "Hyper-Text Markup Language", "Gunilla"},
...].
DocBuilder will collect both local and global definitions in a
glossary, which can be reached from a link in the left frame of
the HTML documentation.
In the generated HTML, it is the term name which will be visible.
For locally defined terms, the id and the name are the same.
The name has a hypertext link to the definition in the glossary.
Example:
Hyper-Text Markup Language
]]>
results in: Hyper-Text Markup Language
If a term is defined both locally and globally, the global
definition takes precedence.
<cite>, <citedef> - Bibliography
Works the same way as <term> and
<termdef>, but for a bibliography list rather than
a glossary.
A global bibliography list is given to DocBuilder in a file,
using the docb_transform:file/1,2
option cite_defs. The file should contain a list of tuples,
one for each cite, on the format
{Id,Title,Info,Owner}. The Owner part is just
for administration, if there are several people contributing to a
bibliography file. Example:
[...,
{"erlbook",
"Concurrent Programming in ERLANG","J. Armstrong, R. Virding, C. Wikström, "
"M. Williams, Concurrent Programming in ERLANG, Prentice Hall, 1996, ISBN 0-13-508301-X",
"jocke"},
...].