Help:Gadget-HotCat - Revision history

Stephensd at 12:04, 8 August 2013

2013-08-08T12:04:29Z

← Older revision		Revision as of 12:04, 8 August 2013
Line 1:		Line 1:
	~~{{Gadget-help\|name=HotCat\|script=HotCat\|doc=Help:Gadget-HotCat}}~~

	[[MediaWiki:Gadget-HotCat.js\|HotCat]] is a JavaScript extension of the MediaWiki user interface. It augments the category bar with quick links to remove, change, or add categories. It can be activated in the "Gadgets" tab of [[Special:Preferences]].		[[MediaWiki:Gadget-HotCat.js\|HotCat]] is a JavaScript extension of the MediaWiki user interface. It augments the category bar with quick links to remove, change, or add categories. It can be activated in the "Gadgets" tab of [[Special:Preferences]].

Stephensd at 12:03, 8 August 2013

2013-08-08T12:03:33Z

← Older revision		Revision as of 12:03, 8 August 2013
Line 106:		Line 106:
	=== Making more than one category change ===		=== Making more than one category change ===

	~~[[File:HotCat save button.png\|thumb\|In multi-change mode, category changes are saved only when the "save" button is clicked.]]~~
	The user interface of HotCat is minimalistic on purpose and geared towards making interactions simple and fast. When you just click on a "(−)" link to remove a category, the edit is—in the default setting of HotCat—executed right away, and likewise when you submit a single category addition or change.		The user interface of HotCat is minimalistic on purpose and geared towards making interactions simple and fast. When you just click on a "(−)" link to remove a category, the edit is—in the default setting of HotCat—executed right away, and likewise when you submit a single category addition or change.

	Still HotCat fully supports changing more than one category at once. If you click the "(+<sup>+</sup>)" link at the beginning of the category line, HotCat will enter its multi-change mode. The "(+<sup>+</sup>)" link is replaced by a "save" button, and all changes you make from now on will be written to the page only when that button is clicked. Initially, this button may appear disabled. It is enabled only when there are indeed category changes that need saving.		Still HotCat fully supports changing more than one category at once. If you click the "(+<sup>+</sup>)" link at the beginning of the category line, HotCat will enter its multi-change mode. The "(+<sup>+</sup>)" link is replaced by a "save" button, and all changes you make from now on will be written to the page only when that button is clicked. Initially, this button may appear disabled. It is enabled only when there are indeed category changes that need saving.
	~~{{-}}~~
	~~[[File:HotCat multimode.png\|800px\|In multi-change mode, changes are reflected on the page view, but are saved only when the "save" button is clicked.]]~~

	This multi-change mode is also entered automatically if you have one category input box open and, while it is still open, add, change, or remove another category.		This multi-change mode is also entered automatically if you have one category input box open and, while it is still open, add, change, or remove another category.
Line 334:		Line 331:
	Unknown shortcuts are not replaced at all. If you type "#foo", that will be left unchanged (with these two example shortcuts).		Unknown shortcuts are not replaced at all. If you type "#foo", that will be left unchanged (with these two example shortcuts).

	HotCat generally tries to leave your input as it is. It will do the replacements for its suggestion list, and when you save the category editor. So, if you type "#ppl“, you'll have "#ppl" in the category input box, but you'll be shown category suggestions starting with "People...". If you now select one of these suggestions, it'll replace whatever you had typed. To get back your input, hit the escape key (normally ~~{{keypress\|esc}}~~ on your keyboard, typically in the upper left corner of the keyboard).		HotCat generally tries to leave your input as it is. It will do the replacements for its suggestion list, and when you save the category editor. So, if you type "#ppl“, you'll have "#ppl" in the category input box, but you'll be shown category suggestions starting with "People...". If you now select one of these suggestions, it'll replace whatever you had typed. To get back your input, hit the escape key (normally Esc on your keyboard), typically in the upper left corner of the keyboard).

	== Localization ==		== Localization ==
Line 342:		Line 339:
	Put only the messages that you see translated in [[MediaWiki:Gadget-HotCat.js/de]] in a localization file here at the Commons. Other messages for edit summaries and so on belong into the <code>/local_defaults</code> file at your wiki (see [[#Using the Commons version of HotCat on another wiki\|below]]). Edit summaries should ''always'' be in the wiki's main language, even if the user's interface language is set to something else, so that other contributors have a chance to understand what the summaries mean. By putting translations for the edit summaries in <code>/local_defaults</code> at a foreign wiki, that wiki can customize the edit summaries in any way without changing the English default messages here at the Commons.		Put only the messages that you see translated in [[MediaWiki:Gadget-HotCat.js/de]] in a localization file here at the Commons. Other messages for edit summaries and so on belong into the <code>/local_defaults</code> file at your wiki (see [[#Using the Commons version of HotCat on another wiki\|below]]). Edit summaries should ''always'' be in the wiki's main language, even if the user's interface language is set to something else, so that other contributors have a chance to understand what the summaries mean. By putting translations for the edit summaries in <code>/local_defaults</code> at a foreign wiki, that wiki can customize the edit summaries in any way without changing the English default messages here at the Commons.

	<span style="border:1px solid #8888aa; background:#fff8cc; padding:0.2em;">As of Version 2.17</span>, HotCat supports complex plural forms in its <code>HotCat.messages.multi_change</code> message. (That is one of those that belongs in <code>/local_defaults</code>, as it is used in edit summaries.) Its default value (in English) is <code>"$1 categories"</code>; the "$1" is replaced by a number strictly greater than 1. For most languages, simply translating this string will be good enough. However, for languages that have several plural forms ~~such as the [[:w:en:Dual (grammatical form)\|dual]]~~, this may be insufficient. If your language ''has'' several plural forms, you can set <code>HotCat.messages.multi_change</code> to an array containing the various forms as strings (don't forget to include the "$1" as appropriate in each form). The array must be set up as is appropriate for your language's implementation of <code>mw.language.convertPlural()</code>~~. You can check that e.g. in [http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/resources/mediawiki.language/languages/ the MediaWiki source code]~~. On older MediaWiki installations that do not have <code>mw.language.convertPlural()</code>, HotCat will simply use the last element of the array.		<span style="border:1px solid #8888aa; background:#fff8cc; padding:0.2em;">As of Version 2.17</span>, HotCat supports complex plural forms in its <code>HotCat.messages.multi_change</code> message. (That is one of those that belongs in <code>/local_defaults</code>, as it is used in edit summaries.) Its default value (in English) is <code>"$1 categories"</code>; the "$1" is replaced by a number strictly greater than 1. For most languages, simply translating this string will be good enough. However, for languages that have several plural forms, this may be insufficient. If your language ''has'' several plural forms, you can set <code>HotCat.messages.multi_change</code> to an array containing the various forms as strings (don't forget to include the "$1" as appropriate in each form). The array must be set up as is appropriate for your language's implementation of <code>mw.language.convertPlural()</code>. On older MediaWiki installations that do not have <code>mw.language.convertPlural()</code>, HotCat will simply use the last element of the array.
	:Note that if you want to be sure that <code>mw.language.convertPlural()</code> exists, you should make sure that the "mediawiki.language" module is loaded (it doesn't appear to be a default module in MediaWiki 1.19). To do so, set up your gadget definition for HotCat in [[MediaWiki:Gadgets-definition]] ''on your wiki'' as follows:		:Note that if you want to be sure that <code>mw.language.convertPlural()</code> exists, you should make sure that the "mediawiki.language" module is loaded (it doesn't appear to be a default module in MediaWiki 1.19). To do so, set up your gadget definition for HotCat in [[MediaWiki:Gadgets-definition]] ''on your wiki'' as follows:
	::<nowiki>*HotCat[ResourceLoader\|dependencies=mediawiki.language]\|HotCat.js</nowiki>		::<nowiki>*HotCat[ResourceLoader\|dependencies=mediawiki.language]\|HotCat.js</nowiki>

Stephensd at 11:59, 8 August 2013

2013-08-08T11:59:30Z

← Older revision		Revision as of 11:59, 8 August 2013
Line 1:		Line 1:
	{{Gadget-help\|name=HotCat\|script=HotCat\|doc=Help:Gadget-HotCat}}		{{Gadget-help\|name=HotCat\|script=HotCat\|doc=Help:Gadget-HotCat}}

	~~<!-- From [[Template:header]] -->~~
	~~{\|border="0" cellspacing="0" cellpadding="2" style="margin:0 0 1em;width:100%;border:1px solid #cccccc;background:#f9f9f9"~~
	\|-
	~~\|valign="top" style="padding:2px 5px 0"\|~~
	~~<div style="color:#888888;font-size:x-small;line-height:1.2">'''{{{text\|This {{namespace}} in other languages:}}}'''</div><!--~~
	~~-->For basic (not specific to Commons) help on HotCat in your language see the interwiki links in the sidebar.~~
	~~{{!}}valign="top" style="padding:0"{{!}}~~
	\|}

	~~<div style="float:right; border:1px solid #8888aa; background:#fff8cc; padding:0.2em;">~~
	~~The Commons is running~~
	~~:'''Version 2.23'''~~
	~~of this gadget.~~
	~~<div style="font-size:smaller; text-align:right;">See the [[Help:Gadget-HotCat/Version history\|version history]].</div>~~
	~~</div>~~
	[[MediaWiki:Gadget-HotCat.js\|HotCat]] is a JavaScript extension of the MediaWiki user interface. It augments the category bar with quick links to remove, change, or add categories. It can be activated in the "Gadgets" tab of [[Special:Preferences]].		[[MediaWiki:Gadget-HotCat.js\|HotCat]] is a JavaScript extension of the MediaWiki user interface. It augments the category bar with quick links to remove, change, or add categories. It can be activated in the "Gadgets" tab of [[Special:Preferences]].

Line 105:		Line 90:
	HotCat tries to automatically resolve redirects between categories when the "OK"-button is clicked (or when a suggestion is double-clicked). If the selected category X is a redirect to another category Y, HotCat will automatically add the category Y instead of X.		HotCat tries to automatically resolve redirects between categories when the "OK"-button is clicked (or when a suggestion is double-clicked). If the selected category X is a redirect to another category Y, HotCat will automatically add the category Y instead of X.

	~~[[File:HotCat disambig.png\|right\|HotCat's input box with a suggestion list from a disambiguation page]]~~
	Similar processing is done for disambiguation categories. If HotCat detects that the chosen category is actually a disambiguation category, it will present again a suggestion list, this time filled from the categories being disambiguated. If, for instance, you entered "Buzet" as the category and then clicked "OK", you would see the suggestion list shown here, as these are all the categories mentioned at [[:Category:Buzet]].		Similar processing is done for disambiguation categories. If HotCat detects that the chosen category is actually a disambiguation category, it will present again a suggestion list, this time filled from the categories being disambiguated. If, for instance, you entered "Buzet" as the category and then clicked "OK", you would see the suggestion list shown here, as these are all the categories mentioned at [[:Category:Buzet]].

Line 114:		Line 98:
	If you change only a single category HotCat will—in its default configuration—perform the edit immediately.		If you change only a single category HotCat will—in its default configuration—perform the edit immediately.

	Sometimes you might still want to check what HotCat does before saving the modified page. To do so, use "control-clicking". Hold down the Control key (marked ~~{{keypress\|~~Ctrl}} on many keyboards~~; on German keyboards, it's often {{keypress\|Strg}}~~; on the Mac, use the ~~{{keypress~~\|Cmd~~}} ~~key) while clicking with the mouse on the "(−)" link, or on the "OK" button, or while double-clicking a suggestion from the list. Or submit the edit by typing ~~{{keypress\|~~Ctrl}}-~~{{keypress\|~~Enter~~}} ({{keypress\|~~Cmd}}-~~{{keypress\|~~Enter}} on a Mac). In that case, HotCat will show you a diff screen instead of saving the edit automatically. Examine the changes at your leisure, and then click "Save page" to commit the changes.		Sometimes you might still want to check what HotCat does before saving the modified page. To do so, use "control-clicking". Hold down the Control key (marked Ctrl) on many keyboards; on the Mac, use the\|Cmd key) while clicking with the mouse on the "(−)" link, or on the "OK" button, or while double-clicking a suggestion from the list. Or submit the edit by typing Ctrl-Enter, or Cmd-Enter on a Mac). In that case, HotCat will show you a diff screen instead of saving the edit automatically. Examine the changes at your leisure, and then click "Save page" to commit the changes.

	HotCat can be configured such that it present a diff screen for ''all'' edits it makes; see <code>hotcat_no_autocommit</code> in the section on [[#User configuration\|user configuration]]. Additionally, it can be configured such that even if that setting is <code>false</code> and thus single-category changes are executed immediately, it still presents a diff screen for single category ''deletions'' (a click on the "(–)" link). That may be a useful setting to avoid that mis-clicks suddenly make changes the user maybe didn't intend. See <code>hotcat_del_needs_diff</code> in the [[#User configuration\|user configuration]] section.		HotCat can be configured such that it present a diff screen for ''all'' edits it makes; see <code>hotcat_no_autocommit</code> in the section on [[#User configuration\|user configuration]]. Additionally, it can be configured such that even if that setting is <code>false</code> and thus single-category changes are executed immediately, it still presents a diff screen for single category ''deletions'' (a click on the "(–)" link). That may be a useful setting to avoid that mis-clicks suddenly make changes the user maybe didn't intend. See <code>hotcat_del_needs_diff</code> in the [[#User configuration\|user configuration]] section.
Line 344:		Line 328:

	=== Using shortcuts ===		=== Using shortcuts ===

	~~[[File:HotCat shortcut.png\|thumb\|User entered "#pnc", a shortcut defined to be replaced by "Paintings not categorised by year"...]]~~
	~~[[File:HotCat shortcut replaced.png\|thumb\|... and then clicked "OK". If the edit is saved now, HotCat will insert [[:Category:Paintings not categorised by year]].]]~~
	~~[[File:HotCat shortcut2.png\|thumb\|Shortcut "#ppl", defined as "people", displays suggestions starting with "People..."]]~~
	Wherever HotCat asks you for a category name, you can now use such shortcuts. However, you have to tell HotCat that the next few characters will be a shortcut. To do so, type a hash character ("#"). The hash was chosen because it cannot appear in category names. So, instead of entering "people", you can now just write "#ppl“. HotCat will replace that automatically by "people" when you save the new category. Shortcuts can be used anywhere in a category name.		Wherever HotCat asks you for a category name, you can now use such shortcuts. However, you have to tell HotCat that the next few characters will be a shortcut. To do so, type a hash character ("#"). The hash was chosen because it cannot appear in category names. So, instead of entering "people", you can now just write "#ppl“. HotCat will replace that automatically by "people" when you save the new category. Shortcuts can be used anywhere in a category name.

Stephensd: removal of wiki specific contents

2013-08-08T11:54:39Z

removal of wiki specific contents

Show changes

Stephensd: Created

2013-08-08T11:44:00Z

Created

Show changes