* PageOne * [[Page two]]Both
WikiWords
and [[Odd Wiki Words]] may be used to refer to topics.
NOTES name = value pairs enclosed in curly braces {} after the tag
name. For example:
%REF{type=Figure,topic="SpidersOfTheWorld",name="The Funnel Web"}%
NOTES name Subsections may be inserted in any topic using the
SECTIONn tag,
where n is the required subsection level. The heading of the section
is taken as all text after the tag up to the end of line. For example,
the heading at the top of this section is marked with
%SECTION1{name=SECTION}% Creating sections using the =SECTION= tag
NOTES name attribute cannot be used to refer to a %SECTION0% tag.
depth topic
You can build a table of contents by inserting
%CONTENTS%in a topic. The first level of the table of contents is normally the topics in the order of the list in WebOrder, though see Bad REF: Current topic not in WebOrder for information about modifying section numbering from the WebOrder topic. Subsections listed in the table are automatically linked to the target
SECTION.
topic attribute may be used to generate a table of contents for just one topic.
depth attribute may be used to set the maximum number of levels to generate.
%TOCCHECK%tag. This causes the entries in the WebOrder topic to be cross-referenced against the files actually stored in the web (see WebIndex). Any topics which exist as files in the web but are missing from the WebOrder will be listed. NOTES
type name display
The ANCHOR tag creates a jump target suitable for jumping to from
somewhere else. The type adds the anchor to a "group"; this group is
required when generating a reference to the anchor, and may be used to
generate tables of same-type anchors (see
Bad REF: Current topic not in WebOrder below). The type can be any name,
though convention suggests the use of types such as Figure and
Table. The special group Section is used internally to refer to
sections and subsections. Avoid using it for an ANCHOR or you may
see strange results.
The ANCHOR tag is normally visible in the output, though it may be
made invisible by setting the display attribute to no . For
example: %ANCHOR{type=Figure,name=A,display=no}% Here be sea
monsters will generate an invisible anchor on the text (there's
one one the line above, honest!) and
<A name="#Figure_A"> </A>
%ANCHOR{type=Table,name=A}% A wooden table
will generate:
type topic name
The REF tag may be used to refer to an anchor. Anchors are
automatically inserted by SECTION tags or may be added using the
ANCHOR tag. For a REF tag to work, the type of the target must be
known. For example:
See %REF{type=Example,name=WebOrder}% for more information about WebOrder
will generate:
See Bad REF: Current topic not in WebOrder for more information about WebOrder
To refer to anchors in a different topic, use the topic attribute.
You can refer to sections by name by using the special type Section
e.g. %REF{type=Section,name=TOCCHECK}%.
If you refer to a non-existant anchor you are warned: for example,
%REF{type=Reference,name=NonExistantAnchor}%generatesBad REF: Current topic not in WebOrder
type
The REFTABLE tag can be used to build tables of references based on
the type assigned to anchors. For example, if you have a lot of
anchors of type Example you can build a table of all these anchors
thus:
%REFTABLE{type=Example}%
| Example |
|---|
%REFTABLE{type=Figure}%
will insert a table like this:
| Figure |
|---|
REFTABLE with the type Section the table will contain a list of all named sections. For example WebOrder special topic to collect a list of topics
into a somewhat "linearized" form (a "book"), it is often very
convenient to be able to add navigation buttons to the previous and
the next pages as well as to the home page (table of contents). This
can be done by adding the %TOCBUTTONS% tag to your pages. For
example, you can use it in a template which is included either at the
top or the bottom of your pages. The included
"view.tocbuttons.tmpl" template (intended to be used with NatSkin)
adds the %TOCBUTTONS% tag to the content footer of all pages in
the web. To activate it, use "* set SKIN = tocbuttons, nat" in your
WebPreferences.
Note that the "Prev", "Home" and "Next" links will be added only for
such topics that are listed in the WebOrder special topic, and they
will only be inserted when viewing a page, i. e. they will for
example not show up when printing such a topic or the whole "book".
* [[Top level topic]] * AnotherTopLevelTopicTopLevelTopic will be numbered 1., and the first
SECTION1 within TopLevelTopic will be 1.1. AnotherTopLevelTopic will be numbered 2. If, instead, WebOrder contains
* [[Top level topic]] * [[Second level topic]] * AnotherTopLevelTopicTopLevelTopic will still be numbered 1., but now SecondLevelTopic will be numbered 1.1., and the first
SECTION1 within SecondLevelTopic will be 1.1.1. The first SECTION1 within
TopLevelTopic will now be numbered 1.2. AnotherTopLevelTopic will still be numbered 2.