summaryrefslogtreecommitdiff
path: root/lib/erl_docgen/doc
diff options
context:
space:
mode:
authorLukas Larsson <lukas@erlang.org>2020-03-11 10:11:22 +0100
committerLukas Larsson <lukas@erlang.org>2020-03-27 11:02:23 +0100
commit0799c2b0e9ae5fce18d092a153fff884d1dd3912 (patch)
treec7c72465bd01591a9163e5ad17cea92bf3be75ec /lib/erl_docgen/doc
parent6c6fe8e774f7cde6d158b450fd1ad6c3129dc22e (diff)
downloaderlang-0799c2b0e9ae5fce18d092a153fff884d1dd3912.tar.gz
otp: Convert all <seealso> to more specific variants
We add `seemfa`, `seeerl`, `seetype`, `seeapp`, `seecom`, `seecref` , `seefile` and `seeguide` in order to make it easier to reason about what each link points to without examining the target. This information will then be embedded in the EEP-48 chunks for usage by other tools. The tool used can be found here: https://gist.github.com/garazdawi/68527d92ae5b37c8f129bfbdfffdfa68
Diffstat (limited to 'lib/erl_docgen/doc')
-rw-r--r--lib/erl_docgen/doc/src/block_tags.xml52
-rw-r--r--lib/erl_docgen/doc/src/doc_storage.xml5
-rw-r--r--lib/erl_docgen/doc/src/inline_tags.xml12
-rw-r--r--lib/erl_docgen/doc/src/overview.xml20
-rw-r--r--lib/erl_docgen/doc/src/refman_dtds.xml126
-rw-r--r--lib/erl_docgen/doc/src/user_guide_dtds.xml22
6 files changed, 119 insertions, 118 deletions
diff --git a/lib/erl_docgen/doc/src/block_tags.xml b/lib/erl_docgen/doc/src/block_tags.xml
index bcaec0fbd1..b2b8829ced 100644
--- a/lib/erl_docgen/doc/src/block_tags.xml
+++ b/lib/erl_docgen/doc/src/block_tags.xml
@@ -36,12 +36,12 @@
<p>The following subset of block tags are common for all DTDs in
the OTP DTD suite:
<marker id="block_subset"></marker>
- <seealso marker="#pTAG">&lt;p&gt;</seealso>,
- <seealso marker="#preTAG">&lt;pre&gt;</seealso>,
- <seealso marker="#codeTAG">&lt;code&gt;</seealso>,
- <seealso marker="#listTAG">&lt;list&gt;</seealso>,
- <seealso marker="#taglistTAG">&lt;taglist&gt;</seealso>,
- <seealso marker="#codeincludeTAG">&lt;codeinclude&gt;</seealso> and
+ <seeguide marker="#pTAG">&lt;p&gt;</seeguide>,
+ <seeguide marker="#preTAG">&lt;pre&gt;</seeguide>,
+ <seeguide marker="#codeTAG">&lt;code&gt;</seeguide>,
+ <seeguide marker="#listTAG">&lt;list&gt;</seeguide>,
+ <seeguide marker="#taglistTAG">&lt;taglist&gt;</seeguide>,
+ <seeguide marker="#codeincludeTAG">&lt;codeinclude&gt;</seeguide> and
</p>
<section>
@@ -86,8 +86,8 @@ sum([]) ->
<note>
<p>No tags are allowed within the tag and no
- <seealso marker="character_entities">character
- entities</seealso> are expanded.</p>
+ <seeguide marker="character_entities">character
+ entities</seeguide> are expanded.</p>
</note>
</section>
@@ -139,9 +139,9 @@ start(Pid) ->
<p>Lists contains list items, tag <c><![CDATA[<item>]]></c>, which
can contain plain text,
- the <seealso marker="#block_subset">common subset of block
- tags</seealso> and <seealso marker="inline_tags">inline
- tags</seealso>. Example:</p>
+ the <seeguide marker="#block_subset">common subset of block
+ tags</seeguide> and <seeguide marker="inline_tags">inline
+ tags</seeguide>. Example:</p>
<pre>
&lt;list type="ordered"&gt;
&lt;item&gt;Askosal:
@@ -173,7 +173,7 @@ start(Pid) ->
<p>Used as an anchor for hypertext references. The
<c><![CDATA[<marker>]]></c> tag is both a block- and an inline
tag and is described in
- the <seealso marker="inline_tags#markerTAG">Inline Tags</seealso>
+ the <seeguide marker="inline_tags#markerTAG">Inline Tags</seeguide>
section.</p>
</section>
@@ -182,7 +182,7 @@ start(Pid) ->
<title>&lt;p&gt; - Paragraph</title>
<p>Paragraphs contain plain text and
- <seealso marker="inline_tags">inline tags</seealso>. Example:</p>
+ <seeguide marker="inline_tags">inline tags</seeguide>. Example:</p>
<pre>
&lt;p&gt;I call specific attention to
the authority given by the &lt;em&gt;21st Amendment&lt;/em&gt;
@@ -224,8 +224,8 @@ start(Pid) ->
<title>&lt;pre&gt; - Pre-formatted Text</title>
<p>Used for documentation of system interaction. Can contain text,
- <seealso marker="inline_tags#seealsoTAG">seealso</seealso>,
- <seealso marker="inline_tags#urlTAG">url</seealso> and
+ <seeguide marker="inline_tags#seealsoTAG">seealso</seeguide>,
+ <seeguide marker="inline_tags#urlTAG">url</seeguide> and
<c><![CDATA[<input>]]></c> tags.</p>
<p>The <c><![CDATA[<input>]]></c> tag is used to highlight user
@@ -252,8 +252,8 @@ Eshell V5.5.3 (abort with ^G)
2> <input>halt().</input>
</pre>
- <p>All <seealso marker="character_entities">character
- entities</seealso> are expanded.</p>
+ <p>All <seeguide marker="character_entities">character
+ entities</seeguide> are expanded.</p>
</section>
<section>
@@ -262,7 +262,7 @@ Eshell V5.5.3 (abort with ^G)
<p>Highlight quotations from other works, or dialog spoken by
characters in a narrative. Contains one or more
- <seealso marker="#pTAG">&lt;p&gt;</seealso> tags. Example:</p>
+ <seeguide marker="#pTAG">&lt;p&gt;</seeguide> tags. Example:</p>
<pre>
&lt;p&gt;Whereas Section 217(a) of the Act of Congress entitled
"An Act ..." approved June 16, 1933, provides as follows:&lt;/p&gt;
@@ -288,16 +288,16 @@ Eshell V5.5.3 (abort with ^G)
<c><![CDATA[<item>]]></c>.</p>
<p><c><![CDATA[<tag>]]></c> can contain plain text,
- <seealso marker="inline_tags#cTAG">&lt;c&gt;</seealso>,
- <seealso marker="inline_tags#emTAG">&lt;em&gt;</seealso>,
- <seealso marker="inline_tags#seealsoTAG">&lt;seealso&gt;</seealso>
- and <seealso marker="inline_tags#urlTAG">&lt;url&gt;</seealso>
+ <seeguide marker="inline_tags#cTAG">&lt;c&gt;</seeguide>,
+ <seeguide marker="inline_tags#emTAG">&lt;em&gt;</seeguide>,
+ <seeguide marker="inline_tags#seealsoTAG">&lt;seealso&gt;</seeguide>
+ and <seeguide marker="inline_tags#urlTAG">&lt;url&gt;</seeguide>
tags.</p>
<p><c><![CDATA[<item>]]></c> can contain plain text,
- the <seealso marker="#block_subset">common subset of block
- tags</seealso> and <seealso marker="inline_tags">inline
- tags</seealso>. Example:</p>
+ the <seeguide marker="#block_subset">common subset of block
+ tags</seeguide> and <seeguide marker="inline_tags">inline
+ tags</seeguide>. Example:</p>
<pre>
&lt;taglist>
&lt;tag>&lt;c>eacces&lt;/c>&lt;/tag>
@@ -377,7 +377,7 @@ Eshell V5.5.3 (abort with ^G)
"<c>left</c>" and "<c>middle</c>".</p>
<p>Each cell contains plain text and
- <seealso marker="inline_tags">inline tags</seealso>. Example:</p>
+ <seeguide marker="inline_tags">inline tags</seeguide>. Example:</p>
<pre><![CDATA[
<table>
<row>
diff --git a/lib/erl_docgen/doc/src/doc_storage.xml b/lib/erl_docgen/doc/src/doc_storage.xml
index 1af81ca3ad..2fd804b522 100644
--- a/lib/erl_docgen/doc/src/doc_storage.xml
+++ b/lib/erl_docgen/doc/src/doc_storage.xml
@@ -35,6 +35,7 @@
defines a common documentation storage format for module documentation in the Erlang/OTP
ecosystem. Erl_Docgen can generate documentation in this format from XML files following
the DTD's descibed in the other User's Guides in this application.</p>
+ <p></p>
<p>Some special considerations have to be taken when writing documentation that
should also be available through EEP-48 style storage.</p>
<list>
@@ -53,8 +54,8 @@
<section>
<title>See Also</title>
<p>
- <seealso marker="stdlib:shell_docs"><c>shell_docs(3)</c></seealso>,
- <seealso marker="kernel:code#get_doc/1"><c>code:get_doc(3)</c></seealso>
+ <seeerl marker="stdlib:shell_docs"><c>shell_docs(3)</c></seeerl>,
+ <seemfa marker="kernel:code#get_doc/1"><c>code:get_doc(3)</c></seemfa>
</p>
</section>
diff --git a/lib/erl_docgen/doc/src/inline_tags.xml b/lib/erl_docgen/doc/src/inline_tags.xml
index d8a59349a7..6d80d47997 100644
--- a/lib/erl_docgen/doc/src/inline_tags.xml
+++ b/lib/erl_docgen/doc/src/inline_tags.xml
@@ -39,7 +39,7 @@
<p>Forces a newline. The <c><![CDATA[<br>]]></c> tag is both a
block- and an inline tag and is described in
- the <seealso marker="block_tags#brTAG">Block Tags</seealso>
+ the <seeguide marker="block_tags#brTAG">Block Tags</seeguide>
section.</p>
</section>
@@ -49,9 +49,9 @@
<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 <seealso marker="block_tags#codeTAG">code</seealso>
- tag. All <seealso marker="character_entities">character
- entities</seealso> are expanded. Example:</p>
+ opposed to the <seeguide marker="block_tags#codeTAG">code</seeguide>
+ tag. All <seeguide marker="character_entities">character
+ entities</seeguide> are expanded. Example:</p>
<pre>
&lt;p>Returns &lt;c>true&lt;/c> if &lt;c>Term&lt;/c> is an integer.&lt;/p>
</pre>
@@ -72,7 +72,7 @@
<p>The application <em>must</em> be up and running.</p>
<p>Contains plain text or a
- <seealso marker="#cTAG">&lt;c&gt;</seealso> tag.</p>
+ <seeguide marker="#cTAG">&lt;c&gt;</seeguide> tag.</p>
</section>
<section>
@@ -86,7 +86,7 @@
&lt;marker id="marker_example"/&gt;
</pre>
- <p>The <seealso marker="#seealsoTAG">&lt;seealso&gt;</seealso> tag
+ <p>The <seeguide marker="#seealsoTAG">&lt;seealso&gt;</seeguide> tag
is used to refer to the marker.</p>
<p>The <c><![CDATA[<marker>]]></c> tag is both a block- and an
diff --git a/lib/erl_docgen/doc/src/overview.xml b/lib/erl_docgen/doc/src/overview.xml
index 5c4576000c..24eaf3a0e6 100644
--- a/lib/erl_docgen/doc/src/overview.xml
+++ b/lib/erl_docgen/doc/src/overview.xml
@@ -39,26 +39,26 @@
<tag><em>User's Guide</em></tag>
<item>
<p>(DTD:
- <seealso marker="user_guide_dtds#partDTD">part</seealso>)
+ <seeguide marker="user_guide_dtds#partDTD">part</seeguide>)
A collection of chapters
- (<seealso marker="user_guide_dtds#chapterDTD">chapter</seealso>).
+ (<seeguide marker="user_guide_dtds#chapterDTD">chapter</seeguide>).
</p>
</item>
<tag><em>Reference Manual</em></tag>
<item>
<p>(DTD:
- <seealso marker="refman_dtds#applicationDTD">application</seealso>
+ <seecref marker="refman_dtds#applicationDTD">application</seecref>
A collection of manual pages for modules
- (<seealso marker="refman_dtds#erlrefDTD">erlref</seealso>),
+ (<seecref marker="refman_dtds#erlrefDTD">erlref</seecref>),
applications
- (<seealso marker="refman_dtds#apprefDTD">appref</seealso>),
+ (<seecref marker="refman_dtds#apprefDTD">appref</seecref>),
commands
- (<seealso marker="refman_dtds#comrefDTD">comref</seealso>),
+ (<seecref marker="refman_dtds#comrefDTD">comref</seecref>),
C libraries
- (<seealso marker="refman_dtds#crefDTD">cref</seealso>) and
+ (<seecref marker="refman_dtds#crefDTD">cref</seecref>) and
files
- (<seealso marker="refman_dtds#filerefDTD">fileref</seealso>).
+ (<seecref marker="refman_dtds#filerefDTD">fileref</seecref>).
</p>
</item>
@@ -95,8 +95,8 @@
use the same DTD.</p>
<p>The basic set of tags are divided into two categories:
- <seealso marker="block_tags">block tags</seealso> and
- <seealso marker="inline_tags">inline tags</seealso>. Block tags
+ <seeguide marker="block_tags">block tags</seeguide> and
+ <seeguide marker="inline_tags">inline tags</seeguide>. Block tags
typically define a separate block of information, like a
paragraph or a list. Inline tags are typically used within block
tags, for example a highlighted word within a paragraph.</p>
diff --git a/lib/erl_docgen/doc/src/refman_dtds.xml b/lib/erl_docgen/doc/src/refman_dtds.xml
index ee3e2f09ad..886031db71 100644
--- a/lib/erl_docgen/doc/src/refman_dtds.xml
+++ b/lib/erl_docgen/doc/src/refman_dtds.xml
@@ -55,11 +55,11 @@
groups a set of manual pages into one unit. The structure is
similar to the part DTD: first an introduction and then the manual
pages, written in separate files with the
- <seealso marker="#apprefDTD">appref</seealso>,
- <seealso marker="#comrefDTD">comref</seealso>,
- <seealso marker="#crefDTD">cref</seealso>,
- <seealso marker="#erlrefDTD">erlref</seealso>, or
- <seealso marker="#filerefDTD">fileref</seealso> DTD.</p>
+ <seecref marker="#apprefDTD">appref</seecref>,
+ <seecref marker="#comrefDTD">comref</seecref>,
+ <seecref marker="#crefDTD">cref</seecref>,
+ <seecref marker="#erlrefDTD">erlref</seecref>, or
+ <seecref marker="#filerefDTD">fileref</seecref> DTD.</p>
<p>Example:</p>
<pre>
@@ -91,11 +91,11 @@
<p>The top level tag of an <c>application</c> DTD.</p>
<p>Contains a
- <seealso marker="header_tags">&lt;header&gt;</seealso>,
+ <seeguide marker="header_tags">&lt;header&gt;</seeguide>,
an optional
- <seealso marker="user_guide_dtds#descriptionTAG">&lt;description&gt;</seealso>,
+ <seeguide marker="user_guide_dtds#descriptionTAG">&lt;description&gt;</seeguide>,
followed by one or more
- <seealso marker="user_guide_dtds#includeTAG">&lt;include&gt;</seealso>.
+ <seeguide marker="user_guide_dtds#includeTAG">&lt;include&gt;</seeguide>.
</p>
</section>
@@ -148,15 +148,15 @@
<p>The top level tag of an <c>appref</c> DTD.</p>
<p>Contains
- <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
- <seealso marker="#appTAG">&lt;app&gt;</seealso>,
- <seealso marker="#appsummaryTAG">&lt;appsummary&gt;</seealso>,
- <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
+ <seeguide marker="header_tags#headerTAG">&lt;header&gt;</seeguide>,
+ <seecref marker="#appTAG">&lt;app&gt;</seecref>,
+ <seecref marker="#appsummaryTAG">&lt;appsummary&gt;</seecref>,
+ <seecref marker="#descriptionTAG">&lt;description&gt;</seecref>,
zero or more
- <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
- <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>,
+ <seecref marker="#sectionTAG">&lt;section&gt;</seecref> and
+ <seecref marker="#funcsTAG">&lt;funcs&gt;</seecref>,
followed by zero or more
- <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
+ <seecref marker="#authorsTAG">&lt;authors&gt;</seecref>.</p>
</section>
<section>
@@ -232,15 +232,15 @@
<p>The top level tag for a <c>comref</c> DTD.</p>
<p>Contains
- <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
- <seealso marker="#comTAG">&lt;com&gt;</seealso>,
- <seealso marker="#comsummaryTAG">&lt;comsummary&gt;</seealso>,
- <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
+ <seeguide marker="header_tags#headerTAG">&lt;header&gt;</seeguide>,
+ <seecref marker="#comTAG">&lt;com&gt;</seecref>,
+ <seecref marker="#comsummaryTAG">&lt;comsummary&gt;</seecref>,
+ <seecref marker="#descriptionTAG">&lt;description&gt;</seecref>,
zero or more
- <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
- <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>,
+ <seecref marker="#sectionTAG">&lt;section&gt;</seecref> and
+ <seecref marker="#funcsTAG">&lt;funcs&gt;</seecref>,
followed by zero or more
- <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
+ <seecref marker="#authorsTAG">&lt;authors&gt;</seecref>.</p>
</section>
<section>
@@ -320,15 +320,15 @@
<p>The top level tag for a <c>cref</c> DTD.</p>
<p>Contains
- <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
- <seealso marker="#libTAG">&lt;lib&gt;</seealso>,
- <seealso marker="#libsummaryTAG">&lt;libsummary&gt;</seealso>,
- <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
+ <seeguide marker="header_tags#headerTAG">&lt;header&gt;</seeguide>,
+ <seecref marker="#libTAG">&lt;lib&gt;</seecref>,
+ <seecref marker="#libsummaryTAG">&lt;libsummary&gt;</seecref>,
+ <seecref marker="#descriptionTAG">&lt;description&gt;</seecref>,
zero or more
- <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
- <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>, followed by
+ <seecref marker="#sectionTAG">&lt;section&gt;</seecref> and
+ <seecref marker="#funcsTAG">&lt;funcs&gt;</seecref>, followed by
zero or more
- <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
+ <seecref marker="#authorsTAG">&lt;authors&gt;</seecref>.</p>
</section>
<section>
@@ -412,15 +412,15 @@
<p>The top level tag for an <c>erlref</c> DTD.</p>
<p>Contains
- <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
- <seealso marker="#moduleTAG">&lt;module&gt;</seealso>,
- <seealso marker="#modulesummaryTAG">&lt;modulesummary&gt;</seealso>,
- <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
+ <seeguide marker="header_tags#headerTAG">&lt;header&gt;</seeguide>,
+ <seecref marker="#moduleTAG">&lt;module&gt;</seecref>,
+ <seecref marker="#modulesummaryTAG">&lt;modulesummary&gt;</seecref>,
+ <seecref marker="#descriptionTAG">&lt;description&gt;</seecref>,
zero or more
- <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
- <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>,
+ <seecref marker="#sectionTAG">&lt;section&gt;</seecref> and
+ <seecref marker="#funcsTAG">&lt;funcs&gt;</seecref>,
followed by zero or more
- <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
+ <seecref marker="#authorsTAG">&lt;authors&gt;</seecref>.</p>
</section>
<section>
@@ -490,15 +490,15 @@
<p>The top level tag for a <c>fileref</c> DTD.</p>
<p>Contains
- <seealso marker="header_tags#headerTAG">&lt;header&gt;</seealso>,
- <seealso marker="#fileTAG">&lt;file&gt;</seealso>,
- <seealso marker="#filesummaryTAG">&lt;filesummary&gt;</seealso>,
- <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
+ <seeguide marker="header_tags#headerTAG">&lt;header&gt;</seeguide>,
+ <seecref marker="#fileTAG">&lt;file&gt;</seecref>,
+ <seecref marker="#filesummaryTAG">&lt;filesummary&gt;</seecref>,
+ <seecref marker="#descriptionTAG">&lt;description&gt;</seecref>,
zero or more
- <seealso marker="#sectionTAG">&lt;section&gt;</seealso> and
- <seealso marker="#funcsTAG">&lt;funcs&gt;</seealso>,
+ <seecref marker="#sectionTAG">&lt;section&gt;</seecref> and
+ <seecref marker="#funcsTAG">&lt;funcs&gt;</seecref>,
followed by zero or more
- <seealso marker="#authorsTAG">&lt;authors&gt;</seealso>.</p>
+ <seecref marker="#authorsTAG">&lt;authors&gt;</seecref>.</p>
</section>
<section>
@@ -524,7 +524,7 @@
"formal" definitions.</p>
<p>Contains any combination and any number of
- <seealso marker="block_tags">block tags</seealso> except
+ <seeguide marker="block_tags">block tags</seeguide> except
<c><![CDATA[<image>]]></c> and <c><![CDATA[<table>]]></c>.</p>
</section>
@@ -533,11 +533,11 @@
<title>&lt;section&gt;</title>
<p>Subdivisions of the document. Contains an optional
- <seealso marker="inline_tags#markerTAG">&lt;marker&gt;</seealso>,
- a <seealso marker="user_guide_dtds#titleTAG">&lt;title&gt;</seealso>,
+ <seeguide marker="inline_tags#markerTAG">&lt;marker&gt;</seeguide>,
+ a <seeguide marker="user_guide_dtds#titleTAG">&lt;title&gt;</seeguide>,
followed by any combination and any number of
- <seealso marker="block_tags">block tags</seealso> except
+ <seeguide marker="block_tags">block tags</seeguide> except
<c><![CDATA[<image>]]></c> and <c><![CDATA[<table>]]></c>.</p>
</section>
@@ -548,7 +548,7 @@
<p>A group of "formal" function definitions.</p>
<p>Contains one or more
- <seealso marker="#funcTAG">&lt;func&gt;</seealso>.</p>
+ <seecref marker="#funcTAG">&lt;func&gt;</seecref>.</p>
</section>
<section>
@@ -558,10 +558,10 @@
<p>A "formal" function definition.</p>
<p>Contains one or more
- <seealso marker="#nameTAG">&lt;name&gt;</seealso>, followed by
- <seealso marker="#fsummaryTAG">&lt;fsummary&gt;</seealso>,
- <seealso marker="#typeTAG">&lt;type&gt;</seealso> (optional) and
- <seealso marker="#descTAG">&lt;desc&gt;</seealso> (optional).</p>
+ <seecref marker="#nameTAG">&lt;name&gt;</seecref>, followed by
+ <seecref marker="#fsummaryTAG">&lt;fsummary&gt;</seecref>,
+ <seecref marker="#typeTAG">&lt;type&gt;</seecref> (optional) and
+ <seecref marker="#descTAG">&lt;desc&gt;</seecref> (optional).</p>
</section>
<section>
@@ -576,7 +576,7 @@
<p>In the case of an <c>erlref</c> DTD, it will
automatically be added a
- <seealso marker="inline_tags#markerTAG">marker</seealso>,
+ <seeguide marker="inline_tags#markerTAG">marker</seeguide>,
<c><![CDATA[<marker id="Name/Arity">]]></c> or
<c><![CDATA[<marker id="Name">]]></c>, based on the contents of
this tag before the function definition.</p>
@@ -590,7 +590,7 @@
<c><![CDATA[<marker id="foo/2">]]></c> before the function
definition in the generated HTML. That is, referring to
the function using
- <c><![CDATA[<seealso marker="#foo/2">foo/2</seealso>]]></c> will
+ <c><![CDATA[<seemfa marker="#foo/2">foo/2</seemfa>]]></c> will
automatically work.</p>
</section>
@@ -599,8 +599,8 @@
<title>&lt;fsummary&gt;</title>
<p>Function/command summary. Contains plain text,
- <seealso marker="inline_tags#cTAG">&lt;c&gt;</seealso> and
- <seealso marker="inline_tags#emTAG">&lt;em&gt;</seealso>.</p>
+ <seeguide marker="inline_tags#cTAG">&lt;c&gt;</seeguide> and
+ <seeguide marker="inline_tags#emTAG">&lt;em&gt;</seeguide>.</p>
</section>
<section>
@@ -610,8 +610,8 @@
<p>Type declarations for the function/command.</p>
<p>Contains one or more pairs of
- <seealso marker="#vTAG">&lt;v&gt;</seealso> and
- <seealso marker="#dTAG">&lt;d&gt;</seealso> (optional).</p>
+ <seecref marker="#vTAG">&lt;v&gt;</seecref> and
+ <seecref marker="#dTAG">&lt;d&gt;</seecref> (optional).</p>
</section>
<section>
@@ -627,8 +627,8 @@
<title>&lt;d&gt;</title>
<p>Description for an argument or return value. Contains plain text,
- <seealso marker="inline_tags#cTAG">&lt;c&gt;</seealso> and
- <seealso marker="inline_tags#emTAG">&lt;em&gt;</seealso>.</p>
+ <seeguide marker="inline_tags#cTAG">&lt;c&gt;</seeguide> and
+ <seeguide marker="inline_tags#emTAG">&lt;em&gt;</seeguide>.</p>
</section>
<section>
@@ -636,7 +636,7 @@
<title>&lt;desc&gt;</title>
<p>Function/command description. Contains
- <seealso marker="block_tags">block tags</seealso> except
+ <seeguide marker="block_tags">block tags</seeguide> except
<c>&lt;image&gt;</c> and <c>&lt;table&gt;</c>.</p>
</section>
@@ -647,8 +647,8 @@
<p>Authors of the manual page. The <c>authors</c> element is optional.</p>
<p>Contains one or more pairs of
- <seealso marker="#anameTAG">&lt;aname&gt;</seealso> and
- <seealso marker="#emailTAG">&lt;email&gt;</seealso>.</p>
+ <seecref marker="#anameTAG">&lt;aname&gt;</seecref> and
+ <seecref marker="#emailTAG">&lt;email&gt;</seecref>.</p>
</section>
<section>
diff --git a/lib/erl_docgen/doc/src/user_guide_dtds.xml b/lib/erl_docgen/doc/src/user_guide_dtds.xml
index fdbaba2d92..0bebf43cdb 100644
--- a/lib/erl_docgen/doc/src/user_guide_dtds.xml
+++ b/lib/erl_docgen/doc/src/user_guide_dtds.xml
@@ -38,7 +38,7 @@
the User's Guide or Release Notes. First are some paragraphs
introducing the main contents. After that follows chapters,
written in separate files with
- the <seealso marker="#chapterDTD">chapter</seealso> DTD.</p>
+ the <seeguide marker="#chapterDTD">chapter</seeguide> DTD.</p>
<p>Example:</p>
<pre>
@@ -70,11 +70,11 @@
<p>The top level tag of a <c>part</c> DTD.</p>
<p>Contains a
- <seealso marker="header_tags">&lt;header&gt;</seealso>,
+ <seeguide marker="header_tags">&lt;header&gt;</seeguide>,
an optional
- <seealso marker="#descriptionTAG">&lt;description&gt;</seealso>,
+ <seeguide marker="#descriptionTAG">&lt;description&gt;</seeguide>,
followed by one or more
- <seealso marker="#includeTAG">&lt;include&gt;</seealso>.</p>
+ <seeguide marker="#includeTAG">&lt;include&gt;</seeguide>.</p>
</section>
<section>
@@ -85,7 +85,7 @@
included chapters/manual pages.</p>
<p>Contains any combination and any number
- of <seealso marker="block_tags">block tags</seealso> except
+ of <seeguide marker="block_tags">block tags</seeguide> except
<c><![CDATA[<image>]]></c> and <c><![CDATA[<table>]]></c>.</p>
</section>
@@ -151,11 +151,11 @@
<p>The top level tag of a <c>chapter</c> DTD.</p>
<p>Contains a
- <seealso marker="header_tags">&lt;header&gt;</seealso>,
+ <seeguide marker="header_tags">&lt;header&gt;</seeguide>,
an optional introduction consisting of any combination of
- <seealso marker="block_tags">block tags</seealso>,
+ <seeguide marker="block_tags">block tags</seeguide>,
followed by one or more
- <seealso marker="#sectionTAG">&lt;section&gt;</seealso>.</p>
+ <seeguide marker="#sectionTAG">&lt;section&gt;</seeguide>.</p>
</section>
<section>
@@ -165,10 +165,10 @@
<p>Subdivision of a chapter.</p>
<p>Contains an optional
- <seealso marker="inline_tags#markerTAG">&lt;marker&gt;</seealso>,
- a <seealso marker="#titleTAG">&lt;title&gt;</seealso>,
+ <seeguide marker="inline_tags#markerTAG">&lt;marker&gt;</seeguide>,
+ a <seeguide marker="#titleTAG">&lt;title&gt;</seeguide>,
followed by any combination and any number of
- <seealso marker="block_tags">block tags</seealso> and
+ <seeguide marker="block_tags">block tags</seeguide> and
<c><![CDATA[<section>]]></c>.</p>
</section>