Guidelines

EQ2Emulator Wiki Guidelines

If you plan to add content to our Wiki, the articles you author must comply with our Wiki Naming Standards. Formatting of the document itself is not as important as where you choose to store it.

General Articles

For example, if you wanted to write a new article about LUA Scripting, you must start your document title with LUA as follows:

[[LUA]]

This is an internal Wiki link format that would drive the reader to the LUA main page.

Adding "sub-content" to the LUA system would require you to come up with a name that makes the most sense. For instance if your article is an sample of how to build a LUA Script "Hail" function, you could name the sub-category something like;

[[LUA:HailSample|Sample of Hail Script]] which would look like this: Sample of Hail Script in the page

Systems and Commands

If you intend to add a a new article relating to an existing system, subsystem or commands, you should observe existing categories (the first part before the ":") and determine if your article falls within that category. If so, you must name your Wiki as such:

{category_name}:{command_function}

Example for LUA systems Wiki's:

LUA:MovementLoopAdd

This keeps all the LUA functions under the LUA category so they are easy to find, even if the reader cannot find a direct link. All they have to do is know the command they are attempting to read about MovementLoopAdd() for example.

Redundancy

Definitely try to keep "redundancies" to a minimum. There is no need to re-write what someone else has already written on the Wiki. If you need to clarify a certain procedure or details about what you are writing, you can always insert an internal link to an existing Wiki page to guide the reader to the details you are explaining.

Occasionally, a Wiki Administrator will audit the pages submitted by the community. Should any page be considered "redundant" or poorly formatted, it may get merged into another document to spare the reader having to read the same material over and over.

General Formatting

Try and keep things simple. There is no need to go hog-wild and spend hours upon hours making fancy tables and image inserts if all you need is simple instructions. Readers can generally get the idea if you use clear, simple examples to express your thoughts.

LUA Commands Template

We have created a standard "template" for how we want all of our LUA Commands to be documented. Refer to the LUA Command Template to make your job easier.