NDCHost Wiki Posting Guidelines
NDCHost-Specific Wiki Syntax
In addition to the normal Dokuwiki syntax, we use a few documentation methods that are worth noting to keep articles consistent and easily readable! These are of course guidelines and we don't expect them to be followed to the T! If you have any suggestions as to how to make our articles more readable, please submit them to email@example.com!
- %%%% blocks are used to highlight text that needs emphasis, similar to a blockquote. Dokuwiki natively supports this by putting two spaces on a blank line before the text, however this does not work when dealing with lists, so we have implemented a workaround.
This is what a sample block looks like. We can even use wiki syntax inside of it.
- %%<sxh lang></sxh>%% blocks are used to provide syntax highlighting for code blocks. Most common languages are recognized by replacing lang with the language of the quoted text. Example of Perl syntax highlighting:
my $message = “Hello World!\n”; print $message; exit(); </sxh>
- Shell command (and output) should be quoted using <code shell></sxh> or <code bash></sxh>, which will render the text appropriately.
- <c></c> blocks are used to do inline command highlighting. <code lang></code> are block-level elements and will be forced onto their own line whereas this block can be used inline with other text; particularly useful when referencing a particular shell command mid-sentence. (Nitty gritty: code uses divs, c uses spans.)
in the middle of this sentencemakes use of <c></c>.
Article Formatting Guidelines
- Namespaces are used for general categorization of articles. Index By Name is a good place to start to find if a particular namespace exists. If you find that your article does not fall into a pre-defined namespace, create your page using namespace/page_name, and your new page will be placed in the given namespace automatically.
- Tags are descriptive words used to categorize articles into a could and to make them more easily searchable. These should be limited to 3-4 and should not be overly specific. Tags already in use are displayed at the bottom of the page creation form. These can be used in conjunction with new tags using the %%
%%syntax, preferably at the bottom of the article.
- Pages always begin with a level 1 heading used to describe the contents of the article. This heading is important as it is also used as the page name when displayed in reference tables.
- Important sections within an article are given bold text, whereas buttons or selections for the user are given italics, and finally input/selected values are “double quoted”.
Ex.: In the WHM, go to Main » Tweak Settings, change Number (or all) of accounts to display per page in list accounts. to “500”.