Date: Sun, 7 Dec 2008 20:15:45 GMT From: Rene Ladan <rene@FreeBSD.org> To: Perforce Change Reviews <perforce@FreeBSD.org> Subject: PERFORCE change 154289 for review Message-ID: <200812072015.mB7KFjOj035798@repoman.freebsd.org>
next in thread | raw e-mail | index | archive | help
http://perforce.freebsd.org/chv.cgi?CH=154289 Change 154289 by rene@rene_self on 2008/12/07 20:14:54 IFC Affected files ... .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/fbsd-from-scratch/article.sgml#3 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml#2 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml#2 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/boot/chapter.sgml#2 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/desktop/chapter.sgml#5 integrate .. //depot/projects/docproj_nl/nl_NL.ISO8859-1/books/handbook/network-servers/chapter.sgml#8 integrate .. //depot/projects/docproj_nl/www/en/multimedia/multimedia-input.xml#3 integrate .. //depot/projects/docproj_nl/www/en/multimedia/multimedia.pl#2 integrate .. //depot/projects/docproj_nl/www/share/sgml/events.xml#10 integrate Differences ... ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/fbsd-from-scratch/article.sgml#3 (text+ko) ==== @@ -20,7 +20,7 @@ <holder>Jens Schweikhardt</holder> </copyright> - <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/fbsd-from-scratch/article.sgml,v 1.12 2008/12/03 21:59:51 schweikh Exp $</pubdate> + <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/fbsd-from-scratch/article.sgml,v 1.14 2008/12/04 18:13:49 schweikh Exp $</pubdate> <legalnotice id="trademarks" role="trademarks"> &tm-attrib.freebsd; @@ -119,7 +119,7 @@ done from within the old system, up to the point where you can chroot to the new system. In other words, we go through three stages, where each stage consists of either running a shell - script or invoke <command>make</command>:</para> + script or invoking <command>make</command>:</para> <orderedlist> <listitem> @@ -176,8 +176,9 @@ not be used for its usual duties. If you run a production server you have to consider the downtime caused by stage two. The ports compiled by <filename>stage_2.conf.default</filename> below require - about 4 hours to build on an AMD1800+ SCSI system with 10krpm disks - and 1GB of RAM. If you prefer to install packages instead of ports, + about 8 hours (of which 4 hours are due to + <application>OpenOffice.org</application>) to build on a contemporary + system. If you prefer to install packages instead of ports, you can significantly reduce the downtime to about 10 minutes.</para> </listitem> </itemizedlist> @@ -524,9 +525,9 @@ appropriate answers to the installation command (e.g. <command>yes | make install</command>. For other ports you need to investigate where exactly the interactive command is located and deal with it - appropriately. The examples above for + appropriately. See the examples above for <filename role="package">print/acroread8</filename> and - <filename role="package">java/jdk16</filename> are examples.</para> + <filename role="package">java/jdk16</filename>. <para>You should also be aware of upgrade issues for config files. In general you do not know when and if the format or contents of a ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml#2 (text+ko) ==== @@ -27,7 +27,7 @@ ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v 1.74 2006/04/28 12:39:55 blackend Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v 1.76 2008/12/06 22:09:01 pgj Exp $ --> <chapter id="sgml-markup"> @@ -50,7 +50,7 @@ content, please post it to the &a.doc;.</para> <note> - <title>Inline vs. block</title> + <title>Inline vs. Block</title> <para>In the remainder of this document, when describing elements, <emphasis>inline</emphasis> means that the element can occur within a @@ -64,7 +64,7 @@ <para>HTML, the HyperText Markup Language, is the markup language of choice on the World Wide Web. More information can be found at - <URL:<ulink url="http://www.w3.org/"></ulink>>.</para>; + <ulink url="http://www.w3.org/"></ulink>.</para>; <para>HTML is used to markup pages on the FreeBSD web site. It should not (generally) be used to mark up other documentation, @@ -77,7 +77,7 @@ latest, 4.0 (available in both <emphasis>strict</emphasis> and <emphasis>loose</emphasis> variants).</para> - <para>The HTML DTDs are available from the ports collection in the + <para>The HTML DTDs are available from the Ports Collection in the <filename role="package">textproc/html</filename> port. They are automatically installed as part of the <filename role="package">textproc/docproj</filename> port.</para> @@ -96,7 +96,7 @@ </sect2> <sect2> - <title>Sectional elements</title> + <title>Sectional Elements</title> <para>An HTML document is normally split into two sections. The first section, called the <emphasis>head</emphasis>, contains @@ -110,11 +110,11 @@ contained within the top-level <sgmltag>html</sgmltag> element.</para> <example> - <title>Normal HTML document structure</title> + <title>Normal HTML Document Structure</title> <programlisting><html> <head> - <title><replaceable>The document's title</replaceable></title> + <title><replaceable>The Document's Title</replaceable></title> </head> <body> @@ -127,7 +127,7 @@ </sect2> <sect2> - <title>Block elements</title> + <title>Block Elements</title> <sect3> <title>Headings</title> @@ -204,7 +204,7 @@ </sect3> <sect3> - <title>Block quotations</title> + <title>Block Quotations</title> <para>A block quotation is an extended quotation from another document that should not appear within the current paragraph.</para> @@ -285,7 +285,7 @@ </example> <example> - <title>Definition lists with <sgmltag>dl</sgmltag></title> + <title>Definition Lists with <sgmltag>dl</sgmltag></title> <para>Use:</para> @@ -308,7 +308,7 @@ </sect3> <sect3> - <title>Pre-formatted text</title> + <title>Pre-formatted Text</title> <para>You can indicate that text should be shown to the user exactly as it is in the file. Typically, this means that the text is shown @@ -370,7 +370,7 @@ <sgmltag>p</sgmltag> element.</para> <example> - <title>Simple use of <sgmltag>table</sgmltag></title> + <title>Simple Use of <sgmltag>table</sgmltag></title> <para>Use:</para> @@ -392,7 +392,7 @@ <para>A cell can span multiple rows and columns. To indicate this, add the <literal>rowspan</literal> and/or <literal>colspan</literal> - attributes, with values indicating the number of rows of columns + attributes, with values indicating the number of rows or columns that should be spanned.</para> <example> @@ -473,10 +473,10 @@ </sect2> <sect2> - <title>In-line elements</title> + <title>In-line Elements</title> <sect3> - <title>Emphasizing information</title> + <title>Emphasizing Information</title> <para>You have two levels of emphasis available in HTML, <sgmltag>em</sgmltag> and <sgmltag>strong</sgmltag>. @@ -498,7 +498,7 @@ </sect3> <sect3> - <title>Bold and italics</title> + <title>Bold and Italics</title> <para>Because HTML includes presentational markup, you can also indicate that particular content should be rendered in bold or @@ -514,7 +514,7 @@ </sect3> <sect3> - <title>Indicating fixed pitch text</title> + <title>Indicating Fixed-Pitch Text</title> <para>If you have content that should be rendered in a fixed pitch (typewriter) typeface, use <sgmltag>tt</sgmltag> (for @@ -532,7 +532,7 @@ </sect3> <sect3> - <title>Content size</title> + <title>Content Size</title> <para>You can indicate that content should be shown in a larger or smaller font. There are three ways of doing this.</para> @@ -555,7 +555,7 @@ <listitem> <para>Use <sgmltag>font</sgmltag> with the <literal>size</literal> - attribute set to a number between 1 and 7. The default font size + attribute set to a number between <literal>1</literal> and <literal>7</literal>. The default font size is <literal>3</literal>. This approach is deprecated.</para> </listitem> </orderedlist> @@ -570,7 +570,7 @@ this text is <big>slightly bigger</big>.</p> <p>This text is <font size="-1">slightly smaller</font>. But - this text is <font size="+1">slightly bigger</font.</p> + this text is <font size="+1">slightly bigger</font>.</p> <p>This text is <font size="2">slightly smaller</font>. But this text is <font size="4">slightly bigger</font>.</p>]]></programlisting> @@ -586,7 +586,7 @@ </note> <sect3> - <title>Linking to other documents on the WWW</title> + <title>Linking to Other Documents on the WWW</title> <para>In order to include a link to another document on the WWW you must know the URL of the document you want to link to.</para> @@ -612,7 +612,7 @@ </sect3> <sect3> - <title>Linking to other parts of documents</title> + <title>Linking to Other Parts of Documents</title> <para>Linking to a point within another document (or within the same document) requires that the document author include anchors that you @@ -636,7 +636,7 @@ <literal>#</literal> symbol.</para> <example> - <title>Linking to a named part of another document</title> + <title>Linking to A Named Part of Another Document</title> <para>Assume that the <literal>para1</literal> example resides in a document called <filename>foo.html</filename>.</para> @@ -651,7 +651,7 @@ the anchor (with the preceding <literal>#</literal>).</para> <example> - <title>Linking to a named part of the same document</title> + <title>Linking to A Named Part of the Same Document</title> <para>Assume that the <literal>para1</literal> example resides in this document:</para> @@ -680,7 +680,7 @@ <emphasis>how</emphasis> it should be presented.</para> <note> - <title><literal>formal</literal> vs. <literal>informal</literal></title> + <title>Formal vs. Informal</title> <para>Some elements may exist in two forms, <emphasis>formal</emphasis> and <emphasis>informal</emphasis>. Typically, the formal version of @@ -689,13 +689,13 @@ title.</para> </note> - <para>The DocBook DTD is available from the ports collection in the + <para>The DocBook DTD is available from the Ports Collection in the <filename role="package">textproc/docbook</filename> port. It is automatically installed as part of the <filename role="package">textproc/docproj</filename> port.</para> <sect2> - <title>FreeBSD extensions</title> + <title>&os; Extensions</title> <para>The FreeBSD Documentation Project has extended the DocBook DTD by adding some new elements. These elements serve to make some of the @@ -717,8 +717,8 @@ touch with &a.doceng;.</para> </note> - <para>The FreeBSD extensions are not (currently) in the ports - collection. They are stored in the FreeBSD CVS tree, as <ulink + <para>The &os; extensions are not (currently) in the Ports Collection. + They are stored in the &os; CVS tree, as <ulink url="http://www.FreeBSD.org/cgi/cvsweb.cgi/doc/share/sgml/freebsd.dtd">doc/share/sgml/freebsd.dtd</ulink>.</para>; </sect2> @@ -733,7 +733,7 @@ </sect2> <sect2> - <title>Document structure</title> + <title>Document Structure</title> <para>DocBook allows you to structure your documentation in several ways. In the FreeBSD Documentation Project we are using two primary @@ -742,7 +742,7 @@ <para>A book is organized into <sgmltag>chapter</sgmltag>s. This is a mandatory requirement. There may be <sgmltag>part</sgmltag>s between the book and the chapter to provide another layer of organization. - The Handbook is arranged in this way.</para> + For example, the Handbook is arranged in this way.</para> <para>A chapter may (or may not) contain one or more sections. These are indicated with the <sgmltag>sect1</sgmltag> element. If a section @@ -770,10 +770,10 @@ document, the <ulink url="&url.books.faq;/index.html">FreeBSD FAQ</ulink>, and the <ulink url="&url.books.handbook;/index.html">FreeBSD Handbook</ulink> are - all marked up as books.</para> + all marked up as books, for example.</para> <sect3> - <title>Starting a book</title> + <title>Starting a Book</title> <para>The content of the book is contained within the <sgmltag>book</sgmltag> element. As well as containing structural @@ -793,7 +793,7 @@ replaceable elements --> <programlisting><book> <bookinfo> - <title><replaceable>Your title here</replaceable></title> + <title><replaceable>Your Title Here</replaceable></title> <author> <firstname><replaceable>Your first name</replaceable></firstname> @@ -822,7 +822,7 @@ </sect3> <sect3> - <title>Starting an article</title> + <title>Starting an Article</title> <para>The content of the article is contained within the <sgmltag>article</sgmltag> element. As well as containing @@ -870,17 +870,17 @@ </example> </sect3> <sect3> - <title>Indicating chapters</title> + <title>Indicating Chapters</title> <para>Use <sgmltag>chapter</sgmltag> to mark up your chapters. Each chapter has a mandatory <sgmltag>title</sgmltag>. Articles do not contain chapters, they are reserved for books.</para> <example> - <title>A simple chapter</title> + <title>A Simple Chapter</title> <programlisting><![ CDATA [<chapter> - <title>The chapter's title</title> + <title>The Chapter's Title</title> ... </chapter>]]></programlisting> @@ -891,10 +891,10 @@ chapter then just use an empty paragraph.</para> <example> - <title>Empty chapters</title> + <title>Empty Ehapters</title> <programlisting><![ CDATA [<chapter> - <title>This is an empty chapter</title> + <title>This is An Empty Chapter</title> <para></para> </chapter>]]></programlisting> @@ -902,7 +902,7 @@ </sect3> <sect3> - <title>Sections below chapters</title> + <title>Sections Below Chapters</title> <para>In books, chapters may (but do not need to) be broken up into sections, subsections, and so on. In articles, sections are the @@ -918,34 +918,34 @@ elements, and so on, down to <sgmltag>sect5</sgmltag>.</para> <example> - <title>Sections in chapters</title> + <title>Sections in Chapters</title> <programlisting><![ RCDATA [<chapter> - <title>A sample chapter</title> + <title>A Sample Chapter</title> <para>Some text in the chapter.</para> <sect1> - <title>First section (1.1)</title> + <title>First Section (1.1)</title> … </sect1> <sect1> - <title>Second section (1.2)</title> + <title>Second Section (1.2)</title> <sect2> - <title>First sub-section (1.2.1)</title> + <title>First Sub-Section (1.2.1)</title> <sect3> - <title>First sub-sub-section (1.2.1.1)</title> + <title>First Sub-Sub-Section (1.2.1.1)</title> … </sect3> </sect2> <sect2> - <title>Second sub-section (1.2.2)</title> + <title>Second Sub-Section (1.2.2)</title> … </sect2> @@ -962,7 +962,7 @@ </sect3> <sect3> - <title>Subdividing using <sgmltag>part</sgmltag>s</title> + <title>Subdividing Using <sgmltag>part</sgmltag> Elements</title> <para>You can introduce another layer of organization between <sgmltag>book</sgmltag> and <sgmltag>chapter</sgmltag> with one or @@ -994,7 +994,7 @@ </sect2> <sect2> - <title>Block elements</title> + <title>Block Elements</title> <sect3> <title>Paragraphs</title> @@ -1025,7 +1025,7 @@ </sect3> <sect3> - <title>Block quotations</title> + <title>Block Quotations</title> <para>A block quotation is an extended quotation from another document that should not appear within the current paragraph. You will @@ -1055,6 +1055,8 @@ <para>Appearance:</para> + <para>A small excerpt from the US Constitution:</para> + <blockquote> <title>Preamble to the Constitution of the United States</title> @@ -1071,8 +1073,8 @@ </sect3> <sect3> - <title>Tips, notes, warnings, cautions, important information and - sidebars.</title> + <title>Tips, Notes, Warnings, Cautions, Important Information and + Sidebars</title> <para>You may need to include extra information separate from the main body of the text. Typically this is <quote>meta</quote> @@ -1120,6 +1122,7 @@ </warning>]]></programlisting> </example> + <para>Appearance:</para> <!-- Need to do this outside of the example --> <warning> <para>Installing FreeBSD may make you want to delete Windows from @@ -1128,7 +1131,7 @@ </sect3> <sect3> - <title>Lists and procedures</title> + <title>Lists and Procedures</title> <para>You will often need to list pieces of information to the user, or present them with a number of steps that must be carried out in @@ -1238,7 +1241,7 @@ </sect3> <sect3> - <title>Showing file samples</title> + <title>Showing File Samples</title> <para>If you want to show a fragment of a file (or perhaps a complete file) to the user, wrap it in the <sgmltag>programlisting</sgmltag> @@ -1390,12 +1393,12 @@ <para>Use:</para> - <programlisting><![ CDATA [<informaltable frame="none" pgwide="1"> + <programlisting><![ CDATA [<informaltable pgwide="1"> <tgroup cols="2"> <thead> <row> - <entry>This is column head 1</entry> - <entry>This is column head 2</entry> + <entry>This is Column Head 1</entry> + <entry>This is Column Head 2</entry> </row> </thead> @@ -1415,12 +1418,12 @@ <para>Appearance:</para> - <informaltable frame="none" pgwide="1"> + <informaltable pgwide="1"> <tgroup cols="2"> <thead> <row> - <entry>This is column head 1</entry> - <entry>This is column head 2</entry> + <entry>This is Column Head 1</entry> + <entry>This is Column Head 2</entry> </row> </thead> @@ -1452,7 +1455,7 @@ frame="none"></literal>).</para> <example> - <title>Tables where <literal>frame="none"</literal></title> + <title>Tables Where <literal>frame="none"</literal></title> <para>Appearance:</para> @@ -1460,8 +1463,8 @@ <tgroup cols="2"> <thead> <row> - <entry>This is column head 1</entry> - <entry>This is column head 2</entry> + <entry>This is Column Head 1</entry> + <entry>This is Column Head 2</entry> </row> </thead> @@ -1482,7 +1485,7 @@ </sect3> <sect3> - <title>Examples for the user to follow</title> + <title>Examples for the User to Follow</title> <para>A lot of the time you need to show examples for the user to follow. Typically, these will consist of dialogs with the computer; @@ -1586,10 +1589,10 @@ </sect2> <sect2> - <title>In-line elements</title> + <title>In-line Elements</title> <sect3> - <title>Emphasizing information</title> + <title>Emphasizing Information</title> <para>When you want to emphasize a particular word or phrase, use <sgmltag>emphasis</sgmltag>. This may be presented as italic, or @@ -1644,7 +1647,7 @@ </sect3> <sect3> - <title>Keys, mouse buttons, and combinations</title> + <title>Keys, Mouse Buttons, and Combinations</title> <para>To refer to a specific key on the keyboard, use <sgmltag>keycap</sgmltag>. To refer to a mouse button, use @@ -1665,7 +1668,7 @@ <sgmltag>keycombo</sgmltag>.</para> <example> - <title>Keys, mouse buttons, and combinations</title> + <title>Keys, Mouse Buttons, and Combinations</title> <para>Use:</para> @@ -1700,10 +1703,10 @@ </sect3> <sect3> - <title>Applications, commands, options, and cites</title> + <title>Applications, Commands, Options, and Cites</title> <para>You will frequently want to refer to both applications and - commands when writing for the Handbook. The distinction between + commands when writing documentation. The distinction between them is simple: an application is the name for a suite (or possibly just 1) of programs that fulfil a particular task. A command is the name of a program that the user can run.</para> @@ -1769,7 +1772,7 @@ clear. Hopefully this example makes it clearer.</para> <example> - <title>Applications, commands, and options.</title> + <title>Applications, Commands, and Options</title> <para>Use:</para> @@ -1780,7 +1783,7 @@ <citerefentry> <refentrytitle>sendmail</refentrytitle> <manvolnum>8</manvolnum> - </citerefentry>, &man.mailq.8;, and &man.newaliases.8; + </citerefentry>, &man.mailq.1;, and &man.newaliases.1; programs.</para> <para>One of the command line parameters to <citerefentry> @@ -1799,13 +1802,7 @@ <citerefentry> <refentrytitle>sendmail</refentrytitle> <manvolnum>8</manvolnum> - </citerefentry>, <citerefentry> - <refentrytitle>mailq</refentrytitle> - <manvolnum>8</manvolnum> - </citerefentry>, and <citerefentry> - <refentrytitle>newaliases</refentrytitle> - <manvolnum>8</manvolnum> - </citerefentry> programs.</para> + </citerefentry>, &man.mailq.1;, and &man.newaliases.1; programs.</para> <para>One of the command line parameters to <citerefentry> <refentrytitle>sendmail</refentrytitle> @@ -1822,7 +1819,7 @@ </sect3> <sect3> - <title>Files, directories, extensions</title> + <title>Files, Directories, Extensions</title> <para>Whenever you wish to refer to the name of a file, a directory, or a file extension, use <sgmltag>filename</sgmltag>.</para> @@ -1833,8 +1830,8 @@ <para>Use:</para> <programlisting><![ CDATA [<para>The SGML source for the Handbook in English can be - found in <filename class="directory">/usr/doc/en/handbook/</filename>. The first - file is called <filename>handbook.sgml</filename> in that + found in <filename class="directory">/usr/doc/en_US.ISO8859-1/books/handbook/</filename>. The first + file is called <filename>book.sgml</filename> in that directory. You should also see a <filename>Makefile</filename> and a number of files with a <filename>.ent</filename> extension.</para>]]></programlisting> @@ -1850,10 +1847,10 @@ </sect3> <sect3> - <title>The name of ports</title> + <title>The Name of Ports</title> <note> - <title>FreeBSD extension</title> + <title>&os; Extension</title> <para>These elements are part of the FreeBSD extension to DocBook, and do not exist in the original DocBook DTD.</para> @@ -1887,7 +1884,7 @@ <title>Devices</title> <note> - <title>FreeBSD extension</title> + <title>&os; Extension</title> <para>These elements are part of the FreeBSD extension to DocBook, and do not exist in the original DocBook DTD.</para> @@ -1938,10 +1935,10 @@ </sect3> <sect3> - <title>Hosts, domains, IP addresses, and so forth</title> + <title>Hosts, Domains, IP Addresses, and So Forth</title> <note> - <title>FreeBSD extension</title> + <title>&os; Extension</title> <para>These elements are part of the FreeBSD extension to DocBook, and do not exist in the original DocBook DTD.</para> @@ -1955,11 +1952,11 @@ <variablelist> <varlistentry> - <term>No role attribute, or + <term>No <literal>role</literal> attribute, or <literal>role="hostname"</literal></term> <listitem> - <para>With no role attribute (i.e., + <para>With no <literal>role</literal> attribute (i.e., <sgmltag>hostid</sgmltag>...<sgmltag>/hostid</sgmltag>) the marked up information is the simple hostname, such as <literal>freefall</literal> or <literal>wcarchive</literal>. @@ -2037,13 +2034,13 @@ <para>The <hostid role="domainname">FreeBSD.org</hostid> domain contains a number of different hosts, including <hostid role="fqdn">freefall.FreeBSD.org</hostid> and - <hostid role="fqdn">bento.FreeBSD.org</hostid>.</para> + <hostid role="fqdn">pointyhat.FreeBSD.org</hostid>.</para> <para>When adding an IP alias to an interface (using <command>ifconfig</command>) <emphasis>always</emphasis> use a netmask of <hostid role="netmask">255.255.255.255</hostid> (which can also be expressed as <hostid - role="netmask">0xffffffff</hostid>.</para> + role="netmask">0xffffffff</hostid>).</para> <para>The MAC address uniquely identifies every network card in existence. A typical MAC address looks like <hostid @@ -2064,7 +2061,7 @@ <command>ifconfig</command>) <emphasis>always</emphasis> use a netmask of <hostid role="netmask">255.255.255.255</hostid> (which can also be expressed as <hostid - role="netmask">0xffffffff</hostid>.</para> + role="netmask">0xffffffff</hostid>).</para> <para>The MAC address uniquely identifies every network card in existence. A typical MAC address looks like <hostid @@ -2076,7 +2073,7 @@ <title>Usernames</title> <note> - <title>FreeBSD extension</title> + <title>&os; Extension</title> <para>These elements are part of the FreeBSD extension to DocBook, and do not exist in the original DocBook DTD.</para> @@ -2105,7 +2102,7 @@ <title>Describing <filename>Makefile</filename>s</title> <note> - <title>FreeBSD extension</title> + <title>&os; Extension</title> <para>These elements are part of the FreeBSD extension to DocBook, and do not exist in the original DocBook DTD.</para> @@ -2158,11 +2155,11 @@ </sect3> <sect3> - <title>Literal text</title> + <title>Literal Text</title> <para>You will often need to include <quote>literal</quote> text in the - Handbook. This is text that is excerpted from another file, or - which should be copied from the Handbook into another file + documentation. This is text that is excerpted from another file, or + which should be copied from the documentation into another file verbatim.</para> <para>Some of the time, <sgmltag>programlisting</sgmltag> will be @@ -2210,9 +2207,7 @@ <para>Use:</para> - <programlisting><![ CDATA [<informalexample> - <screen>&prompt.user; <userinput>man <replaceable>command</replaceable></userinput></screen> -</informalexample>]]></programlisting> + <programlisting><![ CDATA [<screen>&prompt.user; <userinput>man <replaceable>command</replaceable></userinput></screen>]]></programlisting> <para>Appearance:</para> @@ -2249,7 +2244,7 @@ </sect3> <sect3> - <title>Quoting system errors</title> + <title>Quoting System Errors</title> <para>You might want to show errors generated by FreeBSD. Mark these with <sgmltag>errorname</sgmltag>. This @@ -2279,7 +2274,7 @@ <important> <para>Image support in the documentation is currently extremely - experimental. I think the mechanisms described here are unlikely to + experimental. The mechanisms described here are unlikely to change, but that is not guaranteed.</para> <para>You will also need to install the @@ -2301,7 +2296,7 @@ </important> <sect3> - <title>Image formats</title> + <title>Image Formats</title> <para>We currently support two formats for images. The format you should use will depend on the nature of your image.</para> @@ -2423,7 +2418,7 @@ </sect3> <sect3> - <title><filename>Makefile</filename> entries</title> + <title><filename>Makefile</filename> Entries</title> <para>Your images must be listed in the <filename>Makefile</filename> in the <makevar>IMAGES</makevar> @@ -2453,7 +2448,7 @@ </sect3> <sect3> - <title>Images and chapters in subdirectories</title> + <title>Images and Chapters in Subdirectories</title> <para>You must be careful when you separate your documentation into smaller files (see <xref linkend="sgml-primer-include-using-gen-entities">) in @@ -2464,7 +2459,7 @@ <filename>chapter1/chapter.sgml</filename>, <filename>chapter2/chapter.sgml</filename>, and <filename>chapter3/chapter.sgml</filename>. If each chapter has - images associated with it, I suggest you place those images in each + images associated with it, it is suggested to place those images in each chapter's subdirectory (<filename>chapter1/</filename>, <filename>chapter2/</filename>, and <filename>chapter3/</filename>).</para> @@ -2513,7 +2508,7 @@ </note> <sect3> - <title>Linking to other parts of the same document</title> + <title>Linking to Other Parts of the Same Document</title> <para>Linking within the same document requires you to specify where you are linking from (i.e., the text the user will click, or @@ -2532,7 +2527,7 @@ elements.</para> <example> - <title><literal>id on chapters and sections</literal></title> + <title>Attribute <literal>id</literal> on Chapters and Sections</title> <programlisting><![ CDATA [<chapter id="chapter1"> <title>Introduction</title> @@ -2603,7 +2598,7 @@ One</emphasis>.</para> <para>More specific information can be found in <emphasis>the - section called Sub-sect 1</emphasis>.</para> + section called Sub-Sect 1</emphasis>.</para> </blockquote> </example> @@ -2665,7 +2660,7 @@ </sect3> <sect3> - <title>Linking to documents on the WWW</title> + <title>Linking to Documents on the WWW</title> <para>Linking to external documents is much simpler, as long as you know the URL of the document you want to link to. Use ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml#2 (text+ko) ==== @@ -27,11 +27,11 @@ ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml,v 1.17 2005/09/12 16:47:35 yar Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml,v 1.18 2008/12/07 02:05:09 pgj Exp $ --> <chapter id="structure"> - <title>Structuring documents under <filename>doc/</filename></title> + <title>Structuring Documents Under <filename>doc/</filename></title> <para>The <filename>doc/</filename> tree is organized in a particular fashion, and the documents that are part of the FDP are in turn organized @@ -40,17 +40,17 @@ <orderedlist> <listitem> - <para>make it easy to automate converting the document to other formats;</para> + <para>Make it easy to automate converting the document to other formats.</para> </listitem> <listitem> - <para>promote consistency between the different documentation + <para>Promote consistency between the different documentation organizations, to make it easier to switch between working on - different documents;</para> + different documents.</para> </listitem> <listitem> - <para>make it easy to decide where in the tree new documentation should + <para>Make it easy to decide where in the tree new documentation should be placed.</para> </listitem> </orderedlist> @@ -61,7 +61,7 @@ does not enforce any particular defaults or cultural preferences.</para> <sect1 id="structure-top"> - <title>The top level, <filename>doc/</filename></title> + <title>The Top Level, <filename>doc/</filename></title> <para>There are two types of directory under <filename>doc/</filename>, each with very specific directory names and meanings.</para> @@ -101,7 +101,7 @@ <sect1 id="structure-locale"> <title>The - <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename> directories</title> + <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename> Directories</title> <para>These directories contain the documents themselves. The documentation is split into up to three more categories at this @@ -147,7 +147,7 @@ </sect1> <sect1 id="structure-document"> - <title>Document specific information</title> + <title>Document Specific Information</title> <para>This section contains specific notes about particular documents managed by the FDP.</para> @@ -168,7 +168,7 @@ <sgmltag>sect3</sgmltag>) and so on.</para> <sect3> - <title>Physical organization</title> + <title>Physical Organization</title> <para>There are a number of files and directories within the <filename>handbook</filename> directory.</para> @@ -221,17 +221,17 @@ <para>For example, if one of the chapter files contains:</para> <programlisting><![ CDATA [ -<chapter id="kernelconfiguration"> +<chapter id="kernelconfig"> ... </chapter>]]></programlisting> - <para>then it will be called <filename>chapter.sgml</filename> in - the <filename>kernelconfiguration</filename> directory. In + <para>Then it will be called <filename>chapter.sgml</filename> in + the <filename>kernelconfig</filename> directory. In general, the entire contents of the chapter will be held in this file.</para> <para>When the HTML version of the Handbook is produced, this will - yield <filename>kernelconfiguration.html</filename>. This is + yield <filename>kernelconfig.html</filename>. This is because of the <literal>id</literal> value, and is not related to the name of the directory.</para> ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/boot/chapter.sgml#2 (text+ko) ==== @@ -1,7 +1,7 @@ <!-- The FreeBSD Documentation Project - $FreeBSD: doc/en_US.ISO8859-1/books/handbook/boot/chapter.sgml,v 1.65 2006/05/30 23:08:23 trhodes Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/handbook/boot/chapter.sgml,v 1.66 2008/12/06 22:24:36 pgj Exp $ --> <chapter id="boot"> @@ -507,6 +507,187 @@ </listitem> </itemizedlist> </sect3> + + <sect3 id="boot-splash"> + <sect3info> + <authorgroup> + <author> + <firstname>Joseph J.</firstname> >>> TRUNCATED FOR MAIL (1000 lines) <<<
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200812072015.mB7KFjOj035798>