Re: Hyperlinks for source file references

Поиск
Список
Период
Сортировка
От Daniel Gustafsson
Тема Re: Hyperlinks for source file references
Дата
Msg-id 9DAC36DC-D0B5-486B-B4BC-95A611711F2C@yesql.se
обсуждение исходный текст
Ответ на Re: Hyperlinks for source file references  (Peter Eisentraut <peter@eisentraut.org>)
Список pgsql-docs
> On 27 Sep 2023, at 15:18, Peter Eisentraut <peter@eisentraut.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




В списке pgsql-docs по дате отправления:

Предыдущее
От: Laurenz Albe
Дата:
Сообщение: Re: Is CREATE INDEX dependent on the session?
Следующее
От: PG Doc comments form
Дата:
Сообщение: `pg_restore --if-exists` clarification