public inbox for [email protected]  

help / color / mirror / Atom feed

From: Noah Misch <[email protected]>
To: Robert Haas <[email protected]>
Cc: Tom Lane <[email protected]>
Cc: [email protected] <[email protected]>
Cc: pgsql-docs <[email protected]>
Subject: Re: Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)
Date: Tue, 4 Feb 2014 23:43:28 -0500
Message-ID: <[email protected]> (raw)
In-Reply-To: <CA+TgmobCN4ABNYS=4FwQP3MUNdJ8+rdoyedXNn5gGiWSEPdnWg@mail.gmail.com>
References: <[email protected]>
	<[email protected]>
	<CA+Tgmob0Jx_9v9KK95gojkjojeP2hTa38_P8JtOFXVDjjSkT=A@mail.gmail.com>
	<[email protected]>
	<[email protected]>
	<[email protected]>
	<CA+TgmobCN4ABNYS=4FwQP3MUNdJ8+rdoyedXNn5gGiWSEPdnWg@mail.gmail.com>
List-Unsubscribe: <mailto:[email protected]?body=unsub%20pgsql-hackers>

On Tue, Feb 04, 2014 at 03:28:45PM -0500, Robert Haas wrote:
> On Tue, Feb 4, 2014 at 1:38 AM, Tom Lane <[email protected]> wrote:
> > Noah Misch <[email protected]> writes:
> >>> Robert Haas <[email protected]> writes:
> >>>> I wonder if these standalone things are really worthwhile.
> >
> >> I wonder how difficult it would be to make sufficient link data available when
> >> building the standalone files.  There would be no linking per se; we would
> >> just need the referent's text fragment emitted where the <xref> tag appears.
> >
> > IIRC, that's basically what the "workaround" is, except it's not very
> > automated.  Even if it were automated, though, there's still a problem:
> > such links aren't really *useful* in flat text format.  I think that
> > forcing the author to actually think about what to put there in the
> > flat text version is a good thing, if we're going to retain the flat
> > text version at all.
> 
> Right.  I mean, a lot of the links say things like "Section 26.2"
> which obviously makes no sense in a standalone text file.

For <xref>s normally displayed that way, text output could emit a URL, either
inline or in the form of a footnote.  For link targets (e.g. SQL commands)
having a friendly text fragment for <xref> sites, use the normal fragment.

-- 
Noah Misch
EnterpriseDB                                 http://www.enterprisedb.com


-- 
Sent via pgsql-hackers mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

view thread (19+ messages)  latest in thread

reply

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: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected]
  Subject: Re: Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox