Wiki Editing Basics

From Cuendillar MUSH Wiki

Jump to: navigation, search


Introduction to Wiki

Wikifying Webpages is probably one of the easiest processes out there, and it benefits the entire game to have all of our Players able to do this, since it'll allow us all to add new pieces of information to the web far easier than going into the server and changing things.

While reviewing this primer, there is one resource that you'll probably find incredibly useful. That is the Basic Wiki Editing Guide website. The basic guide will have many of the same commands that will be reviewed here, and other commands that you might find useful, but are better aspected toward an advanced Wiki class.

Before you begin, you need to make certain you have a CuendillarWiki login account. If you do not have an account, then please @request asking for one – otherwise log on if you already have one created. Players must have usernames unique from their character names – as we will not approve character names for usernames for the wiki. If you've already got one created but forgotten your password, there is a Wiki utility to have it send you a new password. It's on the same page as the login screen, at the bottom. Click that button after specifying what your account is, and it'll send you a new password to your registered email address.

Internal Links and External Web Links

There are two types of links that you'll be working with when creating pages for the Wiki, however there are several types of links that you'll see. We'll go over how to add internal links, and how to add web based links to the game in this section.

Red Internal links are links that have been created within the text, but have not had any text added to them. When you click on a red link it'll start a new Wiki Web page for you. Blue Internal links are links that already have text created for them. You can click on the link and it'll take you to the associated text.

Anyone who has an account has the ability to add links in their Wiki code. They also have the ability to edit and correct other Wiki Webpages, even if they were not the original author. To add a new link, you simply include the name of the link that you want to use between a set of double brackets [[]]. IE: [[Neri]]. Every Wiki link created can be referenced within the text just as though you were adding the link. So, say you wanted to reference Neri’s character page somewhere? You'd just type: [[Neri]] and it would link back to that page.

If you want to add a webpage link to any of the pages, to reference an outside source, you'd use single brackets []. You'd insert it in this fashion: [webaddress alias]. IE: [ Cuendillar Wiki], and as you can see you can use multiple words for an alias. It will only show the alias, not the web address, when you add it that way.

Creating Wiki Pages

Once you open a Red Internal link you'll be directed to an editing box. Once that editing box is open, you can either write in new text, or copy/paste text into the box from a new source. The best way to describe the Wiki editing box is it's much like using your LiveJournal account to add things, if you have LiveJournal, or the Facebook Notes application, with the exception that some of the commands are slightly different. During the course of you’re writing, you might want to preview your information to see how it looks before you finish your changes. To do that, you make use of the SHOW PREVIEW button, which is located at the bottom of your editing box.

Wiki Webpages automatically offer you the opportunity to have a Table of Contents, depending on whether or not you use headers within your creations. Some players may prefer to have pages with a Table of Contents, and others may not. Should you wish to remove the automatic Table of Contents from your page, you simply insert __NOTOC__, which stands for No Table of Contents, at the top of your page for easy reference. For the __ around the NOTOC you use double underscores _'s.

If you have more than one category in a Wiki page, which is defined by the type of header code you use, it'll automatically create a table of contents for you. All pages should be linked to a type of category. IE: [[Category: Character Pages]] should be used if you are creating a page for your character on the grid. Categories should be placed at the end of every document, as the last item in the document. This will link your character page to all of the other character pages on the game, so that it will be automatically added to an alphabetized list of character pages in the category heading.

When adding or editing information to the Wiki Web page, you want to make sure to eliminate any spaces at the beginning of each paragraph; in other words DO NOT indent. Indenting will cause the wiki page to start to automatically format by adding a border of dashes all the way around your work. This makes for an ultimately ugly wiki page. Only indent or add spaces before a paragraph if you intend to have the dashed outline be part of your page’s formatting

If you want to use bullets or numbered lists in your work, you'll want to make sure that you do not add numbers, use the number # symbol instead and it'll automatically number things. Also, don't create different types of bullets, use the * symbol and it'll automatically create the bullets for you.

For example:

# This is a test
# This is a test again

* This is a point I want to make.
* This is another point I want to make

If you want to have headers or titles within your work, you use the following formats:

  • == TEXT == (two ='s) this is a two point header – which will automatically add a break line underneath of it. IE: == General Information == if you wanted to create a General Information main header
  • === TEXT === (three =’s) is a three point header – which creates a large text header without a line break.
  • ==== TEXT ==== (four =’s) is a four point header – which creates a small text header without a line break.

To create spacing between paragraphs you need two hard returns, or you can make use of the HTML command <BR> for a line break.

Editing Wiki Pages

So, now say that you’ve made a mistake, saw something misspelled that you wanted to correct, or somehow something got messed up. What you would do is click on the link to go back into your work, and at the top of the page you'll see several tabs. One of those tabs is EDIT. To fix something, you'd just click on edit and it'll open the page again, complete with all the already entered text. Once that window is open, you just make your edits and save it.

If you want, you can record a summary of the changes you made in the SUMMARY box just above the SAVE and SHOW PREVIEW buttons. This way, staff and other players will know why you made a specific change to that page. This is especially important when more than one person works on a Wiki Web page, so others can see the reason behind your changes. Whenever you enter a new page or do repairs/fixes/changes to the page, you'll want to make sure you add a line about what it is you're doing. If it's a minor edit, click the minor edit box. It's very important we keep a trail of what we're doing and what was done.

At the top of every page you'll also see the HISTORY tab. Clicking on this tab shows you the history of who made what changes and allows you to look back at all past versions, to see where exactly the changes were made, and if necessary, to revert back to older versions if the newer version is not correct.

There may be some cases where you'll want to add additional things to your Wiki design, and you'll find that you might have a need for tables. The easiest way to add tables is to use the Basic HTML code for it. This is more for a lay out or design issue than anything else. It's also something to be discussed in a more advanced Wiki tutorial. But it's being mentioned here because it's something you should know that you can use if it becomes necessary. And, of course, you can add images to the Wiki Web pages as well, like our Logo or the art in some of our character pages. This is also a discussion best saved for a more advanced class.

Personal tools