Help:Editing

From GPWiki

Files:GUITutorial_warn.gif The Game Programming Wiki has moved! Files:GUITutorial_warn.gif

The wiki is now hosted by GameDev.NET at wiki.gamedev.net. All gpwiki.org content has been moved to the new server.

However, the GPWiki forums are still active! Come say hello.

Contents

The Golden Rules

  1. Please refer to the MediaWiki formatting manual if you are unsure of how to do something.
  2. Please use the sandbox page to do any tests so that regular pages are not disrupted.

Posting Conventions

All Edits

  • When posting code, be sure to enclose all code blocks with <code type="language"> and </code> tags. This will cause your code block to be displayed with syntax highlighting. In the language parameter you can select from an extensive list of languages such as: "asm", "c", "csharp", "cpp", "dos", "ini", "java", "lisp", "lua", "pearl", "php", "python", "qb", "ruby", "vb", "vbnet", "xml" and more. See the Generic Syntax Highlighter website for the complete list.
  • When posting ASCII art, wrap it in <pre></pre> tags. This will cause your text to be displayed in a fixed-width font, with all whitespace preserved.
  • When referring to variables and other technical terms, be sure to use the "Technical Terms" tag: <TT></TT>. This will display the term in a typewriter-style font, emphasizing that it is a technical term.
  • Posts must be made in the English language. Links to non-English content is permitted, but only if the link text itself is in English, and if the linked content is somehow useful to English speaking readers. (ie. Source code is useful, regardless of language.)
  • If you're not confident in your wiki markup abilities and would like to practice, please do so on the sandbox page. Any edits you make on the sandbox page cannot harm the wiki, so feel free to test things out there!

Adding a New Page

  • The easiest way to create a new page is to create a link to it from an appropriate page, and then clicking on that link. Links to uncreated pages will show in a different colour than other links (usually red) and will allow you to create and edit that page directly.
  • If you've added an entirely new article to the wiki, feel free to post on the Current events page to let everyone know what's new.

Modifying an Existing Page

  • When making minor modifications to an article (such as a spelling or grammar correction), please be sure to check the "This is a minor edit" checkbox, above the Save page button. This will ensure that users who are watching for major page changes will not be flooded with minor edits.
  • If you wish to make a major modification to an article that conflicts or disagrees with content already contained within the article, please use the Discussion page attached to the article to explain yourself. (Each article page has a Discussion tab at the top.) Once you've made your case on the discussion page, please visit the forums to inform other users of your intentions. If you do not see a response within a reasonable amount of time, then you may go ahead and make your changes.
  • In order to organize our content, and avoid duplication of information, we use templates to store some of the information. You can recognize a reference to a template in the code by the {{curly braces}}. Please add appropriate changes you make to these existing templates.
  • If you notice that there is a large amount of data duplicated on two or more pages, make a note of it on the discussion page of one of the pages, and also mention it in the Content Issues forum for further investigation.

Game Programming Wiki Features

Syntax Highlighting

Example:

<code type="java">
Guy bob = new Guy();
if (somethingHappened == false) {
    bob.yawn();
}
</code>

Result:

Guy bob = new Guy();
if (somethingHappened == false) {
    bob.yawn();
}

When posting code, be sure to enclose all code blocks with <code type="language"> and </code> tags. This will cause your code block to be displayed with syntax highlighting. In the language parameter you can select from an extensive list of languages such as: "asm", "c", "csharp", "cpp", "dos", "ini", "java", "lisp", "lua", "pearl", "php", "python", "qb", "ruby", "vb", "vbnet", "xml" and more. See the Generic Syntax Highlighter website for the complete list.

Math

Templates

Stub

Example:

{{Stub}}

Result:

This page is far from complete, go ahead and write some more!
You can extend this page by editing it.

Use Stub if you've created a page, but haven't gotten around to putting in any useful information. This will automatically put the page in the stubs category.

TipBox

Example:

{{TipBox|Peanut butter goes well with strawberry jam.}}

Result:

GUITutorial_info.gif Tip
Peanut butter goes well with strawberry jam.

InformationBox

Example:

{{InformationBox|Snapples provide an entire day's worth of your recommended tin intake.}}

Result:

GUITutorial_info.gif Information
One snapple provides an entire day's worth of your recommended tin intake.

NoticeBox

Example:

{{NoticeBox|Never mix coffee and relish.}}

Result:

GUITutorial_warn.gif Notice
Never mix coffee and relish.

Box

Example:

{{Box|color=cyan|content=This box is cyan!}}

Result:

This box is cyan!