FiranWiki Editing Standards

From FiranMUX

There's a lot of content on here and we want it all to have a uniform look and feel and consistent navigational controls. For that reason, this page explains the "rules" we have for editing the wiki. Please do take the time to read these standards and apply them to your pages.

Link to "Menu"

If you must include a link back to the testing page, use the name "Menu" instead of "Testing Page" or "Testing_Page". That way, we won't have to change everything later when we rename the page.

One Topic Per Page

Every page should cover one and only one topic. If there are subtopics, you can break those into separate pages and link them from the master topic page.

Do not glom two or three or more topics into one page. Break them up into separate pages. If they're related, include a crosslink to other related pages. If you have to use "and" in a page description, it's probably more than one topic.

When we put only one topic on a page, it is easier to link to that topic from other pages.

Exclude "top" Links

On the old Firan website, we often placed links at the bottom of each topic to jump back to the "Top" of the page. This occurred most often when a web page contained more than one topic. If we follow the One Topic Per Page rule, this should not be necessary. Delete the "top" links.

Don't Overlink

While text should link to any topic that should have an entry, don't link every instance of that word on the page. One link per page (or per section on large pages) for a given topic is sufficient. That is, if "Anarinuell" appears ten times on a page, only link the first occurrence of that word.

Use # and * for Lists

If a page needs to have a numbered list (1, 2, 3, etc.) use the wiki-markup "#" on the beginning of each line. If a page needs a bullet list, use the wiki-markup "*" on the beginning of each line. Don't number the lines yourself or use some other symbol as a bullet.

Use TT for Firan Commands

If you're referring to a command that a player can use on the game, put it in <tt></tt> code and it will look like this. Don't use the <code> tag or other tags. Eventually, I'll set up a stylesheet to make the <tt> tag display in a uniform way across the site.

Don't Use Tables for Special Text Boxes

If you want to have special text in a free-floating box on the right or elsewhere (like the blue one to the right), don't hack this up using tables. Instead, use a DIV tag with a float:right style and a reasonable width (25% or 33% works nicely). Put the DIV box section where you want the top of your box to be.

Here's the code to make the box on the right:

 <div style="background-color:#ccccff; float:right; width:25%; padding:1em">
 '''Example Punch-Out Box'''
 
 Here's an example of the kind of right-floating box I'm talking about.
 </div>

Use Templates

When writing character wiki pages, please use the Character Page Template or model your information off of an expanded entry like the one for Ronti.