Diff for "TemplateFilters"

Differences between revisions 1 and 3 (spanning 2 versions)

Create a custom filter

Objective

This page shows you how to create a custom filter. For that, we are going to write a python script, and add it as an extension.

Our filter will convert the text passed to it to uppercase.

Write script

First step, write the script and save it somewhere.

   1 from mercurial import templatefilters
   2 
   3 def upper(s):
   4     return s.upper()
   5 
   6 def extsetup(ui):
   7     templatefilters.filters["upper"] = upper

Add Extension

In mercurial.ini, add this script under the [extensions] section.

[extensions]
upper = ~/.hgext/myfeature.py

(if this doesn't work, see Using Mercurial Extensions for help on configuring extensions)

Example

>hg tip --template "{author|upper}\n"
GUIDO VAN ROSSUM <BDFL@PYTHON.ORG>

-  ⇤ ← Revision 1 as of 2011-08-24 11:50:16 → 
  Size: 943
  Editor: medusa
  Comment:
+   ← Revision 3 as of 2011-08-24 11:51:54 → ⇥
  Size: 905
  Editor: medusa
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 2:
-##master-date:Unknown-Date
-Line 6:
+Line 5:
-Line 8:
+Line 6:
-This page shows you how to create a custom filter.
For that, we are going to write a python script, and add it as an extension.
+This page shows you how to create a custom filter. For that, we are going to write a python script, and add it as an extension.
-Line 14:
+Line 11:
-Line 26:
+Line 22:
-Line 37:
+Line 32:
-Line 41:
+Line 35:
 }}}