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

From: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>
To: Dagfinn Ilmari Mannsåker <ilmari(at)ilmari(dot)org>
Cc: PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: <xref> vs <command> formatting in the docs
Date: 2020-06-21 15:30:38
Message-ID: 20200621153038.GA2296@alvherre.pgsql
Views: Raw Message | Whole Thread | Download mbox | Resend email
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>.


> 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
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

In response to


Browse pgsql-hackers by date

  From Date Subject
Next Message Chapman Flack 2020-06-21 15:46:28 Re: <application> vs <command> for command line tools in the docs
Previous Message Dagfinn Ilmari Mannsåker 2020-06-21 15:22:04 <xref> vs <command> formatting in the docs