Date: Sun, 13 Jul 2003 18:16:26 -0400 (EDT) From: Ken Smith <kensmith@cse.Buffalo.EDU> To: FreeBSD-gnats-submit@FreeBSD.org Cc: kensmith@cse.Buffalo.EDU Subject: docs/54456: Minor fixes to fdp-primer docs Message-ID: <200307132216.h6DMGQ9a045683@zeus.cse.buffalo.edu> Resent-Message-ID: <200307132220.h6DMKGVm019973@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 54456
>Category: docs
>Synopsis: Minor fixes to fdp-primer docs
>Confidential: no
>Severity: non-critical
>Priority: medium
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Sun Jul 13 15:20:15 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator: Ken Smith
>Release: FreeBSD 4.8-RELEASE i386
>Organization:
U. Buffalo CSE Department/FreeBSD
>Environment:
System: FreeBSD zeus.cse.buffalo.edu 4.8-RELEASE FreeBSD 4.8-RELEASE #0: Thu Apr 3 10:53:38 GMT 2003 root@freebsd-stable.sentex.ca:/usr/obj/usr/src/sys/GENERIC i386
>Description:
One of the examples has one too many </dd> tags in it. Since I
was mentioning that I included some mis-spellings (ispell agrees
with me) and a filename change (typically setting environment
variables is done in a .cshrc file - but there may have been
a reason they used .login I'm not aware of...).
>How-To-Repeat:
N/A
>Fix:
Apply diff's below (relative to ftp-primer directory)...
--- overview/chapter.sgml.orig Sun Jan 12 13:31:41 2003
+++ overview/chapter.sgml Sat Jul 12 22:25:39 2003
@@ -39,7 +39,7 @@
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
+ the FDP is organized</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>
--- sgml-markup/chapter.sgml.orig Wed May 21 17:05:04 2003
+++ sgml-markup/chapter.sgml Sat Jul 12 22:33:24 2003
@@ -292,7 +292,7 @@
<programlisting><![ CDATA [<dl>
<dt>Term 1</dt>
- <dd><p>Paragraph 1 of definition 1.</p></dd>
+ <dd><p>Paragraph 1 of definition 1.</p>
<p>Paragraph 2 of definition 1.</p></dd>
--- sgml-primer/chapter.sgml.orig Sun Jan 12 13:31:41 2003
+++ sgml-primer/chapter.sgml Sat Jul 12 23:35:28 2003
@@ -119,7 +119,7 @@
these other markup languages. A <emphasis>meta markup
language</emphasis>.</para>
- <para>This is exactly what the Standard Generalised Markup Language (SGML)
+ <para>This is exactly what the Standard Generalized Markup Language (SGML)
is. Many markup languages have been written in SGML, including the two
most used by the FDP, HTML and DocBook.</para>
@@ -369,7 +369,7 @@
</example>
<example>
- <title><filename>.login</filename>, for &man.csh.1; and
+ <title><filename>.cshrc</filename>, for &man.csh.1; and
&man.tcsh.1; users</title>
<programlisting>setenv SGML_ROOT /usr/local/share/sgml
--- structure/chapter.sgml.orig Sun Jan 12 13:31:42 2003
+++ structure/chapter.sgml Sun Jul 13 00:18:03 2003
@@ -45,7 +45,7 @@
<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>
@@ -168,14 +168,14 @@
<sgmltag>sect3</sgmltag>) and so on.</para>
<sect3>
- <title>Physical organisation</title>
+ <title>Physical organization</title>
<para>There are a number of files and directories within the
<filename>handbook</filename> directory.</para>
<note>
- <para>The Handbook's organisation may change over time, and this
- document may lag in detailing the organisational changes. If you
+ <para>The Handbook's organization may change over time, and this
+ document may lag in detailing the organizational changes. If you
have any questions about how the Handbook is organised, please
contact the &a.doc;.</para>
</note>
@@ -259,7 +259,7 @@
<para>Chapters and/or directories should not be named in a fashion
that reflects their ordering within the Handbook. This ordering
might change as the content within the Handbook is reorganised;
- this sort of reorganisation should not (generally) include the
+ this sort of reorganization should not (generally) include the
need to rename files (unless entire chapters are being promoted
or demoted within the hierarchy).</para>
</important>
>Release-Note:
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200307132216.h6DMGQ9a045683>