Re: Hyperlinks for source file references

From: Peter Eisentraut <peter(at)eisentraut(dot)org>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Hyperlinks for source file references
Date: 2023-09-27 13:18:49
Message-ID: ac5ad37e-1e36-eb2c-7b67-954cc83d677d@eisentraut.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

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.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Ilya Priven 2023-09-27 15:23:42 Is CREATE INDEX dependent on the session?
Previous Message Daniel Gustafsson 2023-09-27 07:42:49 Re: pg_upgrade doc uses inconsistent versions within the doc.