Help:Embeddable templates

From CruisersWiki

Revision as of 11:50, 21 February 2015 (view source) Vadim (Talk | contribs) (→Some of the templates used in this wiki) ← Older edit		Revision as of 12:09, 21 February 2015 (view source) Vadim (Talk | contribs) (→Infobox) Newer edit →
Line 112:		Line 112:
	*		*
	===[[Template:Infobox|Infobox]]===		===[[Template:Infobox|Infobox]]===
		+	{{infobox port
		+	| coord={{Coord|41|14.74|N|09|11.93|E|}}
		+	| panoramio=http://www.panoramio.com/map/#lt=41.241287&ln=9.197445&z=2&k=1&a=1&tab=1
		+	| chartlet=http://mapserver.mytopo.com/homepage/index.cfm?lat=41.245667&lon=9.198833&scale=24000&zoom=50&type=1
		+	| image=SantaTeresa.jpg
		+	| imagetext=The port of Santa Teresa
		+	}}
		+	This template is designed to be used to place a table with some standard data (an information box") at the beginning of an article. Such a table is described at the [[Pagetemplates#CO-ORDINATES_INFO_TEMPLATE | Pagetemplates]] article. This template allows creating such a table a more simple way:
		+
		+	<pre><nowiki>{{infobox
		+	| coord={{Coord|||N|||E}}
		+	| panoramio=
		+	| chartlet=
		+	| image=
		+	| imagetext=
		+	}}</nowiki></pre>
		+
		+	Example:
		+	<pre><nowiki>{{infobox
		+	| coord={{Coord|41|14.74|N|09|11.93|E|}}
		+	| panoramio=http://www.panoramio.com/map/#lt=41.241287&ln=9.197445&z=2&k=1&a=1&tab=1
		+	| chartlet=http://mapserver.mytopo.com/homepage/index.cfm?lat=41.245667&lon=9.198833&scale=24000&zoom=50&type=1
		+	| image=SantaTeresa.jpg
		+	| imagetext=The port of Santa Teresa
		+	}}</nowiki></pre>
		+
		+
		+	This expands to a table shown at the beginning of this section.
		+
		+	NB: The title of table is automatically created from this page title hence it reads here as "Embeddable templates".

---

Revision as of 12:09, 21 February 2015

This is a draft. Don't use it in production!

Contents 1 An introduction into embeddable templates 2 Using templates 3 Some of the templates used in this wiki 3.1 Coord 3.2 POI 3.2.1 Cala Spinosa 3.3 POI inline 3.4 Infobox

An introduction into embeddable templates

There are 2 kind of templates in this wiki and one should not be mistaken for another:

• An article template (or Page template) is essentially an article's stub or a boilerplate. To create a new article a user simply copies it's wiki text and pastes it into a new empty article page.
• An embeddable template (or a MediaWiki template) on the other hand is generally used to bring a smaller sniplet of mediawiki markup into an article page. They could be seen as a sort of shortcuts introduced into a wiki to implement some common pattern to avoid excessive typing and errors and to implement some common style.

In this sense an embeddable template can be seen as a stencil for some article's feature while an article template is more like a foundation for a whole article.

Similar to an article template a source text for an embeddable template is stored in a wiki page prefixed with "Template:". The difference with a normal wiki page (or an article template) and MediaWiki template is that the later kind of a template is designed to be embedded (or transcluded) into another page.

Using templates

In the text below embeddable templates will be called simply templates.

Suppose you have a Template:Hello

Hello world!

Then this text can be embedded into another page with this construct:

{{hello}}

An expanded text of a template could be modified with template parameters. Imagine some other template could be called:

{{morning|Earth}}

And give:

Good morning Earth!

Or even like this:

{{go | destination=the Universe}}

Could give:

Our destination is the Universe

Some of the templates used in this wiki

Coord

This template is used to represent coordinates of some geographic location like this:

{{Coord|DD|M.M|N/S|DD|M.M|E/W|}}

It is used either as a standalone, like described in Pagetemplates#CO-ORDINATES TEMPLATE, or in combination with #POI or #Infobox templates (see below).

The 1st 3 parameters of a template are: round number degrees of latitude, minutes of latitude, N or S for hemisphere. The last 3 parameters are the similar ones to the 3 1st, but they denote the longitude part of a coordinate.

Example:

{{Coord|37|43.6|N|26|50.6|W|}}

will show as: 37°43.6′N, 26°50.6′W.

POI

POI stands for point of interest. In a wiki article it denotes some geographic location like a city, port or an anchorage. Such a POI must have a name and a type, also it should have some geographic coordinates and a description text.

Example:

{{poi
|type=anchorage
|name=Cala Spinosa
|coord={{Coord|41|14.633|N|9|08.904|E}}
|text=A narrow bay W of Baia di Santa Reparata, good holding on sandy patches.
}}

This expands to:

To include it into a page copy & paste:

{{poi
|type=
|name=
|coord={{Coord|||N|||E}}
|text=
}}

A value of a type parameter should be one of: port, berth, anchorage, shopping, other ( anything else?).

POI inline

This template is quite similar to POI template, except it doesn't breaks a paragraph and does not create headings, so it could be used "inline" a text.

To include it into a page copy & paste:

{{poi inline
|type=
|name=
|pretext=
|coord={{Coord|||N|||E}}
|text=
}}

Example:

* A few small shops in the town. 
* "ISA" is the nearest minimarket from the harbour. {{poi inline
|type=shopping
|name="ISA" grocery store
|pretext=It is located (
|coord={{coord|41|14.356|N|9|11.446|E|}}
|text=) at the first crossing from the harbour on the Via del Porto}} (with Via Angioy and Via Petrini)
* 

Expands to:

• A few small shops in the town.
• "ISA" is the nearest minimarket from the harbour. Template:Poi inline (with Via Angioy and Via Petrini)

Infobox

This template is designed to be used to place a table with some standard data (an information box") at the beginning of an article. Such a table is described at the Pagetemplates article. This template allows creating such a table a more simple way:

{{infobox
| coord={{Coord|||N|||E}}
| panoramio=
| chartlet=
| image=
| imagetext=
}}

Example:

{{infobox
| coord={{Coord|41|14.74|N|09|11.93|E|}}
| panoramio=http://www.panoramio.com/map/#lt=41.241287&ln=9.197445&z=2&k=1&a=1&tab=1
| chartlet=http://mapserver.mytopo.com/homepage/index.cfm?lat=41.245667&lon=9.198833&scale=24000&zoom=50&type=1
| image=SantaTeresa.jpg
| imagetext=The port of Santa Teresa
}}

This expands to a table shown at the beginning of this section.

NB: The title of table is automatically created from this page title hence it reads here as "Embeddable templates".