Date: Tue, 2 Oct 2001 03:28:13 +0300 (EEST) From: Giorgos Keramidas <charon@labs.gr> To: FreeBSD-gnats-submit@freebsd.org Subject: docs/30977: various whitespace fixes that would be nice to have applied to books/fdp-primer Message-ID: <200110020028.f920SDv01100@hades.hell.gr>
next in thread | raw e-mail | index | archive | help
>Number: 30977
>Category: docs
>Synopsis: various whitespace fixes that would be nice to have applied to books/fdp-primer
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Mon Oct 01 17:30:01 PDT 2001
>Closed-Date:
>Last-Modified:
>Originator: Giorgos Keramidas
>Release: FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD hades.hell.gr 5.0-CURRENT FreeBSD 5.0-CURRENT #5: Tue Sep 4
19:49:44 EEST 2001 root@hades.hell.gr:/usr/obj/usr/src/sys/CHARON i386
>Description:
I'm probably being a style freak now, but the patch included corrects
various whitespace related things in the fdp-primer book.
Forgive me for sending so many changes in one batch, but I did not
know if it was proper to send in one big diff or many small ones.
>How-To-Repeat:
>Fix:
--- patch begins here ---
Index: examples/appendix.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml,v
retrieving revision 1.5
diff -u -r1.5 appendix.sgml
--- examples/appendix.sgml 29 Aug 2001 00:34:27 -0000 1.5
+++ examples/appendix.sgml 1 Oct 2001 23:30:20 -0000
@@ -240,9 +240,9 @@
<callout arearefs="examples-co-jade-2-filename">
<para>Specifies the file that Jade should process. The
- stylesheets determine how the individual HTML files will be
- named, and the name of the <quote>root</quote> file (i.e., the
- one that contains the start of the document.</para>
+ stylesheets determine how the individual HTML files will be
+ named, and the name of the <quote>root</quote> file (i.e., the
+ one that contains the start of the document.</para>
</callout>
</calloutlist>
@@ -294,14 +294,14 @@
<screen>&prompt.user; <userinput>tex "&jadetex" <replaceable>file</replaceable>.tex</userinput></screen>
<para>You have to run <command>tex</command> <emphasis>at
- least</emphasis> three times. The first run processes the
+ least</emphasis> three times. The first run processes the
document, and determines areas of the document which are referenced
from other parts of the document, for use in indexing, and so
on.</para>
<para>Do not be alarmed if you see warning messages such as
<literal>LaTeX Warning: Reference `136' on page 5 undefined on input
- line 728.</literal> at this point.</para>
+ line 728.</literal> at this point.</para>
<para>The second run reprocesses the document now that certain pieces
of information are known (such as the document's page length). This
Index: overview/chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml,v
retrieving revision 1.8
diff -u -r1.8 chapter.sgml
--- overview/chapter.sgml 26 Sep 2001 21:49:28 -0000 1.8
+++ overview/chapter.sgml 1 Oct 2001 23:31:14 -0000
@@ -39,15 +39,15 @@
is produced. Your contributions are very valuable.</para>
<para>This document's main purpose is to clearly explain <emphasis>how
- the FDP is organised</emphasis>, <emphasis>how to write and submit
- documentation to the FDP</emphasis>, and <emphasis>how to
- effectively use the tools available to you when writing
- documentation</emphasis>.</para>
+ the FDP is organised</emphasis>, <emphasis>how to write and submit
+ documentation to the FDP</emphasis>, and <emphasis>how to
+ effectively use the tools available to you when writing
+ documentation</emphasis>.</para>
<para><indexterm>
<primary>Membership</primary>
</indexterm>
-Every one is welcome to join the FDP. There is no minimum
+ Every one is welcome to join the FDP. There is no minimum
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>
Index: sgml-markup/chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v
retrieving revision 1.29
diff -u -r1.29 chapter.sgml
--- sgml-markup/chapter.sgml 12 Aug 2001 19:41:44 -0000 1.29
+++ sgml-markup/chapter.sgml 1 Oct 2001 23:40:50 -0000
@@ -546,7 +546,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 1 and 7. The default font size
is <literal>3</literal>. This approach is deprecated.</para>
</listitem>
</orderedlist>
Index: sgml-primer/chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml,v
retrieving revision 1.19
diff -u -r1.19 chapter.sgml
--- sgml-primer/chapter.sgml 17 Jul 2001 20:51:51 -0000 1.19
+++ sgml-primer/chapter.sgml 1 Oct 2001 23:47:09 -0000
@@ -88,12 +88,12 @@
markup from the user, so the user is not distracted by it.</para>
<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—after all, if computers could
recognise 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
- cost</emphasis> (i.e., the effort required) to create the
- document.</para>
+ cost</emphasis> (i.e., the effort required) to create the
+ document.</para>
<para>The previous example is actually represented in this document like
this;</para>
@@ -117,7 +117,7 @@
in turn, would be very different from a markup language used to describe
poetry. What you really need is a first language that you use to write
these other markup languages. A <emphasis>meta markup
- language</emphasis>.</para>
+ language</emphasis>.</para>
<para>This is exactly what the Standard Generalised Markup Language (SGML)
is. Many markup languages have been written in SGML, including the two
@@ -198,7 +198,7 @@
<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
- 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
elements, and will therefore have different names for the tags.</para>
@@ -398,10 +398,10 @@
<para>Part of <filename>textproc/docproj</filename> is the
&man.nsgmls.1; <link linkend="sgml-primer-validating">validating
- parser</link>. Normally, &man.nsgmls.1; reads in a document
- marked up according to an SGML DTD and returns a copy of the
- document's Element Structure Information Set (ESIS, but that is
- not important right now).</para>
+ parser</link>. Normally, &man.nsgmls.1; reads in a document
+ marked up according to an SGML DTD and returns a copy of the
+ document's Element Structure Information Set (ESIS, but that is
+ not important right now).</para>
<para>However, when &man.nsgmls.1; is given the <option>-s</option>
parameter, &man.nsgmls.1; will suppress its normal output, and
@@ -564,7 +564,7 @@
<para>Lists the Formal Public Identifier (FPI)<indexterm>
<primary>Formal Public Identifier</primary>
</indexterm>
- for the DTD that this
+ for the DTD that this
document conforms to. Your SGML parser will use this to find the
correct DTD when processing this document.</para>
@@ -1147,7 +1147,7 @@
<para>You could list the entities at the top of each book, but this
quickly becomes cumbersome to manage.</para>
- <para>Instead, place the general entity definitions inside one file,
+ <para>Instead, place the general entity definitions inside one file,
and use a parameter entity to include that file within your
document.</para>
Index: structure/chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml,v
retrieving revision 1.6
diff -u -r1.6 chapter.sgml
--- structure/chapter.sgml 11 Jun 2001 01:16:47 -0000 1.6
+++ structure/chapter.sgml 1 Oct 2001 23:50:00 -0000
@@ -270,12 +270,12 @@
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 has had on just
- one chapter.</para>
+ 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 has had on just
+ one chapter.</para>
</sect4>
</sect3>
</sect2>
Index: the-website/chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml,v
retrieving revision 1.5
diff -u -r1.5 chapter.sgml
--- the-website/chapter.sgml 19 Aug 2001 23:54:35 -0000 1.5
+++ the-website/chapter.sgml 1 Oct 2001 23:50:52 -0000
@@ -86,7 +86,8 @@
<screen>&prompt.root; <userinput>cvs -R co www doc</userinput></screen>
</step>
- <step><para>Change in to the <filename>www</filename> directory, and
+ <step>
+ <para>Change in to the <filename>www</filename> directory, and
run the &man.make.1; <maketarget>links</maketarget> target, to
create the necessary symbolic links.</para>
--- patch ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200110020028.f920SDv01100>