<xref> vs <command> formatting in the docs

From: ilmari(at)ilmari(dot)org (Dagfinn Ilmari Mannsåker )
To: PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: <xref> vs <command> formatting in the docs
Date: 2020-06-21 15:22:04
Message-ID: 87o8pco34z.fsf@wibble.ilmari.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

Hi Hackers,

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>. This becomes particularly
apparent when you have one link that can be an <xref/> next to another
that's <link><command>...</command></link> because it's actually
referring to a specific variant of the 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

- ilmari
"The surreality of the universe tends towards a maximum" -- Skud's Law
"Never formulate a law or axiom that you're not prepared to live with
the consequences of." -- Skud's Meta-Law


Browse pgsql-hackers by date

  From Date Subject
Next Message Alvaro Herrera 2020-06-21 15:30:38 Re: <xref> vs <command> formatting in the docs
Previous Message Tom Lane 2020-06-21 15:16:43 Re: <application> vs <command> for command line tools in the docs