doc PG 17 relnotes: add links to documentation sections

Also slightly improve markup instructions.  Indentation is still needed.

Backpatch-through: master
This commit is contained in:
Bruce Momjian 2024-06-18 22:09:41 -04:00
parent aa901a37cf
commit 5ade0b8f80
2 changed files with 268 additions and 285 deletions

File diff suppressed because it is too large Load Diff

View File

@ -16,7 +16,8 @@ pg_[A-Za-z0-9_]+ <application>, <structname>
\<[a-z]+_[a-z_]+\> <varname>, <structfield> \<[a-z]+_[a-z_]+\> <varname>, <structfield>
<systemitem class="osname"> <systemitem class="osname">
non-ASCII characters find using grep -P '[\x80-\xFF]' non-ASCII characters find using grep -P '[\x80-\xFF]' or
(remove 'X') grep -X-color='auto' -P -n "[\x80-\xFF]"
convert to HTML4 named entity (&) escapes convert to HTML4 named entity (&) escapes
official: http://www.w3.org/TR/html4/sgml/entities.html official: http://www.w3.org/TR/html4/sgml/entities.html
@ -25,16 +26,13 @@ non-ASCII characters find using grep -P '[\x80-\xFF]'
http://www.zipcon.net/~swhite/docs/computers/browsers/entities_page.html http://www.zipcon.net/~swhite/docs/computers/browsers/entities_page.html
https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
We cannot use UTF8 because back branches still use SGML Docbook, We cannot use UTF8 because rendering engines have to
which does not support it. Also, rendering engines have to
support the referenced characters. support the referenced characters.
Do not use numeric _UTF_ numeric character escapes (&#nnn;), Do not use numeric _UTF_ numeric character escapes (&#nnn;),
we can only use Latin1. we can only use Latin1.
Example: Alvaro Herrera is &Aacute;lvaro Herrera Example: Alvaro Herrera is &Aacute;lvaro Herrera
Find non-ASCII characters (remove 'X'):
grep -X-color='auto' -P -n "[\x80-\xFF]"
wrap long lines wrap long lines