Date: Wed, 9 Oct 2002 15:46:42 +0200 From: Lukasz Bojarski <ni@merkury.pol.lublin.pl> To: freebsd-doc@freebsd.org Subject: Re: docs/41546: [PATCH] adding non-breaking spaces to the handbook Message-ID: <20021009154642.A1703@merkury.pol.lublin.pl> In-Reply-To: <20021009113333.B86009@sumuk.de>; from martin@sumuk.de on Wed, Oct 09, 2002 at 11:33:33AM %2B0200 References: <200210010916.g919GafL015248@freefall.freebsd.org> <20021009113333.B86009@sumuk.de>
next in thread | previous in thread | raw e-mail | index | archive | help
> 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> Also IMHO: + <listitem> + <para>between first and last name:</para> + <programlisting><![ CDATA [John Smith]]></programlisting> + </listitem> + + <listitem> + <para>between multiword names (use with caution when applying this + to more than 3-4 word names like + "The FreeBSD Brazilian Portuguese Documentation Project"):</para> + <programlisting><![ CDATA [Sun Microsystems]]></programlisting> + </listitem> > + </itemizedlist> > + </sect2> > </sect1> > > <sect1> > *** Best Wishes Lukasz Bojarski 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?20021009154642.A1703>