Skip to content

Commit fb21ed6

Browse files
committed
doc: update guidelines on non-ASCII characters in docs
1 parent 24987c6 commit fb21ed6

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

doc/src/sgml/README.non-ASCII

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,14 @@ others only support Latin-1 characters. Specifically, the PDF rendering
2222
engine can only display Latin-1 characters; non-Latin-1 Unicode
2323
characters are displayed as "###".
2424

25-
Therefore, in the SGML files, we only use Latin-1 characters. We
26-
typically encode these characters as HTML entities, e.g., Álvaro.
27-
It is also possible to safely represent Latin-1 characters in UTF8
28-
encoding for all output formats.
25+
Therefore, in the SGML files, we can only use Latin-1 characters. We
26+
can use UTF8 representations of Latin-1 characters, or HTML entities of
27+
Latin-1 characters, e.g., Álvaro.
2928

3029
Do not use UTF numeric character escapes (&#nnn;).
3130

31+
When building the PDF docs, problem characters will appear as warnings.
32+
3233
HTML entities
3334
official: http://www.w3.org/TR/html4/sgml/entities.html
3435
one page: http://www.zipcon.net/~swhite/docs/computers/browsers/entities_page.html

0 commit comments

Comments
 (0)