wikify
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
wikify [2008/10/25 03:10] Durisian |
wikify [2008/12/20 03:58] (current) stryd_one |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | This page is to serve as a guideline for wiki data FIXME | + | ====== MIDIbox Wiki Instructions ====== |
| - | =====Namespace Map===== | + | This page and the other pages throughout entire wikify:* namespace are just a template. Don't edit these pages. The new pages should be laid out like these. |
| - | * project | + | |
| - | * controller | + | ====== Wiki Syntax ====== |
| - | * project name if required | + | 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.\\ |
| - | * sequencer | + | Follow [[http://www.dokuwiki.org/syntax|this]] link to learn more about the syntax. |
| - | * project name if required | + | |
| - | * synthesizer | + | ====== Namespaces ====== |
| - | * project name if required | + | All wiki-pages are organized in namespaces. A namespace works exactly like a folder on your PC, but instead of a slash '/', a colon ':' is used as a separator. Links can be absolute or relative to the current namespace: |
| - | * misc | + | |
| - | * project name if required | + | '[[:home]]' links to the page 'home' in the root namespace |
| - | | + | '[[:mbhp:module:din]]' links to the page 'mbhp:module:din' in the root namespace |
| - | * mbhp | + | '[[mbhp:module:din]]' links to the page 'mbhp:module:din' in the root namespace |
| - | * module | + | '[[.:mbhp:module:din]]' links to the page 'mbhp:module:din' in the current namespace |
| - | * pic | + | '[[din_dout_pin_list]]' links to the page 'din_dout_pin_list' in the current namespace |
| - | * stm32 | + | |
| - | * mios | + | |
| - | * mios32 | + | If you want to read more about DokuWiki-namespaces, follow [[http://www.dokuwiki.org/namespaces|this]] link. |
| - | * svn | + | |
| - | * community | + | 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'.\\ |
| - | * bulk_order | + | \\ |
| + | 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 | ||
| + | * 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 | ||
| + | * software | ||
| + | * pc | ||
| + | * osx | ||
| + | * linux | ||
| + | * windows | ||
| + | * xplatform | ||
| + | * mbhp | ||
| + | * mios | ||
| + | * mios32 | ||
| + | * code | ||
| + | * picasm | ||
| + | * c | ||
| + | * c++ | ||
| + | * skills | ||
| + | * troubleshooting | ||
| + | * community | ||
| + | * bulk_order | ||
| + | \\ | ||
| * wikify | * wikify | ||
| * template | * template | ||
| + | \\ | ||
| + | \\ | ||
| + | ====== Global Documentation ====== | ||
| + | [[:wikify:home | Homepage template]], with templates for child pages, as per the above namespace map. | ||
| - | =====Documenting Projects===== | + | ===== Documenting Projects ===== |
| - | [[documenting_your_project | Documenting your project]] | + | [[:wikify:documenting_your_project | Documenting your project]] |
| - | [[wikify:template:project | Project Template]] | + | [[:wikify:template:project | Project Template]] |
| - | =====Documenting Modules===== | + | ===== Documenting Modules ===== |
| - | [[docmenting_your_module | Documenting your module]] | + | [[:wikify:docmenting_your_module | Documenting your module]] |
| - | [[wikify:template:module | Module Template]] | + | [[:wikify:template:module | Module Template]] |
wikify.1224904222.txt.gz · Last modified: 2008/10/25 03:10 by Durisian
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
