From: ilmari@ilmari.org
To: PostgreSQL Hackers <pgsql-hackers@postgresql.org>
Subject: <xref> vs <command> formatting in the docs
Date: Sun, 21 Jun 2020 16:22:04 +0100
Message-ID: <87o8pco34z.fsf@wibble.ilmari.org> (raw)
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
both?
- 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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-hackers@postgresql.org
Cc: ilmari@ilmari.org
Subject: Re: <xref> vs <command> formatting in the docs
In-Reply-To: <87o8pco34z.fsf@wibble.ilmari.org>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox