Difference between revisions of "Help:Contents"

From WikiManual
Jump to: navigation, search
m (Placing Comments in the Edit Window)
m (Wiki Code)
Line 50: Line 50:
 
  using <!-- and --> one can place comments in the edit window which will not be visible on the page.
 
  using <!-- and --> one can place comments in the edit window which will not be visible on the page.
 
  like so: <!-- place any comments/code examples/reminders here -->
 
  like so: <!-- place any comments/code examples/reminders here -->
 +
</pre>
 +
 +
===Table of contents (TOC)===
 +
 +
For each article with more than three headings, a '''table of contents (TOC)''' is automatically generated from the section headings, unless:
 +
*(for a user) preferences are set to turn it off
 +
*(for an article) in the edit box the code <tt><nowiki>__NOTOC__</nowiki></tt> is added
 +
 +
The TOC is put before the first section header unless it is placed manually with the code <tt><nowiki>__TOC__</nowiki></tt>.
 +
Thus there may be some introductory text before it, known as the "lead".
 +
 +
<pre>
 +
__NOTOC__ disables Table of Contents on those short pages which may not require it.
 +
__TOC__ will manually place the TOC
 
</pre>
 
</pre>

Revision as of 01:34, 15 October 2005

Wiki Code

This took me a bit to figure out.

all code simply starts with a space at the start of the line


Here's another way:
Use <pre> and </pre> to bracket your code.
This precludes one having to enter a space at the beginning of every line.
An example:

A handy method for eventually unfixing the stuck bot is:

'will normally unfix bot by restoring .fixpos to zero
'typically I place this in most bots to prevent possible attack and accidental fixing
cond
start
.fixpos *.fixed mult dec
stop

This will also disable any HTML code/tags within the 'box'
allowing one to list them as instructions without activating the tag.
example:

 <b><i><u> have no effect within the <nowiki><pre>
tags.</nowiki> </pre>


Indenting

One may indent using one or more colons at the beginning of a line ...
So this:

:this is one colon
::two
:::three ... etc.

results in:

this is one colon
two
three ... etc.

this also precludes having to place <br> at the end of a line to break it.


Placing Comments in the Edit Window

 
 using <!-- and --> one can place comments in the edit window which will not be visible on the page.
 like so: <!-- place any comments/code examples/reminders here -->

Table of contents (TOC)

For each article with more than three headings, a table of contents (TOC) is automatically generated from the section headings, unless:

  • (for a user) preferences are set to turn it off
  • (for an article) in the edit box the code __NOTOC__ is added

The TOC is put before the first section header unless it is placed manually with the code __TOC__. Thus there may be some introductory text before it, known as the "lead".

__NOTOC__ disables Table of Contents on those short pages which may not require it.
__TOC__ will manually place the TOC