svn commit: r44069 - in head/en_US.ISO8859-1/books/fdp-primer: docbook-markup examples overview the-website translations
Warren Block
wblock at FreeBSD.org
Wed Feb 26 03:50:59 UTC 2014
Author: wblock
Date: Wed Feb 26 03:50:57 2014
New Revision: 44069
URL: http://svnweb.freebsd.org/changeset/doc/44069
Log:
Restore <replaceable> tags lost during the DocBook5 conversion.
Modified:
head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml
head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml
head/en_US.ISO8859-1/books/fdp-primer/translations/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 Wed Feb 26 03:27:51 2014 (r44068)
+++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Wed Feb 26 03:50:57 2014 (r44069)
@@ -196,7 +196,7 @@
</row>
<row>
- <entry><literal>&man.command.sectionnumber;</literal></entry>
+ <entry><literal>&man.<replaceable>command</replaceable>.<replaceable>sectionnumber</replaceable>;</literal></entry>
<entry><emphasis>link to
<replaceable>command</replaceable> manual page in
section
@@ -232,7 +232,7 @@
</row>
<row>
- <entry><literal>&a.listname;</literal></entry>
+ <entry><literal>&a.<replaceable>listname</replaceable>;</literal></entry>
<entry><emphasis>link to
<replaceable>listname</replaceable></emphasis></entry>
<entry>Entities are defined for all the <link
@@ -261,7 +261,7 @@
</row>
<row>
- <entry><literal>&url.books.bookname;</literal></entry>
+ <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 <link
@@ -279,7 +279,7 @@
</row>
<row>
- <entry><literal>&url.articles.articlename;</literal></entry>
+ <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 <link
@@ -1468,7 +1468,7 @@ This is the file called 'foo2'</screen>
<link linkend="xml-primer-general-entities">general
entities</link> have been created to make this easier.
Each entity takes the form
- <literal>&man.manual-page.manual-section;</literal>.</para>
+ <literal>&man.<replaceable>manual-page</replaceable>.<replaceable>manual-section</replaceable>;</literal>.</para>
<para>The file that contains these entities is in
<filename>doc/share/xml/man-refs.ent</filename>, and can be
@@ -1497,7 +1497,7 @@ This is the file called 'foo2'</screen>
<para>When referring to the same command multiple times in
close proximity, it is preferred to use the
- <literal>&man.command.section;</literal>
+ <literal>&man.<replaceable>command</replaceable>.<replaceable>section</replaceable>;</literal>
notation to markup the first reference and use
<tag>command</tag> to markup subsequent references.
This makes the generated output, especially
@@ -1549,7 +1549,7 @@ This is the file called 'foo2'</screen>
<note>
<para>Notice how the
- <literal>&man.command.section;</literal>
+ <literal>&man.<replaceable>command</replaceable>.<replaceable>section</replaceable>;</literal>
notation is easier to follow.</para>
</note>
</sect2>
@@ -1980,7 +1980,7 @@ This is the file called 'foo2'</screen>
<para>Appearance:</para>
<para>The
- <literal>maxusers n</literal>
+ <literal>maxusers <replaceable>n</replaceable></literal>
line in the kernel configuration file determines the size
of many system tables, and is a rough guide to how many
simultaneous logins the system will support.</para>
Modified: head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml Wed Feb 26 03:27:51 2014 (r44068)
+++ head/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml Wed Feb 26 03:50:57 2014 (r44069)
@@ -171,7 +171,7 @@
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
-d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \<co xml:id="examples-co-jade-1-dsssl"/>
- -t sgml <co xml:id="examples-co-jade-1-transform"/> file.xml > file.html <co xml:id="examples-co-jade-1-filename"/></userinput></screen>
+ -t sgml <co xml:id="examples-co-jade-1-transform"/> <replaceable>file</replaceable>.xml > <replaceable>file</replaceable>.html <co xml:id="examples-co-jade-1-filename"/></userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-1-nochunks">
@@ -226,7 +226,7 @@
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
-d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \<co xml:id="examples-co-jade-2-dsssl"/>
- -t sgml <co xml:id="examples-co-jade-2-transform"/> file.xml <co xml:id="examples-co-jade-2-filename"/></userinput></screen>
+ -t sgml <co xml:id="examples-co-jade-2-transform"/> <replaceable>file</replaceable>.xml <co xml:id="examples-co-jade-2-filename"/></userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-2-catalog">
@@ -283,7 +283,7 @@
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
-d /usr/local/share/xml/docbook/dsssl/modular/print/docbook.dsl \<co xml:id="examples-co-jade-3-dsssl"/>
- -t tex <co xml:id="examples-co-jade-3-tex"/> file.xml</userinput></screen>
+ -t tex <co xml:id="examples-co-jade-3-tex"/> <replaceable>file</replaceable>.xml</userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-3-tex-backend">
@@ -319,7 +319,7 @@
run through <command>tex</command>, specifying the
<literal>&jadetex</literal> macro package.</para>
- <screen>&prompt.user; <userinput>tex "&jadetex" file.tex</userinput></screen>
+ <screen>&prompt.user; <userinput>tex "&jadetex" <replaceable>file</replaceable>.tex</userinput></screen>
<para><command>tex</command> commands must be run
<emphasis>at least</emphasis> three times. The first run
@@ -341,12 +341,12 @@
necessary.</para>
<para>The output from this stage will be
- <filename>file.dvi</filename>.</para>
+ <filename><replaceable>file</replaceable>.dvi</filename>.</para>
<para>Finally, run <command>dvips</command> to convert the
<filename>.dvi</filename> file to &postscript;.</para>
- <screen>&prompt.user; <userinput>dvips -o file.ps file.dvi</userinput></screen>
+ <screen>&prompt.user; <userinput>dvips -o <replaceable>file</replaceable>.ps <replaceable>file.dvi</replaceable></userinput></screen>
</example>
<example>
@@ -361,12 +361,12 @@
However, use the <literal>&pdfjadetex</literal> macro
package instead.</para>
- <screen>&prompt.user; <userinput>pdftex "&pdfjadetex" file.tex</userinput></screen>
+ <screen>&prompt.user; <userinput>pdftex "&pdfjadetex" <replaceable>file</replaceable>.tex</userinput></screen>
<para>Again, run this command three times.</para>
<para>This will generate
- <filename>file.pdf</filename>,
+ <filename><replaceable>file</replaceable>.pdf</filename>,
which does not need to be processed any further.</para>
</example>
</sect2>
Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Wed Feb 26 03:27:51 2014 (r44068)
+++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Wed Feb 26 03:50:57 2014 (r44069)
@@ -156,7 +156,7 @@
<filename>~/doc</filename> (see
<xref linkend="working-copy"/>).</para>
- <screen>&prompt.user; <userinput>svn checkout https://svn0.us-west.FreeBSD.org/doc/head ~/doc</userinput></screen>
+ <screen>&prompt.user; <userinput>svn checkout https://<replaceable>svn0.us-west.FreeBSD.org</replaceable>/doc/head <replaceable>~/doc</replaceable></userinput></screen>
</step>
<step>
@@ -184,7 +184,7 @@
<step>
<para>Update the local working copy:</para>
- <screen>&prompt.user; <userinput>svn up ~/doc</userinput></screen>
+ <screen>&prompt.user; <userinput>svn up <replaceable>~/doc</replaceable></userinput></screen>
</step>
<step>
@@ -224,7 +224,7 @@
<quote>diff file</quote>:</para>
<screen>&prompt.user; <userinput>cd /usr/doc</userinput>
-&prompt.user; <userinput>svn diff > bsdinstall.diff.txt</userinput></screen>
+&prompt.user; <userinput>svn diff > <replaceable>bsdinstall</replaceable>.diff.txt</userinput></screen>
<para>Give the diff file a descriptive name. In the example
above, changes have been made to the
Modified: head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml Wed Feb 26 03:27:51 2014 (r44068)
+++ head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml Wed Feb 26 03:50:57 2014 (r44069)
@@ -38,7 +38,7 @@
<para>Having obtained the documentation and web site source files,
the web site can be built. In this example, the build directory
- is <filename>~/doc</filename>
+ is <filename role="directory"><replaceable>~/doc</replaceable></filename>
and all the required files are already in place.</para>
<para>The web site is built from the
@@ -76,7 +76,7 @@
<systemitem class="username">jru</systemitem> in their home directory, <filename>/usr/home/jru/doc</filename>.</para>
<screen>&prompt.root; <userinput>cd /home/jru/doc/en_US.ISO8859-1/htdocs</userinput>
-&prompt.root; <userinput>env DESTDIR=/usr/local/www make install</userinput></screen>
+&prompt.root; <userinput>env DESTDIR=<replaceable>/usr/local/www</replaceable> make install</userinput></screen>
<para>The install process will not delete any old or outdated
files that existed previously in the same directory. If a new
@@ -84,7 +84,7 @@
will find and delete all files that have not been updated in
three days.</para>
- <screen>&prompt.root; <userinput>find /usr/local/www -ctime 3 -delete</userinput></screen>
+ <screen>&prompt.root; <userinput>find <replaceable>/usr/local/www</replaceable> -ctime 3 -delete</userinput></screen>
</sect1>
<sect1 xml:id="the-website-env">
@@ -129,7 +129,7 @@
<listitem>
<para>If set, build or install only for the languages
- specified by this variable inside the <filename>~/doc</filename>
+ specified by this variable inside the <filename role="directory"><replaceable>~/doc</replaceable></filename>
directory. All other languages except English will be
ignored. E.g.:</para>
Modified: head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml Wed Feb 26 03:27:51 2014 (r44068)
+++ head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml Wed Feb 26 03:50:57 2014 (r44069)
@@ -135,7 +135,7 @@
copy of the FreeBSD Subversion repository (at least the
documentation part). This can be done by running:</para>
- <screen>&prompt.user; <userinput>svn checkout https://svn0.us-east.FreeBSD.org/doc/head/ head</userinput></screen>
+ <screen>&prompt.user; <userinput>svn checkout <replaceable>https://svn0.us-east.FreeBSD.org</replaceable>/doc/head/ head</userinput></screen>
<para><link xlink:href="https://svn0.us-east.FreeBSD.org/">svn0.us-east.FreeBSD.org</link>
is a public <literal>SVN</literal> server.
@@ -158,7 +158,7 @@
<filename>en_US.ISO8859-1/books/fdp-primer/book.xml</filename>,
run:</para>
- <screen>&prompt.user; <userinput>svn diff -r33733:33734 en_US.ISO8859-1/books/fdp-primer/book.xml</userinput></screen>
+ <screen>&prompt.user; <userinput>svn diff -r<replaceable>33733</replaceable>:<replaceable>33734</replaceable> en_US.ISO8859-1/books/fdp-primer/book.xml</userinput></screen>
</answer>
</qandaentry>
@@ -284,7 +284,7 @@
<para><literal>sv_SE.ISO8859-1</literal> is the name of the
translation, in
- <filename>lang.encoding</filename>
+ <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename>
form. Note the two Makefiles, which will be used to build
the documentation.</para>
@@ -465,7 +465,7 @@
<para>Your translated documents should include their own
$FreeBSD$ line, and change the
<literal>FreeBSD Documentation Project</literal> line to
- <literal>The FreeBSD language
+ <literal>The FreeBSD <replaceable>language</replaceable>
Documentation Project</literal>.</para>
<para>In addition, you should add a third line which indicates
More information about the svn-doc-all
mailing list