| Summary: | Documentation Project Primer doesn't conform to style guide | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | Steven James Huwig <sjh13> | ||||||||||||||
| Component: | Books & Articles | Assignee: | freebsd-doc (Nobody) <doc> | ||||||||||||||
| Status: | Closed FIXED | ||||||||||||||||
| Severity: | Affects Only Me | ||||||||||||||||
| Priority: | Normal | ||||||||||||||||
| Version: | Latest | ||||||||||||||||
| Hardware: | Any | ||||||||||||||||
| OS: | Any | ||||||||||||||||
| Attachments: |
|
||||||||||||||||
State Changed From-To: open->closed Committed. Thanks for the submission. It may take up to 24 hours for your change to be visible on our website. |
Chapter 10 of the FDP Primer reads "Use American English Spelling," yet there are many instances of the British versions of words (e.g. 'organise,' 'normalise,' et cetera. Fix: Attached are diffs correcting "ise" words to their "ize" equivalents. <para>To avoid confusion, these examples use the standard DocBook 3.1 DTD 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 useful as generic DocBook examples.</para> @@ -265,7 +265,7 @@ <calloutlist> <callout arearefs="examples-co-jade-3-tex-backend"> - <para>Customises the stylesheets to use various options + <para>Customizes the stylesheets to use various options specific to producing output for TeX.</para> </callout> <sect3> - <title>Emphasising information</title> + <title>Emphasizing information</title> <para>You have two levels of emphasis available in HTML, <sgmltag>em</sgmltag> and <sgmltag>strong</sgmltag>. @@ -482,8 +482,8 @@ <para>Use:</para> - <programlisting><![ CDATA [<p><em>This</em> has been emphasised, while - <strong>this</strong> has been strongly emphasised.</p>]]></programlisting> + <programlisting><![ CDATA [<p><em>This</em> has been emphasized, while + <strong>this</strong> has been strongly emphasized.</p>]]></programlisting> </example> </sect3> @@ -716,7 +716,7 @@ <title>Formal Public Identifier (FPI)</title> <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> <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 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> <para>A chapter may (or may not) contain one or more sections. These @@ -954,7 +954,7 @@ <sect3> <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 more <sgmltag>part</sgmltag>s. This cannot be done in an <sgmltag>article</sgmltag>.</para> @@ -1573,9 +1573,9 @@ <title>In-line elements</title> <sect3> - <title>Emphasising information</title> + <title>Emphasizing information</title> - <para>When you want to emphasise a particular word or phrase, use + <para>When you want to emphasize a particular word or phrase, use <sgmltag>emphasis</sgmltag>. This may be presented as italic, or bold, or might be spoken differently with a text-to-speech system.</para> @@ -2579,7 +2579,7 @@ in <xref linkend="chapter1-sect1">.</para>]]></programlisting> <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> <blockquote> @@ -2620,7 +2620,7 @@ <link linkend="chapter1-sect1">this</link> section.</para>]]></programlisting> <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> <blockquote> <para>For an element called <replaceable>element-name</replaceable> the @@ -251,7 +251,7 @@ <title>Elements within elements; <sgmltag>em</sgmltag></title> <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> <para>The DTD will specify the rules detailing which elements can contain @@ -643,7 +643,7 @@ <para>ISO 9070:1991 defines how registered names are generated; it 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 to assign registered names. The ISO council delegated this to the American National Standards Institute (ANSI).</para> @@ -796,7 +796,7 @@ your document. Everything between these delimiters is SGML syntax as 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> is an example of SGML syntax that you need to include in your document…</para> @@ -1051,7 +1051,7 @@ <step> <para>Load <filename>example.sgml</filename> into your web browser (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 reference <literal>&version;</literal> replaced with the @@ -1064,10 +1064,10 @@ </step> <step> - <para>The solution is to <emphasis>normalise</emphasis> your - document using an SGML normaliser. The normaliser reads in valid + <para>The solution is to <emphasis>normalize</emphasis> your + document using an SGML normalizer. The normalizer reads in valid 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, replacing the entities with the text that they represent.</para> @@ -1075,7 +1075,7 @@ <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 <filename>example.html</filename>, ready to load into your web browser.</para> @@ -1156,7 +1156,7 @@ entities.</para> <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> <para>You could list the entities at the top of each book, but this @@ -1242,7 +1242,7 @@ </step> <step> - <para>Produce <filename>example.html</filename> by normalising + <para>Produce <filename>example.html</filename> by normalizing <filename>example.sgml</filename>.</para> <screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen> @@ -1299,7 +1299,7 @@ </step> <step> - <para>Produce <filename>example.html</filename> by normalising + <para>Produce <filename>example.html</filename> by normalizing <filename>example.sgml</filename>.</para> <screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen> @@ -1455,7 +1455,7 @@ from your document you could cut it out, or wrap it in comments.</para> - <para>It becomes more useful when you realise you can use <link + <para>It becomes more useful when you realize you can use <link linkend="sgml-primer-parameter-entities">parameter entities</link> to control this. Remember that parameter entities can only be used in SGML contexts, and the keyword of a marked section @@ -1542,7 +1542,7 @@ </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 disappeared, and what has happened to the content of the CDATA marked section.</para> @@ -1551,7 +1551,7 @@ <step> <para>Change the definition of the <literal>text.output</literal> 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> </step> </procedure> @@ -1564,7 +1564,7 @@ <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 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> </chapter> <listitem> <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> </listitem> @@ -76,7 +76,7 @@ <seg>Contains files that are not specific to the various translations 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 <filename>share/mk</filename>, while the additional SGML support files (such as the FreeBSD extended DocBook DTD) are in - <para>The Documentation Project uses a slightly customised version of + <para>The Documentation Project uses a slightly customized version of Norm Walsh's modular DocBook stylesheets.</para> <para>These can be found in @@ -55,7 +55,7 @@ found in <filename>doc/share/sgml/freebsd.dsl</filename>. It is well commented, and pending completion of this section you are encouraged to 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 examples showing how to extend the elements that the stylesheet understands, which is how the FreeBSD specific elements have been <listitem> <para>A suite of applications, including a validating SGML parser, - and an SGML normaliser.</para> + and an SGML normalizer.</para> </listitem> </varlistentry> <answer> <para><phrase>i18n</phrase> means - <phrase>internationalisation</phrase> and <phrase>l10n</phrase> - means <phrase>localisation</phrase>. They are just a convenient + <phrase>internationalization</phrase> and <phrase>l10n</phrase> + means <phrase>localization</phrase>. They are just a convenient shorthand.</para> <para><phrase>i18n</phrase> can be read as <quote>i</quote> followed by @@ -196,7 +196,7 @@ <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 - 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> <para>Write an e-mail to the Documentation Project mailing list,--Rn6Lf86RiwxMQEl6VcWE3bnqZWyUigMqT3PkhdIhcM1bfOpo Content-Type: text/plain; name="file.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="file.diff" --- examples/appendix.sgml.orig Mon Jul 28 17:41:22 2003 +++ examples/appendix.sgml Mon Jul 28 17:26:14 2003 @@ -48,7 +48,7 @@