Help:Editing

From Star Wars: Knights of Darkness wiki

<nomud> Here follows a very much incomplete set of guidelines for editing the Knights of Darkness wiki. As time goes on, this page will be updated with more information to make our wiki as good as it can possibly be.

• The first and most important thing to note is that this wiki also serves as our in-game help system. That said, however, the in-game system doesn't fetch whole pages - aside from the spam issue, trying to handle the more extensive markup that makes up the main body of a page would be very difficult to say the least. So rather than pulling the entire page, the mud only pulls the summary of the page - everything that exists ABOVE the table of contents. Because of this, there are some important things that you have to keep in mind when making an article:
  • DO NOT put extensive markup in the summary. The mud can handle bold and italic text, <pre> blocks (the blue ones with the dotted border), line break, and single-level bulleted lists. It can partially handle numbered lists, but converts them into bullets, as well. ANYTHING beyond this should stay OUT of the summary section and go under a header.
  • DO include headers in any article that's more than a few paragraphs long. If you're going into intricate detail about how something works, put that below a header so it's not displayed in the mud. The help displayed in the mud should be basic.
  • DO include, however, enough information in the summary to give a basic understanding of the command or skill or whatever else and how it works. Include in the summary things like syntax, any materials or conditions required for use, the class that gets it and the level they get it at, and any important notes that need to be accessed quickly without visiting the site itself.
  • DO include mud color codes if you wish to color the article in the mud. It will make the summary look a little less nice on the site, but will improve things in the mud. The wiki parser will be expanded soon to either strip those or convert them to HTML color.
  • DO enclose anything you DON'T want to show up in the mud in <nomud></nomud> tags, and anything you want to show up ONLY in the mud in <mud></mud> tags. These aren't functional wiki-side yet, but are functional mud-side, and will be functional wiki-side soon.
• Please write all pages in an encyclopedic tone. The words "I" and "you" should probably never be used in this wiki.
• Please be as thorough as possible when documenting a command or skill. If you know something most people don't, know of a common mistake, know of any bugs, or just have an interesting note on a command or skill, feel free to post it.

For reference, a <pre> block looks like this:

 Pre block. 

</nomud><mud>This page isn't suitable for viewing on the mud. If you'd like to view it, visit &Rwww.swkod.com/wiki/Help:Editing&C.</mud>