Wiki for documenting MUSHclient, and other MUD-related things

Posted by Nick Gammon on Sat 01 May 2004 02:32 AM — 4 posts, 16,460 views.

Australia Forum Administrator #0

Acting on a recent suggestion, I have set up a "wiki" at this site. A wiki (apparently "wiki" is Hawaiian for "quick) is a quick way of setting up web pages.

Most pages can be edited or added-to by anybody, in a sort-of free-format documentation exercise.

The intention of this wiki is to allow MUSHclient users to self-document MUSHclient (and other related topics like the Area Editor, MUD games in general and so on).

You could, for instance, add tips to a "scripting tips" page, such as example "stat rollers", or various ways of using triggers or aliases to achieve certain effects.

The wiki can be found at http://www.gammon.com.au/wiki/index.php/HomePage

If you know your topic name (eg. AddTrigger) you can replace the last word (HomePage) with it to go direct to that page (note the capitalisation is important here).

To save typing you should also be able to get to it from http://www.mushclient.com/wiki/

Initial content

To kick of the wiki, I have generated a page for each of the 257 scripting functions. This is currently the same as in the Help file, but you can edit them and add your own comments if you like.

A nice side-effect of this is that any page that refers to a script function (eg. AddAlias, or ColourNote) will automatically generate a hyperlink to the relevant page, providing you capitalise it correctly.

Adding content

The wiki pages describe how to add things, but basically you edit an existing page, and add your own words. There are pages describing the mark-up, which is very simple, eg. *bold* for bold words, _italic_ for italics. If you add a "wiki-word" (a word with more than one capital letter LikeThisWord) then the wiki system automatically generates a hyperlink to that topic. If the topic does not exist then a question-mark will appear next to the word when the page is redisplayed. Just click on it to create the new page. If you need to hyperlink to words that do not have multiple capitals (eg. Note) then just put them into square brackets (eg. [Note]).

Other features

You can search, find recently-amended pages, find the changes that have been made to a particular page, and more.

Netiquette

Please do not just delete opinions or techniques you disagree with, it is preferable to add your own method, with a (non-insulting) description of why your method may be better in some cases. It is better for people browsing the wiki to have a range of choices, or different techniques described, rather than just the most recent one.

If anyone is thinking of abusing the system:

  • We have backups
  • You may be site-banned
Amended on Sat 01 May 2004 02:36 AM by Nick Gammon
Australia Forum Administrator #1
If you are planning to paste XML code on the wiki (like triggers etc.) use the tag <verbatim> ... </verbatim> like this:


<verbatim>

<triggers>
  <trigger
   custom_colour="2"
   enabled="y"
   group="attacks"
   match="* attacks you."
   name="mytrigger"
   sequence="100"
  >
  <send>Punch %1</send>
  </trigger>
</triggers>

</verbatim>


Australia Forum Administrator #2
[b]Wiki now closed[/b]

After moving Gammon Software to a new web site I have decided not to re-open the Wiki. As far as I could tell, no-one had posted any messages to it for months, so it effectively wasn't being used.

On top of that, since no-one was posting I wasn't checking it frequently, so it was possible that some malicious person could post something inappropriate and not have it noticed for a long time.
Australia Forum Administrator #3
The handful of articles that I wrote for the Wiki, like about copying and pasting XML, I have reproduced in the forum here, so they aren't lost.