• Do not register here on develop.twiki.org, login with your twiki.org account.
• Use View topic Item7848 for generic doc work for TWiki-6.1.1. Use View topic Item7851 for doc work on extensions that are not part of a release. More... Close
• Anything you create or change in standard webs (Main, TWiki, Sandbox etc) will be automatically reverted on every SVN update.
Does this site look broken?. Use the LitterTray web for test cases.

Item4548: Improve TOC display in TWiki documentation

Item Form Data

AppliesTo: Component: Priority: CurrentState: WaitingFor: TargetRelease ReleasedIn
Engine Documentation Enhancement Closed   minor 4.2.0

Edit Form Data

Summary:
Reported By:
Codebase:
Applies To:
Component:
Priority:
Current State:
Waiting For:
Target Release:
Released In:
 

Detail

Most topics in the distributed TWiki web now have the TOC above the topic title. It is awkward, but tolerated because these pages are used to create large documentation topics.

Since a while we have a number of TOC formatting variables that can be used to improve layout of these topics, AND maintain the current large topics.

I suggest to set these variables in TWiki.WebPreferences:

   * Hide Table of Contents if the topic is included
      * Set TOC_HIDE_IF_INCLUDED = on
   * Set default Table of Contents title
      * Set TOC_TITLE = On this page:
   * The first header level to appear in the TOC:
      * Set TOC_MIN_DEPTH = 2 
And then move the TOC of each topic below the introduction paragraph.

A couple of other topics need to be adjusted. For instance, TWikiDocumentation would need:

<!--
   * Set TOC_MIN_DEPTH = 1
--> 

(or set in the preference pane).

-- TWiki:Main/ArthurClemens - 04 Sep 2007

New and improved TWikiDocumentation

-- TWiki:Main/ArthurClemens - 06 Sep 2007

ItemTemplate
Summary Improve TOC display in TWiki documentation
ReportedBy TWiki:Main.ArthurClemens
Codebase

SVN Range TWiki-4.2.0, Thu, 30 Aug 2007, build 14664
AppliesTo Engine
Component Documentation
Priority Enhancement
CurrentState Closed
WaitingFor

Checkins TWikirev:14760 TWikirev:14761
TargetRelease minor
ReleasedIn 4.2.0
Edit | Attach | Watch | Print version | History: r7 < r6 < r5 < r4 < r3 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r7 - 2008-01-22 - KennethLavrsen
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback