Daya Bay Reactor Neutrino Experiment TWiki > TocPluginHelp Daya Bay webs:
Public | 中文 | Internal | Help

Log In or Register
If you see tags such as %SECTION0% on the next line, read TocPlugin

1. Table of Contents and Cross-Reference Plugin

This topic describes the facilities provided by the TOC TWiki 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.

1.1. Installation and Configuration

Installation of the Plugin is straightforward. Simply unpack the tar file at the top level of your TWiki installation.

1.1.1. The WebOrder special topic

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 TWiki-format bulleted list e.g.
   * PageOne
   * [[Page two]]
Both WikiWords and [[Odd Wiki Words]] may be used to refer to topics.

NOTES

1.2. Attributes on documentation tags

Following the TWiki standard, attributes are used to pass values to tags to control their behaviour. Attributes are given as a list of name = value pairs enclosed in curly braces {} after the tag name. For example:
%REF{type=Figure,topic="SpidersOfTheWorld",name="The Funnel Web"}%

NOTES

1.3. Sections and Tables of Contents

1.3.1. Creating sections using the SECTION tag

Supported attributes: 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

1.3.1.1. The %SECTION0% tag

If a %SECTION0% tag occurs in a topic, the heading of that section will replace the topic name in the table of contents.

NOTES

1.3.2. Building the table of contents; the %TOC% tag

Supported attributes: 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 1.5. Getting clever for information about modifying section numbering from the WebOrder topic. Subsections listed in the table are automatically linked to the target SECTION.

1.3.2.1. Output from %CONTENTS{depth=2}% tag for this web

1.3.2.1.A Table of contents for this web

1.3.2.2. Output from %CONTENTS% tag for this topic

1.3.2.2.A Table of contents for this topic

1.3.3. The TOCCHECK tag

Supported attributes: none

Any topic (but most usually the WebOrder topic) may include the

%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

1.3.3.1. Output from the %TOCCHECK% tag for this web

The following topics were not found in the WebOrder:
  1. ATasteOfTWiki
  2. AccessKeys
  3. AdminDocumentationCategory
  4. AdminSkillsAssumptions
  5. AdminToolsCategory
  6. AdministrationVariables
  7. AllowWebCreateByUserMappingManager
  8. AnApplicationWithWikiForm
  9. AppendixEncodeURLsWithUTF8
  10. ApplicationsAndComponentsVariables
  11. AttachmentsAndFilesVariables
  12. AutonomousWebs
  13. BackupRestoreConsole
  14. BackupRestorePlugin
  15. BehaviourContrib
  16. BookView
  17. BulkRegistration
  18. BulkResetPassword
  19. BumpyWord
  20. CalendarPlugin
  21. CategoryCategory
  22. ChangeEmailAddress
  23. ChangePassword
  24. ChartingAndDrawingVariables
  25. ClassMethod
  26. ClassicSkin
  27. ColorPickerPlugin
  28. CommentPlugin
  29. CommentPluginExamples
  30. CommentPluginTemplate
  31. CopyingTopics
  32. CustomUserGroupNotations
  33. DatabaseAndFormsVariables
  34. DatabasePlugin
  35. DateAndTimeVariables
  36. DatePickerPlugin
  37. DeleteOrRenameATopic
  38. DeleteOrRenameAnAttachment
  39. DeveloperDocumentationCategory
  40. DevelopmentVariables
  41. DontNotify
  42. EditDoesNotIncreaseTheRevision
  43. EditTablePlugin
  44. EditUserAccount
  45. EditingAndContentUpdateVariables
  46. EmailAndNotificationVariables
  47. EmptyPlugin
  48. ExampleTopicTemplate
  49. ExcelImportExportPlugin
  50. ExplicitNumberingPlugin
  51. ExportAndPublishingVariables
  52. ExternalLinkPlugin
  53. FileAttachment
  54. FileAttribute
  55. FilterPlugin
  56. FlexWebListExamples
  57. FlexWebListNavi
  58. FlexWebListPlugin
  59. FlexWebListTree
  60. ForceNewRevision
  61. FormPlugin
  62. FormatTokens
  63. FormattedSearch
  64. FormattingAndRenderingVariables
  65. GenPDFAddOn
  66. GenPDFExampleHeaderFooterTopic
  67. GenPDFExampleTitleTopic
  68. GluePlugin
  69. GnuGeneralPublicLicense
  70. GoodStyle
  71. HeadlinesPlugin
  72. HiddenAttachment
  73. HierarchicalNavigation
  74. HierarchicalNavigationChildExample
  75. IfStatements
  76. ImportVariables
  77. IncludeTopicRaw
  78. IncludeTopicsAndWebPages
  79. InstalledPlugins
  80. InstantEnhancements
  81. InterWikis
  82. InterwikiPlugin
  83. JQueryPlugin
  84. JSCalendarContrib
  85. JSCalendarContribInline
  86. JumpBox
  87. LanguageSelector
  88. LargeSite
  89. LatexIntro
  90. LatexModePlugin
  91. LatexSymbols
  92. LatexSymbols2
  93. LatexSymbols3
  94. LatexSymbols4
  95. LatexSymbols5
  96. LinkingAndNavigationVariables
  97. LoginName
  98. MailerContrib
  99. MainFeatures
  100. ManagingTopics
  101. ManagingUsers
  102. ManagingWebs
  103. MetadataRepository
  104. MovedSkin
  105. NewUserTemplate
  106. ObjectMethod
  107. PageRenderingProcess
  108. ParameterizedVariables
  109. PatternSkin
  110. PatternSkinColorSettings
  111. PatternSkinCss
  112. PatternSkinCssCookbook
  113. PatternSkinCssCookbookCenterPage
  114. PatternSkinCssCookbookCenterPageBorder
  115. PatternSkinCssCookbookEditTableStyle
  116. PatternSkinCssCookbookFonts
  117. PatternSkinCssCookbookNoLeftBar
  118. PatternSkinCssCookbookNoTopBar
  119. PatternSkinCustomization
  120. PatternSkinElements
  121. PatternSkinGraphics
  122. PatternSkinWebCreateNewTopicTemplate
  123. PersonalPreferencesHelp
  124. PeterThoeny
  125. PlainSkin
  126. PreferencesPlugin
  127. PreviewBackground
  128. PrintSkin
  129. QuerySearch
  130. QueryUsers
  131. QuietSave
  132. ReadOnlyAndMirrorWebs
  133. RedDotPlugin
  134. RegistrationApprovals
  135. RegularExpression
  136. RenameWeb
  137. RenderListPlugin
  138. ResetPassword
  139. ScrollBoxAddOn
  140. SearchDoesNotWork
  141. SearchHelp
  142. SearchPatternCookbook
  143. SearchResultsPagination
  144. SearchingAndListingVariables
  145. SecurityAndAccessControlVariables
  146. SetGetPlugin
  147. SimultaneousEdits
  148. SiteChanges
  149. SiteMap
  150. SitePermissions
  151. SiteStatisticsFooter
  152. SiteStatisticsTemplate
  153. SkinsAndTemplatesVariables
  154. SlideShowPlugin
  155. SmiliesPlugin
  156. SourceCode
  157. SpreadSheetPlugin
  158. SpreadSheetPluginTestCases
  159. StandardColors
  160. StartingPoints
  161. StaticMethod
  162. StylePlugin
  163. SubwebAndTopicNames
  164. SystemInformationVariables
  165. TWikiAccessControl
  166. TWikiAccessControlExceptionDotPm
  167. TWikiAccessDotPm
  168. TWikiAddOns
  169. TWikiAggregateIteratorDotPm
  170. TWikiAttachDotPm
  171. TWikiAttrsDotPm
  172. TWikiCompatibilityDotPm
  173. TWikiConfigureCheckersCertificateDotPm
  174. TWikiConfigureCheckersCertificateKeyCheckerDotPm
  175. TWikiConfigureLoadDotPm
  176. TWikiConfigureUIsEXTENDDotPm
  177. TWikiContribs
  178. TWikiContributor
  179. TWikiCss
  180. TWikiDashboardAddOn
  181. TWikiDashboardImages
  182. TWikiDocGraphics
  183. TWikiDocGraphicsTemplate
  184. TWikiDocumentation
  185. TWikiDotPm
  186. TWikiDownload
  187. TWikiEditingShorthand
  188. TWikiEngineDotPm
  189. TWikiEngineExceptionDotPm
  190. TWikiEnhancementRequests
  191. TWikiExternalLinks
  192. TWikiFAQ
  193. TWikiFaqTemplate
  194. TWikiFormDotPm
  195. TWikiFormFieldDefinitionDotPm
  196. TWikiFormListFieldDefinitionDotPm
  197. TWikiFormSelectDotPm
  198. TWikiForms
  199. TWikiFuncDotPm
  200. TWikiGlossary
  201. TWikiHistory
  202. TWikiI18NDotPm
  203. TWikiI18NExtractDotPm
  204. TWikiIfNodeDotPm
  205. TWikiIfOP_iswebDotPm
  206. TWikiIfParserDotPm
  207. TWikiInfixErrorDotPm
  208. TWikiInfixNodeDotPm
  209. TWikiInfixParserDotPm
  210. TWikiInstallationGuide
  211. TWikiJavascripts
  212. TWikiLineIteratorDotPm
  213. TWikiListIteratorDotPm
  214. TWikiLoginManagerApacheLoginDotPm
  215. TWikiLoginManagerDotPm
  216. TWikiLoginManagerSessionDotPm
  217. TWikiLoginManagerTemplateLoginDotPm
  218. TWikiLogos
  219. TWikiMdrepoDotPm
  220. TWikiMergeDotPm
  221. TWikiMetaData
  222. TWikiMetaDotPm
  223. TWikiNetDotPm
  224. TWikiNetHTTPResponseDotPm
  225. TWikiNetSkin
  226. TWikiNetSkinColorSettings
  227. TWikiNetSkinPlugin
  228. TWikiNetSkinWebCreateNewTopicTemplate
  229. TWikiOopsExceptionDotPm
  230. TWikiPluginDotPm
  231. TWikiPlugins
  232. TWikiPluginsDotPm
  233. TWikiPluralsDotPm
  234. TWikiPreferences
  235. TWikiPreferencesForm
  236. TWikiPrefsDotPm
  237. TWikiPrefsParserDotPm
  238. TWikiPrefsPrefsCacheDotPm
  239. TWikiQueryHoistREsDotPm
  240. TWikiQueryNodeDotPm
  241. TWikiQueryParserDotPm
  242. TWikiReferenceManual
  243. TWikiRegistration
  244. TWikiReleaseNotes04x00
  245. TWikiReleaseNotes04x01
  246. TWikiReleaseNotes04x02
  247. TWikiReleaseNotes04x03
  248. TWikiReleaseNotes05x00
  249. TWikiReleaseNotes05x01
  250. TWikiReleaseNotes06x00
  251. TWikiRenderDotPm
  252. TWikiRenderingShortcut
  253. TWikiRequestDotPm
  254. TWikiResponseDotPm
  255. TWikiSandboxDotPm
  256. TWikiScripts
  257. TWikiSearchDotPm
  258. TWikiShorthand
  259. TWikiSite
  260. TWikiSiteTools
  261. TWikiSkinBrowser
  262. TWikiSkins
  263. TWikiStoreDotPm
  264. TWikiStoreQueryAlgorithmsBruteForceDotPm
  265. TWikiStoreRcsFileDotPm
  266. TWikiStoreRcsLiteDotPm
  267. TWikiStoreRcsWrapDotPm
  268. TWikiStoreSearchAlgorithmsForkingDotPm
  269. TWikiStoreSearchAlgorithmsPurePerlDotPm
  270. TWikiSystemRequirements
  271. TWikiTemplates
  272. TWikiTemplatesDotPm
  273. TWikiTimeDotPm
  274. TWikiTip001
  275. TWikiTip002
  276. TWikiTip003
  277. TWikiTip004
  278. TWikiTip005
  279. TWikiTip006
  280. TWikiTip007
  281. TWikiTip008
  282. TWikiTip009
  283. TWikiTip010
  284. TWikiTip011
  285. TWikiTip012
  286. TWikiTip013
  287. TWikiTip014
  288. TWikiTip015
  289. TWikiTip016
  290. TWikiTip017
  291. TWikiTip018
  292. TWikiTip019
  293. TWikiTip020
  294. TWikiTip021
  295. TWikiTip022
  296. TWikiTip023
  297. TWikiTip024
  298. TWikiTip025
  299. TWikiTip026
  300. TWikiTip027
  301. TWikiTip028
  302. TWikiTip029
  303. TWikiTips
  304. TWikiTipsOfTheDay
  305. TWikiTipsOfTheDayAddNew
  306. TWikiTipsOfTheDayAdmin
  307. TWikiTipsOfTheDayInclude
  308. TWikiTipsOfTheDayTemplate
  309. TWikiTopics
  310. TWikiTutorial
  311. TWikiUIChangeFormDotPm
  312. TWikiUICopyDotPm
  313. TWikiUIDotPm
  314. TWikiUIEditDotPm
  315. TWikiUIManageDotPm
  316. TWikiUIMdrepoUIDotPm
  317. TWikiUIOopsDotPm
  318. TWikiUIRDiffDotPm
  319. TWikiUIRegisterDotPm
  320. TWikiUIRestDotPm
  321. TWikiUISaveDotPm
  322. TWikiUISearchDotPm
  323. TWikiUIStatisticsDotPm
  324. TWikiUIUploadDotPm
  325. TWikiUIViewDotPm
  326. TWikiUpgradeGuide
  327. TWikiUserAuthentication
  328. TWikiUserMappingContrib
  329. TWikiUserMappingDotPm
  330. TWikiUserSetting
  331. TWikiUsersApacheHtpasswdUserDotPm
  332. TWikiUsersBaseUserMappingDotPm
  333. TWikiUsersDotPm
  334. TWikiUsersGuide
  335. TWikiUsersHtPasswdUserDotPm
  336. TWikiUsersPasswordDotPm
  337. TWikiUsersTWikiUserMappingDotPm
  338. TWikiUsersTemplate
  339. TWikiVariables
  340. TWikiVariablesCategoryBody
  341. TWikiVariablesQuickStart
  342. TWikiVariablesSearch
  343. TWikiVariablesWizard
  344. TablePlugin
  345. TablesAndSpreadsheetsVariables
  346. TagMeChangeRequests
  347. TagMeCreateNewTag
  348. TagMeDebugSearch
  349. TagMeDebugViewTags
  350. TagMeDeleteTag
  351. TagMePlugin
  352. TagMeRenameTag
  353. TagMeSearch
  354. TagMeViewAllTags
  355. TagMeViewMyTags
  356. TemplateWeb
  357. TextEditor
  358. TextFormattingFAQ
  359. TextFormattingRules
  360. TimBernersLee
  361. TimeSpecifications
  362. TinyMCEFrequentlyAskedQuestions
  363. TinyMCEPlugin
  364. TinyMCEQuickHelp
  365. TipsContrib
  366. TopMenuSkin
  367. TopMenuSkinDefaultWebTopMenu
  368. TopMenuSkinHomeMenu
  369. TopMenuSkinTopBar
  370. TopMenuSkinTopicMenu
  371. TreeBrowserPlugin
  372. TwistyContrib
  373. TwistyPlugin
  374. UIAndVisualizationVariables
  375. UserBookmarks
  376. UserBookmarksTemplate
  377. UserDocumentationCategory
  378. UserForm
  379. UserMasquerading
  380. UserReports
  381. UserSubwebs
  382. UserToolsCategory
  383. UsersAndAuthenticationVariables
  384. UsingHTML
  385. UsingMultipleDisks
  386. VarACTIVATEDPLUGINS
  387. VarADDTOHEAD
  388. VarALLVARIABLES
  389. VarAQUA
  390. VarATTACHURL
  391. VarATTACHURLPATH
  392. VarAUTHREALM
  393. VarBASETOPIC
  394. VarBASEWEB
  395. VarBB
  396. VarBB2
  397. VarBB3
  398. VarBB4
  399. VarBLACK
  400. VarBLUE
  401. VarBR
  402. VarBROWN
  403. VarBUBBLESIG
  404. VarBULLET
  405. VarCALC
  406. VarCALCULATE
  407. VarCARET
  408. VarCOLORPICKER
  409. VarCOMMENT
  410. VarCONTENTMODE
  411. VarCOPY
  412. VarDASHBOARD
  413. VarDATE
  414. VarDATEPICKER
  415. VarDISPLAYTIME
  416. VarDISPLAYTIME2
  417. VarEDITACTION
  418. VarEDITFORMFIELD
  419. VarEDITTABLE
  420. VarENCODE
  421. VarENDBG
  422. VarENDCOLOR
  423. VarENDSECTION
  424. VarENTITY
  425. VarENV
  426. VarEXAMPLEVAR
  427. VarFAILEDPLUGINS
  428. VarFORMFIELD
  429. VarGET
  430. VarGMTIME
  431. VarGMTIME2
  432. VarGRAY
  433. VarGREEN
  434. VarGROUPS
  435. VarH
  436. VarHEADLINES
  437. VarHIDE
  438. VarHIDEINPRINT
  439. VarHOMETOPIC
  440. VarHTTP
  441. VarHTTPHOST
  442. VarHTTPS
  443. VarI
  444. VarICON
  445. VarICONURL
  446. VarICONURLPATH
  447. VarIF
  448. VarINCLUDE
  449. VarINCLUDINGTOPIC
  450. VarINCLUDINGWEB
  451. VarJQENDTAB
  452. VarJQENDTABPANE
  453. VarJQTAB
  454. VarJQTABPANE
  455. VarLANGUAGE
  456. VarLANGUAGES
  457. VarLAQUO
  458. VarLIME
  459. VarLOCALSITEPREFS
  460. VarLOGIN
  461. VarLOGINURL
  462. VarLOGOUT
  463. VarLOGOUTURL
  464. VarM
  465. VarMAINWEB
  466. VarMAKETEXT
  467. VarMAROON
  468. VarMDREPO
  469. VarMETA
  470. VarMETASEARCH
  471. VarN
  472. VarNAVY
  473. VarNBSP
  474. VarNOP
  475. VarNOTIFYTOPIC
  476. VarOLIVE
  477. VarORANGE
  478. VarP
  479. VarPARENTBC
  480. VarPARENTTOPIC
  481. VarPINK
  482. VarPLUGINDESCRIPTIONS
  483. VarPLUGINVERSION
  484. VarPUBURL
  485. VarPUBURLPATH
  486. VarPURPLE
  487. VarQ
  488. VarQUERYPARAMS
  489. VarQUERYSTRING
  490. VarRAQUO
  491. VarRED
  492. VarREDBG
  493. VarREG
  494. VarREMOTEADDR
  495. VarREMOTEPORT
  496. VarREMOTEUSER
  497. VarRENDERLIST
  498. VarREVINFO
  499. VarREVINFO2
  500. VarS
  501. VarSCRIPTNAME
  502. VarSCRIPTSUFFIX
  503. VarSCRIPTURL
  504. VarSCRIPTURL2
  505. VarSCRIPTURLPATH
  506. VarSCRIPTURLPATH2
  507. VarSEARCH
  508. VarSERVERTIME
  509. VarSERVERTIME2
  510. VarSESSIONID
  511. VarSESSIONVAR
  512. VarSESSIONVARIABLE
  513. VarSET
  514. VarSETGETDUMP
  515. VarSILVER
  516. VarSITENAME
  517. VarSITESTATISTICSTOPIC
  518. VarSLIDESHOWEND
  519. VarSLIDESHOWSTART
  520. VarSPACEDTOPIC
  521. VarSPACEOUT
  522. VarSTARTINCLUDE
  523. VarSTARTSECTION
  524. VarSTATISTICSTOPIC
  525. VarSTOPINCLUDE
  526. VarSYSTEMWEB
  527. VarT
  528. VarTABLE
  529. VarTEAL
  530. VarTM
  531. VarTOC
  532. VarTOC2
  533. VarTOPIC
  534. VarTOPICLIST
  535. VarTOPICTITLE
  536. VarTOPICURL
  537. VarTWIKIWEB
  538. VarTWISTY
  539. VarU
  540. VarURLPARAM
  541. VarUSERINFO
  542. VarUSERNAME
  543. VarUSERREPORT
  544. VarUSERSIG
  545. VarUSERSWEB
  546. VarVAR
  547. VarVBAR
  548. VarWEB
  549. VarWEBLIST
  550. VarWEBPREFSTOPIC
  551. VarWHITE
  552. VarWIKIHOMEURL
  553. VarWIKILOGOALT
  554. VarWIKILOGOIMG
  555. VarWIKILOGOURL
  556. VarWIKINAME
  557. VarWIKIPREFSTOPIC
  558. VarWIKITOOLNAME
  559. VarWIKIUSERNAME
  560. VarWIKIUSERSTOPIC
  561. VarWIKIVERSION
  562. VarWIP
  563. VarX
  564. VarY
  565. VarYELLOW
  566. ViewTildeJsmith
  567. WabiSabi
  568. WatchlistPlugin
  569. WatchlistTemplate
  570. WelcomeGuest
  571. WhatDoesTWikiStandFor
  572. WhatIsWikiWiki
  573. WikiCulture
  574. WikiName
  575. WikiNotation
  576. WikiReferences
  577. WikiSyntax
  578. WikiSyntaxSummary
  579. WikiWord
  580. WorkflowAndAutomationVariables
  581. WysiwygPlugin
  582. WysiwygPluginSettings
  583. WysiwygPluginTopicLister
  584. YouAreHere
1.3.3.1.A Output of the %TOCCHECK% tag

1.4. Anchors and References - the ANCHOR, REF and REFTABLE tags

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

1.4.1. The ANCHOR tag

Supported attributes: 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 1.4.3. The REFTABLE tag 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: 1.4.1.A A wooden table

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.

1.4.2. The REF tag

Supported attributes: 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 1.1.1.A The Weborder topic 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}%
generates

Reference TocPluginHelp:Reference:NonExistantAnchor not satisfied

1.4.3. The REFTABLE tag

Supported attributes: 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}%
This will insert a table like this:
Example
1.1.1.A The Weborder topic
1.3.2.1.A Table of contents for this web
1.3.2.2.A Table of contents for this topic
1.3.3.1.A Output of the %TOCCHECK% tag
1.4.3.A REFTABLE{type=Table} example
1.4.3.B REFTABLE{type=Figure} example
1.4.3.C REFTABLE{type=Section} example %REFTABLE{type=Section}%

and

%REFTABLE{type=Figure}%
will insert a table like this:
Figure
1.4.1.A Here be sea monsters

All topics listed in the WebOrder are scanned, but only anchors of the requested type will be listed.

NOTES

1.5. Getting clever

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
	* [[Top level topic]]
	* AnotherTopLevelTopic
TopLevelTopic 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]]
	* AnotherTopLevelTopic
TopLevelTopic 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.

1.6. Hints and Tips

1.7. Copyright

The TOC Plugin is a development of the Architectures and Systems Platforms group of Motorola Inc. and is protected by the following copyrights:

1.8. License

As required for the publication of all extensions to TWiki, the software is published under the terms of the GNU General Public License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details, published at http://www.gnu.org/copyleft/gpl.html



Revision: r1 - 2015-03-20 - 20:23:07 - TWikiGuest

Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Daya Bay? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TocPluginHelp.