Differences

This shows you the differences between two versions of the page.

--- wikify [2008/11/20 09:37]
stryd_one
+++ wikify [2008/12/19 15:42]
stryd_one This namespace is tricky but I think I got it
@@ Line 1: / Line 1: @@
 ====== MIDIbox Wiki Instructions ======
-Durisian [[http://www.midibox.org/forum/index.php/topic,12348.msg102543.html#msg102543|opened a can of worms]] and followed through and ate them all like they were gummi worms. Thus, this wiki redesign was born.
+====== 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 top of this page is a spot to talk about the new wiki layout. When it's all done (other than this page) we can clean this page up as the final step, then redirect the old home page to the new one. Here goes:
+Follow [[http://www.dokuwiki.org/syntax|this]] link to learn more about the syntax.
-\\
-=== Guidelines ===
-Follow the Template!!
+====== Namespaces ======
+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:
-Don't call anything "new". It'll be old soon ;)
+  '[[: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: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
+  '[[din_dout_pin_list]]' links to the page 'din_dout_pin_list' in the current namespace
-Don't touch the old stuff...except for one thing: Mark the top of the page with some text so that we know you're already working on that page.
+If you want to read more about DokuWiki-namespaces, follow [[http://www.dokuwiki.org/namespaces|this]] link.
-Remove everything that's duplicated or outdated...If you remove outdated stuff, replace it with new info, and put a pointer to the old info there, so that if people find old info, they'll know to ignore it when they read your page.
+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'.\\
+\\
-When you remove a page, follow backlinks so that you can update links to your replacement doco.
+However, in most cases it will be easier and safer to just use absolute links.
-Search the forum for corroborating info. You don't wanna put the wrong info on there and get egg on your face when someone screws up because of your words Smiley
-If you find one little bit of mess, chances are there are related messes that should be cleaned at the same time. Search for similar pages to the one you're working on, and follow links from it.
-Dont use the H1 header style only for the title of the page, the page name will serve as the title. Use the headers for sectioning out the document so it gets a menu automatically.
-D said: - not sure about this, lay down the law and scare people away, or have to clean it up on a regualr basis...
-stryd says: lay down the law a little, but let it be somewhat dynamic. I've put some guidelines here for us, I guess some of them could stay on this page later on...
-space things out well, it makes it easier to read
-Add stuff here if you think of anything
+===== 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
+    * template
 \\
 \\
-**What follows is the proper content that will be left on this page when the overhaul is done:**
-=====Namespace Map=====
-  * 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
-  * svn
-  * community
-    * bulk_order
-  * wikify
-    * 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]]

MIDIbox

User Tools

Site Tools

Differences

Page Tools