Mercurial > hg
annotate doc/README @ 8781:385a2d94885e
hgrc.5: fix quoting of literal strings
The quotes would go wrong in many places due to differences between
asciidoc version 8.2.7 used by Benoit and 8.4.5 used by me. Between
those versions asciidoc stopped interpreting the content of `quoted
strings`, and so `*` would start bold text in the old version, but do
nothing in the new version.
To complicate things further, `\*` would escape the bold tag in the
old version, but in the new version the backslash was inserted
literally into the output (because the backtick quotes it).
I've now replaced backticks with non-quoting plusses and escaped
backslashes as appropriate.
author | Martin Geisler <mg@lazybytes.net> |
---|---|
date | Thu, 11 Jun 2009 17:19:48 +0200 |
parents | 8db8e1100f3f |
children | bc1de09090bc |
rev | line source |
---|---|
453 | 1 Mercurial's documentation is currently kept in ASCIIDOC format, which |
2 is a simple plain text format that's easy to read and edit. It's also | |
3 convertible to a variety of other formats including standard UNIX man | |
4 page format and HTML. | |
177 | 5 |
453 | 6 To do this, you'll need to install ASCIIDOC: |
177 | 7 |
453 | 8 http://www.methods.co.nz/asciidoc/ |
177 | 9 |
453 | 10 To generate the man page: |
177 | 11 |
453 | 12 asciidoc -d manpage -b docbook hg.1.txt |
13 xmlto man hg.1.xml | |
177 | 14 |
453 | 15 To display: |
177 | 16 |
453 | 17 groff -mandoc -Tascii hg.1 | more |
177 | 18 |
453 | 19 To create the html page (without stylesheets): |
177 | 20 |
5048
8db8e1100f3f
Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents:
453
diff
changeset
|
21 asciidoc -b html4 hg.1.txt |
8db8e1100f3f
Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents:
453
diff
changeset
|
22 |
8db8e1100f3f
Update asciidoc instructions to suggest html4 for newer versions
Brendan Cully <brendan@kublai.com>
parents:
453
diff
changeset
|
23 (older asciidoc may want html instead of html4 above) |