Wiki

The most recent version of this page is a draft.DiffThis version (14 Oct 2010 22:55) was approved by Robin Getz.

This is an old revision of the document!


Documentation Organization

This document covers how the wiki is organized. This is of course a standard constantly in-flux. Any changes to the proposed layout should go through the wiki mailing list.

Layout

Generally speaking, the wiki is organized into a taxonomy that matches the main ADI site taxonomy. Products have catagories, and are seperated into various namespaces (see below). There are various things that don't have specific product catagories, which are a little looser in organization. Since it's easy to move things around after - don't worry too much about exactly where things go - try to think of where it makes the most sense, and put it there.

Some suggestions:

  • use :namespace:namespace as the main page for topics under that namespace rather than having the introductory page be :namespace:main. This will keep the proper sidebar on the page.
  • every namespace can have, or not have it's main sidebar. the sidebar for the root namespace is autogenerated, so don't change it (you will loose your changes).

Here are the current namespaces.

  • : Root Namespace - Try not to put anything here, except the start page.
  • :product catagory: The wiki assumes a similar taxonomy as the main ADI site taxonomy. Not all name spaces will exist at the outside of the project, and will point back to the analog.com web page. For example:
  • :software:drivers:linux:adp5520
  • :wiki: Wiki Topics

These special pages exist in every namespace, and should not be used for other content.

  • review - will list the pages needed for review in the current namespace
  • sidebar - will be the content for the current namespace's sidebar

Naming conventions

For names of namespaces the same restrictions hold as for pagenames.

  • page names in the wiki are converted to lowercase automatically.
  • Allowed characters are letters, digits and, within names 1), the “special characters” ., - and _2).
  • All other special characters (i.e. other than letters and digits) are converted to underscores
  • Colons (:) are used to identify or, if necessary, create namespaces.

Namespaces

A namespace is similar to a directory or folder, while pagenames are similar to files.

In the Wiki, we use namespaces to categorize the pages.

A default DokuWiki installation comes with built-in namespace:

You don't need to create namespaces separately; simply create pages with colons in the pagename. The token after the last colon will be the name of the page itself, while all other tokens are namespaces. All namespaces used in your pagename that don't exist already will be created by DokuWiki automatically.

Examples:
example
.example
.:example
refers to the page “example” in the current namespace.
:examplerefers to the page “example” in the root namespace.
..example
..:example
.:..:example
refers to the page “example” in the parent namespace
wiki:examplerefers to the page “example” in the namespace “wiki”. The namespace “wiki” is located beneath the root namespace.
ns1:ns2:example
:ns1:ns2:example
refers to the page “example” in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located beneath the root namespace.
.ns1:ns2:example
.:ns1:ns2:example
refers to the page “example” in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located beneath the current namespace.
..ns1:ns2:example
..:ns1:ns2:example
refers to the page “example” in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located beside the current namespace (i.e. both ns1 and the current namespace are beneath the same parent namespace, wherever according to the root namespace this parent may be located itself).
1)
i.e. you cannot start or end names with them, resp. they will be eliminated at start or end of names
2)
effectively, only “.” and “-” can be used since for “_” it will become unclear if the user or the system have put it, see next bullet
/var/www/analog-staging.dw1.cosmocode.de/data/pages/wiki/organization.txt · Last modified: 19 Apr 2016 10:57 by Support.s