diff options
| author | Peter Eisentraut | 2020-10-03 14:16:51 +0000 |
|---|---|---|
| committer | Peter Eisentraut | 2020-10-03 14:40:02 +0000 |
| commit | 9081bddbd75e4e8994ca243c820ca63387bd33f7 (patch) | |
| tree | a9e9f66b96fa16067375262a99a39e4b9a501254 /doc/src/sgml/tsm-system-time.sgml | |
| parent | 1a9388bd0fefccc81430192d0b2c87938bb62d38 (diff) | |
Improve <xref> vs. <command> formatting in the documentation
SQL commands are generally marked up as <command>, except when a link
to a reference page is used using <xref>. But the latter doesn't
create monospace markup, so this looks strange especially when a
paragraph contains a mix of links and non-links.
We considered putting <command> in the <refentrytitle> on the target
side, but that creates some formatting side effects elsewhere.
Generally, it seems safer to solve this on the link source side.
We can't put the <xref> inside the <command>; the DTD doesn't allow
this. DocBook 5 would allow the <command> to have the linkend
attribute itself, but we are not there yet.
So to solve this for now, convert the <xref>s to <link> plus
<command>. This gives the correct look and also gives some more
flexibility what we can put into the link text (e.g., subcommands or
other clauses). In the future, these could then be converted to
DocBook 5 style.
I haven't converted absolutely all xrefs to SQL command reference
pages, only those where we care about the appearance of the link text
or where it was otherwise appropriate to make the appearance match a
bit better. Also in some cases, the links where repetitive, so in
those cases the links where just removed and replaced by a plain
<command>. In cases where we just want the link and don't
specifically care about the generated link text (typically phrased
"for further information see <xref ...>") the xref is kept.
Reported-by: Dagfinn Ilmari Mannsåker <[email protected]>
Discussion: https://www.postgresql.org/message-id/flat/[email protected]
Diffstat (limited to 'doc/src/sgml/tsm-system-time.sgml')
| -rw-r--r-- | doc/src/sgml/tsm-system-time.sgml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/src/sgml/tsm-system-time.sgml b/doc/src/sgml/tsm-system-time.sgml index cd074926d85..df6e83a9236 100644 --- a/doc/src/sgml/tsm-system-time.sgml +++ b/doc/src/sgml/tsm-system-time.sgml @@ -10,7 +10,7 @@ <para> The <filename>tsm_system_time</filename> module provides the table sampling method <literal>SYSTEM_TIME</literal>, which can be used in - the <literal>TABLESAMPLE</literal> clause of a <xref linkend="sql-select"/> + the <literal>TABLESAMPLE</literal> clause of a <link linkend="sql-select"><command>SELECT</command></link> command. </para> |