<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- Inline Tags</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/docbuilder-0.9.8.10.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>DocBuilder</strong><br><strong>User's Guide</strong><br><small>Version 0.9.8.10</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Chapters</strong></small></p>
<ul class="flipMenu" imagepath="../../../../doc/js/flipmenu">
<li id="no" title="Overview" expanded="false">Overview<ul>
<li><a href="overview.html">
Top of chapter
</a></li>
<li title="Background"><a href="overview.html#id235375">Background</a></li>
<li title="DTD Suite"><a href="overview.html#id235319">DTD Suite</a></li>
<li title="Structure of Generated HTML"><a href="overview.html#id235207">Structure of Generated HTML</a></li>
<li title="Basic Tags"><a href="overview.html#id235168">Basic Tags</a></li>
<li title="About This Document"><a href="overview.html#id235135">About This Document</a></li>
<li title="Usage"><a href="overview.html#id235075">Usage</a></li>
</ul>
</li>
<li id="no" title="User's Guide DTDs" expanded="false">User's Guide DTDs<ul>
<li><a href="user_guide_dtds.html">
Top of chapter
</a></li>
<li title="The part DTD"><a href="user_guide_dtds.html#id234937">The part DTD</a></li>
<li title="<part>"><a href="user_guide_dtds.html#id234900"><part></a></li>
<li title="<description>"><a href="user_guide_dtds.html#id234847"><description></a></li>
<li title="<include>"><a href="user_guide_dtds.html#id234817"><include></a></li>
<li title="The chapter DTD"><a href="user_guide_dtds.html#id234770">The chapter DTD</a></li>
<li title="<chapter>"><a href="user_guide_dtds.html#id234749"><chapter></a></li>
<li title="<section>"><a href="user_guide_dtds.html#id234664"><section></a></li>
<li title="<title>"><a href="user_guide_dtds.html#id234645"><title></a></li>
</ul>
</li>
<li id="no" title="Reference Manual DTDs" expanded="false">Reference Manual DTDs<ul>
<li><a href="refman_dtds.html">
Top of chapter
</a></li>
<li title="The application DTD"><a href="refman_dtds.html#id234515">The application DTD</a></li>
<li title="<application>"><a href="refman_dtds.html#id234433"><application></a></li>
<li title="The appref DTD"><a href="refman_dtds.html#id234403">The appref DTD</a></li>
<li title="The comref DTD"><a href="refman_dtds.html#id234262">The comref DTD</a></li>
<li title="The cref DTD"><a href="refman_dtds.html#id234117">The cref DTD</a></li>
<li title="The erlref DTD"><a href="refman_dtds.html#id233994">The erlref DTD</a></li>
<li title="The fileref DTD"><a href="refman_dtds.html#id233591">The fileref DTD</a></li>
<li title="<description>"><a href="refman_dtds.html#id233809"><description></a></li>
<li title="<section>"><a href="refman_dtds.html#id233877"><section></a></li>
<li title="<funcs>"><a href="refman_dtds.html#id228952"><funcs></a></li>
<li title="<func>"><a href="refman_dtds.html#id233882"><func></a></li>
<li title="<name>"><a href="refman_dtds.html#id233539"><name></a></li>
<li title="<fsummary>"><a href="refman_dtds.html#id225740"><fsummary></a></li>
<li title="<type>"><a href="refman_dtds.html#id233888"><type></a></li>
<li title="<v>"><a href="refman_dtds.html#id233488"><v></a></li>
<li title="<d>"><a href="refman_dtds.html#id226608"><d></a></li>
<li title="<desc>"><a href="refman_dtds.html#id233746"><desc></a></li>
<li title="<authors>"><a href="refman_dtds.html#id225750"><authors></a></li>
<li title="<aname>"><a href="refman_dtds.html#id228751"><aname></a></li>
<li title="<email>"><a href="refman_dtds.html#id227143"><email></a></li>
</ul>
</li>
<li id="no" title="Fascicules DTDs" expanded="false">Fascicules DTDs<ul>
<li><a href="fasc_dtds.html">
Top of chapter
</a></li>
<li title="The fascicules DTD"><a href="fasc_dtds.html#id230173">The fascicules DTD</a></li>
<li title="<fascicules>"><a href="fasc_dtds.html#id224041"><fascicules></a></li>
<li title="<fascicule>"><a href="fasc_dtds.html#id228705"><fascicule></a></li>
</ul>
</li>
<li id="no" title="Header Tags" expanded="false">Header Tags<ul>
<li><a href="header_tags.html">
Top of chapter
</a></li>
<li title="<header>"><a href="header_tags.html#id231805"><header></a></li>
<li title="<copyright>"><a href="header_tags.html#id227221"><copyright></a></li>
<li title="<legalnotice>"><a href="header_tags.html#id232484"><legalnotice></a></li>
<li title="<title>"><a href="header_tags.html#id232132"><title></a></li>
<li title="<shorttitle>"><a href="header_tags.html#id233866"><shorttitle></a></li>
<li title="<prepared>"><a href="header_tags.html#id225709"><prepared></a></li>
<li title="<responsible>"><a href="header_tags.html#id229279"><responsible></a></li>
<li title="<docno>"><a href="header_tags.html#id229293"><docno></a></li>
<li title="<approved>"><a href="header_tags.html#id229638"><approved></a></li>
<li title="<checked>"><a href="header_tags.html#id229653"><checked></a></li>
<li title="<date>"><a href="header_tags.html#id232666"><date></a></li>
<li title="<rev>"><a href="header_tags.html#id232623"><rev></a></li>
<li title="<file>"><a href="header_tags.html#id232755"><file></a></li>
</ul>
</li>
<li id="no" title="Block Tags" expanded="false">Block Tags<ul>
<li><a href="block_tags.html">
Top of chapter
</a></li>
<li title="<br> - Line Break"><a href="block_tags.html#id232697"><br> - Line Break</a></li>
<li title="<code> - Code Example"><a href="block_tags.html#id232734"><code> - Code Example</a></li>
<li title="<codeinclude> - Code Inclusion"><a href="block_tags.html#id231718"><codeinclude> - Code Inclusion</a></li>
<li title="<erleval> - Erlang Evaluation"><a href="block_tags.html#id232503"><erleval> - Erlang Evaluation</a></li>
<li title="<list> - List"><a href="block_tags.html#id232534"><list> - List</a></li>
<li title="<marker> - Marker"><a href="block_tags.html#id233630"><marker> - Marker</a></li>
<li title="<p> - Paragraph"><a href="block_tags.html#id233654"><p> - Paragraph</a></li>
<li title="<note> - Note"><a href="block_tags.html#id233692"><note> - Note</a></li>
<li title="<pre> - Pre-formatted Text"><a href="block_tags.html#id233348"><pre> - Pre-formatted Text</a></li>
<li title="<quote> - Quotation"><a href="block_tags.html#id233417"><quote> - Quotation</a></li>
<li title="<taglist> - Definition List"><a href="block_tags.html#id231483"><taglist> - Definition List</a></li>
<li title="<warning> - Warning"><a href="block_tags.html#id231578"><warning> - Warning</a></li>
<li title="<image> - Image"><a href="block_tags.html#id231627"><image> - Image</a></li>
<li title="<table> - Table"><a href="block_tags.html#id232806"><table> - Table</a></li>
</ul>
</li>
<li id="loadscrollpos" title="Inline Tags" expanded="true">Inline Tags<ul>
<li><a href="inline_tags.html">
Top of chapter
</a></li>
<li title="<br> - Line Break"><a href="inline_tags.html#id232990"><br> - Line Break</a></li>
<li title="<c> - Code"><a href="inline_tags.html#id233013"><c> - Code</a></li>
<li title="<em> - Emphasis"><a href="inline_tags.html#id233058"><em> - Emphasis</a></li>
<li title="<marker> - Marker"><a href="inline_tags.html#id233096"><marker> - Marker</a></li>
<li title="<path> - Path"><a href="inline_tags.html#id233139"><path> - Path</a></li>
<li title="<seealso> - Local Cross Reference"><a href="inline_tags.html#id233212"><seealso> - Local Cross Reference</a></li>
<li title="<url> - Non-Local Cross Reference"><a href="inline_tags.html#id237343"><url> - Non-Local Cross Reference</a></li>
<li title="<term>, <termdef> - Glossary"><a href="inline_tags.html#id237373"><term>, <termdef> - Glossary</a></li>
<li title="<cite>, <citedef> - Bibliography"><a href="inline_tags.html#id237455"><cite>, <citedef> - Bibliography</a></li>
</ul>
</li>
<li id="no" title="Character Entities" expanded="false">Character Entities<ul>
<li><a href="character_entities.html">
Top of chapter
</a></li>
<li title="Added Latin 1"><a href="character_entities.html#id237540">Added Latin 1</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<h1>7 Inline Tags</h1>
<p>Inline tags are typically used within block tags, for example to
highlight a word within a paragraph.</p>
<h3><a name="id232990">7.1
<br> - Line Break</a></h3>
<a name="brTAG"></a>
<p>Forces a newline. The <span class="code"><br></span> tag is both a
block- and an inline tag and is described in
the <span class="bold_code"><a href="block_tags.html#brTAG">Block Tags</a></span>
section.</p>
<h3><a name="id233013">7.2
<c> - Code</a></h3>
<a name="cTAG"></a>
<p>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 <span class="bold_code"><a href="block_tags.html#codeTAG">code</a></span>
tag. All <span class="bold_code"><a href="character_entities.html">character
entities</a></span> are expanded. Example:</p>
<div class="example"><pre>
<p>Returns <c>true</c> if <c>Term</c> is an integer.</p>
</pre></div>
<p>results in:</p>
<p>Returns <span class="code">true</span> if <span class="code">Term</span> is an integer.</p>
<h3><a name="id233058">7.3
<em> - Emphasis</a></h3>
<a name="emTAG"></a>
<p>Highlights words which are important within a text flow. Example:
</p>
<div class="example"><pre>
<p>The application <em>must</em> be up and running.</p>
</pre></div>
<p>results in:</p>
<p>The application <strong>must</strong> be up and running.</p>
<p>Contains plain text or a
<span class="bold_code"><a href="#cTAG"><c></a></span> tag.</p>
<h3><a name="id233096">7.4
<marker> - Marker</a></h3>
<a name="markerTAG"></a>
<p>Used as an anchor for hypertext references. The <span class="code">id</span>
attribute defines the name of the marker. Example:</p>
<a name="marker_example"></a>
<div class="example"><pre>
<marker id="marker_example"/>
</pre></div>
<p>The <span class="bold_code"><a href="#seealsoTAG"><seealso></a></span> tag
is used to refer to the marker.</p>
<p>The <span class="code"><marker></span> tag is both a block- and an
inline tag.</p>
<h3><a name="id233139">7.5
<path> - Path</a></h3>
<a name="pathTAG"></a>
<p>Highlights file paths. The attributes <span class="code">unix</span> and
<span class="code">windows</span> makes it possible to specify different paths for
different file path notations. Default for both are "".
Example:</p>
<div class="example"><pre>
<p>Look at the <path unix=".profile" windows="win.ini">start-up file</path>
if you intend to alter the initial behavior.</p>
</pre></div>
<p>If no <span class="code">ptype</span> option is specified when calling
<span class="bold_code"><a href="docb_transform.html#file-1">docb_transform:file/1,2</a></span>,
this simply results in:</p>
<p>"Look at the start-up file
if you intend to alter the initial behavior."</p>
<p>If both the options <span class="code">{ptype,unix}</span> and
<span class="code">{ptype,windows}</span> are specified, the example instead results
in:</p>
<p>"Look at the start-up file
if you intend to alter the initial behavior."</p>
<h3><a name="id233212">7.6
<seealso> - Local Cross Reference</a></h3>
<a name="seealsoTAG"></a>
<p>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 <span class="code">marker</span> attribute. Must contain plain text. Examples:
</p>
<div class="example"><pre>
<seealso marker="#marker_example">marker example</seealso>
</pre></div>
<p>results in:
<span class="bold_code"><a href="#marker_example">marker example</a></span>
(a hypertext link to the marker example above).</p>
<div class="example"><pre>
<seealso marker="block_tags#markerTAG">marker tag</seealso>
</pre></div>
<p>results in:
<span class="bold_code"><a href="block_tags.html#markerTAG">marker tag</a></span>
(a hypertext link to the marker section in the Block Tags
chapter).</p>
<div class="example"><pre>
<seealso marker="overview">Overview</seealso>
</pre></div>
<p>results in:
<span class="bold_code"><a href="overview.html">Overview</a></span>
(a hypertext link to the Overview chapter).</p>
<p>Note the use of "#" before the name of the marker. Note also
that the filename extension <span class="code">.html</span> is omitted. This is
because the default behavior of DocBuilder is to translate
<span class="code"><seealso marker="File#Marker">text</seealso></span>
to <span class="code"><A HREF="File.html#Marker">text</A></span>.</p>
<p>The default behaviour can be modified by using the callback
module option to <span class="code">docb_transform:file/1,2</span> and defining a
callback function
<span class="bold_code"><a href="docb_transform.html#Module:seealso-1">Module:seealso/1</a></span>.
This possibility is for example used in OTP to resolve cross
references between applications.</p>
<h3><a name="id237343">7.7
<url> - Non-Local Cross Reference</a></h3>
<a name="urlTAG"></a>
<p>A reference to a file outside the documentation, a web address or
similar, given by the <span class="code">href</span> attribute. Must contain plain
text. Example:</p>
<div class="example"><pre>
<url href="http://www.erlang.org">erlang.org</url>
</pre></div>
<p>results in: <span class="bold_code"><a href="http://www.erlang.org">erlang.org</a></span>
</p>
<h3><a name="id237373">7.8
<term>, <termdef> - Glossary</a></h3>
<a name="termTAG"></a>
<a name="termdefTAG"></a>
<p>Used to highlight a term with a local (for this document only) or
global definition. The identity of the term is given by
the <span class="code">id</span> attribute.</p>
<p>For a locally defined term, the tag contains a
<span class="code"><termdef></span>, which in turn contains an explanation of
the term as plain text. Example:</p>
<div class="example"><pre>
<term id="HTML"><termdef>Hyper-Text Markup Language</termdef></term>
</pre></div>
<p>For a globally defined term, the tag is empty. Example:</p>
<div class="example"><pre>
<term id="HTML"/>
</pre></div>
<p>Global definitions are given to DocBuilder in a file, using the
<span class="bold_code"><a href="docb_transform.html#file-1">docb_transform:file/1,2</a></span>
option <span class="code">term_defs</span>. The file should contain a list of tuples,
one for each term definition, on the format
<span class="code">{Id,Name,Definition,Owner}</span>. The <span class="code">Owner</span> part is just
for administration, if there are several people contributing to a
term definition file. Example:</p>
<div class="example"><pre>
[...,
{"HTML", "HTML", "Hyper-Text Markup Language", "Gunilla"},
...].
</pre></div>
<p>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.</p>
<p>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:</p>
<div class="example"><pre>
<term id="HTML"><termdef>Hyper-Text Markup Language</termdef></term>
</pre></div>
<p>results in: HTML
</p>
<p>If a term is defined both locally and globally, the global
definition takes precedence.</p>
<h3><a name="id237455">7.9
<cite>, <citedef> - Bibliography</a></h3>
<a name="citeTAG"></a>
<a name="citedefTAG"></a>
<p>Works the same way as <span class="code"><term></span> and
<span class="code"><termdef></span>, but for a bibliography list rather than
a glossary.</p>
<p>A global bibliography list is given to DocBuilder in a file,
using the <span class="bold_code"><a href="docb_transform.html#file-1">docb_transform:file/1,2</a></span>
option <span class="code">cite_defs</span>. The file should contain a list of tuples,
one for each cite, on the format
<span class="code">{Id,Title,Info,Owner}</span>. The <span class="code">Owner</span> part is just
for administration, if there are several people contributing to a
bibliography file. Example:</p>
<div class="example"><pre>
[...,
{"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"},
...].
</pre></div>
</div>
<div class="footer">
<hr>
<p>Copyright © 1997-2011 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
153de8e767391ee69acb7025d88d7586
>
files
>
545
