Tiki Doc Content Reorg Proposal | |
|
pianoliv: This proposal from 2011 is still being worked on (2013), don't hesitate to join in!
The Problem
The Proposal
| |
1.1. Content reorg - Tiki Doc Suite | |
|
Instead of a single Tiki user guide (structure), a "suite" of Tiki docs was proposed: | |
Tiki Installation Guide | |
| |
Tiki User Guide | |
| |
Tiki Administrator Guide | |
| |
Tiki Reference Guide | |
| |
Other structures | |
|
pianoliv: I propose to create a couple of small structures for:
See here for details. | |
1.2. Ease contribution | |
|
| |
Documentation Categories | |
|
I proposed a somewhat simplified (and perhaps easier) set of status markers:
pianoliv: agreed. I started migrating categories to status tags. See this forum thread Not sure if a "complete" tag is necessary. A complete page is one that doesn't have any other tags, as complete a page can be. Also, I propose to not tag pages that are not in English. English should be the reference (since not everyone can translate from all languagues), and localised pages are only a translation of this reference, thus have the same status. Localized pages don't need to appear in a status list. One tag could eventualy be added in other languages, such as "Page à traduire" (page to translate).
| |
Templates | |
|
By using standard page layout/design/templates:
What should the pages look like? At a minimum: Style:
Content:
Sample ''Live sample here: http://doc.tiki.org/Security Copy to clipboard
| |
Proposed Menus | |
|
Menus should use PHPLayers ('cause I think they look nicer, 😊 ) Side Menu
This is really a simplified "table of contents" of the entire doc "book". I wonder if there's a way to automatically create a menu based on structure Xavi: That should be possible through using a module menupage, and in that page, add a {toc} while setting the structure id and depth level... 😉 Those params should be described in http://doc.tiki.org/toc
tobi_h: I was wondering what the difference is between the Side Menu's Introduction, Installation, and following, in comparison to the Top Menu's Get Started Section. I ask since I would like to suggest an additional item "Operation & Maintenance", covering information on chores like tuning, logging, backups, and upgrades/updates. I hope this is a good place to put this, otherwise sorry in advance. 😊
Torsten: If you want to use kind of an 'automatic menu', which I refer sometimes as 'magic menu', you can use the "module_menu", where you optionally can use either the parameter menuId or the parameter structureId. Using a structureId, you are getting a 'CSS-Menu', which is working eactly as a normal 'CSS-Menu', but the 'menu' gets its menu items out of the "toc" of the structure. If you use the parameter type=horiz, the first level of the toc will be horizontal, whilst the lower levels stay vertical drop down on hover. Adding pages to the structure automattically adds a link to the page in the menu at the same level, where the page is located in the structure. | |
Open Questions | |
|
| |
Previous work | |||||||||||||||||||||||
| [+] The information below, was part of the general revamp, completed for Tiki 3.
I think it may be time to move doc.tw.o Home Page
I propose a simplified, streamlined Home Page that present four "types" of information.
Get Help
Authors
Learn More
(notice how the top menu mimics the four boxes from the Home Page....)
Left
Right
| |||||||||||||||||||||||
Deleted structure | |
|
Here is the tree of the old deleted structure Documentation TOC, in case of...
| |