# HG changeset patch
# User Christian Ebert <blacktrash@gmx.net>
# Date 1169250931 -3600
# Node ID 09847a7eb5d73773ec7b89b4127cc37f4801b0dc
# Parent  3412cbc772751298e2f483c2893523a2c8e3b0dc
Describe substitution mechanism in doc

diff -r 3412cbc77275 -r 09847a7eb5d7 hgkw/keyword.py
--- a/hgkw/keyword.py	Sat Jan 20 00:54:03 2007 +0100
+++ b/hgkw/keyword.py	Sat Jan 20 00:55:31 2007 +0100
@@ -14,14 +14,18 @@
 For in-depth discussion refer to
 <http://www.selenic.com/mercurial/wiki/index.cgi/KeywordPlan>.
 
-You can either use the default cvs-like keywords or provide your
-own in hgrc.
+Keywords are only expanded in local repositories and not logged by
+Mercurial internally. The mechanism can be regarded as a convenience
+for the current user and may be turned off anytime.
 
-It is recommended to enable this extension on a per-repo basis only.
-You can still configure keywordmaps globally.
+Substitution takes place on every commit and update of the working
+repository.
 
-Expansions spanning more than one line are truncated to their first line.
-Incremental expansion (like CVS' $Log$) is not supported.
+Keyword expansion is based on Mercurial's changeset template mappings.
+The extension provides an additional UTC-date filter.
+
+The user has the choice either to create his own keywords and their
+expansions or to use the CVS-like default ones.
 
 Default $keywords$ and their $keyword: substition $ are:
     Revision: changeset id
@@ -32,10 +36,13 @@
     Id:       basename,v csetid %Y/%m/%d %H:%M:%S username
     Header:   /path/to/basename,v csetid %Y/%m/%d %H:%M:%S username
 
+Expansions spanning more than one line are truncated to their first line.
+Incremental expansion (like CVS' $Log$) is not supported.
+
 Simple setup in hgrc:
 
     # enable extension
-    hgext.keyword = /full/path/to/script
+    keyword = /full/path/to/keyword.py
     # or, if script in hgext folder:
     # hgext.keyword =