doc/README
author mpm@selenic.com
Tue, 31 May 2005 21:10:10 -0800
changeset 201 f918a6fa2572
parent 182 089594a5bbde
child 453 7a3a3952c431
permissions -rw-r--r--
hgweb: add template filters, template style maps, and raw pages -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 hgweb: add template filters, template style maps, and raw pages Template filters: in templates, you can now specify a chain of filters like #desc|firstline|escape# #desc|escape|addbreaks# #date|age# to specify how you'd like raw text (or whatever) to be transformed. Template style maps: add ;style=foo to a URL and we'll use templates/map-foo if it exists. Raw output: Together, these two features make it east to implement raw downloadable files and patches. Simply link to the same page with style=raw and present the output as unfiltered text/plain with that template. manifest hash: 5954a648b3d6b4e6dc2dcd1975f96b4b0178da2a -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (GNU/Linux) iD8DBQFCnUMyywK+sNU5EO8RAkKjAJ9h9JElSCbWBPUnL+koCSDxgo38AwCgrccM 0qwyKdh/fUNglICxSh3HBNA= =Svlo -----END PGP SIGNATURE-----
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     1
Files in this directory:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     2
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     3
README - this file
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     4
hg.1.txt - asciidoc source for the files
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     5
hg.1 - groff man page for hg
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     6
hg.1.html - man page in html format
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     7
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     8
How to generate the man page and html files
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
     9
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    10
For now we use asciidoc which is available at:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    11
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    12
http://www.methods.co.nz/asciidoc/
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    13
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    14
the file hg.1.txt is the input file, to generate the man page:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    15
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    16
asciidoc.py -d manpage -b docbook hg.1.txt
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    17
xmlto man hg.1.xml
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    18
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    19
to display:
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    20
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    21
groff -mandoc -Tascii hg.1 | more
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    22
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    23
to create the html page (without stylesheets):
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    24
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
    25
asciidoc.py -b html hg.1.txt