Help:Embeddable templates

From CruisersWiki

Revision as of 17:54, 19 February 2015

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

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 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 https://www.mediawiki.org/wiki/Transclusion 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

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, 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:

Cala Spinosa

Cala Spinosa/wiki/Help:Embeddable_templates#Cala_Spinosa

anchorage Cala Spinosa [[Help:Embeddable templates#Cala Spinosa|Cala Spinosa]]

A narrow bay W of Baia di Santa Reparata, good holding on sandy patches.

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?).