Difference between revisions of "Template:Extension/doc"

Jump to navigation Jump to search
→‎Content parameters: type parameter documentation - made link to implementation type clearer, cleaned up documentation of parser extension types
>Egfrank~mediawikiwiki
(→‎Content parameters: hook parameter documentation - more copy edit)
>Egfrank~mediawikiwiki
(→‎Content parameters: type parameter documentation - made link to implementation type clearer, cleaned up documentation of parser extension types)
Line 71: Line 71:
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">'''type1'''</span><br/>''type2''<br/>''type3''<br/>''type4''<br/>''type5''<br/>''type6''<br/> || '''type of extension'''
| <span id="type">'''type1'''</span><br/>''type2''<br/>''type3''<br/>''type4''<br/>''type5''<br/>''type6''<br/> || '''implementation type'''
Can contain any value, but the following special values ensure proper categorisation:
Legal values are:
* ''[[:Category:Parser extensions|parser]]'' - catchall for uncategorized [[Manual:Extending wiki markup|parser extensions]]. If you have written a parser extension, please use one of the more specific types below:
** ''[[:Category:Parser function extensions|parser function]]'' - custom [[Manual:Parser functions|parameterized template markup]], e.g. <code><nowiki>{{</nowiki>''#name:'' ... }}</code>
** ''[[:Category:Tag extensions|tag]]'' - [[Manual:Tag extensions|custom XML tag markup]], e.g. <code><nowiki><</nowiki>''tagname''>...<nowiki></</nowiki>''tagname''></code>
** ''[[:Category:Variable extensions|variable]]'' - custom [[Manual:Variables|unparameterized template markup]], e.g. <code><nowiki>{{NAME}}</nowiki></code>
** ''[[: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:Category extensions|category]]'' - Category
* ''[[:Category:Category extensions|category]]'' - Category
* ''[[:Category:Database extensions|database]]'' - adds tables and/or fields to the database backing a MediaWiki installation
* ''[[:Category:Database extensions|database]]'' - adds tables and/or fields to the database backing a MediaWiki installation
Line 78: Line 85:
* ''[[:Category:Data extraction extensions|data extraction]]'' - Data extraction
* ''[[:Category:Data extraction extensions|data extraction]]'' - Data extraction
* ''[[:Category:Extension examples|example]]'' - Not a real extension, but an example of how to write one
* ''[[:Category:Extension examples|example]]'' - Not a real extension, but an example of how to write one
* ''[[: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 - defines a <em>new</em> hook - see hook1, etc below if you want to define hooks <em>used</em> by your 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]]'' - catchall for uncategorized user interface extensions. (e.g. [[w:javascript|javascript]] code)
* ''[[:Category:Link markup extensions|link]]'' - Link markup extensions
* ''[[:Category:Link markup extensions|link]]'' - Link markup extensions
* ''[[:Category:List extensions|list]]'' - List
* ''[[:Category:List extensions|list]]'' - List
* ''[[:Category:Media handling extensions|media]]'' - Media
* ''[[:Category:Media handling extensions|media]]'' - Media
* ''[[:Category:Namespace extensions|namespace]]'' - Namespace
* ''[[:Category:Namespace extensions|namespace]]'' - Namespace
* ''[[:Category:Parser extensions|parser]]'' - Parser extension (uncategorized)
* ''[[:Category:Parser function extensions|parser function]]'' - Parser function
* ''[[:Category:Parser function extensions|pfunc]]'' - same as ''parser function''
* ''[[:Category:Parser function extensions|pfunc]]'' - same as ''parser function''
* ''[[:Category:Special page extensions|special]]'' - [[Manual:Special pages|Special page]]
* ''[[:Category:Special page extensions|special]]'' - [[Manual:Special pages|Special page]]
* ''[[:Category:Table extensions|table]]'' - Table
* ''[[:Category:Table extensions|table]]'' - Table
* ''[[:Category:Tag extensions|tag]]'' - [[Manual:Tag extensions|Tag extension]]
* ''[[:Category:Variable extensions|variable]]'' - defines [[Manual:Variables|wiki variables]]


Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:Extensions with invalid or missing type]].
Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:Extensions with invalid or missing type]].

Navigation menu