pg.ddx.io pgsql-docs@postgresql.org mailing list archivehelp / color / mirror / Atom feed
Cross-referencing 2+ messages / 2 participants [nested] [flat]
* Cross-referencing @ 2006-08-09 20:29 Jim Nasby <jnasby@pervasive.com> 2006-08-10 00:24 ` Re: Cross-referencing Neil Conway <neilc@samurai.com> 0 siblings, 1 reply; 2+ messages in thread From: Jim Nasby @ 2006-08-09 20:29 UTC (permalink / raw) To: pgsql-docs It's always bugged me that the docs don't do a better job of cross- referencing things. IE: if a webpage mentions pg_start_backup(), that mention should be a link to the documentation for that function. Is there a historical reason for this? Any reason not to change it? -- Jim C. Nasby, Sr. Engineering Consultant jnasby@pervasive.com Pervasive Software http://pervasive.com work: 512-231-6117 vcard: http://jim.nasby.net/pervasive.vcf cell: 512-569-9461 ^ permalink raw reply [nested|flat] 2+ messages in thread
* Re: Cross-referencing 2006-08-09 20:29 Cross-referencing Jim Nasby <jnasby@pervasive.com> @ 2006-08-10 00:24 ` Neil Conway <neilc@samurai.com> 0 siblings, 0 replies; 2+ messages in thread From: Neil Conway @ 2006-08-10 00:24 UTC (permalink / raw) To: Jim Nasby <jnasby@pervasive.com>; +Cc: pgsql-docs On Wed, 2006-08-09 at 15:29 -0500, Jim Nasby wrote: > It's always bugged me that the docs don't do a better job of cross- > referencing things. IE: if a webpage mentions pg_start_backup(), that > mention should be a link to the documentation for that function. > > Is there a historical reason for this? When the documentation was split into separate DocBook books, you couldn't link easily link between books. That has since changed. Several people have been incrementally improving the cross-references, but there is room for further improvement. > Any reason not to change it? If a phrase is mentioned multiple times within a short span of text, I think we need only make a link out of the first mention. It would also be nice to ensure the typesetting is consistent: for example, if we're marking up "pg_start_backup" with <function>, it would be nice to ensure that linked versions of same are typeset in a similar manner. If you'd like to improve the cross-referencing, please go ahead and submit patches. -Neil ^ permalink raw reply [nested|flat] 2+ messages in thread
end of thread, other threads:[~2006-08-10 00:24 UTC | newest] Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2006-08-09 20:29 Cross-referencing Jim Nasby <jnasby@pervasive.com> 2006-08-10 00:24 ` Neil Conway <neilc@samurai.com>
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