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

Follow the rule set down in this book and use American English

Browse source 
spelling.  Translators can ignore.

PR:		docs/54999
Submitted by:	Steven James Huwig <sjh13@cwru.edu>
This commit is contained in:
Murray Stokely 2004-08-02 05:43:34 +00:00
parent 9bace42dc4
commit 19ca5b971f
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=21763
6 changed files with 31 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml
View file

@ -48,7 +48,7 @@
<para>To avoid confusion, these examples use the standard DocBook 4.1 DTD <para>To avoid confusion, these examples use the standard DocBook 4.1 DTD
rather than the FreeBSD extension. They also use the stock stylesheets rather than the FreeBSD extension. They also use the stock stylesheets
distributed by Norm Walsh, rather than any customisations made to those distributed by Norm Walsh, rather than any customizations made to those
stylesheets by the FreeBSD Documentation Project. This makes them more stylesheets by the FreeBSD Documentation Project. This makes them more
useful as generic DocBook examples.</para> useful as generic DocBook examples.</para>

16
en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
View file

@ -466,7 +466,7 @@
<title>In-line elements</title> <title>In-line elements</title>
<sect3> <sect3>
<title>Emphasising information</title> <title>Emphasizing information</title>
<para>You have two levels of emphasis available in HTML, <para>You have two levels of emphasis available in HTML,
<sgmltag>em</sgmltag> and <sgmltag>strong</sgmltag>. <sgmltag>em</sgmltag> and <sgmltag>strong</sgmltag>.
@ -482,8 +482,8 @@
<para>Use:</para> <para>Use:</para>
<programlisting><![ CDATA [<p><em>This</em> has been emphasised, while <programlisting><![ CDATA [<p><em>This</em> has been emphasized, while
<strong>this</strong> has been strongly emphasised.</p>]]></programlisting> <strong>this</strong> has been strongly emphasized.</p>]]></programlisting>
</example> </example>
</sect3> </sect3>
@ -716,7 +716,7 @@
<title>Formal Public Identifier (FPI)</title> <title>Formal Public Identifier (FPI)</title>
<para>In compliance with the DocBook guidelines for writing FPIs for <para>In compliance with the DocBook guidelines for writing FPIs for
DocBook customisations, the FPI for the FreeBSD extended DocBook DTD DocBook customizations, the FPI for the FreeBSD extended DocBook DTD
is;</para> is;</para>
<programlisting>PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN"</programlisting> <programlisting>PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN"</programlisting>
@ -731,7 +731,7 @@
<para>A book is organized into <sgmltag>chapter</sgmltag>s. This is a <para>A book is organized into <sgmltag>chapter</sgmltag>s. This is a
mandatory requirement. There may be <sgmltag>part</sgmltag>s between mandatory requirement. There may be <sgmltag>part</sgmltag>s between
the book and the chapter to provide another layer of organisation. the book and the chapter to provide another layer of organization.
The Handbook is arranged in this way.</para> The Handbook is arranged in this way.</para>
<para>A chapter may (or may not) contain one or more sections. These <para>A chapter may (or may not) contain one or more sections. These
@ -954,7 +954,7 @@
<sect3> <sect3>
<title>Subdividing using <sgmltag>part</sgmltag>s</title> <title>Subdividing using <sgmltag>part</sgmltag>s</title>
<para>You can introduce another layer of organisation between <para>You can introduce another layer of organization between
<sgmltag>book</sgmltag> and <sgmltag>chapter</sgmltag> with one or <sgmltag>book</sgmltag> and <sgmltag>chapter</sgmltag> with one or
more <sgmltag>part</sgmltag>s. This cannot be done in an more <sgmltag>part</sgmltag>s. This cannot be done in an
<sgmltag>article</sgmltag>.</para> <sgmltag>article</sgmltag>.</para>
@ -2579,7 +2579,7 @@ IMAGES= chapter1/fig1.png
in <xref linkend="chapter1-sect1">.</para>]]></programlisting> in <xref linkend="chapter1-sect1">.</para>]]></programlisting>
<para>The text of the link will be generated automatically, and will <para>The text of the link will be generated automatically, and will
look like (<emphasis>emphasised</emphasis> text indicates the text look like (<emphasis>emphasized</emphasis> text indicates the text
that will be the link);</para> that will be the link);</para>
<blockquote> <blockquote>
@ -2620,7 +2620,7 @@ IMAGES= chapter1/fig1.png
<link linkend="chapter1-sect1">this</link> section.</para>]]></programlisting> <link linkend="chapter1-sect1">this</link> section.</para>]]></programlisting>
<para>This will generate the following <para>This will generate the following
(<emphasis>emphasised</emphasis> text indicates the text that will (<emphasis>emphasized</emphasis> text indicates the text that will
be the link);</para> be the link);</para>
<blockquote> <blockquote>

32
en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
View file

@ -90,7 +90,7 @@
<para>The extra information stored in the markup <emphasis>adds <para>The extra information stored in the markup <emphasis>adds
value</emphasis> to the document. Adding the markup to the document value</emphasis> to the document. Adding the markup to the document
must typically be done by a person&mdash;after all, if computers could must typically be done by a person&mdash;after all, if computers could
recognise the text sufficiently well to add the markup then there would recognize the text sufficiently well to add the markup then there would
be no need to add it in the first place. This <emphasis>increases the be no need to add it in the first place. This <emphasis>increases the
cost</emphasis> (i.e., the effort required) to create the cost</emphasis> (i.e., the effort required) to create the
document.</para> document.</para>
@ -199,7 +199,7 @@
<para>A tag is used to identify where a particular element starts, and <para>A tag is used to identify where a particular element starts, and
where the element ends. <emphasis>The tag is not part of the element where the element ends. <emphasis>The tag is not part of the element
itself</emphasis>. Because each DTD was normally written to mark up itself</emphasis>. Because each DTD was normally written to mark up
specific types of information, each one will recognise different specific types of information, each one will recognize different
elements, and will therefore have different names for the tags.</para> elements, and will therefore have different names for the tags.</para>
<para>For an element called <replaceable>element-name</replaceable> the <para>For an element called <replaceable>element-name</replaceable> the
@ -251,7 +251,7 @@
<title>Elements within elements; <sgmltag>em</sgmltag></title> <title>Elements within elements; <sgmltag>em</sgmltag></title>
<programlisting><![ CDATA [<p>This is a simple <em>paragraph</em> where some <programlisting><![ CDATA [<p>This is a simple <em>paragraph</em> where some
of the <em>words</em> have been <em>emphasised</em>.</p>]]></programlisting> of the <em>words</em> have been <em>emphasized</em>.</p>]]></programlisting>
</example> </example>
<para>The DTD will specify the rules detailing which elements can contain <para>The DTD will specify the rules detailing which elements can contain
@ -643,7 +643,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>ISO 9070:1991 defines how registered names are generated; it <para>ISO 9070:1991 defines how registered names are generated; it
might be derived from the number of an ISO publication, an ISBN might be derived from the number of an ISO publication, an ISBN
code, or an organisation code assigned according to ISO 6523. code, or an organization code assigned according to ISO 6523.
In addition, a registration authority could be created in order In addition, a registration authority could be created in order
to assign registered names. The ISO council delegated this to to assign registered names. The ISO council delegated this to
the American National Standards Institute (ANSI).</para> the American National Standards Institute (ANSI).</para>
@ -796,7 +796,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
your document. Everything between these delimiters is SGML syntax as your document. Everything between these delimiters is SGML syntax as
you might find within a DTD.</para> you might find within a DTD.</para>
<para>As you may just have realised, the <link <para>As you may just have realized, the <link
linkend="sgml-primer-doctype-declaration">DOCTYPE declaration</link> linkend="sgml-primer-doctype-declaration">DOCTYPE declaration</link>
is an example of SGML syntax that you need to include in your is an example of SGML syntax that you need to include in your
document&hellip;</para> document&hellip;</para>
@ -1051,7 +1051,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<step> <step>
<para>Load <filename>example.sgml</filename> into your web browser <para>Load <filename>example.sgml</filename> into your web browser
(you may need to copy it to <filename>example.html</filename> (you may need to copy it to <filename>example.html</filename>
before your browser recognises it as an HTML document).</para> before your browser recognizes it as an HTML document).</para>
<para>Unless your browser is very advanced, you will not see the entity <para>Unless your browser is very advanced, you will not see the entity
reference <literal>&amp;version;</literal> replaced with the reference <literal>&amp;version;</literal> replaced with the
@ -1064,10 +1064,10 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
</step> </step>
<step> <step>
<para>The solution is to <emphasis>normalise</emphasis> your <para>The solution is to <emphasis>normalize</emphasis> your
document using an SGML normaliser. The normaliser reads in valid document using an SGML normalizer. The normalizer reads in valid
SGML and outputs equally valid SGML which has been transformed in SGML and outputs equally valid SGML which has been transformed in
some way. One of the ways in which the normaliser transforms the some way. One of the ways in which the normalizer transforms the
SGML is to expand all the entity references in the document, SGML is to expand all the entity references in the document,
replacing the entities with the text that they represent.</para> replacing the entities with the text that they represent.</para>
@ -1075,7 +1075,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<screen>&prompt.user; <userinput>sgmlnorm example.sgml > example.html</userinput></screen> <screen>&prompt.user; <userinput>sgmlnorm example.sgml > example.html</userinput></screen>
<para>You should find a normalised (i.e., entity references <para>You should find a normalized (i.e., entity references
expanded) copy of your document in expanded) copy of your document in
<filename>example.html</filename>, ready to load into your web <filename>example.html</filename>, ready to load into your web
browser.</para> browser.</para>
@ -1156,7 +1156,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
entities.</para> entities.</para>
<para>Suppose that you had many chapters in your document, and you <para>Suppose that you had many chapters in your document, and you
reused these chapters in two different books, each book organising the reused these chapters in two different books, each book organizing the
chapters in a different fashion.</para> chapters in a different fashion.</para>
<para>You could list the entities at the top of each book, but this <para>You could list the entities at the top of each book, but this
@ -1242,7 +1242,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
</step> </step>
<step> <step>
<para>Produce <filename>example.html</filename> by normalising <para>Produce <filename>example.html</filename> by normalizing
<filename>example.sgml</filename>.</para> <filename>example.sgml</filename>.</para>
<screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen> <screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen>
@ -1299,7 +1299,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
</step> </step>
<step> <step>
<para>Produce <filename>example.html</filename> by normalising <para>Produce <filename>example.html</filename> by normalizing
<filename>example.sgml</filename>.</para> <filename>example.sgml</filename>.</para>
<screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen> <screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen>
@ -1542,7 +1542,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
</step> </step>
<step> <step>
<para>Normalise this file using &man.sgmlnorm.1; and examine the <para>Normalize this file using &man.sgmlnorm.1; and examine the
output. Notice which paragraphs have appeared, which have output. Notice which paragraphs have appeared, which have
disappeared, and what has happened to the content of the CDATA disappeared, and what has happened to the content of the CDATA
marked section.</para> marked section.</para>
@ -1551,7 +1551,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<step> <step>
<para>Change the definition of the <literal>text.output</literal> <para>Change the definition of the <literal>text.output</literal>
entity from <literal>INCLUDE</literal> to entity from <literal>INCLUDE</literal> to
<literal>IGNORE</literal>. Re-normalise the file, and examine the <literal>IGNORE</literal>. Re-normalize the file, and examine the
output to see what has changed. </para> output to see what has changed. </para>
</step> </step>
</procedure> </procedure>
@ -1564,7 +1564,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>That is the conclusion of this SGML primer. For reasons of space <para>That is the conclusion of this SGML primer. For reasons of space
and complexity several things have not been covered in depth (or at and complexity several things have not been covered in depth (or at
all). However, the previous sections cover enough SGML for you to be all). However, the previous sections cover enough SGML for you to be
able to follow the organisation of the FDP documentation.</para> able to follow the organization of the FDP documentation.</para>
</sect1> </sect1>
</chapter> </chapter>

4
en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml
View file

@ -45,7 +45,7 @@
<listitem> <listitem>
<para>promote consistency between the different documentation <para>promote consistency between the different documentation
organisations, to make it easier to switch between working on organizations, to make it easier to switch between working on
different documents</para> different documents</para>
</listitem> </listitem>
@ -76,7 +76,7 @@
<seg>Contains files that are not specific to the various translations <seg>Contains files that are not specific to the various translations
and encodings of the documentation. Contains subdirectories to and encodings of the documentation. Contains subdirectories to
further categorise the information. For example, the files that further categorize the information. For example, the files that
comprise the &man.make.1; infrastructure are in comprise the &man.make.1; infrastructure are in
<filename>share/mk</filename>, while the additional SGML support <filename>share/mk</filename>, while the additional SGML support
files (such as the FreeBSD extended DocBook DTD) are in files (such as the FreeBSD extended DocBook DTD) are in

2
en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml
View file

@ -55,7 +55,7 @@
found in <filename>doc/share/sgml/freebsd.dsl</filename>. It is well found in <filename>doc/share/sgml/freebsd.dsl</filename>. It is well
commented, and pending completion of this section you are encouraged to commented, and pending completion of this section you are encouraged to
examine that file to see how some of the available options in the examine that file to see how some of the available options in the
standard stylesheets have been configured in order to customise the standard stylesheets have been configured in order to customize the
output for the FreeBSD Documentation Project. That file also contains output for the FreeBSD Documentation Project. That file also contains
examples showing how to extend the elements that the stylesheet examples showing how to extend the elements that the stylesheet
understands, which is how the FreeBSD specific elements have been understands, which is how the FreeBSD specific elements have been

6
en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml
View file

@ -66,8 +66,8 @@
<answer> <answer>
<para><phrase>i18n</phrase> means <para><phrase>i18n</phrase> means
<phrase>internationalisation</phrase> and <phrase>l10n</phrase> <phrase>internationalization</phrase> and <phrase>l10n</phrase>
means <phrase>localisation</phrase>. They are just a convenient means <phrase>localization</phrase>. They are just a convenient
shorthand.</para> shorthand.</para>
<para><phrase>i18n</phrase> can be read as <quote>i</quote> followed by <para><phrase>i18n</phrase> can be read as <quote>i</quote> followed by
@ -178,7 +178,7 @@
<para>First, decide whether or not you have got the time to spare. Since <para>First, decide whether or not you have got the time to spare. Since
you are the only person working on your language at the moment it is you are the only person working on your language at the moment it is
going to be your responsibility to publicise your work and going to be your responsibility to publicize your work and
coordinate any volunteers that might want to help you.</para> coordinate any volunteers that might want to help you.</para>
<para>Write an e-mail to the Documentation Project mailing list, <para>Write an e-mail to the Documentation Project mailing list,