##// END OF EJS Templates
help.hgweb: add a section describing URLs and common parameters...
Gregory Szorc -
r24079:afe03a61 default
parent child Browse files
Show More
@@ -48,3 +48,32 b' In this example::'
48
48
49 The ``collections`` section is deprecated and has been superseded by
49 The ``collections`` section is deprecated and has been superseded by
50 ``paths``.
50 ``paths``.
51
52 URLs and Common Arguments
53 =========================
54
55 URLs under each repository have the form ``/{command}[/{arguments}]``
56 where ``{command}`` represents the name of a command or handler and
57 ``{arguments}`` represents any number of additional URL parameters
58 to that command.
59
60 The web server has a default style associated with it. Styles map to
61 a collection of named templates. Each template is used to render a
62 specific piece of data, such as a changeset or diff.
63
64 The style for the current request can be overwritten two ways. First,
65 if ``{command}`` contains a hyphen (``-``), the text before the hyphen
66 defines the style. For example, ``/atom-log`` will render the ``log``
67 command handler with the ``atom`` style. The second way to set the
68 style is with the ``style`` query string argument. For example,
69 ``/log?style=atom``. The hyphenated URL parameter is preferred.
70
71 Not all templates are available for all styles. Attempting to use
72 a style that doesn't have all templates defined may result in an error
73 rendering the page.
74
75 Many commands take a ``{revision}`` URL parameter. This defines the
76 changeset to operate on. This is commonly specified as the short,
77 12 digit hexidecimal abbreviation for the full 40 character unique
78 revision identifier. However, any value described by
79 :hg:`help revisions` typically works.
General Comments 0
You need to be logged in to leave comments. Login now