Difference between revisions of "Guidelines"
From Scriptwiki
m (Added cat.) |
|||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
As this wiki is supposed to be very user-friendly, all articles should follow the guidelines listed in here. Please note that we will not accept any articles not following these rules and reserve the right to block your account in case you break these rules repeatedly. | As this wiki is supposed to be very user-friendly, all articles should follow the guidelines listed in here. Please note that we will not accept any articles not following these rules and reserve the right to block your account in case you break these rules repeatedly. | ||
| + | |||
| + | Feel free to ask any editor if you are unsure about specific subjects. To get an example, just take a look at already added articles. | ||
| + | |||
| + | == Guidelines == | ||
| + | |||
| + | |||
| + | If you wish to add comments to your examples (to the same 'example box') in the article, you can do it either by adding two spaces and a ; (like: echo -a blah ;this is an echo) OR adding the comment to the next line, starting it with a space and a ;. Comments outside the 'example box' shouldn't include the ;. | ||
'''Topic (the name of the page) examples''' | '''Topic (the name of the page) examples''' | ||
| − | * $ | + | * $identifier |
* Command | * Command | ||
* On_join | * On_join | ||
| Line 29: | Line 36: | ||
'''Add "See also" and Category''' | '''Add "See also" and Category''' | ||
* It's good to add a 'see also' section with <nowiki>== See also ==</nowiki> at the end of the article that contains useful links to similar commands/identifiers/whatever. Remember also to add the article to the correct category/categories with adding <nowiki>[[Category:name_of_the_category]] at the end. Like [[Category:Text and Number Identifiers]]</nowiki>. | * It's good to add a 'see also' section with <nowiki>== See also ==</nowiki> at the end of the article that contains useful links to similar commands/identifiers/whatever. Remember also to add the article to the correct category/categories with adding <nowiki>[[Category:name_of_the_category]] at the end. Like [[Category:Text and Number Identifiers]]</nowiki>. | ||
| + | ''Syntax for "See also":'' | ||
| + | |||
| + | <nowiki> == See Also ==</nowiki> <br/> | ||
| + | <nowiki> * [[link]] explanation</nowiki> <br /> | ||
| + | <nowiki> * [[another link|to somewhere]]</nowiki> | ||
| + | |||
| + | notes: | ||
| + | * Use "See Also", and not "Also See". | ||
| + | * List different items with the star <nowiki>*</nowiki>. | ||
| + | * Try to start the line with the link: <nowiki>* [[link]] and then some explanation</nowiki> | ||
'''Stubs''' | '''Stubs''' | ||
| − | * If you know your article is incomplete you can add <nowiki>{{Stub}}</nowiki> marking it as incomplete | + | * If you know your article is incomplete you can add <nowiki>{{Stub}}</nowiki> marking it as incomplete for others/yourself to complete later on. It appears to look the best if you add the <nowiki>{{Stub}}</nowiki> at the top of the page. |
'''Shared articles''' | '''Shared articles''' | ||
| − | * <nowiki>{{Disambling}}</nowiki> is used to split articles into smaller pieces when article holds reference to more than one article and it's '''not''' unambiguous where it should belong. | + | * <nowiki>{{Disambling}}</nowiki> is used to split articles into smaller pieces when article holds reference to more than one article and it's '''not''' unambiguous where it should belong. (For example [[$chan]]) |
| − | + | [[Category:Wiki]] | |
| − | |||
| − | |||
Latest revision as of 21:45, 22 June 2013
As this wiki is supposed to be very user-friendly, all articles should follow the guidelines listed in here. Please note that we will not accept any articles not following these rules and reserve the right to block your account in case you break these rules repeatedly.
Feel free to ask any editor if you are unsure about specific subjects. To get an example, just take a look at already added articles.
Guidelines
If you wish to add comments to your examples (to the same 'example box') in the article, you can do it either by adding two spaces and a ; (like: echo -a blah ;this is an echo) OR adding the comment to the next line, starting it with a space and a ;. Comments outside the 'example box' shouldn't include the ;.
Topic (the name of the page) examples
- $identifier
- Command
- On_join
- If-Then-Else
First line of the text
- Short description what it does / what it's good for.
- Example: Returns the Nth token in text. A token is blah blah blah.
Second line of the text
- The syntax, starting with a space to get a box around it.
- Example: (space)$gettok(text,N,C)
Next one/few line(s) of the text
- Explanation what the non-trivial parameters mean. The parameter(s) is/are to be inside '' '' to make it italic.
- Example: C is the ascii number of the character that is set to separate the tokens blah blah.
Next one/few line(s) of the text
- Short example(s) how to use the command/identifier/whatever. The (possible) return value is to be inside '' '' to make it italic.
- Example: //echo -a $gettok(this.is.text,2,46) returns is.
Sections
- If the command/identifier/whatever is complex enough to be needed to demonstrate further, use == Examples == to start a section with more examples. Remember to add links to other wiki items such as [[var]] for the first occurence in each article. All example lines are to be started with a space and all return values are to be put inside '' ''.
Add "See also" and Category
- It's good to add a 'see also' section with == See also == at the end of the article that contains useful links to similar commands/identifiers/whatever. Remember also to add the article to the correct category/categories with adding [[Category:name_of_the_category]] at the end. Like [[Category:Text and Number Identifiers]].
Syntax for "See also":
== See Also ==
* [[link]] explanation
* [[another link|to somewhere]]
notes:
- Use "See Also", and not "Also See".
- List different items with the star *.
- Try to start the line with the link: * [[link]] and then some explanation
Stubs
- If you know your article is incomplete you can add {{Stub}} marking it as incomplete for others/yourself to complete later on. It appears to look the best if you add the {{Stub}} at the top of the page.
Shared articles
- {{Disambling}} is used to split articles into smaller pieces when article holds reference to more than one article and it's not unambiguous where it should belong. (For example $chan)
