none
authorPeterThoeny <PeterThoeny>
Fri, 2 Mar 2001 02:05:13 +0000 (02:05 +0000)
committerPeterThoeny <PeterThoeny>
Fri, 2 Mar 2001 02:05:13 +0000 (02:05 +0000)
TWiki/TWikiVariables.mdwn
TWiki/TextFormattingRules.mdwn

index 7f78355..4e0d981 100644 (file)
@@ -83,7 +83,7 @@
   </tr>
   <tr>
     <td><code>%GMTIME%</code></td>
-    <td> GM time, is <b>29 Jun 2010 - 15:25</b></td>
+    <td> GM time, is <b>29 Jun 2010 - 15:26</b></td>
   </tr>
   <tr>
     <td><code>%GMTIME{"format"}%</code></td>
           <td> 2 digit year </td>
           <td> 99 </td>
         </tr>
-      </table> Variables can be shortened to 3 characters. Example: <br /><code>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</code> is <br /><b>29 Jun, 2010 - 15:25:46</b></td>
+      </table> Variables can be shortened to 3 characters. Example: <br /><code>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</code> is <br /><b>29 Jun, 2010 - 15:26:06</b></td>
   </tr>
   <tr>
     <td><code>%SERVERTIME%</code></td>
-    <td> Server time, is <b>29 Jun 2010 - 11:25</b></td>
+    <td> Server time, is <b>29 Jun 2010 - 11:26</b></td>
   </tr>
   <tr>
     <td><code>%SERVERTIME{"format"}%</code></td>
-    <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:25</b></td>
+    <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:26</b></td>
   </tr>
   <tr>
     <td><code>%HTTP_HOST%</code></td>
     <td> If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the <code>%STOPINCLUDE%</code> variable itself. </td>
   </tr>
   <tr>
+    <td><code>%TOC%</code></td>
+    <td> Table of Content of current topic. </td>
+  </tr>
+  <tr>
+    <td><code>%TOC{"SomeTopic" ...}%</code></td>
+    <td> Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in [[Main/WikiSyntax]] (<code>"---++ text"</code>) and HTML (<code>"&lt;h2&gt;text&lt;h2&gt;"</code>) are taken into account. Parameter is composed of the topic name, followed by optional <code>name="value"</code> pairs: <table border="1" cellpadding="0" cellspacing="0">
+        <tr>
+          <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
+          <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+          <th bgcolor="#99CCCC"><strong> Default: </strong></th>
+        </tr>
+        <tr>
+          <td><code>web="Name"</code></td>
+          <td> Name of web </td>
+          <td> Current web </td>
+        </tr>
+        <tr>
+          <td><code>depth="2"</code></td>
+          <td> Limit depth of headings shown in TOC </td>
+          <td> 6 </td>
+        </tr>
+      </table> Examples: <code><b>%TOC{depth="2"}%</b></code>, <code><b>%TOC{"TWikiDocumentation" web="TWiki"}%</b></code></td>
+  </tr>
+  <tr>
     <td><code>%SEARCH{"str" ...}%</code></td>
     <td> Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional <code>name="value"</code> pairs: <table border="1" cellpadding="0" cellspacing="0">
         <tr>
@@ -365,4 +389,4 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in
 - Additional preferences variables can be defined on all three level as needed. Example:
   - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
 
--- [[PeterThoeny]] - 19 Jan 2001 <br />
+-- [[PeterThoeny]] - 01 Mar 2001 <br />
index 29979e6..f0dfc62 100644 (file)
@@ -33,6 +33,20 @@ The %WIKITOOLNAME% web has the following types of **_internal links:_**
     </td>
   </tr>
   <tr>
+    <td valign="top"><strong>Headings:</strong><br /> At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. <strong><em>Note:</em></strong> A Table of Content can be created automatically with the <code>%TOC%</code> variable, see [[Main/TWikiVariables]]. </td>
+    <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+---++ Sushi
+
+---+++ Maguro
+</pre> </font></span></td>
+    <td valign="top">
+      <h2><a name="Sushi"></a> Sushi </h2>
+      <p>
+      </p>
+      <h3><a name="Maguro"></a> Maguro </h3>
+    </td>
+  </tr>
+  <tr>
     <td valign="top"><strong>Bold Text:</strong><br /> Words get <strong>bold</strong> by enclosing them in <code>*</code> asterisks. </td>
     <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
 *Bold*
@@ -95,7 +109,7 @@ class CatAnimal {
 </pre></td>
   </tr>
   <tr>
-    <td valign="top"><strong>Separator:</strong><br /> At least four dashes at the beginning of a line. </td>
+    <td valign="top"><strong>Separator:</strong><br /> At least three dashes at the beginning of a line. </td>
     <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
 -------
 </pre> </font></span></td>
@@ -205,26 +219,26 @@ Know.ReadmeFirst
     </td>
   </tr>
   <tr>
-    <td valign="top"><strong>Specific Links:</strong><br /> Create a link where you can specify the link text and the link reference separately, using nested square brackets like <code>[[text][reference]]</code>. Internal link references (i.e. [[Main/WikiSyntax]]) and external link references (i.e. <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a>) are supported. The same <strong><em>Forced Links</em></strong> rules apply for internal link references. Anchor names can be added as well, like <code>[[go home][WebHome@MyAnchor]]</code> and <code>[[Yahoo!][http://www.yahoo.com/#somewhere]]</code>. </td>
+    <td valign="top"><strong>Specific Links:</strong><br /> Create a link where you can specify the link text and the link reference separately, using nested square brackets like <code>[[reference][text]]</code>. Internal link references (i.e. [[Main/WikiSyntax]]) and external link references (i.e. <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a>) are supported. The same <strong><em>Forced Links</em></strong> rules apply for internal link references. Anchor names can be added as well, like <code>[[WebHome#MyAnchor][go home]]</code> and <code>[[http://www.yahoo.com/#somewhere][Yahoo!]]</code>. </td>
     <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
-[[syntax][WikiSyntax]]
+[[WikiSyntax][syntax]]
 
-[[GNU][http://gnu.org]]
+[[http://gnu.org][GNU]]
 </pre> </font></span></td>
-    <td valign="top">[[Main/Syntax]]<p>[[Main/GNU]]</p>
+    <td valign="top">[[Main/WikiSyntax]]<p><a href="http://gnu.org" target="_top">GNU</a></p>
     </td>
   </tr>
   <tr>
-    <td valign="top"><strong>Anchors:</strong><br /> You can define a link reference inside a %WIKITOOLNAME% topic (called an anchor name) and link to that. To <strong><em>define</em></strong> an anchor write <code>@AnchorName</code> at the beginning of a line. The anchor name must be a [[Main/WikiWord]]. To <strong><em>link to</em></strong> an anchor name use the <code>[[MyTopic@MyAnchor]]</code> syntax. You can omit the topic name if you want to link within the same topic. </td>
+    <td valign="top"><strong>Anchors:</strong><br /> You can define a link reference inside a %WIKITOOLNAME% topic (called an anchor name) and link to that. To <strong><em>define</em></strong> an anchor write <code>#AnchorName</code> at the beginning of a line. The anchor name must be a [[Main/WikiWord]]. To <strong><em>link to</em></strong> an anchor name use the <code>[[MyTopic#MyAnchor]]</code> syntax. You can omit the topic name if you want to link within the same topic. </td>
     <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
-[[WebHome@NotThere]]
+[[WebHome#NotThere]]
 
-[[Jump][@MyAnchor]]
+[[#MyAnchor][Jump]]
 
-@MyAnchor To here
+#MyAnchor To here
 </pre> </font></span></td>
-    <td valign="top">[[Main/WebHomeNotThere]]<p>[[Main/Jump]]</p>
-      <p> @MyAnchor To here </p>
+    <td valign="top">[[Main/WebHome#NotThere]]<p>[[Main/WebHome#MyAnchor]]</p>
+      <p><a name="MyAnchor"></a> To here </p>
     </td>
   </tr>
   <tr>