annotate mercurial/help/templates.txt @ 11034:3b89899934a6 stable

log: document the new xml style
author Dan Connolly <http://www.w3.org/People/Connolly/>
date Wed, 28 Apr 2010 13:36:06 -0500
parents 9f6e30a89f11
children 6faf015e0ba0 df95b31bbdd7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
1 Mercurial allows you to customize output of commands through
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
2 templates. You can either pass in a template from the command
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
3 line, via the --template option, or select an existing
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
4 template-style (--style).
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
5
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
6 You can customize output for any "log-like" command: log,
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
7 outgoing, incoming, tip, parents, heads and glog.
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
8
11034
3b89899934a6 log: document the new xml style
Dan Connolly <http://www.w3.org/People/Connolly/>
parents: 10759
diff changeset
9 Four styles are packaged with Mercurial: default (the style used
3b89899934a6 log: document the new xml style
Dan Connolly <http://www.w3.org/People/Connolly/>
parents: 10759
diff changeset
10 when no explicit preference is passed), compact, changelog,
3b89899934a6 log: document the new xml style
Dan Connolly <http://www.w3.org/People/Connolly/>
parents: 10759
diff changeset
11 and xml.
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
12 Usage::
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
13
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
14 $ hg log -r1 --style changelog
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
15
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
16 A template is a piece of text, with markup to invoke variable
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
17 expansion::
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
18
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
19 $ hg log -r1 --template "{node}\n"
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
20 b56ce7b07c52de7d5fd79fb89701ea538af65746
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
21
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
22 Strings in curly braces are called keywords. The availability of
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
23 keywords depends on the exact context of the templater. These
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
24 keywords are usually available for templating a log-like command:
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
25
10066
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
26 :author: String. The unmodified author of the changeset.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
27
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
28 :branches: String. The name of the branch on which the changeset was
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
29 committed. Will be empty if the branch name was default.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
30
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
31 :date: Date information. The date when the changeset was committed.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
32
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
33 :desc: String. The text of the changeset description.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
34
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
35 :diffstat: String. Statistics of changes with the following format:
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
36 "modified files: +added/-removed lines"
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
37
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
38 :files: List of strings. All files modified, added, or removed by this
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
39 changeset.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
40
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
41 :file_adds: List of strings. Files added by this changeset.
10066
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
42
10061
9e2ab10728a2 Make {file_copies} usable as a --template key
Patrick Mezard <pmezard@gmail.com>
parents: 9999
diff changeset
43 :file_copies: List of strings. Files copied in this changeset with
10066
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
44 their sources.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
45
10061
9e2ab10728a2 Make {file_copies} usable as a --template key
Patrick Mezard <pmezard@gmail.com>
parents: 9999
diff changeset
46 :file_copies_switch: List of strings. Like "file_copies" but displayed
10066
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
47 only if the --copied switch is set.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
48
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
49 :file_mods: List of strings. Files modified by this changeset.
10066
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
50
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
51 :file_dels: List of strings. Files removed by this changeset.
10066
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
52
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
53 :node: String. The changeset identification hash, as a 40-character
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
54 hexadecimal string.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
55
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
56 :parents: List of strings. The parents of the changeset.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
57
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
58 :rev: Integer. The repository-local changeset revision number.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
59
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
60 :tags: List of strings. Any tags associated with the changeset.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
61
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
62 :latesttag: String. Most recent global tag in the ancestors of this
10066
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
63 changeset.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
64
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
65 :latesttagdistance: Integer. Longest path to the latest tag.
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
66
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
67 The "date" keyword does not produce human-readable output. If you
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
68 want to use a date in your output, you can use a filter to process
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
69 it. Filters are functions which return a string based on the input
10759
9f6e30a89f11 help: point out need for stringification
Dirkjan Ochtman <dirkjan@ochtman.nl>
parents: 10066
diff changeset
70 variable. Be sure to use the stringify filter first when you're
9f6e30a89f11 help: point out need for stringification
Dirkjan Ochtman <dirkjan@ochtman.nl>
parents: 10066
diff changeset
71 applying a string-input filter to a list-like input variable.
9f6e30a89f11 help: point out need for stringification
Dirkjan Ochtman <dirkjan@ochtman.nl>
parents: 10066
diff changeset
72 You can also use a chain of filters to get the desired output::
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
73
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
74 $ hg tip --template "{date|isodate}\n"
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
75 2008-08-21 18:22 +0000
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
76
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
77 List of filters:
9539
c904e76e3834 help: move help topics from mercurial/help.py to help/*.txt
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
78
10066
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
79 :addbreaks: Any text. Add an XHTML "<br />" tag before the end of
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
80 every line except the last.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
81
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
82 :age: Date. Returns a human-readable date/time difference between the
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
83 given date/time and the current date/time.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
84
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
85 :basename: Any text. Treats the text as a path, and returns the last
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
86 component of the path after splitting by the path separator
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
87 (ignoring trailing separators). For example, "foo/bar/baz" becomes
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
88 "baz" and "foo/bar//" becomes "bar".
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
89
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
90 :stripdir: Treat the text as path and strip a directory level, if
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
91 possible. For example, "foo" and "foo/bar" becomes "foo".
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
92
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
93 :date: Date. Returns a date in a Unix date format, including the
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
94 timezone: "Mon Sep 04 15:13:13 2006 0700".
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
95
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
96 :domain: Any text. Finds the first string that looks like an email
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
97 address, and extracts just the domain component. Example: ``User
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
98 <user@example.com>`` becomes ``example.com``.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
99
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
100 :email: Any text. Extracts the first string that looks like an email
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
101 address. Example: ``User <user@example.com>`` becomes
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
102 ``user@example.com``.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
103
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
104 :escape: Any text. Replaces the special XML/XHTML characters "&", "<"
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
105 and ">" with XML entities.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
106
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
107 :fill68: Any text. Wraps the text to fit in 68 columns.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
108
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
109 :fill76: Any text. Wraps the text to fit in 76 columns.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
110
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
111 :firstline: Any text. Returns the first line of text.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
112
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
113 :nonempty: Any text. Returns '(none)' if the string is empty.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
114
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
115 :hgdate: Date. Returns the date as a pair of numbers: "1157407993
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
116 25200" (Unix timestamp, timezone offset).
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
117
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
118 :isodate: Date. Returns the date in ISO 8601 format: "2009-08-18 13:00
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
119 +0200".
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
120
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
121 :isodatesec: Date. Returns the date in ISO 8601 format, including
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
122 seconds: "2009-08-18 13:00:13 +0200". See also the rfc3339date
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
123 filter.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
124
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
125 :localdate: Date. Converts a date to local date.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
126
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
127 :obfuscate: Any text. Returns the input text rendered as a sequence of
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
128 XML entities.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
129
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
130 :person: Any text. Returns the text before an email address.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
131
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
132 :rfc822date: Date. Returns a date using the same format used in email
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
133 headers: "Tue, 18 Aug 2009 13:00:13 +0200".
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
134
9540
cad36e496640 help: un-indent help topics
Martin Geisler <mg@lazybytes.net>
parents: 9539
diff changeset
135 :rfc3339date: Date. Returns a date using the Internet date format
10066
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
136 specified in RFC 3339: "2009-08-18T13:00:13+02:00".
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
137
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
138 :short: Changeset hash. Returns the short form of a changeset hash,
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
139 i.e. a 12-byte hexadecimal string.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
140
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
141 :shortdate: Date. Returns a date like "2006-09-18".
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
142
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
143 :strip: Any text. Strips all leading and trailing whitespace.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
144
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
145 :tabindent: Any text. Returns the text, with every line except the
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
146 first starting with a tab character.
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
147
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
148 :urlescape: Any text. Escapes all "special" characters. For example,
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
149 "foo bar" becomes "foo%20bar".
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
150
788e7d04c594 help/templates: use hanging indent for field list
Martin Geisler <mg@lazybytes.net>
parents: 10061
diff changeset
151 :user: Any text. Returns the user portion of an email address.