Difference between revisions of "Template:Extension/doc"
Jump to navigation
Jump to search
Template:Extension/doc (view source)
Revision as of 13:58, 8 September 2007
, 13:58, 8 September 2007→Usage: added documentation for hooks in use
>Egfrank~mediawikiwiki (added id so can jump to #type) |
>Egfrank~mediawikiwiki (→Usage: added documentation for hooks in use) |
||
| Line 41: | Line 41: | ||
If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorised as [[:category:extensions with unknown status|unknown]]. In cases where the value is invalid, it will be placed in a [[:category:extensions with invalid status|special category]] so that the error can be caught and fixed. | If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorised as [[:category:extensions with unknown status|unknown]]. In cases where the value is invalid, it will be placed in a [[:category:extensions with invalid status|special category]] so that the error can be caught and fixed. | ||
|- | |- | ||
| <span id="type">''' | | <span id="type">'''type1'''</span><br/>''type2''<br/>''type3''<br/>''type4''<br/>''type5''<br/>''type6''<br/> || '''type of extension''' | ||
Can contain any value, but the following special values ensure proper categorisation: | Can contain any value, but the following special values ensure proper categorisation: | ||
* ''[[:Category:Category extensions|category]]'' - Category | * ''[[:Category:Category extensions|category]]'' - Category | ||
| Line 50: | Line 50: | ||
* ''[[:Category:Extended syntax extensions|extended syntax]]'' - Extensions that add non-standard wiki syntax (i.e. <em>not</em> [[Manual:Tag extensions|tags]], [[Manual:Parser functions|parser functions]], or [[Manual:Variables|variables]]). | * ''[[:Category:Extended syntax extensions|extended syntax]]'' - Extensions that add non-standard wiki syntax (i.e. <em>not</em> [[Manual:Tag extensions|tags]], [[Manual:Parser functions|parser functions]], or [[Manual:Variables|variables]]). | ||
* ''[[:Category:Form extensions|form]]'' - Form | * ''[[:Category:Form extensions|form]]'' - Form | ||
* ''[[:Category:Hook extensions|hook]]'' - Hook extension | * ''[[:Category:Hook extensions|hook]]'' - Hook extension - defines a <em>new</em> hook - see hook1, etc below if you want to define hooks <em>used</em> by your extension | ||
* ''[[:Category:User interface extensions|interface]]'' - User interface extension (e.g. [[w:javascript|javascript]] code) | * ''[[:Category:User interface extensions|interface]]'' - User interface extension (e.g. [[w:javascript|javascript]] code) | ||
* ''[[:Category:Link markup extensions|link]]'' - Link markup extensions | * ''[[:Category:Link markup extensions|link]]'' - Link markup extensions | ||
| Line 67: | Line 67: | ||
Note: Many extensions have more than one type, if this applies to yours,replace <code><nowiki>|type=</nowiki></code> with <code><nowiki>|type1=|type2=|type3=...</nowiki></code>. You may define up to six types for an extension. | Note: Many extensions have more than one type, if this applies to yours,replace <code><nowiki>|type=</nowiki></code> with <code><nowiki>|type1=|type2=|type3=...</nowiki></code>. You may define up to six types for an extension. | ||
|- | |||
| <span id="type">'''hook1'''</span><br/>''hook2''<br/>''hook3''<br/>''hook4''<br/>''hook5''<br/>''hook6''<br/> || '''name of each hook used by the extension''' - please see [[Manual:Hooks]] for a list of valid values. | |||
|- | |- | ||
| author || The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present). | | author || The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present). | ||