Feedback-ID: ie0a040ee:Fastmail
Message-ID: <ac5ad37e-1e36-eb2c-7b67-954cc83d677d@eisentraut.org>
Date: Wed, 27 Sep 2023 14:18:49 +0100
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:102.0)
 Gecko/20100101 Thunderbird/102.15.0
Subject: Re: Hyperlinks for source file references
Content-Language: en-US
To: Daniel Gustafsson <daniel@yesql.se>, pgsql-docs@lists.postgresql.org
References: <7C6E4AF2-62BA-49AB-8EC6-FA27136A8B88@yesql.se>
From: Peter Eisentraut <peter@eisentraut.org>
In-Reply-To: <7C6E4AF2-62BA-49AB-8EC6-FA27136A8B88@yesql.se>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Archived-At: 
 <https://www.postgresql.org/message-id/ac5ad37e-1e36-eb2c-7b67-954cc83d677d%40eisentraut.org>
Precedence: bulk

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.