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/12/01 07:54] this |
wikify [2008/12/20 03:58] (current) stryd_one |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== MIDIbox Wiki Instructions ====== | ====== MIDIbox Wiki Instructions ====== | ||
| - | =====Wiki Syntax==== | + | |
| + | 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. | ||
| + | |||
| + | |||
| + | ====== 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.\\ | 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 [[http://www.dokuwiki.org/syntax|this]] link to learn more about the syntax. | Follow [[http://www.dokuwiki.org/syntax|this]] link to learn more about the syntax. | ||
| - | =====About Namespaces===== | + | ====== 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: | + | 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: |
| - | '[[:home | Home]]' links to the page 'home' in the root namespace | + | '[[: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 | + | '[[:mbhp:module:din]]' links to the page 'mbhp:module:din' in the root namespace |
| - | '[[din_dout_pin_list | DIN & DOUT pin table]]' links to the page 'din_dout_pin_list' in the current namespace | + | '[[mbhp:module:din]]' links to the page 'mbhp:module:din' in the root namespace |
| - | | + | '[[.:mbhp:module:din]]' links to the page 'mbhp:module:din' in the current namespace |
| - | The text before the '|' is the page to link to, the one after it is the linked text. | + | '[[din_dout_pin_list]]' links to the page 'din_dout_pin_list' in the current namespace |
| - | + | ||
| - | note that 'mbhp:module:din' would **not** be relative to the current namespace. It would be equivalent to ':mbhp:module:din' | + | |
| | | ||
| Line 23: | Line 25: | ||
| However, in most cases it will be easier and safer to just use absolute links. | However, in most cases it will be easier and safer to just use absolute links. | ||
| - | =====Namespace Map===== | + | ===== 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. | 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. | ||
| Line 29: | Line 31: | ||
| * about | * about | ||
| * faq | * faq | ||
| - | * skills | ||
| * project | * project | ||
| * controller | * controller | ||
| Line 43: | Line 44: | ||
| * pic | * pic | ||
| * stm32 | * stm32 | ||
| - | * mios | + | * software |
| - | * mios32 | + | * pc |
| - | * troubleshooting | + | * osx |
| - | * svn | + | * linux |
| + | * windows | ||
| + | * xplatform | ||
| + | * mbhp | ||
| + | * mios | ||
| + | * mios32 | ||
| + | * code | ||
| + | * picasm | ||
| + | * c | ||
| + | * c++ | ||
| + | * skills | ||
| + | * troubleshooting | ||
| * community | * community | ||
| - | * bulk_order | + | * 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 ===== |
| [[:wikify: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 ===== |
| [[:wikify:docmenting_your_module | Documenting your module]] | [[:wikify:docmenting_your_module | Documenting your module]] | ||
| [[:wikify:template:module | Module Template]] | [[:wikify:template:module | Module Template]] | ||
wikify.1228118058.txt.gz · Last modified: 2008/12/01 07:54 by this
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
