Help:Editing

From Valve Developer Community
Revision as of 02:50, 28 June 2005 by Geogriffith (talk | contribs) (Horizontal lines)

Jump to: navigation, search

Here is a crash course in editing, based on what I have learned in the last 5 minutes. If you find that something I have written is incorrect, well then, feel free to correct me!

When you select Edit on a page that is unlocked, you will be taken to a new page, where the top will be the page as it is currently, and the bottom will be a textbox with simple editing features. You can make whatever changes you like, add a quick summary of your changes (useful if you're fixing an obscure spelling error), and then save it. And that's it! Your changed page is now the "official" page-- That is, until someone else edits it.

The editing buttons:

Each button, when pressed, will paste a small example of the usage of a peice of special formatting. Based on these examples, I have made the following guide.

Bold Text

Example is given as: '''Bold text'''

Bold text is very simple. Put in three (3) single apostrophes before the section of text you wish to bold, and three (3) after.

If I wanted to make this text bold, then the code would run as so:

    If I wanted to '''make this text bold'''

Italicized Text

Example is given as: ''Italic text''

Italics are just as easy as bold text. Put in two (2) single apostrophes before the section of text you wish to bold, and two (2) after.

If I wanted to make this text italicized, then the code would run as so:

    If I wanted to ''make this text italicized''

Internal Links (not working fully)

Example is given as: [[Link title]]

If you want to link to another page that is in this particular wiki database, you simply need the title of the page. To link to the Main Page, you simple use "Main_Page". Simple!

So to link to Main_Page, I would need the following code:

    So to link to [[Main_Page]]

You can also change the text of the link, without affecting what it links to. This is useful if you have to adjust for grammar.

So to link to A Page that is in the manner of being Main, I would need the following code:

    So to link to [[Main_Page|A Page that is in the manner of being Main]]

External Links

Example is given as: [http://www.example.com link title]

External links are used to link to web pages that are not in this wiki.

To link to a site like Google.com, I would use the following code:

    To link to a site like [http://www.google.com Google.com]

Headline Text

Example is given as: == Headline text ==

A headline is often used as an eye-catching title or brief summary of a wiki page. The first time a headline is used in a page, it will be very large. The second time it is used, it is somewhat smaller. All additional headlines will be the same size as the second. This makes it very easy to categorize a page, creating a clean, efficient way to find information. Additionally, with multiple headlines, the wiki engine will eventually add a title box to the beginning of the page, allowing a viewer to instantly click down to the subject they want.

So to get nice big beatiful text like this

Use the following code:

    ==So to get nice big beatiful text like this==


Embedded Pictures

Example is given as: [[Image:Example.jpg]]

Embedded pictures are pictures that have been uploaded to the wiki and are now directly hosted by it.Special:Upload is where you can go to upload your pictures. MAKE SURE THEY ARE NOT COPYRIGHTED.

So to show this stupid little picture of a smily face Test.gif I made in 5 seconds (although I don't know why you would want to), use the following code:

    So to show this stupid little picture of a smily face [[Image:Test.gif]]

Media links

Example is given as: [[Media:Example.mp3]]

If for some reason you want to include video or sound files, you can go to Special:Upload, load them onto the wiki server, and then link to them. I would include an example, but I have no access to a microphone, and I don't want to post anything copyrighted. But if you were to say, link to Media:scream07.ogg, this is the code for it:

    But if you were to say, link to [[Media:scream07.ogg]]

Symbols

Example is given as: <math>Insert formula here</math>

(Geogriffith: This one is a little sketchy. If anyone knows how to use LaTeX, please fill this in.)

Ignore Wiki formatting

Example is given as: <nowiki>Insert non-formatted text here</nowiki>

This is rarely used, except in the making of a Help with Editing page, where you need to show what a tag is like, but you can't write it out, because the wiki will then think it is formatted text. To get around that, you put a <nowiki> tag and a </nowiki> tag around the entire tag.

Example is given as: <math>Insert formula here</math>

    '''Example is given as:''' <nowiki><math>Insert formula here</math></nowiki>

Horizontal lines

Example is given as: ----

Horizontal lines are usually only used at the end of a large section of a single page. Use them sparingly, as too many make a page look ugly. To seperate


text this easily, just use the following code:

    To seperate
    ----
    text this easily

"Code" boxes

No example is given. Bastards.

To make those pretty little code boxes I've used throughout this guide, just skip a few lines, then put in a single space before the code you want. When you skip a few more lines, the wiki will close the code box.

 So if you want a pretty code box kinda like this, copy down the entire contents of this code box. Dur.

Other Info

Wikipedia has excellent resources on text formatting available here. The information is referential of the Wikipedia site, but is applicable to all MediaWiki powered sites.