[Checkins] SVN: Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt Further README update.

Uli Fouquet uli at gnufix.de
Sun Jan 6 10:45:49 EST 2008


Log message for revision 82690:
  Further README update.

Changed:
  U   Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt

-=-
Modified: Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt
===================================================================
--- Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt	2008-01-06 15:28:39 UTC (rev 82689)
+++ Sandbox/ulif/grok-reference-with-rest2/doc/grokref/README.txt	2008-01-06 15:45:49 UTC (rev 82690)
@@ -73,6 +73,26 @@
 to better describe the things you describe:
 
 
+Additional value substitutions:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following keys can be used in reference documents by enclosing
+them in pipe characters (`|`). They will be substituted by values
+defined in the ``ReferenceProducer``.
+
+* ``version``:
+
+  The version of grok that is documented.
+
+* ``release``:
+
+  The release that is documented.
+
+* ``today``:
+
+  The date of today.
+
+
 Additional directives:
 ~~~~~~~~~~~~~~~~~~~~~~
 



More information about the Checkins mailing list