Bug 20056
| Summary: | Bad SGML in the "@ sign" entry of the FAQ | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | ue <ue> | ||||||
| Component: | Books & Articles | Assignee: | freebsd-doc (Nobody) <doc> | ||||||
| Status: | Closed FIXED | ||||||||
| Severity: | Affects Only Me | ||||||||
| Priority: | Normal | ||||||||
| Version: | Latest | ||||||||
| Hardware: | Any | ||||||||
| OS: | Any | ||||||||
| Attachments: |
|
||||||||
|
Description
ue
2000-07-20 13:30:00 UTC
Udo Erdelhoff wrote: > Two diffs. The first replaces <@> with <@>. 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. Looks good to me, with one minor exception: the white space before the "pn=\@" line in <programlisting> is unnecessary. > 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 :-> I think I'll leave this bit, if you don't mind too much, it can be committed in one batch at some point. -- Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D FreeBSD Documentation Project / Hi, > Looks good to me, with one minor exception: the white space before the > "pn=\@" line in <programlisting> is unnecessary. whitespace and linebreaks within a <programlisting> element are significant. With the whitespace in front of the pn=\@, the output will be intended by approximately one tab. Without it, it will start in column 0. Or did you mean that I should not intend the the output? In that case, replace the whole line with <para><literal>pn=\@</literal></para>. You could even change the end of the previous paragraph to read ...with a backslash, i.e. use <literal>pn=\@</literal>.</para> and remove the <programlisting> element completly. > I think I'll leave this bit, if you don't mind too much, it can be > committed in one batch at some point. I don't mind. /s/Udo -- Ich bin root, ich darf das. Udo Erdelhoff wrote: > Hi, >> Looks good to me, with one minor exception: the white space before the >> "pn=\@" line in <programlisting> is unnecessary. > > whitespace and linebreaks within a <programlisting> element are significant. > With the whitespace in front of the pn=\@, the output will be intended by > approximately one tab. Without it, it will start in column 0. Not in the HTML output I see. <pre class="PROGRAMLISTING"> pn=\@ </pre> That results from <programlisting>pn=\@</programlisting>, and I'd assume conversions to other formats get this right too. -- Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D FreeBSD Documentation Project / State Changed From-To: open->closed Functional part committed. White space change not committed, that will probably all get cleaned up in a mega-commit at some point. On Thu, Jul 20, 2000 at 04:54:56PM +0100, Ben Smithurst wrote: > <pre class="PROGRAMLISTING"> > pn=\@ > </pre> The html-tag pre indicates preformatted text and both Netscape 4 and the Preview 1 of Netscape 6 (I admit my sin: Yes, I'm using Windows 98, too) indent this text. Note: You must activate style sheets and javascript in a 4.x Netscape to see the effect - Netscape 4 handles style sheets by converting them into javascript commands. No javascript -> no style sheets -> left aligned. Even lynx creates the indent. w3m should do that, too. > That results from <programlisting>pn=\@</programlisting>, and I'd assume > conversions to other formats get this right too. My eyes tell me a rather different story :-) /s/Udo -- Q: How do you play religious roulette? A: You stand around in a circle and blaspheme and see who gets struck by lightning first. Udo Erdelhoff wrote: > On Thu, Jul 20, 2000 at 04:54:56PM +0100, Ben Smithurst wrote: >> <pre class="PROGRAMLISTING"> >> pn=\@ >> </pre> > The html-tag pre indicates preformatted text and both Netscape 4 and the > Preview 1 of Netscape 6 (I admit my sin: Yes, I'm using Windows 98, too) > indent this text. Yes. That's what I see too. >> That results from <programlisting>pn=\@</programlisting>, and I'd assume >> conversions to other formats get this right too. > > My eyes tell me a rather different story :-) About what? <programlisting> without the leading white space produces an indent, are you saying the other formats get this wrong? -- Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D FreeBSD Documentation Project / Hi Ben, my apologies for the late answer, but I wanted to have lots of sleep before I tried to unravel this mess. > > The html-tag pre indicates preformatted text and both Netscape 4 and the > > Preview 1 of Netscape 6 (I admit my sin: Yes, I'm using Windows 98, too) > > indent this text. > > Yes. That's what I see too. Duh. I assumed your statement "the whitespace is not neccessary" meant "the whitespace is ignored". Repeat after me: "assume makes an ass out of u and me" :-( > About what? <programlisting> without the leading white space produces an > indent, are you saying the other formats get this wrong? I compared the indent created by the old version (literallayout) with the new version (programlisting). The default indentation created by <programlisting> (or, to be precise, created by the corresponding HTML code) is much smaller than the indentation created by <literallayout>. I added the additional whitespace to have an almost identical amount of indentation in the new version. BTW: I've found another instance of the original problem: There's a <\@> a few entries later. The patch replaces <\@> with <\@> While I'm here :-) - replace <ulink ...man.cgi>/etc/remote</ulink> with <filename>... - replace <emphasis remap=tt>-Elements with <literal>-elements - replace <literallayout>-elments with <programlisting>-elements - remove the useless <para>-elements around the <programlisting>-elements; this change removes two tidy-warnings - replace the first instance of <ulink..man.cgi>tip</ulink> with &man.tip.1; - replace the second instace of this element with <command>tip</command> and add a command-element around the while of "in a while loop". --- book.sgml.orig Fri Jul 21 16:17:22 2000 +++ book.sgml Fri Jul 21 16:32:40 2000 @@ -8368,30 +8368,26 @@ <para>This is often a problem where a university has several modem lines and several thousand students trying to use them...</para> -<para>Make an entry for your university in <ulink URL="http://www.FreeBSD.org/cgi/man.cgi?remote">/etc/remote</ulink> -and use <emphasis remap=tt><\@></emphasis> for the <emphasis remap=tt>pn</emphasis> capability:</para> +<para>Make an entry for your university in <filename>/etc/remote</filename> +and use <literal><\@></literal> for the <literal>pn</literal> capability:</para> -<para> -<literallayout> big-university:\ +<programlisting> big-university:\ :pn=\@:tc=dialout dialout:\ :dv=/dev/cuaa3:br#9600:at=courier:du:pa=none: - </literallayout> -</para> +</programlisting> <para>Then, list the phone numbers for the university in -<ulink URL="http://www.FreeBSD.org/cgi/man.cgi?phones">/etc/phones</ulink>:</para> +<filename>/etc/phones</filename>:</para> -<para> -<literallayout> big-university 5551111 +<programlisting> big-university 5551111 big-university 5551112 big-university 5551113 big-university 5551114 - </literallayout> -</para> +</programlisting> -<para><ulink URL="http://www.FreeBSD.org/cgi/man.cgi?tip">tip</ulink> will try each one in the listed order, then give up. If -you want to keep retrying, run <emphasis remap=tt>tip</emphasis> in a while loop.</para> +<para>&man.tip.1; will try each one in the listed order, then give up. If +you want to keep retrying, run <command>tip</command> in a <command>while</command> loop.</para> </answer></qandaentry> /s/Udo Udo Erdelhoff wrote: > BTW: I've found another instance of the original problem: There's a <\@> a > few entries later. The patch replaces <\@> with <\@> > While I'm here :-) > - replace <ulink ...man.cgi>/etc/remote</ulink> with <filename>... I'll be axing all man.cgi unless anyone on -doc objects... > - replace <emphasis remap=tt>-Elements with <literal>-elements > - replace <literallayout>-elments with <programlisting>-elements > - remove the useless <para>-elements around the <programlisting>-elements; > this change removes two tidy-warnings > - replace the first instance of <ulink..man.cgi>tip</ulink> with &man.tip.1; > - replace the second instace of this element with <command>tip</command> > and add a command-element around the while of "in a while loop". A load of that will be fixed in my megapatch too. Patience. :-) -- Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D FreeBSD Documentation Project / |
