VassarWiki:Templates: Difference between revisions

(6 intermediate revisions by the same user not shown)

Line 1:

'''Templates''' are pages designed for inclusion in other pages.

'''Templates''' are pages designed for inclusion in other pages. For a list of templates, go to [[Special:AllPages]] and change the Namespace to "Template".

== Using a template ==

~~<nowiki>~~To use a template in the Visual Editor, click "Insert" then "Template", or type two left curly brackets {{. From here, you can search for the template you need, and save commonly used templates.~~</nowiki>~~

To use a template in the Visual Editor, click "Insert" then "Template", or type two left curly brackets (<code><nowiki>{{</nowiki></code>). From here, you can search for the template you need, and save commonly used templates.

In the Source Editor, you will have to type the syntax manually. Take a look at the desired template's documentation, where there may be example syntax that you can adapt.

In the Source Editor, you will have to type the syntax manually:

<nowiki>{{Name

|parameter1 = value1

|parameter2 = value2

}}</nowiki>

Take a look at the desired template's documentation, where there may be example syntax that you can adapt.

If you insert a template with the prefix "subst:" before it (e.g. <code><nowiki>{{subst:Name}}</nowiki></code>), it will substitute the template code into the page and it will longer be editable as a template. You generally shouldn't do this unless specified on the template documentation.

== Making a template ==

Anyone can make a template! Just create a page with the prefix "Template:" and insert the text and code you wish to be transferred to another page. Templates can be newly written or, to save duplicating work already done, exported from another wiki like Wikipedia, and then imported here.

Anyone can make a template! Just create a page with the prefix "Template:" and insert the text and/or code you wish to be transferred to another page. Templates can be newly written or, to save duplicating work already done, exported from another wiki like Wikipedia, and then imported here.

=== Documentation ===

To make it easy for contributors to use your template, all templates should have documentation.

Without any line breaks or spaces, write "<nowiki><noinclude>{{Documentation}}</nowiki><nowiki></noinclude></nowiki>" at the end of your template―this will transclude the information from your template's documentation page (located at "Template:Example/doc") onto the Template page, but not when using your template on another page.

Without any line breaks or spaces, write "<nowiki><noinclude>{{Documentation}}</nowiki><nowiki></noinclude></nowiki>" at the end of your template―this will transclude the information from your template's documentation page (located at "Template:Example/doc") onto the Template page, but not when using your template on another page. You should also include any categories that apply to the Template

Template documentation should have at least two parts:

Line 19:

Line 26:

# Example usage: In an "Examples" section, provide both example syntax (between <nowiki><pre> </pre></nowiki>) and an example template displayed (the same syntax but without <nowiki><pre> </pre></nowiki>).

== ~~Notable~~ templates ==

== List of templates ==

{{See also|Category:~~Templates}}~~

*[[Template:Event|Event]], to be placed on any page for events (will autopopulate on [[Upcoming Events]])

* [[Template:Transclude|Transclude]], to copy part of one page on another page (will update when

* [[Template:See also|See also]] & [[Template:Main article|Main article]]: Italicized notes at the top of pages or sections, to display important links

[[:Category:Infoboxes|Infoboxes]] (using the metatemplate [[Template:Infobox|Infobox]]) can be placed on pages to easily display basic data/information about a subject. Notable infoboxes include:

* [[Template:Infobox group|Infobox group]], for student groups

* [[Template:Infobox house|Infobox house]], for campus housing

[[:Category:Userboxes|Userboxes]] (using the metatemplate [[Template:Userbox|Userbox]]) are a way to easily communicate about yourself on your [[VassarWiki:User pages|user page]].

Banners (using the metatemplate [[Template:Banner|Banner]]) can be placed at the very top of pages to notify readers of especially pertinent information.

* [[Template:~~Userbox~~]]~~: A meta-template that can~~ be ~~built upon~~ to ~~easily communicate about yourself on your user page.~~

* [[Template:Consensus|Consensus]], to be placed on VassarWiki pages to clarify level of consensus

* [[Template:~~See also~~]] ~~& [[Template:Main article]]: Notes at the top of~~ pages ~~or sections to display important links~~

* [[Template:Construction|Construction]], to be placed on pages under construction (recognizing that VassarWiki is a continual work in progress)

== See also ==

* ~~https~~:~~//www.mediawiki.org/wiki/~~Help:Templates

* [[mediawikiwiki:Help:Templates|MediaWiki's help page on templates]]

[[Category:Page types]]

@@ Line 1: / Line 1: @@
-'''Templates''' are pages designed for inclusion in other pages.
+'''Templates''' are pages designed for inclusion in other pages. For a list of templates, go to [[Special:AllPages]] and change the Namespace to "Template".
 == Using a template ==
-<nowiki>To use a template in the Visual Editor, click "Insert" then "Template", or type two left curly brackets {{. From here, you can search for the template you need, and save commonly used templates.</nowiki>
+To use a template in the Visual Editor, click "Insert" then "Template", or type two left curly brackets (<code><nowiki>{{</nowiki></code>). From here, you can search for the template you need, and save commonly used templates.
-In the Source Editor, you will have to type the syntax manually. Take a look at the desired template's documentation, where there may be example syntax that you can adapt.
+In the Source Editor, you will have to type the syntax manually:
+ <nowiki>{{Name
+  |parameter1 = value1
+  |parameter2 = value2
+ }}</nowiki>
+Take a look at the desired template's documentation, where there may be example syntax that you can adapt.
+If you insert a template with the prefix "subst:" before it (e.g. <code><nowiki>{{subst:Name}}</nowiki></code>), it will substitute the template code into the page and it will longer be editable as a template. You generally shouldn't do this unless specified on the template documentation.
 == Making a template ==
-Anyone can make a template! Just create a page with the prefix "Template:" and insert the text and code you wish to be transferred to another page. Templates can be newly written or, to save duplicating work already done, exported from another wiki like Wikipedia, and then imported here.
+Anyone can make a template! Just create a page with the prefix "Template:" and insert the text and/or code you wish to be transferred to another page. Templates can be newly written or, to save duplicating work already done, exported from another wiki like Wikipedia, and then imported here.
 === Documentation ===
 To make it easy for contributors to use your template, all templates should have documentation.
-Without any line breaks or spaces, write "<nowiki><noinclude>{{Documentation}}</nowiki><nowiki></noinclude></nowiki>" at the end of your template―this will transclude the information from your template's documentation page (located at "Template:Example/doc") onto the Template page, but not when using your template on another page.
+Without any line breaks or spaces, write "<nowiki><noinclude>{{Documentation}}</nowiki><nowiki></noinclude></nowiki>" at the end of your template―this will transclude the information from your template's documentation page (located at "Template:Example/doc") onto the Template page, but not when using your template on another page. You should also include any categories that apply to the Template
 Template documentation should have at least two parts:
@@ Line 19: / Line 26: @@
 # Example usage: In an "Examples" section, provide both example syntax (between <nowiki><pre> </pre></nowiki>) and an example template displayed (the same syntax but without <nowiki><pre> </pre></nowiki>).
-== Notable templates ==
+== List of templates ==
-{{See also|Category:Templates}}
+*[[Template:Event|Event]], to be placed on any page for events (will autopopulate on [[Upcoming Events]])
+* [[Template:Transclude|Transclude]], to copy part of one page on another page (will update when
+* [[Template:See also|See also]] & [[Template:Main article|Main article]]: Italicized notes at the top of pages or sections, to display important links
+[[:Category:Infoboxes|Infoboxes]] (using the metatemplate [[Template:Infobox|Infobox]]) can be placed on pages to easily display basic data/information about a subject. Notable infoboxes include:
+* [[Template:Infobox group|Infobox group]], for student groups
+* [[Template:Infobox house|Infobox house]], for campus housing
+[[:Category:Userboxes|Userboxes]] (using the metatemplate [[Template:Userbox|Userbox]]) are a way to easily communicate about yourself on your [[VassarWiki:User pages|user page]].
+Banners (using the metatemplate [[Template:Banner|Banner]]) can be placed at the very top of pages to notify readers of especially pertinent information.
-* [[Template:Userbox]]: A meta-template that can be built upon to easily communicate about yourself on your user page.
+* [[Template:Consensus|Consensus]], to be placed on VassarWiki pages to clarify level of consensus
-* [[Template:See also]] & [[Template:Main article]]: Notes at the top of pages or sections to display important links
+* [[Template:Construction|Construction]], to be placed on pages under construction (recognizing that VassarWiki is a continual work in progress)
 == See also ==
-* https://www.mediawiki.org/wiki/Help:Templates
+* [[mediawikiwiki:Help:Templates|MediaWiki's help page on templates]]
 [[Category:Page types]]