aboutsummaryrefslogtreecommitdiffstats
path: root/lib/erl_docgen/doc/src/inline_tags.xml
diff options
context:
space:
mode:
authorLars Thorsen <[email protected]>2011-11-17 12:27:59 +0100
committerLars Thorsen <[email protected]>2011-11-18 14:28:44 +0100
commit4424b10d7054025eef3e721f64fb53ad7b357282 (patch)
tree3021ca22d285757cd63054e6925b7c56ec8724a7 /lib/erl_docgen/doc/src/inline_tags.xml
parentebaf44e2d10bdf6bca2fc83d10e75e144dcbde2d (diff)
downloadotp-4424b10d7054025eef3e721f64fb53ad7b357282.tar.gz
otp-4424b10d7054025eef3e721f64fb53ad7b357282.tar.bz2
otp-4424b10d7054025eef3e721f64fb53ad7b357282.zip
[erl_docgen] Tidy up the documentation moved from docbuilder to erl_docgen
Diffstat (limited to 'lib/erl_docgen/doc/src/inline_tags.xml')
-rw-r--r--lib/erl_docgen/doc/src/inline_tags.xml49
1 files changed, 3 insertions, 46 deletions
diff --git a/lib/erl_docgen/doc/src/inline_tags.xml b/lib/erl_docgen/doc/src/inline_tags.xml
index 5bcca54c05..9b27da659b 100644
--- a/lib/erl_docgen/doc/src/inline_tags.xml
+++ b/lib/erl_docgen/doc/src/inline_tags.xml
@@ -92,7 +92,7 @@
inline tag.</p>
</section>
- <section>
+ <!-- section>
<marker id="pathTAG"></marker>
<title>&lt;path&gt; - Path</title>
@@ -115,7 +115,7 @@
in:</p>
<p>"Look at the <path unix=".profile" windows="win.ini">start-up file</path>
if you intend to alter the initial behavior."</p>
- </section>
+ </section -->
<section>
<marker id="seealsoTAG"></marker>
@@ -150,16 +150,10 @@
<p>Note the use of "#" before the name of the marker. Note also
that the filename extension <c>.html</c> is omitted. This is
- because the default behavior of DocBuilder is to translate
+ because the default behavior is to translate
<c><![CDATA[<seealso marker="File#Marker">text</seealso>]]></c>
to <c><![CDATA[<A HREF="File.html#Marker">text</A>]]></c>.</p>
- <p>The default behaviour can be modified by using the callback
- module option to <c>docb_transform:file/1,2</c> and defining a
- callback function
- <seealso marker="docb_transform#Module:seealso-1">Module:seealso/1</seealso>.
- This possibility is for example used in OTP to resolve cross
- references between applications.</p>
</section>
<section>
@@ -192,28 +186,6 @@
<term id="HTML"><termdef>Hyper-Text Markup Language</termdef></term>
]]></pre>
- <p>For a globally defined term, the tag is empty. Example:</p>
- <pre><![CDATA[
-<term id="HTML"/>
- ]]></pre>
-
- <p>Global definitions are given to DocBuilder in a file, using the
- <seealso marker="docb_transform#file/1">docb_transform:file/1,2</seealso>
- option <c>term_defs</c>. The file should contain a list of tuples,
- one for each term definition, on the format
- <c>{Id,Name,Definition,Owner}</c>. The <c>Owner</c> part is just
- for administration, if there are several people contributing to a
- term definition file. Example:</p>
- <pre>
-[...,
- {"HTML", "HTML", "Hyper-Text Markup Language", "Gunilla"},
- ...].
- </pre>
-
- <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.
@@ -237,21 +209,6 @@
<c>&lt;termdef&gt;</c>, but for a bibliography list rather than
a glossary.</p>
- <p>A global bibliography list is given to DocBuilder in a file,
- using the <seealso marker="docb_transform#file/1">docb_transform:file/1,2</seealso>
- option <c>cite_defs</c>. The file should contain a list of tuples,
- one for each cite, on the format
- <c>{Id,Title,Info,Owner}</c>. The <c>Owner</c> part is just
- for administration, if there are several people contributing to a
- bibliography file. Example:</p>
- <pre>
-[...,
- {"erlbook",
- "Concurrent Programming in ERLANG","J. Armstrong, R. Virding, C. Wikstr&ouml;m, "
- "M. Williams, Concurrent Programming in ERLANG, Prentice Hall, 1996, ISBN 0-13-508301-X",
- "jocke"},
- ...].
- </pre>
</section>
</chapter>