Contribution guidelines
From REALbasicWiki
Contents |
[edit] What's REALbasicWiki ?
The goal of REALbasicWiki is to provide additional information about REALbasic, especially:
- Programming tips & tricks
- Usual traps
- Information about poorly documented REALbasic features
- Other resources outside of what REAL Software provides
Of course, providing a full REALbasic documentation would be nice, but contributors may not have enough time to do something so tedious.
We are also committed to help beginners improving their knowledge.
[edit] Who can contribute ?
Everyone who is interested in REALbasic and wants to help (note you will need to sign up to edit/create articles. This is free and painless).
- Advanced or expert contributors can share their knowledge, correct mistakes, add their own creations of source code, plugins, blogs etc.
- Beginners can also really help by
- filling the blanks in the articles about basic knowledge
- asking for information that the community forgot to provide
- completing information in the "boxes" (class box, method box...)
- correcting typos, adding categories...
- Good graphists can propose icons to make the wiki more attractive
[edit] Do you want to practice wiki ?
It may not be easy to start editing in a wiki. If you want to train yourself, make sure to add
[[Category:Sandbox]]
at the end of your new article. This way, your article will not appear in the usual categories.
[edit] How to contribute ?
The first thing you have to do is to register. It is free and easy. You will then be allowed to edit/create articles.
- To extend existing articles, simply click on the edit button at the top of the page.
- To add a new article, follow the information on this page. This ensures you follow the common guidelines for this wiki.
| Do not copy the REALbasic documentation nor shall you copy other copyrighted material. Instead, use your own words when adding to this wiki. |
[edit] Presentation of the articles
- Your article should immediately start with the description of what you are talking about, without any Description or Summary headline. It is also a good idea to put in boldface the first occurrence of the title
- Constructors should be described apart from regular methods because they have a special role.
[edit] Available templates
The REALbasicWiki Templates (list) will help you providing information in a standard way (note that each template is documented).
[edit] Stub
When you create a page and do not have time to put much information, you should indicate that this article is a stub. You can achieve this by inserting
{{ stub }}
at the beginning of your article. See Template:Stub for more information.
[edit] Article skill
It is a good idea to indicate that your article is more specifically aimed at a particular user's skill. You should use the Template:Artskill template to to that.
Note: This method still needs some improvements.
[edit] Quote a bug report
If you ever need to quote a bug report from the REALbasic feedback system, use the Template:Bugreport template.
{{ bugreport|report_id}}
[edit] For classes, use the Classbox
The classbox template makes it easy to propose a comprehensive list of a class methods/properties...
