Author: mnodine
Date: 2010-03-01 22:15:22 +0100 (Mon, 01 Mar 2010)
New Revision: 6249
Modified:
trunk/prest/doc/src/roles.rst
Log:
* Document the substitution-reference role.
Modified: trunk/prest/doc/src/roles.rst
===================================================================
--- trunk/prest/doc/src/roles.rst 2010-03-01 20:59:57 UTC (rev 6248)
+++ trunk/prest/doc/src/roles.rst 2010-03-01 21:15:22 UTC (rev 6249)
@@ -350,6 +350,24 @@
There is another :target:`target <ghi>` with the same physical text,
but which I can refer to as ghi_.
+``:substitution-reference:``
+============================
+
+:Aliases: None
+:DTD Element: substitution_reference
+:Customization:
+ :Options: class_.
+ :Content: None.
+
+The ``:substitution-reference:`` role creates a reference to a
+substitution definition, with which it is substituted.
+entered into the symbol table of targets. For example, ::
+
+ .. |mydef| replace:: a substitution definition
+
+ Now we can reference `mydef`:substitution-reference: using a
+ substitution-reference role.
+
--------------
Plug-in Roles
--------------
|