Help:Editing/Template: Difference between revisions
Content deleted Content added
imported>Rob Kam No edit summary |
No edit summary |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1:
A '''template''' is a page that gets included in another page, this other page is said to transclude the template.
== Simple templates ==
For example, create a page called ''Template:Main article'' with the text
''The main article for this is at <nowiki>[[{{{1}}}]]</nowiki>.''
and then to use the template insert "<nowiki>{{Main article|Whatever}}</nowiki> where you want that text to appear.
To include the page where the template is used in some category, without that template being included in the same category, use <nowiki><includeonly></includeonly></nowiki> tags and for text on the template page to be excluded on the target page use <nowiki><noinclude></noinclude></nowiki> tags.
<nowiki><includeonly>
''The main article for this is at [[{{{1}}}]].''
[[Category:Some category]]
</includeonly>
<noinclude>
Some documentaion here.
[[Category:Templates]]
</noinclude></nowiki>
== Using templates from Wikipedia ==
Complex templates are easier obtained from Wikipedia, where considerable work has already gone into developing and debugging these.
== Customisation ==
Be sure to check for and copy any required JavaScript from MediaWiki:Common.js and any relevant styling from MediaWiki:Common.css. Site specific templates need to be made more generally usable, as follows:
* Replace instances of ''Wikipedia'' in the text with <nowiki>{{ns:Project}}</nowiki>, (or ''Miraheze'' if appropriate).
* Replace instances of ''WikiMedia'' in the text with ''Miraheze''.
* Replace namespace wikilinks e.g. Wikipedia to <nowiki>{{ns:Project}}</nowiki> or meta.
* <!-- https://webmasters.stackexchange.com/questions/112873/how-to-use-mw-site-sitename-in-moduleasbox -->
In Lua modules replace ''Wikipedia'' with ''<nowiki>' .. mw.site.siteName .. '</nowiki>'' for example to alter the text in {{tlx|stub|SISTER=w:}} change in [[Special:MyLanguage/Module:Asbox|module asbox]] line 233 from:
<syntaxhighlight lang="lua">
' is a [[Wikipedia:stub|stub]]. You can help Wikipedia by [',
</syntaxhighlight>
to:
<syntaxhighlight lang="lua">
' is a [[' .. mw.site.namespaces.Project.name .. ':stub|stub]]. You can help ' .. mw.site.siteName .. ' by [',
</syntaxhighlight>.
* Remove assumptions about the structure of the wiki (such as a template producing an error when used in certain namespaces - you can't know what namespace configuration the target wiki will use) from both the code and the documentation.
* Remove or import (making sure to follow this process again) any dependencies that don't exist here.
* Remove any red-linked categories and add the template to [[:Category:Templates]] or an appropriate subcategory.
== Icons ==
{{ns:Project}} is [https://www.mediawiki.org/wiki/InstantCommons Instant Commons] enabled, otherwise the images for icons would have to be uploaded locally. A good source for icon images is Wikimedia Commons' [https://commons.wikimedia.org/wiki/Category:Icons_by_subject Category:Icons by subject].
== Licensing ==
Because of [https://creativecommons.org/licenses/by-sa/3.0/ CC-BY-SA licensing] considerations the previous authors need to be acknowledged. Insert the appropriate source and attribution template at the bottom of the imported pages, (but not sub-pages) e.g. before </noinclude> from [[:Category:Attribution templates]].
== Testing ==
Line 23 ⟶ 55:
[[Category:Help:Editing]]
[[Category:
|