You are here: Fladi.at>System Web>TocPluginHelp (16 Apr 2010, WolfgangDenk)EditAttach
If you see tags such as %SECTION0% on the next line, read TocPlugin
This topic describes the facilities provided by the TOC Plugin
for the support of documentation generation. The extensions support
definition of an order among the topics in the web for the generation
of tables of contents, together with cross-references that operate
within, as well as between, topics.
Installation of the Plugin is straightforward. Simply unpack the tar
file at the top level of your installation.
The documentation extensions depend on the existance of a special
topic called WebOrder, which is is analagous to a Framemaker
"book". This topic should contain a list of the topics you want
included. This list must be formatted as a wiki-format bulleted list
e.g.
Following the TWiki standard, attributes are used to pass values to
tags to control their behaviour. Attributes are given as a list of
Supported attributes:
If a %SECTION0% tag occurs in a topic, the heading of that section will replace the topic name in the table of contents.
NOTES
Supported attributes:
Bad topic TocPluginHelp
Supported attributes: none
Any topic (but most usually the WebOrder topic) may include the
The following topics were not found in the WebOrder:
Bookmarks and references can be inserted into text using the ANCHOR
and REF tags. These can be used for references, for example, to tables
or figures.
NOTES
Supported attributes:
All the text between the anchor and the next end-of-line will be
used to create the anchor. If the anchor is invisible, this text will
be invisible too.
Supported attributes:
Supported attributes:
This will insert a table like this:
and
All topics listed in the WebOrder are scanned, but only anchors of the
requested type will be listed.
NOTES
When using the
It is possible to change the way the table of contents for the web is
ordered by using extra levels of indent in the WebOrder. If you indent
a topic below another topic, then that topic will be treated as a
section of the parent topic. Section numbers within the subtopic are
adjusted accordingly. For example, say the WebOrder contains
* PageOne * [[Page two]]Both
WikiWords
and [[Odd Wiki Words]] may be used to refer to topics.
NOTES - The WebOrder can contain any other TML or HTML formatting but it should be noted that all TML-format list bullets in the topic are taken as part of the ordering list.
name = value pairs enclosed in curly braces {} after the tag
name. For example:
%REF{type=Figure,topic="SpidersOfTheWorld",name="The Funnel Web"}%
NOTES - Attribute values that contain only no spaces or punctuation need not be quoted, but values containing punctuation or white space must be protected by double quotes. You are highly recommended to stick to values that don't require quoting! All attribute names and values are case sensitive.
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 - See also Bad REF: Current topic not in WebOrder for information about modifying section numbering from the WebOrder topic.
- Sections do not have to be named, but if they are not then they can only be referred to by knowing the exact section number. Section names must be unique within the topic.
- The only way to close a section is to start a new section with a different level, or to end the topic.
- You can still use standard HTML heading tags such as <H1>, but sections marked this way will not be included in the table of contents.
- The
nameattribute 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.
- The
topicattribute may be used to generate a table of contents for just one topic. - The
depthattribute 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
- Any topics that begin with the characters "Web" are special topics and are excluded from the list, though they can still be listed in the WebOrder and will appear in the table of contents.
- AccessControl
- AccessKeys
- ACRONYM
- ActionTrackerPluginQBE
- ActionTrackerPlugin
- AdminDocumentationCategory
- AdminSkillsAssumptions
- AdminToolsCategory
- AppendixCascadingStyleSheets
- AppendixEncodeURLsWithUTF8
- ApprovalPlugin
- AttachLinkPlugin
- AttachmentListPlugin
- AutoViewTemplatePlugin
- BeginnersStartHere
- BehaviourContrib
- BookmakerPlugin
- BookView
- BuildContrib
- BulkRegistration
- BulkResetPassword
- BumpyWord
- CalDAVPlugin
- ChangeEmailAddress
- ChangePassword
- ChecklistTablePlugin
- ClassMethod
- CommandAndCGIScripts
- CommentPluginTemplate
- CommentPlugin
- CompareRevisionsAddonPlugin
- CompareRevisionsAddOn
- CompleteDocumentation
- Contribs
- ContributedAddOns
- ContributorsPlugin
- CountryList
- DatabasePlugin
- DataForms
- DebugLogPlugin
- DefaultPreferencesForm
- DefaultPreferences
- DefaultUserRegistration
- DefaultWebStatistics
- DeveloperDocumentationCategory
- DevelopingPlugins
- DocumentGraphics
- DontNotify
- EasyTimelinePlugin
- EditingShorthand
- EditTablePlugin
- EmptyPlugin
- EnhancementRequests
- EventObject
- ExampleBook
- ExampleTopicTemplate
- ExtensionsRepositoryContrib
- FamFamFamContrib
- FamFamFamFlagIcons
- FamFamFamFoswikiExtras
- FamFamFamMiniIcons
- FamFamFamMintIcons
- FamFamFamSilkCompanion1Icons
- FamFamFamSilkCompanion2Icons
- FamFamFamSilkIcons
- FAQAnApplicationWithWikiForm
- FAQDeleteOrRenameAnAttachment
- FAQDeleteOrRenameATopic
- FAQDownloadSources
- FAQEditDoesNotIncreaseTheRevision
- FAQEditTemplate
- FAQForm
- FAQGnuGeneralPublicLicense
- FAQHiddenUsersAndGroups
- FAQRebuildingWikiUsersTopic
- FAQSearchDoesNotWork
- FAQSimultaneousEdits
- FAQTemplate
- FAQTroubleshootingExtensions
- FAQViewTemplate
- FAQWhatIsWikiWiki
- FAQWhyYouAreAskedToConfirm
- FastCGIEngineContrib
- FileAttachment
- FileAttribute
- FlexWebListExamples
- FlexWebListPlugin
- FlexWebListTree
- ForceNewRevision
- FormattedSearch
- FormatTokens
- FrequentlyAskedQuestions
- FrequentlyAskedQuestion
- FullCalendarEventTemplate
- FullCalendarPlugin
- FullCalendarViewTemplate
- GeoPlugin
- GlossaryOfTerms
- GluePlugin
- GoBox
- GoodStyle
- HiddenAttachment
- HierarchicalNavigationChildExample
- HierarchicalNavigation
- HijaxPluginTemplate
- HijaxPlugin
- HistoryPlugin
- HttpsRedirectPlugin
- IfDefinedPlugin
- IfStatements
- ImagePlugin
- ImmediateNotifyPlugin
- IncludeTopicsAndWebPages
- InstallationGuidePart1
- InstallationGuidePart2
- InstallationGuide
- InstalledPlugins
- InstantEnhancements
- InterwikiPlugin
- InterWikis
- JavascriptFiles
- JQueryAjaxHelper
- JQueryAutocomplete
- JQueryBgiframe
- JQueryBlockUI
- JQueryButton
- JQueryChili
- JQueryCodingStandards
- JQueryCookie
- JQueryCorner
- JQueryCycle
- JQueryDebug
- JQueryEasing
- JQueryEmpty
- JQueryFarbtastic
- JQueryFluidFont
- JQueryFocus
- JQueryForm
- JQueryFoswiki
- JQueryGradient
- JQueryHoverIntent
- JQueryInnerFade
- JQueryLiveQuery
- JQueryLoader
- JQueryLocalScroll
- JQueryMarkItUpEditor
- JQueryMaskedInput
- JQueryMasonry
- JQueryMedia
- JQueryMetadata
- JQueryPlaceholder
- JQueryPlugin
- JQueryPNotify
- JQueryPopUpWindow
- JQueryQueryObject
- JQueryQuickSearch
- JQueryRating
- JQueryScrollTo
- JQuerySerialScroll
- JQueryShake
- JQueryShrinkUrls
- JQuerySimpleModal
- JQuerySlimbox
- JQuerySuperfish
- JQuerySupersubs
- JQueryTabpane
- JQueryTextboxList
- JQueryThemeSwitcher
- JQueryTmpl
- JQueryTooltip
- JQueryTreeview
- JQueryUIAutocomplete
- JQueryUIDialog
- JQueryUI
- JQueryValidate
- JQueryWikiWord
- JSCalendarContribInline
- JSCalendarContrib
- JSTreeContrib
- LanguageSelector
- LatexIntro
- LatexModePlugin
- LatexSymbols2
- LatexSymbols3
- LatexSymbols4
- LatexSymbols5
- LatexSymbols
- LdapContrib
- LdapNgPlugin
- LdapUserViewTemplate
- LoginName
- MacrosQuickStart
- Macros
- MailerContribPlugin
- MailerContrib
- MainFeatures
- ManagingTopics
- ManagingUsers
- ManagingWebs
- MetaData
- MetroAreaToWidgetTheme
- ModPerlEngineContrib
- MonitoringLivestatusPlugin
- NewLdapUserTemplate
- NewUserPlugin
- NewUserTemplate
- ObjectMethod
- ObjectModules
- ObjectPluginQBE
- ObjectPlugin
- ObjectTemplate
- OriginalDocumentGraphics
- PageCaching
- PatternSkinColorSettings
- PatternSkinCssCookbookCenterPageBorder
- PatternSkinCssCookbookCenterPage
- PatternSkinCssCookbookEditTableStyle
- PatternSkinCssCookbookFonts
- PatternSkinCssCookbookNoLeftBar
- PatternSkinCssCookbookNoTopBar
- PatternSkinCssCookbookSidebarBackground
- PatternSkinCssCookbook
- PatternSkinCss
- PatternSkinCustomization
- PatternSkinElements
- PatternSkinGraphics
- PatternSkinHorizontalNavigationExample
- PatternSkinTheme2009
- PatternSkinThemeFatWillyNavigation
- PatternSkinThemeFatWilly
- PatternSkinTheme
- PatternSkin
- PatternSkinWebCreateNewTopicTemplate
- PerlDoc
- PlainSkin
- Plugins
- PreferenceSettings
- PreferencesPlugin
- PreviewBackground
- PrintSkin
- ProjectContributor
- ProjectLogos
- PublishedAPI
- QuerySearch
- QuietSave
- ReferenceManual
- RegularExpression
- ReleaseHistory
- ReleaseNotes01x00
- ReleaseNotes01x01
- RenameWeb
- RenderLdapUser
- RenderListPlugin
- ResetPassword
- RevisionLinkPlugin
- SearchHelp
- SearchPatternCookbook
- ShortcutMacros
- ShortHand
- SiteChanges
- SiteMap
- SitePermissions
- SiteToolStatistics
- SiteTools
- SkinBrowser
- Skins
- SkinTemplates
- SkinTemplateTokens
- SkinTemplateViewTemplate
- SlideShowPlugin
- SmiliesPlugin
- SpreadSheetPlugin
- StandardColors
- StaticMethod
- SubscribePlugin
- SyntaxHighlightingPlugin
- SystemRequirements
- TablePlugin
- TalkContrib
- TemplateTopics
- TemplateWeb
- TextEditor
- TextFormattingRules
- TimBernersLee
- TimeSpecifications
- TinyMCEFrequentlyAskedQuestions
- TinyMCEPlugin
- TinyMCEQuickHelp
- TipsContrib
- TipsOfTheDayAddNew
- TipsOfTheDayAdmin
- TipsOfTheDayInclude
- TipsOfTheDayTemplate
- TipsOfTheDay
- TipsTopics
- TipTopic001
- TipTopic002
- TipTopic003
- TipTopic004
- TipTopic005
- TipTopic006
- TipTopic007
- TipTopic008
- TipTopic009
- TipTopic010
- TipTopic011
- TipTopic012
- TipTopic013
- TipTopic014
- TipTopic015
- TipTopic016
- TipTopic017
- TipTopic018
- TipTopic019
- TipTopic020
- TipTopic021
- TipTopic022
- TipTopic023
- TipTopic024
- TipTopic025
- TipTopic026
- TipTopic027
- TipTopic028
- TipTopic029
- TocPluginHelp
- TopicClassification
- TopicDataHelperPlugin
- TopicDoesNotExistViewTemplate
- TopicsAndWebs
- TopicTranslationsPlugin
- TopicUserMappingContrib
- TreePluginBookviewOutlineSample
- TreePluginHeadingOutlineSample
- TreePluginSamples
- TreePlugin
- TwentyMinuteTutorial
- TWikiCompatibilityPlugin
- TwistyPlugin
- UpdateInfoPlugin
- UpgradeGuide
- UserAuthentication
- UserDocumentationCategory
- UserFormHelp
- UserForm
- UserInfoPlugin
- UserRegistration
- UserSetting
- UsersGuide
- UsersTemplate
- UserToolsCategory
- UsingHTML
- VarACTIVATEDPLUGINS
- VarADDTOHEAD
- VarADDTOZONE
- VarALLVARIABLES
- VarAQUA
- VarATTACHURLPATH
- VarATTACHURL
- VarAUTHREALM
- VarBASETOPIC
- VarBASEWEB
- VarBB2
- VarBB3
- VarBB4
- VarBB
- VarBLACK
- VarBLUE
- VarBROWN
- VarBR
- VarBULLET
- VarBUTTON
- VarCALC
- VarCARET
- VarCHECKLISTTABLE
- VarCOMMENT
- VarCONTRIBUTORS
- VarCOVER
- VarDATE
- VarDISPLAYTIME
- VarEDITACTION
- VarEDITTABLE
- VarENCODE
- VarENDCOLOR
- VarENDSECTION
- VarENDTABPANE
- VarENDTAB
- VarENDTWISTYTOGGLE
- VarENDTWISTY
- VarENV
- VarEXAMPLETAG
- VarEXPAND
- VarFAILEDPLUGINS
- VarFORMAT
- VarFORMFIELD
- VarGEO
- VarGMTIME
- VarGRAY
- VarGREEN
- VarGROUPINFO
- VarGROUPS
- VarHISTORY
- VarHOMETOPIC
- VarHTTPHOST
- VarHTTPS
- VarHTTP
- VarH
- VarICON
- VarICONURLPATH
- VarICONURL
- VarIF
- VarINCLUDE
- VarINCLUDINGTOPIC
- VarINCLUDINGWEB
- VarI
- VarJQICONPATH
- VarJQICON
- VarJQPLUGINS
- VarJQREQUIRE
- VarJQTHEME
- VarLANG
- VarLANGUAGES
- VarLANGUAGE
- VarLIME
- VarLOCALSITEPREFS
- VarLOGIN
- VarLOGOUT
- VarMAINWEB
- VarMAKETEXT
- VarMAROON
- VarMETASEARCH
- VarMETA
- VarM
- VarNAVY
- VarNOP
- VarNOTIFYTOPIC
- VarN
- VarOLIVE
- VarORANGE
- VarPINK
- VarPLUGINDESCRIPTIONS
- VarPLUGINVERSION
- VarPOPUPWINDOW
- VarP
- VarPUBURLPATH
- VarPUBURL
- VarPURPLE
- VarQ
- VarQUERYPARAMS
- VarQUERYSTRING
- VarQUERY
- VarRED
- VarREMOTEADDR
- VarREMOTE_IP_ADDRESS
- VarREMOTEPORT
- VarREMOTEUSER
- VarRENDERLIST
- VarRENDERZONE
- VarREVARG
- VarREVINFO
- VarREVTITLE
- VarSCRIPTNAME
- VarSCRIPTSUFFIX
- VarSCRIPTURLPATH
- VarSCRIPTURL
- VarSEARCHLOG
- VarSEARCH
- VarSERVERTIME
- VarSESSIONID
- VarSESSIONVARIABLE
- VarSESSIONVAR
- VarSHOWPREFERENCE
- VarSILVER
- VarSKIN
- VarSLIDESHOWEND
- VarSLIDESHOWSTART
- VarSPACEDTOPIC
- VarSPACEOUT
- VarSTARTINCLUDE
- VarSTARTSECTION
- VarSTATISTICSTOPIC
- VarSTOPINCLUDE
- VarS
- VarSUBSCRIBE
- VarSYSTEMWEB
- VarTABLE
- VarTABPANE
- VarTAB
- VarTEAL
- VarTOC
- VarTOPICLIST
- VarTOPIC
- VarTOPICURL
- VarT
- VarTWIKIWEB
- VarTWISTYBUTTON
- VarTWISTYHIDE
- VarTWISTYSHOW
- VarTWISTYTOGGLE
- VarTWISTY
- VarURLPARAM
- VarUSERINFO
- VarUSERNAME
- VarUSERSWEB
- VarU
- VarVAR
- VarVBAR
- VarWEBLIST
- VarWEBPREFSTOPIC
- VarWEB
- VarWHITE
- VarWIKIHOMEURL
- VarWIKINAME
- VarWIKIPREFSTOPIC
- VarWIKITOOLNAME
- VarWIKIUSERNAME
- VarWIKIUSERSTOPIC
- VarWIKIVERSION
- VarWIKIWEBMASTERNAME
- VarWIKIWEBMASTER
- VarX
- VarYELLOW
- VarY
- WabiSabi
- WelcomeGuest
- WikiCulture
- WikiName
- WikiNotation
- WikiReferences
- WikiSyntaxSummary
- WikiSyntax
- WikiWikiClones
- WikiWord
- WysiwygPluginSettings
- WysiwygPluginTopicLister
- WysiwygPlugin
- YouAreHere
- ZonePlugin
- Anchors and references only work within the current web; they cannot be used to create references between webs.
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 |
|---|
- If you use
REFTABLEwith the typeSectionthe 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.
- Include a %TOCCHECK% tag at the end of the table of contents topic.
- Name all sections. This makes it easier to refer to them by symbolic names rather than trying to REF numbered sections.
Edit | Attach | Print version | History: r1 | Backlinks | View wiki text | More topic actions
Topic revision: 16 Apr 2010, WolfgangDenk
- Toolbox
-
Users
-
Groups
-
Index
-
Search
-
Changes
-
Notifications
-
RSS Feed
-
Statistics
-
Preferences
- User Reference
- BeginnersStartHere
- TextFormattingRules
- Macros
- FormattedSearch
- QuerySearch
- DocumentGraphics
- SkinBrowser
- InstalledPlugins
Campus02 |
|
Copyright © by the contributing authors. All material on this site is the property of the contributing authors. Ideas, requests, problems regarding Fladi.at? Send feedback