Talk:Documentation/Project DevGuide To Wiki

Initial issues being considered

To get the discussion started, these are some of the things that are being considered with respect to putting books into Wiki format:

• Navigation through documents is difficult due to the nature of Wikis (more encyclopedic than linear book style=
  • Possible solutions include using the MenuTabs extension
  • Using a Template (containing the chapter titles or possibly heading 1 levels) that floats or is placed on the right hand side of each Wiki page within a document
  • Other??
• Efficient and manageable Table of Contents
• Presenting the reader their location within a larger document
• Other??

--Ccornell 14:00, 11 April 2007 (CEST)

---

A solution has already been found for building some intelligent navigation into the books put into the Wiki. This works quite nicely too. We can use a Wiki Template to insert a small somewhat dynamic TOC on each Wiki page of the book. The Template would contain the Book title, the chapter titles, and as many heading levels as necessary to let the reader know where they are in the flow of information. The sub levels can easily be turned on and off with block and none parameters.

So the initial pseudo code for the template would be

div 
  div 
    Book Title
  /div
  div
    Heading 1
    div style="display:[[[sublevel_name|none]]]"
      Heading 2
      Heading 2
    /div
  /div 
/div

And so on for each Chapter and the heading in the book. Setting the display to none means that initially each block marked with none is hidden. When you want to display a hidden section of the TOC within a Wiki page, you insert the template with some syntax that looks something like this {{TOC1|toc11=block}}

Each book would have a TOC template specific to its own structure.

--Ccornell 16:06, 11 April 2007 (CEST)

---