Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 20 Jul 2000 14:22:41 +0200 (CEST)
From:      Udo Erdelhoff <ue@nathan.ruhr.de>
To:        FreeBSD-gnats-submit@freebsd.org
Subject:   docs/20056: Bad SGML in the "@ sign" entry of the FAQ
Message-ID:  <200007201222.OAA66040@nathan.ruhr.de>

next in thread | raw e-mail | index | archive | help

>Number:         20056
>Category:       docs
>Synopsis:       Bad SGML in the "@ sign" entry of the FAQ
>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:   Thu Jul 20 05:30:00 PDT 2000
>Closed-Date:
>Last-Modified:
>Originator:     Udo Erdelhoff
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:

$FreeBSD: doc/en_US.ISO_8859-1/books/faq/book.sgml,v 1.72

>Description:

The FAQ entry about the use of @ for the pn capability uses the string
<@> to denote the @-character. The use of <> is reserved for SGML tags,
<@> is not a valid tag.

Found during devlopment of suppe.

>How-To-Repeat:

n/a

>Fix:

Two diffs. The first replaces <@> with &lt;@&gt;. While I'm here, replace
<emphasis remap=tt></emphasis> with <literal></literal>, replace the
links to man.cgi for the filenames with the proper <filename></filename>,
use <programlisting> instead of <literallayout> and remove the <para></para>
around <programlisting> to remove one of the many warnings issued by tidy.

The second diff fixes the indentation and the word wrapping. Whitespace
changes only, may be ignored by the translations teams. Reformatting done
by suppe 1.6, about 850 KBytes (19763 lines) of diffs left :->

First diff:
--- book.sgml	Thu Jul 20 13:20:55 2000
+++ book.sgml.orig	Thu Jul 20 13:36:15 2000
@@ -8209,14 +8209,17 @@
 </answer></qandaentry>
 
 <qandaentry><question>
-<para>The <literal>&lt;@&gt;</literal> sign for the pn capability doesn't work!</para></question><answer>
+<para>The <emphasis remap=tt><@></emphasis> sign for the pn capability doesn't work!</para></question><answer>
 
-<para>The <literal>&lt;@&gt;</literal> sign in the phone number capability tells tip to look in
-<filename>/etc/phones</filename> for a phone number.  But the <literal>&lt;@&gt;</literal> sign is
+<para>The <emphasis remap=tt><@></emphasis> sign in the phone number capability tells tip to look in
+<ulink URL="http://www.FreeBSD.org/cgi/man.cgi?phones(5)">/etc/phones</ulink>; for a phone number.  But the <emphasis remap=tt><@></emphasis> sign is
 also a special character in capability files like
-<filename>/etc/remote</filename>.  Escape it with a backslash:</para>
+<ulink URL="http://www.FreeBSD.org/cgi/man.cgi?remote">/etc/remote</ulink>.  Escape it with a backslash:</para>
 
-<programlisting>        pn=\@</programlisting>
+<para>
+<literallayout>        pn=\@
+      </literallayout>
+</para>
 
 </answer></qandaentry>
 
Second diff:

--- book.sgml.orig	Thu Jul 20 13:41:05 2000
+++ book.sgml	Thu Jul 20 13:41:39 2000
@@ -8208,17 +8208,24 @@
 
 </answer></qandaentry>
 
-<qandaentry><question>
-<para>The <literal>&lt;@&gt;</literal> sign for the pn capability doesn't work!</para></question><answer>
+      <qandaentry>
+        <question>
+          <para>The <literal>&lt;@&gt;</literal> sign for the pn capability
+            doesn't work!</para>
+        </question>
 
-<para>The <literal>&lt;@&gt;</literal> sign in the phone number capability tells tip to look in
-<filename>/etc/phones</filename> for a phone number.  But the <literal>&lt;@&gt;</literal> sign is
-also a special character in capability files like
-<filename>/etc/remote</filename>.  Escape it with a backslash:</para>
+        <answer>
+          <para>The <literal>&lt;@&gt;</literal> sign in the phone number
+            capability tells tip to look in
+            <filename>/etc/phones</filename> for a phone number.  But the
+            <literal>&lt;@&gt;</literal> sign is also a special character
+            in capability files like <filename>/etc/remote</filename>.
+            Escape it with a backslash:</para>
 
 <programlisting>        pn=\@</programlisting>
 
-</answer></qandaentry>
+        </answer>
+      </qandaentry>
 
 <qandaentry><question>
 <para>How can I dial a phone number on the command line?</para></question><answer>

>Release-Note:
>Audit-Trail:
>Unformatted:


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?200007201222.OAA66040>