User Tools

Site Tools


wikify

This is an old revision of the document!


MIDIbox Wiki Instructions

Wiki Syntax

The best way to learn the syntax and how it is used in the midibox-wiki is just to study existing pages. The syntax is easy to read and learn.
Follow this link to learn more about the syntax.

About Namespaces

All wiki-pages are organized in namespaces. A namespace works excatly like a folder, ':' is used as a separator, links can be absolute or relative to the current namespace:

'[[:home | Home]]' links to the page 'home' in the root namespace
'[[.:mbhp:module:din | DIN digital inputs]]' links to the page 'mbhp:module:din' in the current namespace
'[[din_dout_pin_list | DIN & DOUT pin table]]' links to the page 'din_dout_pin_list' in the current namespace

The text before the '|' is the page to link to, the one after it is the linked text.

note that 'mbhp:module:din' would **not** be relative to the current namespace. It would be equivalent to ':mbhp:module:din'

If you want to read more about DokuWiki-namespaces, follow this link.

Note that if you are on the page ':home:mbhp', you are in the namespace 'home', not 'home:mbhp'. This is a bit confusing, because there is on one hand a page called 'mbhp', on the other there is a namespace called 'mbhp' (:home:mbhp), for example 'home:mbhp:module:din'. To link from the page ':home:mbhp' to ':home:mbhp:module:din' relatively, you would use '.:mbhp:module:din'. Of course you could also use the absolute link ':home:mbhp:module:din'.

However, in most cases it will be easier and safer to just use absolute links.

Namespace Map

This is the namespace-structure of the midibox-wiki. All information concerning the midibox-project has to be somwhere in the 'home' namespace, the 'wikify' namespace is the place for information about how to edit/update the midibox-wiki.

  • home
    • about
      • faq
    • skills
    • project
      • controller
        • project name if required
      • sequencer
        • project name if required
      • synthesizer
        • project name if required
      • misc
        • project name if required
    • mbhp
      • module
      • pic
      • stm32
    • mios
    • mios32
    • troubleshooting
    • svn
    • community
    • bulk_order


  • wikify
    • template

Documenting Projects

Documenting Modules

wikify.1228118058.txt.gz · Last modified: 2008/12/01 07:54 by this