Help:Embeddable templates
From CruisersWiki
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 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
Position marking templates
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 can be used in combination with Poi or Infobox templates (see below) or standalone, as described in Pagetemplates#CO-ORDINATES TEMPLATE,
The first 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 to the first group, but they rather 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:
Cala Spinosa
To include it into an article copy & paste:
{{poi |type= |name= |coord={{Coord|||N|||E}} |text= }}
A value of a type
parameter should be one of: port, berth, marina, anchorage, shopping, other ( anything else?).
POI inline
This template is quite similar to POI template, except it doesn't break a paragraph and does not create headings, thus it could be used inside a paragraph ("inline").
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)
Article information templates
Infobox
"Infobox" is not a quite right name as in search it coincides with class="infobox bordered". Perhaps a better name is "Pageinfo" od even "Pageheader"
Embeddable templates
| |
| |
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".
Infobox country
Embeddable templates
| |
Capital | Rome |
---|---|
Language | Italian |
Currency | Euro € |
Time zone | CET (UTC + 1) , DST: CEST (UTC + 2 summer) |
Calling code | ? |
{{infobox country | map= | mapwidth= | flag= | capital= | capitalcoord={{Coord|||N|||E}} | language= | currency= | timezone= | dsttimezone= | notes= | news= }}
Example:
{{infobox country | map=Italymap.gif | mapwidth=330px | flag=Italyflag.gif | capital=Rome | capitalcoord={{Coord|41|54.00|N|012|29.00|E}} | language=Italian | currency=Euro € | timezone=CET (UTC + 1) | dsttimezone=CEST (UTC + 2 summer) | notes= | news= }}
This expands to a table shown at the beginning of this section. As with the previous example the title of table is automatically created from this page title hence it renders here to something that is not quite useful.
Infobox marina
[http://www.portosantateresa.com/ Embeddable templates]
| |
Radio | VHF channel 12 |
---|---|
Phone | +39 (789) 751936 |
[mailto:[email protected] [email protected]] | |
Berths | 400 |
Max. length | 35 |
Max. draft | ? |
Fuel | Fuel station |
Water | Yes, on berth |
Electricity | Yes, 240v |
Toilets | Yes |
Showers | Yes |
Cable TV | No |
Hours | ? |
More notes about the marina |
This template is somewhat similar to the previous one, but it was designed to create an infobox that is specific to an article about a marina:
{{infobox marina | coord= | panoramio= | vhf= | berths= | maxlength= | maxdraft= | fuel= | water= | elect= | toilets= | showers= | laundry= | internet= | wifi= | cabletv= | phone= | email= | web= | image= | imagetext= | note= }}
Example:
{{infobox marina | coord={{Coord|41|14.159|N|9|11.671|E|}} | panoramio=http://www.panoramio.com/map/#lt=41.235983&ln=9.194517&z=0&k=0&a=1&tab=2 | vhf=12 | berths=400 | maxlength=35 | maxdraft= | fuel= Fuel station | water= Yes, on berth | elect= Yes, 240v | toilets=Yes | showers=Yes | laundry= | internet= | wifi= | cabletv=No | phone= {{phone|39|789|751936}} | email={{email|[email protected]}} | web={{web|http://www.portosantateresa.com/}} | image= | note= }}
It is recommended to use a Phone template (see below) to fill in a phone parameter here, especially if such a number is in international format (which is also recommended).
Likewise the templates Email and Web are recommended to fill in email and web parameters.
Some helper templates
Image right
This template puts a standard thumbnail of an image at the right side of the page:
Copy and paste:
{{thumb| | }}
Example:
{{thumb|Favignana.jpg|Cala Principale, Favignana}}
This one displays an image from Wikimedia Commons (Wikipedia):
{{thumb|EU-Italy.svg|Location of Italy (dark green) in Europe}}
Phone
Phone number in international format.
Copy & paste:
{{phone|||}}
Example:
{{phone|39|789|751936}}
This expands to:
+39 (789) 751936
Copy & paste:
{{email||}}
This template can be used make an email address visible at the email links.
Compare a traditional:
[mailto:[email protected]]
Which renders to:
[1]
While:
{{email|[email protected]}}
Expands to:
As a convenience another form of this template mimics a traditional syntax:
{{email|[email protected]|Marina email}}
Expands to:
Web
Copy & paste:
{{web||}}
This template can be used make an web address visible at the simple external links.
Compare a traditional:
[http://www.portosantateresa.com/]
Which renders to:
[2]
While:
{{web|http://www.portosantateresa.com/}}
Expands to:
http://www.portosantateresa.com/
As a convenience another form of this template mimics a traditional syntax:
{{web|http://www.portosantateresa.com/|Marina web address}}
Expands to: