Date: Sat, 20 Jul 2013 20:46:29 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42332 - head/en_US.ISO8859-1/books/fdp-primer/docbook-markup Message-ID: <201307202046.r6KKkTn3026879@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Sat Jul 20 20:46:28 2013 New Revision: 42332 URL: http://svnweb.freebsd.org/changeset/doc/42332 Log: Add some tables showing common FreeBSD entities and their usage. Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Sat Jul 20 15:24:54 2013 (r42331) +++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Sat Jul 20 20:46:28 2013 (r42332) @@ -46,7 +46,7 @@ not answer to the &a.doc;.</para> <para>DocBook was originally developed by HaL Computer Systems and - O'Reilly & Associates to be a <acronym>DTD</acronym> for + O'Reilly & 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, …) 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>&os;</literal></entry> + <entry><literal>&os;</literal></entry> + </row> + + <row> + <entry><literal>&os.stable;</literal></entry> + <entry><literal>&os.stable;</literal></entry> + </row> + + <row> + <entry><literal>&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>&a.doc;</literal></entry> + <entry><literal>&a.doc;</literal></entry> + <entry> + <programlisting>Usage: A link to the &a.doc;.</programlisting></entry> + </row> + + <row> + <entry><literal>&a.questions;</literal></entry> + <entry><literal>&a.questions;</literal></entry> + <entry> + <programlisting>Usage: A link to the &a.questions;.</programlisting></entry> + </row> + + <row> + <entry><literal>&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>&url.books.handbook;</literal></entry> + <entry><literal>&url.books.handbook;</literal></entry> + <entry> + <programlisting>Usage: A link to the <sgmltag class="starttag">ulink url="&url.books.handbook;/advanced-networking.html"</sgmltag>Advanced + Networking<sgmltag class="endtag">ulink</sgmltag> chapter of the Handbook.</programlisting></entry> + </row> + + <row> + <entry><literal>&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>&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="&url.articles.committers-guide;"</sgmltag>Committer's Guide<sgmltag class="endtag">ulink</sgmltag> article.</programlisting></entry> + </row> + + <row> + <entry><literal>&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>&linux;</literal></entry> + <entry>&linux;</entry> + <entry>The &linux; operating system.</entry> + </row> + + <row> + <entry><literal>&unix;</literal></entry> + <entry>&unix;</entry> + <entry>The &unix; operating system.</entry> + </row> + + <row> + <entry><literal>&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>&prompt.root;</literal></entry> + <entry><literal>&prompt.root;</literal></entry> + <entry>The <username>root</username> user + prompt.</entry> + </row> + + <row> + <entry><literal>&prompt.user;</literal></entry> + <entry><literal>&prompt.user;</literal></entry> + <entry>A prompt for an unprivileged user.</entry> + </row> + + <row> + <entry><literal>&postscript;</literal></entry> + <entry>&postscript;</entry> + <entry>The trademarked term to refer to the + &postscript; programming language.</entry> + </row> + + <row> + <entry><literal>&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>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201307202046.r6KKkTn3026879>