diff options
| author | Peter Thoeny <web-hurd@gnu.org> | 2001-03-02 02:05:13 +0000 |
|---|---|---|
| committer | Peter Thoeny <web-hurd@gnu.org> | 2001-03-02 02:05:13 +0000 |
| commit | 3422f664120283c5adb065921180490586693f2c (patch) | |
| tree | 3305c2b33d61c542962cf9794e56593da29677d8 /TWiki/TWikiVariables.mdwn | |
| parent | c2639e7f25349408fc70c195cc8df20fd8de0aa3 (diff) | |
none
Diffstat (limited to 'TWiki/TWikiVariables.mdwn')
| -rw-r--r-- | TWiki/TWikiVariables.mdwn | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/TWiki/TWikiVariables.mdwn b/TWiki/TWikiVariables.mdwn index 5f988f90..a089e12e 100644 --- a/TWiki/TWikiVariables.mdwn +++ b/TWiki/TWikiVariables.mdwn @@ -172,6 +172,30 @@ <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>%<nop>STOPINCLUDE%</nop></code> variable itself. </td> </tr> <tr> + <td><code>%<nop>TOC%</nop></code></td> + <td> Table of Content of current topic. </td> + </tr> + <tr> + <td><code>%<nop>TOC{"SomeTopic" ...}%</nop></code></td> + <td> Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in <span style="background:"><font color="">Wiki Syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a> (<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="1" 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>%<nop>TOC{depth="2"}%</nop></b></code>, <code><b>%<nop>TOC{"TWikiDocumentation" web="%TWIKIWEB%"}%</nop></b></code></td> + </tr> + <tr> <td><code>%<nop>SEARCH{"str" ...}%</nop></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="1" 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: * <code>Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif</code> --- %MAINWEB%.PeterThoeny - 19 Jan 2001 <br /> +-- %MAINWEB%.PeterThoeny - 01 Mar 2001 <br /> |