Allegwiki: Difference between revisions

From FreeAllegiance Wiki
Jump to navigationJump to search
(This page needs an update, but I gtg)
(Now I know my ABC, next time won't you sing with me?)
Line 29: Line 29:
|align="center"| Guides to using Alleg-related programs  
|align="center"| Guides to using Alleg-related programs  
<small>[[Teamspeak]], [[Map Editor]], [[ICE]], etc.</small>
<small>[[Teamspeak]], [[Map Editor]], [[ICE]], etc.</small>
|-
!style="background-color:#ffa2a2; text-align:center;"|Tertiary
|-
|align="center"|A basic guide to [[core]] differences*.
:<nowiki>*</nowiki> <i><small>Tentatively added to the list only recently.</small>
|}
|}
{|style="float: right;" width=3%
{|style="float: right;" width=3%
Line 41: Line 35:
|}
|}


Allegwiki was established in September 2007 and since then has grown vastly in breadth and scope. Originally it was designed to replace the cumbersome Knowledge Base but it has gradually had more articles added to it until it rivals the Academy in content.
'''Allegwiki''' was established in September 2007 and since then has grown vastly in breadth and scope. Originally it was designed to replace the cumbersome Knowledge Base but it has gradually had more articles added to it until it rivals the [[Academy]] in content. The wiki is still somewhat unorganised but can be broken down into several key sections as shown on the table on the right.
 
The wiki is still somewhat unorganised but can be broken down into several key sections:
*Installation and trouble shooting
*FAZ
*Cores
*Archived material
*Newbie training material
*Information about squads
*Information about community history
*Information about current events
*Information about disclipine and enforcement


{{stub}}
==Content policy==
Allegwiki is designed as a reference source whether it be [[tech support]], [[squad|squad information]], or [[history|community history]]. As such there are no training guides on the wiki (with the exception of the [[Cadet I|Cadet I training guide]] and the [[Allegiance Command School]]).


The Wiki is NOT for gameplay material, the sole exception being the Cadet I program. Gameplay information should be kept to other websites or forums if the page is not directly part of the Cadet I curriculum.
You may feel free to add anything you like to Allegwiki as long as it is factual, as opposed to advice on playing the game. If you add something borderline you will be contacted by an [[Allegwiki moderator]] to discuss your contribution.


==Rules==
==Rules==
There are only two rules, but there are plenty of guidelines (see [[#Guidelines|below]]).
#You cannot edit if your forum post count is less than 50 (exception being people who're [[FreeAllegiance Wiki:Site support|Supporters]]).
#You cannot edit if your forum post count is less than 50 (exception being people who're [[FreeAllegiance Wiki:Site support|Supporters]]).
#You cannot put gameplay material on the wiki. If you do, it will get deleted.
#You cannot move or delete pages, or upload files. If you need any of these tasks done contact one of the [[AllegWiki:Moderators|Allegwiki moderators]].
#You cannot move or delete pages, or upload files. If you need any of these tasks done contact one of the [[AllegWiki:Moderators|wiki moderators]].


==See also==
*[[Category|Allegwiki articles by category]]
*[[AllegWiki:Improvement project|Allegwiki improvement project]]


==Guidelines==
==Guidelines==
If you're unsure about something you want to add, post in the Documentation forum explaining your dilemma. But when it comes to editing something that is already there, feel free to edit away! But please follow these guidelines:
* Use the Preview feature to make sure the page looks the way you want it before you Save the page.
**This avoids having an excessive number of edits which have to be checked.
* If you are fixing a minor mistake (such as a typo) please check the Minor Edit checkbox.
*Use proper spelling
*Use the titles of positions, rather than the name of the person that holds them
**No one wants to edit twenty pages when Tigereye retires and TheBored takes over Documentation Zone Lead, just to change their names.
*Don't use swear words, smart-ass commentary, etc.
*Use headers, bold, italics, etc. appropriately.
*Try and link to other wiki articles.
*<b>Don't</b> click the discussion button if you have nothing to discuss!
**It creates a new, empty, thread which clutters up the forums.
*Don't use present tense - words like "Recently", "Currently" and "Now" quickly lose meaning on a wiki.
Any changes made on the wiki are monitored by wiki moderators, and don't be surprised if your work gets subtly altered to meet their seal of approval (mostly just adding links to other wiki pages).
==Editing old articles==
If you see a mistake in an article be it a typo, broken link, or outdated (such as referring to an ex-squad leader) then feel free to correct it straight away. Or, if you don't have editing rights, report it in the Wiki forum simply by clicking on the 'Discussion' link at the top of the page.
If you come across a [[Stub]] feel free to wax lyrical on those articles. They've been stubbed because the original author needs help :).
But if you're changing things just for the sake of change ... well, it's your life. You can waste time if you want.
==Creating new articles==
Before you launch into creating new pages carefully think to yourself "Is this gameplay related?" If it is, don't stick it in the Wiki.
Then consider if it is really necessary. Are you writing something for the sake of writing it, or will it actually benefit the Wiki? A key point of the Wiki engine is how everything links together in a giant spiderweb - what other parts of the Wiki is your new article relevant to? If it doesn't relate to anything, it's not relevant.
Finally, check and see if it isn't already on the Wiki - personally I've created a redundant page, "FAZ Beta" when "FAZ Beta Games" already existed simply because I didn't check first. Use the search engine sensibly to determine if the article already exists.
If in doubt, discuss it with the Documentation [[Zone Leads|Zone Leader]].
==[[AllegWiki:Improvement project|Improvement project]]==
Go to that page to check out how to help improve the wiki.
==Documentation Zone Guidelines (2007)==
What follows are the original Doc Zone Leads thoughts on writing documentation, posted on the forums. Some concepts are applicable to the wiki.
<!---FYI - Any headers stuck under here will be fubarred by the quote tags --->
[quote]So, I'm supposed to be making sure all of the documentation is OK. Here are some groundrules I'll make for this forum of mine.
* Technical documentation only should be discussed here, with the exception of a small handful of the most commonly-asked gameplay questions that are covered in the KB.
* Gameplay documentation is handled by the Academy, Training, and others. Not us.
* NOTHING should be published to "public locations" unless it's been reviewed by at least 2 Documentation Mods and both agree that there are no typos/mistakes/misinformation
* Everyone should feel free to propose suggestions to reword any documentation. Just post a topic here, or reply if a topic is already discussing the article you'd like to improve.
* Doc mods should feel free to post drafts in this forum, or any other "hidden" documentation they're preparing on the side. The more eyes the better. (Just make sure you have another mod sign off before publishing!)
* Write your documentation for the idiot. Sorry if that's not politically correct, but try to make your solutions understandable by 8 year olds. If you need to add technical stuff to explain it, try to organize your solution so that you give the basics of the problem/solution up top, and a disclaimer "For more detailed/technical information, see below".
* Follow similar form across documents where possible. (Don't freak out if yours is slightly different. Fix it if you have time, or leave it.) See below for an example
* Stay Classy
Enjoy documenting!!
--TE[/quote]
And here are his thoughts on writing help articles for the (obsolete) knowledge base:
[quote]Subject: Try to include the exact error text seen by the user in the subject. eg: "How do I fix 'Cannot connect to lobby'?"
* At the top, include the question or error text at the top of the article so users know where they are. A good start is: "This solution covers the following error messages..."
* Underneath, include symptoms or other specific info that uniquely identifies the issue/problem. This is important because there could be 2 or more ways for a user to receive the same error text/problem. "Do you see 'Could not connect to Lobby' when clicking 'Free Games Listing'? Or do you see that error message in the middle of gameplay after being kicked out?"<br>
A good example is: "You receive the error 'blahblahblah' when clicking yaddayadda after you did suchandsuch"
* (this isn't necessary but depending on problem can help) Identify the cause of the problem in a small sentence/paragraph. eg: "This problem is encountered when Allegiance cannot talk to the server; something is likely blocking it"
* Solution. This should list specific steps (as exact as possible) on how to resolve the symptoms read at the top of the article.
** Separate multiple solutions visually. Paragraphs with bold headlines clearly separate one section of a solution from another
** bullet points separate steps visually too
** The solution is dependant on what's being fixed, so there's leeway here. Just make sure you cover the bases and lay out the solution in clear/easy wording (Not too technical!) and visually separate the solution from the rest of the document. Most users dart their eyes straight to a set of itemized instructions on how to fix it instead of reading your whole article. Don't be sad - it's not because of your writing.
** format your stuff nicer than this example. I'm lazy today and didn't watch my capitals, bolds, italics, etc.
* Additional Information should be separated below the solution under its own heading. Put technical stuff here for the people who want to know specifics
* Always include a link to the helpline somewhere in the article with text like "If this didn't solve your problem, go here and post a new topic"
* Feel free to be lazy and copy/paste sections to your new articles - it'll help keep everything consistent. Just make sure you proofread what you've copied!!!!!!!11
In everything you write, try to visually separate important strings from your text. Ideally all filepaths, registry keys, and other technical strings should be in Courier New, or other monospaced font to distinguish it from text. Otherwise users may not know whether you're talking about different program files like word and excel or the program files folder. See what I did there? Annoying, ain't it?
Make it stand out. (If you can't do fonts, do bold/italics/underlines/colours/whatever is at your disposal. Don't overdo the color though)
OK that's good enough.
Obviously everything can't be covered identically so use your judgement as best you can... but we should make an effort to keep things in a consistant format. If you think anything about this format sucks, propose improvements. Documentation is always changing, and if you can make it better, let's hear it!!
--TE[/quote]


<!---FYI - Any headers stuck under here will be fubarred by the quote tags --->
* '''A'''llegiance. This wiki is about [[Allegiance]], for Allegiance players. Don't forget that when you're writing.
* '''B'''e bold! So says Wikipedia. If you see a mistake, be it a fact or a typo, change it. Don't leave it to someone else to clean up mistakes. Feel free to make changes. If you think an article needs a major rewrite, then if you think you can do it, go ahead and do it. You can also use the discussion (talk) page to post suggestions.
* '''C'''ategories: When editing a page, stop to think about what categories it should be included in, and add them if necessary. Don't forget to consider categories that don't yet exist.
* '''D'''iscussion: Unlike most wikis, clicking the discussion link on a page will automaticcaly create a new forum thread about the article. Since no one likes the forum cluttered by empty threads, only click discussion if you actually have something to discuss!
* '''E'''nglish: Should you use American English, or Rest-of-the-World English? Use whatever is comfortable for you.
* '''F'''ulfill: Don't create one line articles that aren't linked to from any other page, nor link out to any other page.
* '''G'''reed shall not be your motivation, but grace shall.
* '''H'''eadings: Organize the content of each page into sections of related information. After the introduction, use appropriate headings for each section, and follow the '''N'''aming style of this guide. Keep number of headings to a minimum, consider a list or a table if you have many repetitive facts.
* '''I'''mages: Only [[Allegwiki moderator]]s can upload images, but that doesn't stop you creating them and handing them on. Use your photoshop skills to create beautiful, relevant pictures!
* '''J'''ealousy: Don't be shocked if someone rewrites or removes your article; your hard work is not lost.
* '''K'''
* '''L'''inks: Although it is good to fill your article with links, it is easy to get carried away. If you want to turn a word into a link, only do so for its first appearance in the article, not every single time it crops up (unless of course the article is extremely long).
* '''M'''inor edits: If you are making small changes, such as correcting typos, check the <tt>This is a minor edit</tt> box that is near the <tt>Save</tt> button.
* '''N'''aming: The titles of new pages should be <u>singular</u> nouns, with <u>only the first word capitalized</u>. Example: [[Squad leader]], not "Squad Leader" or "Squad leaders". The exceptions are terms that are always plural and proper nouns. Getting the wrong name can mean extra redirects and always means a page move.
* '''O'''
* '''P'''review: Use the preview button to check for typos. Avoid cluttering the history of a page with multiple edits.
* '''Q'''ueue: Check the [[AllegWiki:Improvement project|improvement project]] for work underway that you can help out on. Or try your hand at the special pages, such as [[Special:Deadendpages|dead end pages]], [[Special:Uncategorizedcategories|uncategorized categories]], [[Special:DoubleRedirects|double redirects]], [[Special:BrokenRedirects|broken redirects]], and [[Special:Specialpages|others]] that all need work occasionally. If you feel more like writing content than maintaining the wiki, the list of [[:Category:Stub|stub pages]] is a good place for you to start, followed by the [[Special:ShortPages|short pages]] that exist.
* '''R'''edundancy: Before creating a new page, do a search to find out if the topic is already discussed in detail somewhere else. If you find that redundant pages already exist, merge their content and have one redirect to the other. This rule also refers to redundant material inside pages.
* '''S'''tyle: In general, try to follow the [http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia Manual of Style] when writing articles.
* '''T'''imelessness: The wiki is intended as a guide for all players, now and in the future. Use of phrases like "recently", "currently" and "now" should be avoided, as they quickly render the article out of date.
* '''U'''niversal: Although Allegiance is primarily an American game it is now played by people around the world, including both hemispheres. When talking about the time of year use the name of the month, as words like "Spring" and "Fall" are not relevant to many players.
* '''V'''
* '''W'''it: Humour can be hard to recognise once it has been written down. Avoid using tongue-in-cheek, smart-ass commentary, etc. as it will undoubtedly be taken the wrong way by someone.
* '''X'''
* '''Y'''
* '''Z'''

Revision as of 22:00, 21 March 2009

PRIMARY
The Wiki is a resource for new players. It has articles:

Explaining what the game is
Explaining how to download and install
Covering most of newbies' FAQ
Links to where they can learn gameplay material
A copy of the Cadet I training program

A repository of technical information, for example:

Troubleshooting guide
Development

A repository of community history, for example:

General history
Zone games
Tournament results

Secondary
Community related information:

Squads, Current events, enforcement issues, etc.

A repository of development information

Changelogs, etc.

Guides to using Alleg-related programs

Teamspeak, Map Editor, ICE, etc.

Allegwiki was established in September 2007 and since then has grown vastly in breadth and scope. Originally it was designed to replace the cumbersome Knowledge Base but it has gradually had more articles added to it until it rivals the Academy in content. The wiki is still somewhat unorganised but can be broken down into several key sections as shown on the table on the right.

Content policy

Allegwiki is designed as a reference source whether it be tech support, squad information, or community history. As such there are no training guides on the wiki (with the exception of the Cadet I training guide and the Allegiance Command School).

You may feel free to add anything you like to Allegwiki as long as it is factual, as opposed to advice on playing the game. If you add something borderline you will be contacted by an Allegwiki moderator to discuss your contribution.

Rules

There are only two rules, but there are plenty of guidelines (see below).

  1. You cannot edit if your forum post count is less than 50 (exception being people who're Supporters).
  2. You cannot move or delete pages, or upload files. If you need any of these tasks done contact one of the Allegwiki moderators.

See also

Guidelines

  • Allegiance. This wiki is about Allegiance, for Allegiance players. Don't forget that when you're writing.
  • Be bold! So says Wikipedia. If you see a mistake, be it a fact or a typo, change it. Don't leave it to someone else to clean up mistakes. Feel free to make changes. If you think an article needs a major rewrite, then if you think you can do it, go ahead and do it. You can also use the discussion (talk) page to post suggestions.
  • Categories: When editing a page, stop to think about what categories it should be included in, and add them if necessary. Don't forget to consider categories that don't yet exist.
  • Discussion: Unlike most wikis, clicking the discussion link on a page will automaticcaly create a new forum thread about the article. Since no one likes the forum cluttered by empty threads, only click discussion if you actually have something to discuss!
  • English: Should you use American English, or Rest-of-the-World English? Use whatever is comfortable for you.
  • Fulfill: Don't create one line articles that aren't linked to from any other page, nor link out to any other page.
  • Greed shall not be your motivation, but grace shall.
  • Headings: Organize the content of each page into sections of related information. After the introduction, use appropriate headings for each section, and follow the Naming style of this guide. Keep number of headings to a minimum, consider a list or a table if you have many repetitive facts.
  • Images: Only Allegwiki moderators can upload images, but that doesn't stop you creating them and handing them on. Use your photoshop skills to create beautiful, relevant pictures!
  • Jealousy: Don't be shocked if someone rewrites or removes your article; your hard work is not lost.
  • K
  • Links: Although it is good to fill your article with links, it is easy to get carried away. If you want to turn a word into a link, only do so for its first appearance in the article, not every single time it crops up (unless of course the article is extremely long).
  • Minor edits: If you are making small changes, such as correcting typos, check the This is a minor edit box that is near the Save button.
  • Naming: The titles of new pages should be singular nouns, with only the first word capitalized. Example: Squad leader, not "Squad Leader" or "Squad leaders". The exceptions are terms that are always plural and proper nouns. Getting the wrong name can mean extra redirects and always means a page move.
  • O
  • Preview: Use the preview button to check for typos. Avoid cluttering the history of a page with multiple edits.
  • Queue: Check the improvement project for work underway that you can help out on. Or try your hand at the special pages, such as dead end pages, uncategorized categories, double redirects, broken redirects, and others that all need work occasionally. If you feel more like writing content than maintaining the wiki, the list of stub pages is a good place for you to start, followed by the short pages that exist.
  • Redundancy: Before creating a new page, do a search to find out if the topic is already discussed in detail somewhere else. If you find that redundant pages already exist, merge their content and have one redirect to the other. This rule also refers to redundant material inside pages.
  • Style: In general, try to follow the Wikipedia Manual of Style when writing articles.
  • Timelessness: The wiki is intended as a guide for all players, now and in the future. Use of phrases like "recently", "currently" and "now" should be avoided, as they quickly render the article out of date.
  • Universal: Although Allegiance is primarily an American game it is now played by people around the world, including both hemispheres. When talking about the time of year use the name of the month, as words like "Spring" and "Fall" are not relevant to many players.
  • V
  • Wit: Humour can be hard to recognise once it has been written down. Avoid using tongue-in-cheek, smart-ass commentary, etc. as it will undoubtedly be taken the wrong way by someone.
  • X
  • Y
  • Z