Bug 78240
| Summary: | [patch] handbook: replace <literal> with <quote> around a # | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | Brad Davis <so14k> | ||||
| Component: | Books & Articles | Assignee: | freebsd-doc (Nobody) <doc> | ||||
| Status: | Closed FIXED | ||||||
| Severity: | Affects Only Me | CC: | carlavilla | ||||
| Priority: | Normal | ||||||
| Version: | Latest | ||||||
| Hardware: | Any | ||||||
| OS: | Any | ||||||
| Attachments: |
|
||||||
|
Description
Brad Davis
2005-03-01 13:00:39 UTC
On Tue, Mar 01, 2005 at 05:54:25AM -0700, Brad Davis wrote:
>
> --- doc-ori/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml Fri Feb 25 13:31:42 2005
> +++ doc/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml Tue Mar 1 05:51:14 2005
> @@ -4262,7 +4262,7 @@
> installed as
> <filename>/usr/local/etc/apache/httpd.conf</filename> on &os;.
> This file is a typical &unix; text configuration file with
> - comment lines beginning with the <literal>#</literal>
> + comment lines beginning with the <quote>#</quote>
> character. A comprehensive description of all possible
The current markup seems right to me. <quote></quote> should be used to
quote some text or to indicate a word is not used in the usual way, etc.
I'm not sure there is a rule for a single character.
Marc
Well we should decide which one to use because in the inetd section we use <quote> which looks better IMO. Regards, Brad Davis Brad Davis <so14k@so14k.com> wrote: > Well we should decide which one to use because in the inetd section we > use <quote> which looks better IMO. I'm personally a fan of <quote><literal>foo</literal></quote>, because it looks good both in plain text _and_ html output. It is also similar to the way literal text is quoted in many places in the manpages, where the canonical way of quoting literal text is: .Dq Li foo Well if that is what we want to do I can remake my patch to fix both instances that I know about and look for others. Regards, Brad Davis On 2005-03-02 00:19, Brad Davis <so14k@so14k.com> wrote regarding <quote><literal>foo</literal></quote> elements: > > Well if that is what we want to do I can remake my patch to fix both > instances that I know about and look for others. I'm not sure if nested <quote> and <literal> is something we can all agree about. Even I have not decided if it's good to use nested elements or if we should marking up for style altogether and let the stylesheets decide how things are going to be presented (i.e. with quotes around the literal text, or not). Something like this, perhaps, in our doc/share/sgml/freebsd.dsl? (element literal (make-sequence (literal "``") (process-children) (literal "''"))) I'm not very acquainted with DSSSL, so this may be wrong. The general idea is that all <literal> elements will automagically quote their contents, so we don't need to <quote></quote> literal stuff. Responsible Changed From-To: freebsd-doc->brd Over to Brad, it's his PR. For bugs matching the following criteria: Status: In Progress Changed: (is less than) 2014-06-01 Reset to default assignee and clear in-progress tags. Mail being skipped |
