Add a section explaining
Reviewed by: Lukasz Bojarski <ni@merkury.pol.lublin.pl> Approved by: murray, alex (mentor)
This commit is contained in:
parent
70ced0286c
commit
2bfcee3890
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=14576
1 changed files with 36 additions and 0 deletions
|
@ -314,6 +314,42 @@ V
|
|||
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>
|
||||
|
||||
<listitem>
|
||||
<para>between multiword names (use with caution when applying this
|
||||
to more than 3-4 word names like <quote>The FreeBSD Brazilian
|
||||
Portuguese Documentation Project</quote>):</para>
|
||||
<programlisting><![ CDATA [Sun Microsystems]]></programlisting>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect1>
|
||||
|
|
Loading…
Reference in a new issue