diff options
| author | Tom Lane <tgl@sss.pgh.pa.us> | 2020-05-11 14:15:49 -0400 |
|---|---|---|
| committer | Tom Lane <tgl@sss.pgh.pa.us> | 2020-05-11 14:15:55 -0400 |
| commit | 60c90c16c1885bb9aa2047b66f958b865c5d397e (patch) | |
| tree | e45c686fe871fdd90094bd10d63bc1e66bc8273a /doc/src/sgml/ref/postgres-ref.sgml | |
| parent | 624686abcf87d26fe7c03543c4a54aad2237cb93 (diff) | |
| download | postgresql-60c90c16c1885bb9aa2047b66f958b865c5d397e.tar.gz postgresql-60c90c16c1885bb9aa2047b66f958b865c5d397e.zip | |
Doc: fix "Unresolved ID reference" warnings, clean up man page cross-refs.
Use xreflabel attributes instead of endterm attributes to control the
appearance of links to subsections of SQL command reference pages.
This is simpler, it matches what we do elsewhere (e.g. for GUC variables),
and it doesn't draw "Unresolved ID reference" warnings from the PDF
toolchain.
Fix some places where the text was absolutely dependent on an <xref>
rendering exactly so, by using a <link> around the required text
instead. At least one of those spots had already been turned into
bad grammar by subsequent changes, and the whole idea is just too
fragile for my taste. <xref> does NOT have fixed output, don't write
as if it does.
Consistently include a page-level link in cross-man-page references,
because otherwise they are useless/nonsensical in man-page output.
Likewise, be consistent about mentioning "below" or "above" in same-page
references; we were doing that in about 90% of the cases, but now it's
100%.
Also get rid of another nonfunctional-in-PDF idea, of making
cross-references to functions by sticking ID tags on <row> constructs.
We can put the IDs on <indexterm>s instead --- which is probably not any
more sensible in abstract terms, but it works where the other doesn't.
(There is talk of attaching cross-reference IDs to most or all of
the docs' function descriptions, but for now I just fixed the two
that exist.)
Discussion: https://postgr.es/m/14480.1589154358@sss.pgh.pa.us
Diffstat (limited to 'doc/src/sgml/ref/postgres-ref.sgml')
| -rw-r--r-- | doc/src/sgml/ref/postgres-ref.sgml | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index 1a4b7c7825d..5e5794bc90d 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -530,8 +530,7 @@ PostgreSQL documentation <para> The following options only apply to the single-user mode - (see <xref linkend="app-postgres-single-user" - endterm="app-postgres-single-user-title"/>). + (see <xref linkend="app-postgres-single-user"/> below). </para> <variablelist> @@ -753,8 +752,8 @@ PostgreSQL documentation </para> </refsect1> - <refsect1 id="app-postgres-single-user"> - <title id="app-postgres-single-user-title">Single-User Mode</title> + <refsect1 id="app-postgres-single-user" xreflabel="Single-User Mode"> + <title>Single-User Mode</title> <para> To start a single-user mode server, use a command like |