Changes between Version 28 and Version 29 of MarkupTemplates

Timestamp:

Aug 18, 2006, 6:35:56 PM (18 years ago)

Author:

cmlenz

Comment:

Documentation for template comments

MarkupTemplates

@@ -492 +492 @@
               py:for="name in ('foo', 'bar', 'baz')" />
 }}}
+
+== Comments ==
+
+Normal XML/HTML comment syntax can be used in templates:
+
+{{{
+#!xml
+<!-- this is a comment -->
+}}}
+
+However, such comments get passed through the processing pipeline and are by default included in the final output. If that's not desired, prefix the comment text with an exclamation mark:
+
+{{{
+#!xml
+<!-- !this is a comment too, but one that will be stripped from the output -->
+}}}
+
+Note that it does not matter whether there's whitespace before or after the exclamation mark, so the above could also be written as follows:
+
+{{{
+#!xml
+<!--! this is a comment too, but one that will be stripped from the output -->
+}}}
+
 ----
 See also: MarkupGuide, MarkupRecipes