Guidelines - Revision history

Albie: Added cat.

2013-06-22T20:45:12Z

Added cat.

← Older revision		Revision as of 20:45, 22 June 2013
Line 52:		Line 52:
	'''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. (For example [[$chan]])		* <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]]

Cail: how 'bout now?

2007-07-02T10:23:48Z

how 'bout now?

← Older revision		Revision as of 10:23, 2 July 2007
Line 34:		Line 34:
	* If the command/identifier/whatever is complex enough to be needed to demonstrate further, use <nowiki>== Examples ==</nowiki> to start a section with more examples. Remember to add links to other wiki items such as <nowiki>[[var]]</nowiki> 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 <nowiki>'' ''</nowiki>.		* If the command/identifier/whatever is complex enough to be needed to demonstrate further, use <nowiki>== Examples ==</nowiki> to start a section with more examples. Remember to add links to other wiki items such as <nowiki>[[var]]</nowiki> 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 <nowiki>'' ''</nowiki>.

	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":'''		''Syntax for "See also":''

	<nowiki> == See Also ==</nowiki> <br/>		<nowiki> == See Also ==</nowiki> <br/>

Cail: okay, removed the codebox

2007-07-02T10:22:33Z

okay, removed the codebox

← Older revision		Revision as of 10:22, 2 July 2007
Line 38:		Line 38:
	'''Syntax for "See also":'''		'''Syntax for "See also":'''

	<nowiki>== See Also ==</nowiki> <br/>		<nowiki> == See Also ==</nowiki> <br/>
	<nowiki>* [[link]] explanation</nowiki> <br />		<nowiki> * [[link]] explanation</nowiki> <br />
	<nowiki>* [[another link\|to somewhere]]</nowiki>		<nowiki> * [[another link\|to somewhere]]</nowiki>

	notes:		notes:

Cail: $identifier sound better than $variable ...

2007-07-02T10:21:26Z

$identifier sound better than $variable ...

← Older revision		Revision as of 10:21, 2 July 2007
Line 10:		Line 10:

	'''Topic (the name of the page) examples'''		'''Topic (the name of the page) examples'''
	* $~~variable~~		* $identifier
	* Command		* Command
	* On_join		* On_join

Cail: changed a bit more

2007-07-02T10:18:21Z

changed a bit more

← Older revision		Revision as of 10:18, 2 July 2007
Line 34:		Line 34:
	* If the command/identifier/whatever is complex enough to be needed to demonstrate further, use <nowiki>== Examples ==</nowiki> to start a section with more examples. Remember to add links to other wiki items such as <nowiki>[[var]]</nowiki> 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 <nowiki>'' ''</nowiki>.		* If the command/identifier/whatever is complex enough to be needed to demonstrate further, use <nowiki>== Examples ==</nowiki> to start a section with more examples. Remember to add links to other wiki items such as <nowiki>[[var]]</nowiki> 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 <nowiki>'' ''</nowiki>.

	~~'''~~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":''		'''Syntax for "See also":'''

	<nowiki>== See Also ==</nowiki> <br/>		<nowiki>== See Also ==</nowiki> <br/>
	<nowiki>* [[link]] explanation</nowiki> <br />		<nowiki>* [[link]] explanation</nowiki> <br />
	<nowiki>* [[another link\|to somewhere]]</nowiki>		<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'''

Cail: added stuff about the "see also" READ!

2007-07-02T10:11:37Z

added stuff about the "see also" READ!

← Older revision		Revision as of 10:11, 2 July 2007
Line 36:		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>


	'''Stubs'''		'''Stubs'''

Microbe: clarified some places and removed irrelevant parts

2006-05-05T12:22:29Z

clarified some places and removed irrelevant parts

← Older revision		Revision as of 12:22, 5 May 2006
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 ==

	~~The following syntax is to be used in ALL mIRC help pages. (Parts like "use italic in return values" are to be used in full tutorials & scripts aswell.)~~

	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 ;.		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 ;.
Line 37:		Line 38:

	'''Stubs'''		'''Stubs'''
	* If you know your article is incomplete you can add <nowiki>{{Stub}}</nowiki> marking it as incomplete ~~and placing it in the [[:Category:Stubs]]~~ for others/yourself to complete later on. It appears to look the best if you add it at the top of the page~~. To make sure whoever reads the article knows that it is 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]])



	~~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.~~

Doomie at 12:03, 5 May 2006

2006-05-05T12:03:47Z

← Older revision		Revision as of 12:03, 5 May 2006
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.



			The following syntax is to be used in ALL mIRC help pages. (Parts like "use italic in return values" are to be used in full tutorials & scripts aswell.)

			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 ;.

Doomie at 11:59, 5 May 2006

2006-05-05T11:59:11Z

← Older revision		Revision as of 11:59, 5 May 2006
Line 38:		Line 38:


	Feel free to ask any editor if you are unsure about specific subjects. To get ~~examples~~, just take a look at already added articles.		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.

Doomie at 11:58, 5 May 2006

2006-05-05T11:58:35Z

← Older revision		Revision as of 11:58, 5 May 2006
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.


			'''Topic (the name of the page) examples'''
			* $variable
			* 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 <nowiki>'' ''</nowiki> 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 <nowiki>'' ''</nowiki> 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 <nowiki>== Examples ==</nowiki> to start a section with more examples. Remember to add links to other wiki items such as <nowiki>[[var]]</nowiki> 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 <nowiki>'' ''</nowiki>.

			'''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>.

			'''Stubs'''
			* If you know your article is incomplete you can add <nowiki>{{Stub}}</nowiki> marking it as incomplete and placing it in the [[:Category:Stubs]] for others/yourself to complete later on. It appears to look the best if you add it at the top of the page. To make sure whoever reads the article knows that it is incomplete.

			'''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.



			Feel free to ask any editor if you are unsure about specific subjects. To get examples, just take a look at already added articles.