Date: Wed, 9 Oct 2002 11:33:33 +0200 From: Martin Heinen <martin@sumuk.de> To: Murray Stokely <murray@FreeBSD.org> Cc: martin@sumuk.de, freebsd-doc@FreeBSD.org Subject: Re: docs/41546: [PATCH] adding non-breaking spaces to the handbook Message-ID: <20021009113333.B86009@sumuk.de> In-Reply-To: <200210010916.g919GafL015248@freefall.freebsd.org>; from murray@FreeBSD.org on Tue, Oct 01, 2002 at 02:16:36AM -0700 References: <200210010916.g919GafL015248@freefall.freebsd.org>
index | next in thread | previous in thread | raw e-mail
On Tue, Oct 01, 2002 at 02:16:36AM -0700, Murray Stokely wrote:
> Synopsis: [PATCH] adding non-breaking spaces to the handbook
> This is great work, thanks! I've committed your huge patch. Do you
> think you could update the Doc Project Primer so that other new doc
> authors remember to use non-breaking spaces in the appropriate places?
> I don't recall if this is covered in the primer.
How about the following patch?
***
Index: writing-style/chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml,v
retrieving revision 1.30
diff -u -r1.30 chapter.sgml
--- writing-style/chapter.sgml 31 Aug 2002 20:14:13 -0000 1.30
+++ writing-style/chapter.sgml 9 Oct 2002 09:10:22 -0000
@@ -314,6 +314,35 @@
the second change, be sure to indicate that this is a whitespace-only
change, and that the translation team can ignore it.</para>
</sect2>
+
+ <sect2>
+ <title>Nonbreaking space</title>
+
+ <para>Avoid line breaks in places where they look ugly
+ or make it difficult to follow a sentence. Line breaks depend
+ on the width of the chosen output medium. In particular, viewing
+ the HTML documentation with a text browser can lead to badly
+ formatted paragraphs like the next one:</para>
+
+ <literallayout class="monospaced">Data capacity ranges from 40 MB to 15
+GB. Hardware compression …</literallayout>
+
+ <para>The general entity <literal>&nbsp;</literal> prohibits
+ line breaks between parts belonging together. Use nonbreaking
+ spaces in the following places:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>between numbers and units:</para>
+ <programlisting><![ CDATA [57600 bps]]></programlisting>
+ </listitem>
+
+ <listitem>
+ <para>between program names and version numbers:</para>
+ <programlisting><![ CDATA [FreeBSD 4.7]]></programlisting>
+ </listitem>
+ </itemizedlist>
+ </sect2>
</sect1>
<sect1>
***
--
Marxpitn
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
help
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20021009113333.B86009>