Re: <xref> vs <command> formatting in the docs

Alvaro Herrera <alvherre@2ndquadrant.com>

From: Alvaro Herrera <alvherre@2ndquadrant.com>
To: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
Cc: PostgreSQL Hackers <pgsql-hackers@postgresql.org>
Date: 2020-06-21T15:30:38Z
Lists: pgsql-hackers
On 2020-Jun-21, Dagfinn Ilmari Mannsåker wrote:

> While looking at making more <command>SQL</command> into links, I
> noticed that <xref> loses the monospace formatting of <command>, and
> can't itself be wrapped in <command>.

Ouch.

> By some trial and error I found that putting <command> inside the
> <refentrytitle> tag propagates the formatting to the <xref> contents.
> We already do this with <application> for (most of) the client and
> server applications.  Is this something we want to do consistently for
> both?

Looking at the ones that use <application>, it looks like manpages are
not damaged, so +1.

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services



Commits

  1. Improve <xref> vs. <command> formatting in the documentation

  2. Add missing <application> tags in application doc <refentrytitle>s