##// END OF EJS Templates
help: format templating help topic with a field list
Martin Geisler -
r9294:5f4862a0 default
parent child Browse files
Show More
@@ -375,24 +375,27 b' PYTHONPATH'
375 375 keywords depends on the exact context of the templater. These
376 376 keywords are usually available for templating a log-like command:
377 377
378 - author: String. The unmodified author of the changeset.
379 - branches: String. The name of the branch on which the changeset
380 was committed. Will be empty if the branch name was default.
381 - date: Date information. The date when the changeset was
382 committed.
383 - desc: String. The text of the changeset description.
384 - diffstat: String. Statistics of changes with the following
385 format: "modified files: +added/-removed lines"
386 - files: List of strings. All files modified, added, or removed by
387 this changeset.
388 - file_adds: List of strings. Files added by this changeset.
389 - file_mods: List of strings. Files modified by this changeset.
390 - file_dels: List of strings. Files removed by this changeset.
391 - node: String. The changeset identification hash, as a
392 40-character hexadecimal string.
393 - parents: List of strings. The parents of the changeset.
394 - rev: Integer. The repository-local changeset revision number.
395 - tags: List of strings. Any tags associated with the changeset.
378 :author: String. The unmodified author of the changeset.
379 :branches: String. The name of the branch on which the changeset
380 was committed. Will be empty if the branch name was
381 default.
382 :date: Date information. The date when the changeset was
383 committed.
384 :desc: String. The text of the changeset description.
385 :diffstat: String. Statistics of changes with the following
386 format: "modified files: +added/-removed lines"
387 :files: List of strings. All files modified, added, or removed
388 by this changeset.
389 :file_adds: List of strings. Files added by this changeset.
390 :file_mods: List of strings. Files modified by this changeset.
391 :file_dels: List of strings. Files removed by this changeset.
392 :node: String. The changeset identification hash, as a
393 40-character hexadecimal string.
394 :parents: List of strings. The parents of the changeset.
395 :rev: Integer. The repository-local changeset revision
396 number.
397 :tags: List of strings. Any tags associated with the
398 changeset.
396 399
397 400 The "date" keyword does not produce human-readable output. If you
398 401 want to use a date in your output, you can use a filter to process
@@ -405,48 +408,53 b' PYTHONPATH'
405 408
406 409 List of filters:
407 410
408 - addbreaks: Any text. Add an XHTML "<br />" tag before the end of
409 every line except the last.
410 - age: Date. Returns a human-readable date/time difference between
411 the given date/time and the current date/time.
412 - basename: Any text. Treats the text as a path, and returns the
413 last component of the path after splitting by the path separator
414 (ignoring trailing separators). For example, "foo/bar/baz"
415 becomes "baz" and "foo/bar//" becomes "bar".
416 - stripdir: Treat the text as path and strip a directory level, if
417 possible. For example, "foo" and "foo/bar" becomes "foo".
418 - date: Date. Returns a date in a Unix date format, including the
419 timezone: "Mon Sep 04 15:13:13 2006 0700".
420 - domain: Any text. Finds the first string that looks like an
421 email address, and extracts just the domain component. Example:
422 'User <user@example.com>' becomes 'example.com'.
423 - email: Any text. Extracts the first string that looks like an
424 email address. Example: 'User <user@example.com>' becomes
425 'user@example.com'.
426 - escape: Any text. Replaces the special XML/XHTML characters "&",
427 "<" and ">" with XML entities.
428 - fill68: Any text. Wraps the text to fit in 68 columns.
429 - fill76: Any text. Wraps the text to fit in 76 columns.
430 - firstline: Any text. Returns the first line of text.
431 - nonempty: Any text. Returns '(none)' if the string is empty.
432 - hgdate: Date. Returns the date as a pair of numbers: "1157407993
433 25200" (Unix timestamp, timezone offset).
434 - isodate: Date. Returns the date in ISO 8601 format.
435 - localdate: Date. Converts a date to local date.
436 - obfuscate: Any text. Returns the input text rendered as a
437 sequence of XML entities.
438 - person: Any text. Returns the text before an email address.
439 - rfc822date: Date. Returns a date using the same format used in
440 email headers.
441 - short: Changeset hash. Returns the short form of a changeset
442 hash, i.e. a 12-byte hexadecimal string.
443 - shortdate: Date. Returns a date like "2006-09-18".
444 - strip: Any text. Strips all leading and trailing whitespace.
445 - tabindent: Any text. Returns the text, with every line except
446 the first starting with a tab character.
447 - urlescape: Any text. Escapes all "special" characters. For
448 example, "foo bar" becomes "foo%20bar".
449 - user: Any text. Returns the user portion of an email address.
411 :addbreaks: Any text. Add an XHTML "<br />" tag before the end of
412 every line except the last.
413 :age: Date. Returns a human-readable date/time difference
414 between the given date/time and the current
415 date/time.
416 :basename: Any text. Treats the text as a path, and returns the
417 last component of the path after splitting by the
418 path separator (ignoring trailing separators). For
419 example, "foo/bar/baz" becomes "baz" and "foo/bar//"
420 becomes "bar".
421 :stripdir: Treat the text as path and strip a directory level,
422 if possible. For example, "foo" and "foo/bar" becomes
423 "foo".
424 :date: Date. Returns a date in a Unix date format, including
425 the timezone: "Mon Sep 04 15:13:13 2006 0700".
426 :domain: Any text. Finds the first string that looks like an
427 email address, and extracts just the domain
428 component. Example: 'User <user@example.com>' becomes
429 'example.com'.
430 :email: Any text. Extracts the first string that looks like
431 an email address. Example: 'User <user@example.com>'
432 becomes 'user@example.com'.
433 :escape: Any text. Replaces the special XML/XHTML characters
434 "&", "<" and ">" with XML entities.
435 :fill68: Any text. Wraps the text to fit in 68 columns.
436 :fill76: Any text. Wraps the text to fit in 76 columns.
437 :firstline: Any text. Returns the first line of text.
438 :nonempty: Any text. Returns '(none)' if the string is empty.
439 :hgdate: Date. Returns the date as a pair of numbers:
440 "1157407993 25200" (Unix timestamp, timezone offset).
441 :isodate: Date. Returns the date in ISO 8601 format.
442 :localdate: Date. Converts a date to local date.
443 :obfuscate: Any text. Returns the input text rendered as a
444 sequence of XML entities.
445 :person: Any text. Returns the text before an email address.
446 :rfc822date: Date. Returns a date using the same format used in
447 email headers.
448 :short: Changeset hash. Returns the short form of a changeset
449 hash, i.e. a 12-byte hexadecimal string.
450 :shortdate: Date. Returns a date like "2006-09-18".
451 :strip: Any text. Strips all leading and trailing whitespace.
452 :tabindent: Any text. Returns the text, with every line except
453 the first starting with a tab character.
454 :urlescape: Any text. Escapes all "special" characters. For
455 example, "foo bar" becomes "foo%20bar".
456 :user: Any text. Returns the user portion of an email
457 address.
450 458 ''')),
451 459
452 460 (['urls'], _('URL Paths'),
General Comments 0
You need to be logged in to leave comments. Login now