]> granicus.if.org Git - apache/commitdiff
Adds examples to the various <!--#config attributes.
authorRich Bowen <rbowen@apache.org>
Wed, 16 Jan 2013 01:43:26 +0000 (01:43 +0000)
committerRich Bowen <rbowen@apache.org>
Wed, 16 Jan 2013 01:43:26 +0000 (01:43 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1433789 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/mod/mod_include.xml

index f82c28494d98034ae1823e59164f143e249c7c57..9d9203d5ee07f2407c9f645df5b8abe415f6ab94 100644 (file)
@@ -140,28 +140,50 @@ AddOutputFilter INCLUDES .shtml
 
       <dl>
       <dt><code>echomsg</code> (<em>Apache 2.1 and later</em>)</dt>
-      <dd>The value is a message that is sent back to the
+      <dd><p>The value is a message that is sent back to the
       client if the <code><a href="#element.echo">echo</a></code> element
       attempts to echo an undefined variable. This overrides any <directive
-      module="mod_include">SSIUndefinedEcho</directive> directives.</dd>
+      module="mod_include">SSIUndefinedEcho</directive> directives.</p>
+
+      <example>
+        &lt;!--#config errmsg="[Value Undefined]" --&gt;
+      </example>
+      </dd>
 
       <dt><code>errmsg</code></dt>
-      <dd>The value is a message that is sent back to the
+      <dd><p>The value is a message that is sent back to the
       client if an error occurs while parsing the
       document. This overrides any <directive
-      module="mod_include">SSIErrorMsg</directive> directives.</dd>
+      module="mod_include">SSIErrorMsg</directive> directives.</p>
+     
+      <example>
+       &lt;!--#config errmsg="[Oops, something broke.]" --&gt;
+      </example>
+      </dd>
 
       <dt><code>sizefmt</code></dt>
-      <dd>The value sets the format to be used when displaying
+      <dd><p>The value sets the format to be used when displaying
       the size of a file. Valid values are <code>bytes</code>
       for a count in bytes, or <code>abbrev</code> for a count
       in Kb or Mb as appropriate, for example a size of 1024 bytes
-      will be printed as "1K".</dd>
+      will be printed as "1K".</p>
+      
+      <example>
+      &lt;!--#config sizefmt="abbrev" --&gt;
+      </example>
+      
+      </dd>
 
       <dt><code>timefmt</code></dt>
-      <dd>The value is a string to be used by the
+      <dd><p>The value is a string to be used by the
       <code>strftime(3)</code> library routine when printing
-      dates.</dd>
+      dates.</p>
+      
+      <example
+      &lt;!--#config timefmt=""%R, %B %d, %Y"" --&gt;
+      </example>
+      
+      </dd>
       </dl>
     </section> <!-- /config -->