os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add some tables showing common FreeBSD entities and their usage.

Browse source
This commit is contained in:
Warren Block 2013-07-20 20:46:28 +00:00
parent 2a03f8c539
commit 52ce6f423a
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=42332
1 changed files with 217 additions and 15 deletions

232
en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
View file

@ -46,7 +46,7 @@
not answer to the &a.doc;.</para>
<para>DocBook was originally developed by HaL Computer Systems and
O'Reilly &amp; Associates to be a <acronym>DTD</acronym> for
O'Reilly &amp; Associates to be a Document Type Definition (<acronym>DTD</acronym>) for
writing technical documentation <footnote><para>A short history
can be found under <ulink
url="http://www.oasis-open.org/docbook/intro.shtml#d0e41">
@ -92,31 +92,233 @@
<title>&os; Extensions</title>
<para>The &os; Documentation Project has extended the
DocBook <acronym>DTD</acronym> by adding some new elements.
These elements serve to make some of the markup more
DocBook <acronym>DTD</acronym> with additional elements and entities.
These additions serve to make some of the markup easier or more
precise.</para>
<para>Where a &os;-specific element is listed below, it is
clearly marked.</para>
<para>Throughout the rest of this document, the term
<quote>DocBook</quote> is used to mean the &os;-extended
DocBook <acronym>DTD</acronym>.</para>
<note>
<para>There is nothing about these extensions that is &os;
specific, it was just felt that they were useful
<para>Most of these extensions are not unique to &os;,
it was just felt that they were useful
enhancements for this particular project. Should anyone
from any of the other *nix camps (NetBSD, OpenBSD, Linux,
&hellip;) be interested in collaborating on a standard
DocBook extension set, please get in touch with
DocBook extension set, please contact
&a.doceng;.</para>
</note>
<para>The &os; extensions are not (currently) in the
Ports Collection. They are stored in the &os; Subversion
tree, as <ulink
url="http://svnweb.FreeBSD.org/doc/head/share/xml/freebsd.dtd">head/share/xml/freebsd.dtd</ulink>.</para>
<sect2 id="docbook-markup-freebsd-extensions-elements">
<title>&os; Elements</title>
<para>The additional &os; elements are not (currently) in the
Ports Collection. They are stored in the &os; Subversion
tree, as <ulink
url="http://svnweb.FreeBSD.org/doc/head/share/xml/freebsd.dtd">head/share/xml/freebsd.dtd</ulink>.</para>
<para>&os;-specific elements used in the examples below are
clearly marked.</para>
</sect2>
<sect2 id="docbook-markup-freebsd-extensions-entities">
<title>&os; Entities</title>
<table frame="none">
<title>&os; Name Entities</title>
<tgroup cols="2">
<thead>
<row>
<entry>Name</entry>
<entry>Expands To</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>&amp;os;</literal></entry>
<entry><literal>&os;</literal></entry>
</row>
<row>
<entry><literal>&amp;os.stable;</literal></entry>
<entry><literal>&os.stable;</literal></entry>
</row>
<row>
<entry><literal>&amp;os.current;</literal></entry>
<entry><literal>&os.current;</literal></entry>
</row>
</tbody>
</tgroup>
</table>
<table frame="none">
<title>&os; Mailing List Entities</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Expands To</entry>
<entry>Notes</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>&amp;a.doc;</literal></entry>
<entry><literal>&a.doc;</literal></entry>
<entry>
<programlisting>Usage: A link to the &amp;a.doc;.</programlisting></entry>
</row>
<row>
<entry><literal>&amp;a.questions;</literal></entry>
<entry><literal>&a.questions;</literal></entry>
<entry>
<programlisting>Usage: A link to the &amp;a.questions;.</programlisting></entry>
</row>
<row>
<entry><literal>&amp;a.<replaceable>listname</replaceable>;</literal></entry>
<entry><emphasis>link to
<replaceable>listname</replaceable></emphasis></entry>
<entry>Entities are defined for all the <ulink
url="&url.books.handbook;/eresources.html#eresources-mail">&os; mailing
lists</ulink>.</entry>
</row>
</tbody>
</tgroup>
</table>
<table frame="none">
<title>&os; Document Links</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Expands To</entry>
<entry>Notes</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>&amp;url.books.handbook;</literal></entry>
<entry><literal>&url.books.handbook;</literal></entry>
<entry>
<programlisting>Usage: A link to the <sgmltag class="starttag">ulink url="&amp;url.books.handbook;/advanced-networking.html"</sgmltag>Advanced
Networking<sgmltag class="endtag">ulink</sgmltag> chapter of the Handbook.</programlisting></entry>
</row>
<row>
<entry><literal>&amp;url.books.<replaceable>bookname</replaceable>;</literal></entry>
<entry><emphasis>relative path to
<replaceable>bookname</replaceable></emphasis></entry>
<entry>Entities are defined for all the <ulink
url="&url.doc.langbase;/books/">&os;
books</ulink>.</entry>
</row>
<row>
<entry><literal>&amp;url.articles.committers-guide;</literal></entry>
<entry><literal>&url.articles.committers-guide;</literal></entry>
<entry>
<programlisting>Usage: A link to the <sgmltag class="starttag">ulink url="&amp;url.articles.committers-guide;"</sgmltag>Committer's Guide<sgmltag class="endtag">ulink</sgmltag> article.</programlisting></entry>
</row>
<row>
<entry><literal>&amp;url.articles.<replaceable>articlename</replaceable>;</literal></entry>
<entry><emphasis>relative path to
<replaceable>articlename</replaceable></emphasis></entry>
<entry>Entities are defined for all the <ulink
url="&url.doc.langbase;/articles/">&os; articles</ulink>.</entry>
</row>
</tbody>
</tgroup>
</table>
<table frame="none">
<title>Other Operating System Name Entities</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Expands To</entry>
<entry>Notes</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>&amp;linux;</literal></entry>
<entry>&linux;</entry>
<entry>The &linux; operating system.</entry>
</row>
<row>
<entry><literal>&amp;unix;</literal></entry>
<entry>&unix;</entry>
<entry>The &unix; operating system.</entry>
</row>
<row>
<entry><literal>&amp;windows;</literal></entry>
<entry>&windows;</entry>
<entry>The &windows; operating system.</entry>
</row>
</tbody>
</tgroup>
</table>
<table frame="none">
<title>Miscellaneous Entities</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Expands To</entry>
<entry>Notes</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>&amp;prompt.root;</literal></entry>
<entry><literal>&prompt.root;</literal></entry>
<entry>The <username>root</username> user
prompt.</entry>
</row>
<row>
<entry><literal>&amp;prompt.user;</literal></entry>
<entry><literal>&prompt.user;</literal></entry>
<entry>A prompt for an unprivileged user.</entry>
</row>
<row>
<entry><literal>&amp;postscript;</literal></entry>
<entry>&postscript;</entry>
<entry>The trademarked term to refer to the
&postscript; programming language.</entry>
</row>
<row>
<entry><literal>&amp;xorg;</literal></entry>
<entry>&xorg;</entry>
<entry>The term to refer to the &xorg; open source X
Window System.</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
</sect1>
<sect1 id="docbook-markup-fpi">
@ -1635,8 +1837,8 @@ This is the file called 'foo2'</screen>
exported by a <filename>Makefile</filename> that can be
given as a parameter to <command>make</command>.
<sgmltag>makevar</sgmltag> identifies a variable that can be
set (in the environment, on the <command>make</command>
command line, or within the <filename>Makefile</filename>)
set (in the environment, on the command line with <command>make</command>,
or within the <filename>Makefile</filename>)
to influence the process.</para>
<example>