Don't give a poor example of letting special characters slip

into text cut'n'pasted to a <pre> HTML element.  Warn readers
that such characters are likely to appear in plain-text sources
often used to copy pre-formatted text from.
This commit is contained in:
Yaroslav Tykhiy 2005-09-12 16:01:07 +00:00
parent 3735e320fd
commit a08f137b33
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=25610

View file

@ -332,11 +332,22 @@
There is a new copy of my primer for contributors to the FreeBSD
Documentation Project available at
<URL:http://people.FreeBSD.org/~nik/primer/index.html>
&lt;URL:http://people.FreeBSD.org/~nik/primer/index.html&gt;
Comments appreciated.
N</pre>]]></programlisting>
<para>Keep in mind that <literal>&lt;</literal> and
<literal>&amp;</literal> still are recognized as special
characters in pre-formatted text. This is why the example
shown had to use <literal>&amp;lt;</literal> instead of
<literal>&lt;</literal>. For consistency,
<literal>&amp;gt;</literal> was used in place of
<literal>&gt;</literal>, too. Watch out for the special characters
that may appear in text copied from a plain-text source,
e.g., an e-mail message or program code.</para>
</example>
</sect3>