From: Peter Eisentraut <peter_e@gmx.net>
To: Josh Kupershmidt <schmiddy@gmail.com>
Cc: pgsql-docs <pgsql-docs@postgresql.org>
Subject: Re: sgml cleanup: unescaped '>' characters
Date: Tue, 30 Aug 2011 20:36:19 +0300
Message-ID: <1314725779.11209.1.camel@vanquo.pezone.net> (raw)
In-Reply-To: <CAK3UJRF2saBe6EDZ90eKVZ316DrkW_USMs2Kp9jzaQuRygdUeg@mail.gmail.com>
References: <CAK3UJRENGTA97ZEhguS6CzjqQgqU-D8fpFdh54tHT-1xfx2LpQ@mail.gmail.com>
<1314478125.2349.39.camel@vanquo.pezone.net>
<CAK3UJRF2saBe6EDZ90eKVZ316DrkW_USMs2Kp9jzaQuRygdUeg@mail.gmail.com>
On mån, 2011-08-29 at 18:22 -0500, Josh Kupershmidt wrote:
> >> The rewritten version picked up a few stylistic inconsistencies in the
> >> SGML, such as:
> >> * breaking the trailing '>' of an SGML marker across lines. AFAIK
> >> this is legal, but is a bit inconsistent and just confuses simplistic
> >> tools like find_gt_lt
> >
> > The cases you show don't appear to be terribly useful, but I think on
> > occasion this can be necessary to work around some arcane whitespace
> > rules in SGML or XML. (Just look at the generated HTML; it uses this
> > technique throughout.)
>
> Hrm, well if the spurious whitespace isn't serving any purpose in
> these cases, why not just fix it to match the rest of SGML style?
>
> >> * using single quotes instead of double quotes to surround a node
> >> attribute, as in <orderedlist numeration='loweralpha'>
> >
> > It would be better if the tool could handle that, because sometimes you
> > want to use single quotes if the value contains double quotes.
>
> It's trivial to adjust the regex I was using to ignore such cases. I'm
> just on about stylistic consistency here. If there's a reason to use
> single quotes, such as when the value contains double quotes, then
> that's fine -- but I don't think any of the cases I pointed out fall
> under that category.
I have committed your fixes relevant to these two points.
> >> as well as seemingly-invalid SGML, such as using '>' unescaped inside
> >> normal SGML entries.
> >
> > Unescaped > is valid, AFAIK.
>
> Oh, that's interesting. I took a quick look at "The SGML FAQ book",
> page 73 [1], which supports this claim.
>
> But I notice we've been fixing such issues in the recent past (e.g.
> commit d420ba2a2d4ea4831f89a3fd7ce86b05eff932ff). Don't we want to
> continue doing so? Not to mention the fact that we have
> ./src/tools/find_gt_lt, which while somewhat broken, has the
> ostensible goal of finding such problems in the SGML. Or do we want to
> stop worrying about '>' entirely, and rename find_gt_lt to find_lt,
> instead?
> [1] http://books.google.com/books?id=OyJHFJsnh10C&lpg=PA229&ots=DGkYDdvbhE&pg=PA73#v=onepage...
I don't know what the rationale for this tool is. I have never used it.
Clearly, the reference shows, and the tools we use confirm, that it is
not necessary to use it.
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: peter_e@gmx.net, schmiddy@gmail.com
Subject: Re: sgml cleanup: unescaped '>' characters
In-Reply-To: <1314725779.11209.1.camel@vanquo.pezone.net>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox