Help:Editing - Revision history

PhilmASTErpLus: Changed

to

,

to

, etc.

2010-06-21T07:04:50Z

Changed <h1> to <h2>, <h2> to <h3>, etc.

← Older revision		Revision as of 07:04, 21 June 2010
Line 1:		Line 1:
	{{TOCright}}		{{TOCright}}
	=ASH Scripting=
	==Adding New Function Pages==		== ASH Scripting ==

			=== Adding New Function Pages ===
	<p>For a list of functions that don't have a page, please see: [[Ash Functions]]. All red links mean the page doesn't exist; if you click on one, you'll have the option to create it.</p>		<p>For a list of functions that don't have a page, please see: [[Ash Functions]]. All red links mean the page doesn't exist; if you click on one, you'll have the option to create it.</p>
	<p>For information on how to add new functions to the wiki according to our current standards, please refer to [[Template:FunctionPage]] as well as the additional templates referenced on that page.</p>		<p>For information on how to add new functions to the wiki according to our current standards, please refer to [[Template:FunctionPage]] as well as the additional templates referenced on that page.</p>
	<p>Also note that you can click "Edit" on an existing page, and it will list all templates in use by that page at the bottom.</p>		<p>Also note that you can click "Edit" on an existing page, and it will list all templates in use by that page at the bottom.</p>
	<p><b>IMPORTANT!</b>: If you add a new function page, please make sure to either add the function to the category-like pages linked to on the main page using the <nowiki>{{Flink}}</nowiki> template OR set the category of the function to "Uncategorized."</p>		<p><b>IMPORTANT!</b>: If you add a new function page, please make sure to either add the function to the category-like pages linked to on the main page using the <nowiki>{{Flink}}</nowiki> template OR set the category of the function to "Uncategorized."</p>
	===Information Only===
			==== Information Only ====
	<p>If you'd like to help provide information for a page, but don't feel like diving into the ins-and-outs of our template system, please feel free to edit in whatever information you'd like! If the page already exists, please do all of your edits on the page's Discussion page. If the page doesn't exist, feel free to edit the page itself. Either way, <b>please</b> copy & paste the following somewhere on the page you edit so we can keep track of where we need to add formatting: <nowiki>{{Format}}</nowiki></p>		<p>If you'd like to help provide information for a page, but don't feel like diving into the ins-and-outs of our template system, please feel free to edit in whatever information you'd like! If the page already exists, please do all of your edits on the page's Discussion page. If the page doesn't exist, feel free to edit the page itself. Either way, <b>please</b> copy & paste the following somewhere on the page you edit so we can keep track of where we need to add formatting: <nowiki>{{Format}}</nowiki></p>
	==Updating Current Pages==
			=== Updating Current Pages ===
	<p>Quite a few pages exist, but are in need of some help.</p>		<p>Quite a few pages exist, but are in need of some help.</p>
	==Request for Information==
			=== Request for Information ===
	<p>Anything listed here: [[:Category:Request_For_Information]] is missing important information on how the function operates. Please add in anything you can.</p>		<p>Anything listed here: [[:Category:Request_For_Information]] is missing important information on how the function operates. Please add in anything you can.</p>
	<p>If you've filled in all of the requested information, please remove <nowiki>{{RFI}}</nowiki> from the bottom of the page.</p>		<p>If you've filled in all of the requested information, please remove <nowiki>{{RFI}}</nowiki> from the bottom of the page.</p>
	==Code Samples==
			=== Code Samples===
	<p>Anything listed here: [[:Category:Needs_Code_Sample]] either needs a code sample, or needs improvements made to its current code samples.</p>		<p>Anything listed here: [[:Category:Needs_Code_Sample]] either needs a code sample, or needs improvements made to its current code samples.</p>
	<p>Please refer to [[Template:CodeSample]] for information on how to add them to pages.</p>		<p>Please refer to [[Template:CodeSample]] for information on how to add them to pages.</p>
	==Formatting Requested==
			=== Formatting Requested ===
	<p>Anything listed here: [[:Category:Formatting Needed]] has information, but lacks page formatting. If you'd like to edit the page so that it includes any appropriate templates, please do so (and remove the line that reads <nowiki>{{Format}}</nowiki> when done.</p>		<p>Anything listed here: [[:Category:Formatting Needed]] has information, but lacks page formatting. If you'd like to edit the page so that it includes any appropriate templates, please do so (and remove the line that reads <nowiki>{{Format}}</nowiki> when done.</p>
	~~==Datatypes==~~

			=== Datatypes ===
	We need a deep overhaul of these. Currently, various templates link to each as if it's on its own page, but this is possible to change if we find it necessary. However, each having its own page would result in better search functionality.		We need a deep overhaul of these. Currently, various templates link to each as if it's on its own page, but this is possible to change if we find it necessary. However, each having its own page would result in better search functionality.

	Also, we should clarify the difference between say, "class" the datatype and "$class" the built-in way to cast to and from "class" with strings / etc. I don't really grok the programming philosophy and jargon well enough to handle this myself.		Also, we should clarify the difference between say, "class" the datatype and "$class" the built-in way to cast to and from "class" with strings / etc. I don't really grok the programming philosophy and jargon well enough to handle this myself.

	==Versions==		=== Versions ===

	Please note! In general, KoLmafia version numbers should be omitted from descriptions. If, for example, a function is new as of a certain version, there's no need to mention that. This wiki is intended as a guide & reference to the current version of KoLmafia.		Please note! In general, KoLmafia version numbers should be omitted from descriptions. If, for example, a function is new as of a certain version, there's no need to mention that. This wiki is intended as a guide & reference to the current version of KoLmafia.
Line 32:		Line 39:
	The only exception to this rule on mentioning versions is if you know the information on the wiki is OUT OF DATE; in this case it is appropriate to mention that the information is accurate as of a specified version. For most cases, such pages should be tagged with an RFI requesting an update. A few pages can be an exception to this as well; notably the [[Ash Functions\|Master Function List]], which will only be sporadically updated until a good automated way of doing so can be put in place.		The only exception to this rule on mentioning versions is if you know the information on the wiki is OUT OF DATE; in this case it is appropriate to mention that the information is accurate as of a specified version. For most cases, such pages should be tagged with an RFI requesting an update. A few pages can be an exception to this as well; notably the [[Ash Functions\|Master Function List]], which will only be sporadically updated until a good automated way of doing so can be put in place.

	=Main Interface=		== Main Interface ==
	==CLI Commands==		=== CLI Commands ===
	While the [[CLI Reference]] is a great start, it would be nice to:		While the [[CLI Reference]] is a great start, it would be nice to:
	* See this information presented in a "cleaner" format (I'm thinking each parameter should be a list item with its own explanation, probably).		* See this information presented in a "cleaner" format (I'm thinking each parameter should be a list item with its own explanation, probably).
	* Show examples for as much as possible, saying what that example will do.		* Show examples for as much as possible, saying what that example will do.
	==Other==
			=== Other ===
	The Adventuring, Item Manager, etc. windows / tabs could use more documentation. Sally's guide is a nice start, but eventually it would be nice to have comprehensive pages for everything.		The Adventuring, Item Manager, etc. windows / tabs could use more documentation. Sally's guide is a nice start, but eventually it would be nice to have comprehensive pages for everything.

	=Miscellaneous=
	==Preferences==		== Miscellaneous ==
			=== Preferences ===
	The [[KoLmafia Properties]] is a nice start, but an explanation of what each option does would be ideal. Again, this will probably require something beyond a table; probably a list of what each option is and does following the preference.		The [[KoLmafia Properties]] is a nice start, but an explanation of what each option does would be ideal. Again, this will probably require something beyond a table; probably a list of what each option is and does following the preference.

	==Jargon==		=== Jargon ===
	I know, but not everyone visiting this wiki will understand, that:		I know, but not everyone visiting this wiki will understand, that:
	* Seeing a parameter in square brackets means it's optional.		* Seeing a parameter in square brackets means it's optional.
Line 53:		Line 62:
	* Countless other things that I can't come up with at the moment (feel free to add them here).		* Countless other things that I can't come up with at the moment (feel free to add them here).
	It would be great to have a page explaining these things, or linking to other pages that do, linked to on the front page.		It would be great to have a page explaining these things, or linking to other pages that do, linked to on the front page.
	==Format-breaking==
			=== Format-breaking ===
	Here is an incomplete list of known issues with wiki-markup which lead to erratic formatting (and fixes):		Here is an incomplete list of known issues with wiki-markup which lead to erratic formatting (and fixes):
	* Ending a function description with a list will break the whole page, if a code sample is present.		* Ending a function description with a list will break the whole page, if a code sample is present.
Line 62:		Line 72:
	** If you don't want it to be part of a list (see [[Cli]] for an instance of this), surround the asterisk with <nowiki><nowiki></nowiki> tags, as such: <nowiki><nowiki>*</nowiki</nowiki>>		** If you don't want it to be part of a list (see [[Cli]] for an instance of this), surround the asterisk with <nowiki><nowiki></nowiki> tags, as such: <nowiki><nowiki>*</nowiki</nowiki>>

	=KoLmafia Guide=		== KoLmafia Guide ==

	[[KoLmafia Guide\|Sally's Guide]] is a special case as far as this wiki goes; please see the [[Talk:KoLmafia_Guide\|talk page]] for the guide for info on its editing guidelines.		[[KoLmafia Guide\|Sally's Guide]] is a special case as far as this wiki goes; please see the [[Talk:KoLmafia_Guide\|talk page]] for the guide for info on its editing guidelines.

Heeheehee: Linked to talk page for guide.

2010-05-18T00:08:06Z

Linked to talk page for guide.

← Older revision		Revision as of 00:08, 18 May 2010
Line 64:		Line 64:
	=KoLmafia Guide=		=KoLmafia Guide=

	[[KoLmafia Guide\|Sally's Guide]] is a special case as far as this wiki goes; please see the talk page for the guide for info on its editing guidelines.		[[KoLmafia Guide\|Sally's Guide]] is a special case as far as this wiki goes; please see the [[Talk:KoLmafia_Guide\|talk page]] for the guide for info on its editing guidelines.

Bale: /* Preferences */

2010-05-17T23:47:04Z

Preferences

← Older revision		Revision as of 23:47, 17 May 2010
Line 42:		Line 42:
	=Miscellaneous=		=Miscellaneous=
	==Preferences==		==Preferences==
	The [[~~List_of_KoLmafia_Properties~~]] is a nice start, but an explanation of what each option does would be ideal. Again, this will probably require something beyond a table; probably a list of what each option is and does following the preference.		The [[KoLmafia Properties]] is a nice start, but an explanation of what each option does would be ideal. Again, this will probably require something beyond a table; probably a list of what each option is and does following the preference.

	==Jargon==		==Jargon==
	I know, but not everyone visiting this wiki will understand, that:		I know, but not everyone visiting this wiki will understand, that:

StDoodle: /* Versions */

2010-04-30T23:52:08Z

Versions

← Older revision		Revision as of 23:52, 30 April 2010
Line 26:		Line 26:
	==Versions==		==Versions==

	Please note~~; eventually~~, ~~all mention of "~~as of version~~..." will become somewhat out-of-date. I~~'~~d like~~ to ~~propose~~ that ~~from here forward, we only mention versions if there are things ''missing'' from~~ a ~~list that are included in more modern versions (ie the [[Ash Functions\|Master Function List]] should mention when it was last updated); I'd prefer~~ to ~~add in a general note somewhere along~~ the ~~lines~~ of ~~"unless noted otherwise, all documentation refers to the latest daily build~~.~~" Thoughts? --[[User:StDoodle\|StDoodle (#1059825)]] 15:48, 30 April 2010 (UTC)~~		Please note! In general, KoLmafia version numbers should be omitted from descriptions. If, for example, a function is new as of a certain version, there's no need to mention that. This wiki is intended as a guide & reference to the current version of KoLmafia.

	~~:Please. Let~~'s ~~not make this wiki a history lesson~~ of ~~how every function gets changed~~. ~~Did~~ you ~~accidently post~~ this ~~here instead of on~~ the ~~Talk page? I'm afraid I don't quite understand your example~~ of ~~when to list~~ version ~~numbers~~. --[[~~User:Bale~~\|~~Bale~~]] ~~21:38~~, ~~30 April 2010 (UTC)~~		Some special pages may be included & linked to for historical notes, where they may be of interest, but let's try to keep that off of the main pages unless there is compelling reason to do otherwise.

			The only exception to this rule on mentioning versions is if you know the information on the wiki is OUT OF DATE; in this case it is appropriate to mention that the information is accurate as of a specified version. For most cases, such pages should be tagged with an RFI requesting an update. A few pages can be an exception to this as well; notably the [[Ash Functions\|Master Function List]], which will only be sporadically updated until a good automated way of doing so can be put in place.

	=Main Interface=		=Main Interface=

Bale: /* Versions */

2010-04-30T21:38:06Z

Versions

← Older revision		Revision as of 21:38, 30 April 2010
Line 27:		Line 27:

	Please note; eventually, all mention of "as of version..." will become somewhat out-of-date. I'd like to propose that from here forward, we only mention versions if there are things ''missing'' from a list that are included in more modern versions (ie the [[Ash Functions\|Master Function List]] should mention when it was last updated); I'd prefer to add in a general note somewhere along the lines of "unless noted otherwise, all documentation refers to the latest daily build." Thoughts? --[[User:StDoodle\|StDoodle (#1059825)]] 15:48, 30 April 2010 (UTC)		Please note; eventually, all mention of "as of version..." will become somewhat out-of-date. I'd like to propose that from here forward, we only mention versions if there are things ''missing'' from a list that are included in more modern versions (ie the [[Ash Functions\|Master Function List]] should mention when it was last updated); I'd prefer to add in a general note somewhere along the lines of "unless noted otherwise, all documentation refers to the latest daily build." Thoughts? --[[User:StDoodle\|StDoodle (#1059825)]] 15:48, 30 April 2010 (UTC)

			:Please. Let's not make this wiki a history lesson of how every function gets changed. Did you accidently post this here instead of on the Talk page? I'm afraid I don't quite understand your example of when to list version numbers. --[[User:Bale\|Bale]] 21:38, 30 April 2010 (UTC)

	=Main Interface=		=Main Interface=

StDoodle: stupid inconsistent capitalization...

2010-04-30T15:48:55Z

stupid inconsistent capitalization...

← Older revision		Revision as of 15:48, 30 April 2010
Line 26:		Line 26:
	==Versions==		==Versions==

	Please note; eventually, all mention of "as of version..." will become somewhat out-of-date. I'd like to propose that from here forward, we only mention versions if there are things ''missing'' from a list that are included in more modern versions (ie the [[~~ASH~~ Functions\|Master Function List]] should mention when it was last updated); I'd prefer to add in a general note somewhere along the lines of "unless noted otherwise, all documentation refers to the latest daily build." Thoughts? --[[User:StDoodle\|StDoodle (#1059825)]] 15:48, 30 April 2010 (UTC)		Please note; eventually, all mention of "as of version..." will become somewhat out-of-date. I'd like to propose that from here forward, we only mention versions if there are things ''missing'' from a list that are included in more modern versions (ie the [[Ash Functions\|Master Function List]] should mention when it was last updated); I'd prefer to add in a general note somewhere along the lines of "unless noted otherwise, all documentation refers to the latest daily build." Thoughts? --[[User:StDoodle\|StDoodle (#1059825)]] 15:48, 30 April 2010 (UTC)

	=Main Interface=		=Main Interface=

StDoodle at 15:48, 30 April 2010

2010-04-30T15:48:14Z

← Older revision		Revision as of 15:48, 30 April 2010
Line 23:		Line 23:

	Also, we should clarify the difference between say, "class" the datatype and "$class" the built-in way to cast to and from "class" with strings / etc. I don't really grok the programming philosophy and jargon well enough to handle this myself.		Also, we should clarify the difference between say, "class" the datatype and "$class" the built-in way to cast to and from "class" with strings / etc. I don't really grok the programming philosophy and jargon well enough to handle this myself.

			==Versions==

			Please note; eventually, all mention of "as of version..." will become somewhat out-of-date. I'd like to propose that from here forward, we only mention versions if there are things ''missing'' from a list that are included in more modern versions (ie the [[ASH Functions\|Master Function List]] should mention when it was last updated); I'd prefer to add in a general note somewhere along the lines of "unless noted otherwise, all documentation refers to the latest daily build." Thoughts? --[[User:StDoodle\|StDoodle (#1059825)]] 15:48, 30 April 2010 (UTC)

	=Main Interface=		=Main Interface=

StDoodle at 13:15, 27 April 2010

2010-04-27T13:15:08Z

← Older revision		Revision as of 13:15, 27 April 2010
Line 52:		Line 52:
	* Lines that start with an asterisk ( * ) are automatically added to a bulleted list (like this one here) whether you want it or not.		* Lines that start with an asterisk ( * ) are automatically added to a bulleted list (like this one here) whether you want it or not.
	** If you don't want it to be part of a list (see [[Cli]] for an instance of this), surround the asterisk with <nowiki><nowiki></nowiki> tags, as such: <nowiki><nowiki>*</nowiki</nowiki>>		** If you don't want it to be part of a list (see [[Cli]] for an instance of this), surround the asterisk with <nowiki><nowiki></nowiki> tags, as such: <nowiki><nowiki>*</nowiki</nowiki>>

			=KoLmafia Guide=

			[[KoLmafia Guide\|Sally's Guide]] is a special case as far as this wiki goes; please see the talk page for the guide for info on its editing guidelines.

Heeheehee: /* Format-breaking */ Added another case

2010-04-23T01:57:15Z

Format-breaking: Added another case

← Older revision		Revision as of 01:57, 23 April 2010
Line 50:		Line 50:
	* Multiple code samples on a single page lead to some extra tags.		* Multiple code samples on a single page lead to some extra tags.
	** Remove everything between the "</syntaxhighlight>}}" and the "{{CodeSample\|", leaving one line break between these two lines.		** Remove everything between the "</syntaxhighlight>}}" and the "{{CodeSample\|", leaving one line break between these two lines.
			* Lines that start with an asterisk ( * ) are automatically added to a bulleted list (like this one here) whether you want it or not.
			** If you don't want it to be part of a list (see [[Cli]] for an instance of this), surround the asterisk with <nowiki><nowiki></nowiki> tags, as such: <nowiki><nowiki>*</nowiki</nowiki>>

Heeheehee: /* Format-breaking */ Made " " actually appear. Silly HTML entities.

2010-03-23T05:20:43Z

Format-breaking: Made " " actually appear. Silly HTML entities.

← Older revision		Revision as of 05:20, 23 March 2010
Line 47:		Line 47:
	Here is an incomplete list of known issues with wiki-markup which lead to erratic formatting (and fixes):		Here is an incomplete list of known issues with wiki-markup which lead to erratic formatting (and fixes):
	* Ending a function description with a list will break the whole page, if a code sample is present.		* Ending a function description with a list will break the whole page, if a code sample is present.
	** Get around this by either using HTML, adding " " on a new line right before the "\|", or not ending a description with a list (avoid the problem in the first place!)		** Get around this by either using HTML, adding "&nbsp;" on a new line right before the "\|", or not ending a description with a list (avoid the problem in the first place!)
	* Multiple code samples on a single page lead to some extra tags.		* Multiple code samples on a single page lead to some extra tags.
	** Remove everything between the "</syntaxhighlight>}}" and the "{{CodeSample\|", leaving one line break between these two lines.		** Remove everything between the "</syntaxhighlight>}}" and the "{{CodeSample\|", leaving one line break between these two lines.