diff options
Diffstat (limited to 'en_US.ISO_8859-1/books/fdp-primer')
8 files changed, 62 insertions, 62 deletions
diff --git a/en_US.ISO_8859-1/books/fdp-primer/overview/chapter.sgml b/en_US.ISO_8859-1/books/fdp-primer/overview/chapter.sgml index 9ea5225913..ff994d5ac3 100644 --- a/en_US.ISO_8859-1/books/fdp-primer/overview/chapter.sgml +++ b/en_US.ISO_8859-1/books/fdp-primer/overview/chapter.sgml @@ -27,7 +27,7 @@ ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - $FreeBSD$ + $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/overview/chapter.sgml,v 1.4 1999/09/06 06:52:40 peter Exp $ --> <chapter id="overview"> @@ -45,7 +45,7 @@ documentation</emphasis>.</para> <para>Every one is welcome to join the FDP. There is no minimum - membership requirements, no quota of documentation you need to + membership requirement, no quota of documentation you need to produce per month. All you need to do is subscribe to the <email>freebsd-doc@FreeBSD.org</email> mailing list.</para> @@ -127,16 +127,16 @@ </variablelist> <para>These four groups of documentation are all available in the - FreeBSD CVS tree. This means that the logs and changes to these + FreeBSD CVS tree. This means that the logs of changes to these files are visible to anyone, and anyone can use a program such as <application>CVSup</application> or - <application>CTM</application> to keep their own local copies of + <application>CTM</application> to keep local copies of this documentation.</para> <para>In addition, many people have written tutorials or other web sites relating to FreeBSD. Some of these are stored in the CVS repository as well (where the author has agreed to this). In - other cases the author has decided to keep their documentation + other cases the author has decided to keep his documentation separate from the main FreeBSD repository. The FDP endeavours to provide links to as much of this documentation as possible.</para> @@ -150,7 +150,7 @@ <itemizedlist> <listitem> <para>How to maintain an up-to-date local copy of the FreeBSD - documentation. Either by maintaining a local copy of the + documentation by maintaining a local copy of the FreeBSD CVS repository (using <application>CVS</application> and either <application>CVSup</application> or <application>CTM</application>) or by using diff --git a/en_US.ISO_8859-1/books/fdp-primer/psgml-mode/chapter.sgml b/en_US.ISO_8859-1/books/fdp-primer/psgml-mode/chapter.sgml index 79415582fa..8abcde6496 100644 --- a/en_US.ISO_8859-1/books/fdp-primer/psgml-mode/chapter.sgml +++ b/en_US.ISO_8859-1/books/fdp-primer/psgml-mode/chapter.sgml @@ -27,7 +27,7 @@ ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - $FreeBSD$ + $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/psgml-mode/chapter.sgml,v 1.3 1999/09/06 06:52:41 peter Exp $ --> <chapter id="psgml-mode"> @@ -36,7 +36,7 @@ <para>Recent versions of Emacs or Xemacs (available from the ports collection) contain a very useful package called PSGML. Automatically - invoked when a file with <filename>.sgml</filename> extension is loaded, + invoked when a file with the <filename>.sgml</filename> extension is loaded, or by typing <command>M-x sgml-mode</command>, it is a major mode for dealing with SGML files, elements and attributes.</para> diff --git a/en_US.ISO_8859-1/books/fdp-primer/see-also/chapter.sgml b/en_US.ISO_8859-1/books/fdp-primer/see-also/chapter.sgml index 9698df7b0b..9f8ac6dd06 100644 --- a/en_US.ISO_8859-1/books/fdp-primer/see-also/chapter.sgml +++ b/en_US.ISO_8859-1/books/fdp-primer/see-also/chapter.sgml @@ -27,7 +27,7 @@ ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - $FreeBSD$ + $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/see-also/chapter.sgml,v 1.4 1999/09/06 06:52:41 peter Exp $ --> <chapter id="see-also"> @@ -75,7 +75,7 @@ <itemizedlist> <listitem> <para><ulink url="http://www.w3.org/">The World Wide Web - organisation</ulink></para> + Consortium</ulink></para> </listitem> <listitem> @@ -90,8 +90,8 @@ <itemizedlist> <listitem> - <para><ulink url="http://www.oreilly.com/davenport/">The Davenport - Group</ulink>, maintainers of the DocBook DTD</para> + <para><ulink url="http://www.oasis-open.org/docbook/">The DocBook + Technical Committee</ulink>, maintainers of the DocBook DTD</para> </listitem> </itemizedlist> </sect1> @@ -101,7 +101,7 @@ <itemizedlist> <listitem> - <para><ulink url="http://metalab.unc.edu/LDP/">The Linux Documentation + <para><ulink url="http://www.linuxdoc.org/">The Linux Documentation Project web pages</ulink></para> </listitem> </itemizedlist> diff --git a/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml b/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml index 0ac3f02504..ef88ad5fd1 100644 --- a/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml +++ b/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml @@ -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.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v 1.10 2000/01/16 22:05:58 asmodai Exp $ + $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v 1.11 2000/02/08 19:39:12 peter Exp $ --> <chapter id="sgml-markup"> @@ -215,7 +215,7 @@ <para>Use:</para> - <programlisting><![ CDATA [<p>A small excerpt from the US Constitution;</p> + <programlisting><![ CDATA [<p>A small excerpt from the US Constitution:</p> <blockquote>We the People of the United States, in Order to form a more perfect Union, establish Justice, insure domestic @@ -233,7 +233,7 @@ unordered, and definition.</para> <para>Typically, each entry in an ordered list will be numbered, while - each entry in an unordered list will be proceeded by a bullet point. + each entry in an unordered list will be preceded by a bullet point. Definition lists are composed of two sections for each entry. The first section is the term being defined, and the second section is the definition of the term.</para> @@ -476,7 +476,7 @@ <para>Typically, <sgmltag>em</sgmltag> is rendered in italic and <sgmltag>strong</sgmltag> is rendered in bold. This is not always - the case however, and you should not rely on it.</para> + the case, however, and you should not rely on it.</para> <example> <title><sgmltag>em</sgmltag> and <sgmltag>strong</sgmltag></title> @@ -661,7 +661,7 @@ <para>DocBook was designed by the <ulink url="http://www.oreilly.com/davenport/">Davenport Group</ulink> to be a DTD for writing technical documentation. As such, and unlike LinuxDoc - and HTML, DocBook is very heavily orientated towards markup that + and HTML, DocBook is very heavily oriented towards markup that describes <emphasis>what</emphasis> something is, rather than describing <emphasis>how</emphasis> it should be presented.</para> @@ -724,7 +724,7 @@ <para>DocBook allows you to structure your documentation in several ways. In the FreeBSD Documentation Project we are using two primary - types of DocBook document, the book, and the article.</para> + types of DocBook document: the book and the article.</para> <para>A book is organised into <sgmltag>chapter</sgmltag>s. This is a mandatory requirement. There may be <sgmltag>part</sgmltag>s between @@ -747,9 +747,9 @@ <para>Obviously, you should consider the nature of the documentation you are writing in order to decide whether it is best marked up as a book or an article. Articles are well suited to information that does not - need to be broken down in to several chapters, and that is, relatively + need to be broken down into several chapters, and that is, relatively speaking, quite short, at up to 20-25 pages of content. Books are - best suited to information that can be broken up in to several + best suited to information that can be broken up into several chapters, possibly with appendices and similar content as well.</para> <para>The <ulink url="http://www.FreeBSD.org/tutorials/">FreeBSD @@ -877,7 +877,7 @@ </chapter>]]></programlisting> </example> - <para>A chapter can not be empty, it must contain elements in addition + <para>A chapter cannot be empty; it must contain elements in addition to <sgmltag>title</sgmltag>. If you need to include an empty chapter then just use an empty paragraph.</para> @@ -957,7 +957,7 @@ <para>You can introduce another layer of organisation between <sgmltag>book</sgmltag> and <sgmltag>chapter</sgmltag> with one or - more <sgmltag>part</sgmltag>s. This can not be done in an + more <sgmltag>part</sgmltag>s. This cannot be done in an <sgmltag>article</sgmltag>.</para> <programlisting><![ CDATA [<part> @@ -990,7 +990,7 @@ <sect3> <title>Paragraphs</title> - <para>DocBook supports three types of paragraphs; + <para>DocBook supports three types of paragraphs: <sgmltag>formalpara</sgmltag>, <sgmltag>para</sgmltag>, and <sgmltag>simpara</sgmltag>.</para> @@ -1134,12 +1134,12 @@ </para> <para><sgmltag>itemizedlist</sgmltag> and - <sgmltag>orderedlist</sgmltag> are similar to the counterparts in + <sgmltag>orderedlist</sgmltag> are similar to their counterparts in HTML, <sgmltag>ul</sgmltag> and <sgmltag>ol</sgmltag>. Each one consists of one or more <sgmltag>listitem</sgmltag> elements, and each <sgmltag>listitem</sgmltag> contains one or more block elements. The <sgmltag>listitem</sgmltag> elements are analagous to - HTMLs <sgmltag>li</sgmltag> tags. However, unlike HTML they are + HTML's <sgmltag>li</sgmltag> tags. However, unlike HTML, they are required.</para> <para><sgmltag>procedure</sgmltag> is slightly different. It consists @@ -1542,21 +1542,21 @@ This is the file called 'foo2'</screen> <para>You will frequently want to refer to both applications and commands when writing for the Handbook. The distinction between - them is simple; an application is the name for a suite (or possibly + 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> <para>In addition, you will occasionally need to list one or more of the options that a command might take.</para> - <para>Finally, you will often want to list a command with it's manual + <para>Finally, you will often want to list a command with its manual section number, in the “command(number)” format so common in Unix manuals.</para> <para>Mark up application names with <sgmltag>application</sgmltag>.</para> - <para>When you want to list a command with it's manual section number + <para>When you want to list a command with its manual section number (which should be most of the time) the DocBook element is <sgmltag>citerefentry</sgmltag>. This will contain a further two elements, <sgmltag>refentrytitle</sgmltag> and @@ -1572,12 +1572,12 @@ This is the file called 'foo2'</screen> <para>The file that contains these entities is in <filename>doc/share/sgml/man-refs.ent</filename>, and can be - referred to using this FPI;</para> + referred to using this FPI:</para> <programlisting>PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"</programlisting> <para>Therefore, the introduction to your documentation will probably - look like this;</para> + look like this:</para> <programlisting><!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [ @@ -2108,7 +2108,7 @@ This is the file called 'foo2'</screen> <para>Both of these elements have a <literal>linkend</literal> attribute. The value of this attribute should be the value that you have used in a <literal>id</literal> attribute (it does not matter - if that value has not yet occured in your document, this will work + if that value has not yet occurred in your document; this will work for forward links as well as backward links).</para> <para>If you use <sgmltag>xref</sgmltag> then you have no control over @@ -2229,7 +2229,7 @@ This is the file called 'foo2'</screen> <title>* LinuxDoc</title> <para>LinuxDoc is an adaptation of the QWERTZ DTD, first adopted by the - <ulink url="http://sunsite.unc.edu/LDP/">Linux Documentation + <ulink url="http://www.linuxdoc.org/">Linux Documentation Project</ulink>, and subsequently adopted by the FreeBSD Documentation Project.</para> diff --git a/en_US.ISO_8859-1/books/fdp-primer/sgml-primer/chapter.sgml b/en_US.ISO_8859-1/books/fdp-primer/sgml-primer/chapter.sgml index da050c4242..58e81d90bf 100644 --- a/en_US.ISO_8859-1/books/fdp-primer/sgml-primer/chapter.sgml +++ b/en_US.ISO_8859-1/books/fdp-primer/sgml-primer/chapter.sgml @@ -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.ISO_8859-1/books/fdp-primer/sgml-primer/chapter.sgml,v 1.10 2000/04/30 23:00:03 nik Exp $ + $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/sgml-primer/chapter.sgml,v 1.11 2000/06/14 19:01:53 alex Exp $ --> <chapter id="sgml-primer"> @@ -763,7 +763,7 @@ PUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd"</programlisting> conforms to (and therefore, which file on the system contains the DTD) you can explicitly specify the name of the file.</para> - <para>The syntax for this is slightly different;</para> + <para>The syntax for this is slightly different:</para> <programlisting> <![ CDATA [<!DOCTYPE html SYSTEM "/path/to/file.dtd">]]></programlisting> @@ -1306,7 +1306,7 @@ PUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd"</programlisting> <step> <para>Create a new file, <filename>entities.sgml</filename>, with - this content;</para> + this content:</para> <programlisting> <![ CDATA [<!ENTITY version "1.1"> @@ -1350,7 +1350,7 @@ PUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd"</programlisting> </example> <para>As you would expect, being an SGML construct, a marked section - starts <literal><!</literal>.</para> + starts with <literal><!</literal>.</para> <para>The first square bracket begins to delimit the marked section.</para> diff --git a/en_US.ISO_8859-1/books/fdp-primer/structure/chapter.sgml b/en_US.ISO_8859-1/books/fdp-primer/structure/chapter.sgml index 6b42003e89..f564b25e4d 100644 --- a/en_US.ISO_8859-1/books/fdp-primer/structure/chapter.sgml +++ b/en_US.ISO_8859-1/books/fdp-primer/structure/chapter.sgml @@ -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.ISO_8859-1/books/fdp-primer/structure/chapter.sgml,v 1.2 1999/09/06 06:52:42 peter Exp $ + $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/structure/chapter.sgml,v 1.3 2000/04/30 23:01:09 nik Exp $ --> <chapter id="structure"> @@ -36,11 +36,11 @@ <para>The <filename>doc/</filename> tree is organised in a particular fashion, and the documents that are part of the FDP are in turn organised in a particular fashion. The aim is to make it simple to add new - documentation in to the tree and;</para> + documentation in to the tree and:</para> <orderedlist> <listitem> - <para>be 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> @@ -100,7 +100,7 @@ <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename> directories</title> <para>These directories contain the documents themselves. The - documentation is split in to up to three more categories at this + documentation is split into up to three more categories at this level, indicated by the different directory names.</para> <segmentedlist> @@ -108,7 +108,7 @@ <seg><filename>articles</filename></seg> <seg>Documentation marked up as a DocBook <sgmltag>article</sgmltag> - (or equivalent). Reasonably short, and broken up in to sections. + (or equivalent). Reasonably short, and broken up into sections. Normally only available as one HTML file.</seg> </seglistitem> @@ -118,7 +118,7 @@ <seg>Documentation marked up as a DocBook <sgmltag>book</sgmltag> (or equivalent). Book length, and broken up in to chapters. Normally available as both one large HTML file (for people with fast - connections, or who want to print it easily from their browser) and + connections, or who want to print it easily from a browser) and as a collection of linked, smaller files.</seg> </seglistitem> @@ -134,7 +134,7 @@ <para>Not every <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename> directory will contain all of these directories. It depends - on much translation has been accomplished by that translation + on how much translation has been accomplished by that translation team.</para> </sect1> @@ -259,14 +259,14 @@ <para>Each <filename>chapter.sgml</filename> file will not be a complete SGML document. In particular, they will not have their - own DOCTYPE line at the start of the file.</para> + own DOCTYPE lines at the start of the files.</para> <para>This is unfortunate as it makes it impossible to treat these as generic SGML files and simply convert them to HTML, RTF, PS, and other formats in the same way the main Handbook is generated. This <emphasis>would</emphasis> force you to rebuild the Handbook - every time you want to see the effect a change as had on just + every time you want to see the effect a change has had on just one chapter.</para> </sect4> </sect3> diff --git a/en_US.ISO_8859-1/books/fdp-primer/tools/chapter.sgml b/en_US.ISO_8859-1/books/fdp-primer/tools/chapter.sgml index b47420fdb0..5ec9dcb95e 100644 --- a/en_US.ISO_8859-1/books/fdp-primer/tools/chapter.sgml +++ b/en_US.ISO_8859-1/books/fdp-primer/tools/chapter.sgml @@ -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.ISO_8859-1/books/fdp-primer/tools/chapter.sgml,v 1.7 1999/09/06 06:52:43 peter Exp $ + $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/tools/chapter.sgml,v 1.8 2000/05/06 10:59:01 nik Exp $ --> <chapter id="tools"> @@ -44,7 +44,7 @@ <para>You will need to install these tools before you work through any of the examples in later chapters. The actual usage of these - tools is covered in these later chapters.</para> + tools is covered in later chapters.</para> <important> <title>Use <filename>textproc/docproj</filename> if possible</title> @@ -55,7 +55,7 @@ itself. Instead, it depends on various other ports being installed correctly. Installing this port <emphasis>should</emphasis> automatically download and install all of the packages listed in this - chapter that you need that are missing from your system.</para> + chapter that you need.</para> <para>One of the packages that you might need is the JadeTeX macro set. In turn, this macro set requires that TeX is installed. TeX is a large @@ -160,7 +160,7 @@ <listitem> <para>DocBook is designed for marking up technical documentation, and the FDP is migrating from LinuxDoc to DocBook. At the time - of writing, this document, and the FreeBSD Handbook are marked + of writing, this document and the FreeBSD Handbook are marked up in DocBook.</para> </listitem> </varlistentry> @@ -193,7 +193,7 @@ <listitem> <para>The Modular DocBook Stylesheets are used when converting documentation marked up in DocBook to other formats, such as - HTML, or RTF.</para> + HTML or RTF.</para> </listitem> </varlistentry> </variablelist> @@ -257,7 +257,7 @@ includes commands to reduce the amount of typing you need, and help reduce the possibility of errors.</para> - <para>You do not need to use them, any text editor can be used to + <para>You do not need to use them; any text editor can be used to edit marked up documents. You may find they make you more efficient.</para> </listitem> diff --git a/en_US.ISO_8859-1/books/fdp-primer/translations/chapter.sgml b/en_US.ISO_8859-1/books/fdp-primer/translations/chapter.sgml index abc80c3879..2ceb9b0153 100644 --- a/en_US.ISO_8859-1/books/fdp-primer/translations/chapter.sgml +++ b/en_US.ISO_8859-1/books/fdp-primer/translations/chapter.sgml @@ -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.ISO_8859-1/books/fdp-primer/translations/chapter.sgml,v 1.3 1999/09/06 06:52:44 peter Exp $ + $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/translations/chapter.sgml,v 1.4 2000/01/16 22:10:22 asmodai Exp $ --> <chapter id="translations"> @@ -173,13 +173,13 @@ <para>The <ulink url="http://www.FreeBSD.org/docproj/translations.html">Documentation Project translations page</ulink> lists the translation efforts - that are currently known about. If someone else is already working + that are currently known about. If others are already working on translating documentation to your language, please don't duplicate their efforts. Instead, contact them to see how you can help.</para> <para>If no one is listed on that page as translating for your - language then send a message to + language, then send a message to <email>freebsd-doc@FreeBSD.org</email> in case someone else is thinking of doing a translation, but hasn't announced it yet.</para> </answer> @@ -187,7 +187,7 @@ <qandaentry> <question> - <para>No one else is translating to my language. What do I do?</para> + <para>No one else is translating to my language. What do I do?</para> </question> <answer> @@ -209,8 +209,8 @@ described earlier).</para> <para>If there is already someone in your country providing FreeBSD - mirroring services you should contact them and ask if they can - provide some webspace for your project, and possibly an e-mail + mirroring services you should contact them and ask if you can + have some webspace for your project, and possibly an e-mail address or mailing list services.</para> <para>Then pick a document and start translating. It is best to start @@ -312,23 +312,23 @@ <orderedlist> <listitem> - <para>Do all your files use RCS strings (such as "ID").</para> + <para>Do all your files use RCS strings (such as "ID")?</para> </listitem> <listitem> <para>Does <command>make all</command> in the - <filename>sv</filename> directory work correctly.</para> + <filename>sv</filename> directory work correctly?</para> </listitem> <listitem> - <para>Does <command>make install</command> work correctly.</para> + <para>Does <command>make install</command> work correctly?</para> </listitem> </orderedlist> <para>If there are any problems then whoever is looking at the submission will get back to you to try and work them out.</para> - <para>If there are no problems then your translation will be committed + <para>If there are no problems your translation will be committed as soon as possible.</para> </answer> </qandaentry> |