Re: Hyperlinks for source file references

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Peter Eisentraut <peter(at)eisentraut(dot)org>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Hyperlinks for source file references
Date: 2023-09-28 12:13:44
Message-ID: 9DAC36DC-D0B5-486B-B4BC-95A611711F2C@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 27 Sep 2023, at 15:18, Peter Eisentraut <peter(at)eisentraut(dot)org> wrote:
>
> On 25.09.23 13:09, Daniel Gustafsson wrote:
>> Commit b73c3a11963 introduced <ulink url=xyz><filename>xyz</filename><ulink>
>> hyperlinks for files in the postgres source tree by linking to the gitweb
>> interface at git.postgresql.org. This, IMO, makes the content referred to more
>> accessible, and is especially interesting for README files. The links in
>> question can be found here:
>> https://www.postgresql.org/docs/devel/tableam.html
>> Right now we have ~85 references to source files using <filename /> in the
>> docs, should we convert them to hyperlinks like the ones in the Table AM docs?
>> I would be happy to make a patch that implements this, but I wanted to check
>> here before making the effort to make sure it's not immediately nayed.
>
> A slightly fancier variant that avoids having to hardcode the git web URL pattern in a bunch of places:
>
> You mark it up like
>
> <ulink url="file://src/include/access/tableam.h" type="pgsrc"/>
>
> and then write a bit of XSL to process that into whatever form you want.

Ah yes, thats a neater version. Since noone objected to the idea I will go
hack up an attempt at this to share.

--
Daniel Gustafsson

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2023-09-28 12:49:26 `pg_restore --if-exists` clarification
Previous Message Laurenz Albe 2023-09-28 06:23:35 Re: Is CREATE INDEX dependent on the session?