Contributing to the wiki
The Warboard is a roadmap detailing how to create an ideal GScript wiki, in the never-ending war against a lack of documentation! It also explains a few useful features you will find. Contributors should read this document before adding any documents to the wiki.
Introduction
The GScript Wiki aims to be more in the style of the PHP Manual, with the idea being that every function, built-in variable, etc. will have a page not only explaining it's exact use, but also providing small snippets of code which demonstrate how they can be integrated into your code.
In order to create a worthwhile resource of scripting documentation, we need to create:
- A complete set of documents explaining:
- Functions (clientside and serverside)
- Language constructs (return, for, while, ...)
- Variable prefixes (temp, this, player, ...)
- Event functions (onCreated, onPlayerEnters, onPlayerChats, ...)
- A sensible way of organising all of the documents:
- The Wikka category system can be used to automatically arrange pages into categories just by placing tags at the bottom of the page
- Templates for pages for consistency
Remember, it's not just about adding new pages to the wiki. If you feel there are existing pages that can be improved, go ahead and improve them.
Finding something to write about
If you aren't sure what to write about, consider the following sources for inspiration:
- WantedPages, an automatically generated list of pages which have been linked to inside the wiki that don't exist yet (just click one and start editing, but please make sure that the page names are lower case for function and variable names). Some of the entries here might be junk from when spammers have got to the wiki, but there should be some useful stuff in there.
- Graal Bible, where there are lists upon lists of things that need documenting!
Creating pages
Before creating or editing pages on the wiki, you must first register an account. Please do not use the same username and password combination as your Graal account.
Once you are logged in, simply modify the end of the URL, for example, replacing "Warboard" with the desired name of the page.
Category system
The Wiki already has an automatic category system that means we can put pages into categories without having to link the pages up manually. For instance, we would have a category for clientside functions, serverside functions, event functions, variable prefixes, language constructs, so on and so forth.
It is important to specify a set of categories and stick with them, so that things can be found easily.
Chosen categories
- CategoryFunctionClientside
- CategoryFunctionServerside
- CategoryFunctionEvent
- CategoryObjectFunction (for things like obj.add())
- CategoryLanguageConstruct
- CategoryBuiltInVariable
- CategoryVariablePrefix
- CategoryTutorial
- CategoryExampleCode
Editor categories
These categories are for the use of wiki editors. These category markers should be removed once the page has been fixed.
- CategoryExpansionRequired should be used to mark a page that does not contain enough information and should be expanded
- CategoryInconsistentFormatting should be used to mark a page that does not have consistent formatting and should be fixed
- CategoryReferToComments should be used to mark a page that has on-going discussion in the comments section regarding the page's contents, formatting or categorisation
More information is available on the QualityControl page about how to use these categories.
Adding a page to a category
When finished editing a page, simply add a Category tag to the end of the page, like so:
===Categories=== CategoryLanguageConstruct
Consistency
In order to maintain a consistent appearance across the wiki, template pages have been created for you to use. Simply copy and paste the wiki source of these pages and edit them to create your own.
- TemplateFunction should be used for clientside, serverside and event functions
- TemplateExampleCode should be used for posting example code/scripts
- TemplateBuiltInVariable should be used for posting information on built-in variables
Please use good English grammar and spelling while posting pages on the wiki, and where possible, please include notes on your edit at the bottom of the Edit page. This way, we can keep a track on edits in the Recent Changes.
If you see a page that you feel is out of place or inconsistent with other documents on the wiki, please edit and fix it.
You may need to leave a blank line after a subheading so that the pages look evenly spaced, for example:
===Heading=== Writing
The same applies with code blocks; they require a blank line before but not after.
Please also remember, where possible, to create inter-article links:
For server variables that are not readable by the client, see ##[[server]]##.
There are 6 comments on this page. [Display comments]