Help:Embeddable templates
From CruisersWiki
Istioploos (Talk | contribs) (Some editing) |
m |
||
| Line 112: | Line 112: | ||
{{doc|Infobox country}} | {{doc|Infobox country}} | ||
| - | + | {{hold vertical}} | |
===Article footer templates=== | ===Article footer templates=== | ||
Revision as of 08:41, 26 March 2015
|
An introduction into embeddable templates
There are two rather different kinds of templates in this wiki and one should not be mistaken for another:
- An article template (or Page template) is essentially a pro-forma for a new article or a stub. 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.
The either type of template is stored in a wiki page prefixed with "Template:". The difference between 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 as they say 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
Helper templates
These templates could be used anywhere in an article's text.
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}}
Color
Template:Color is used to make a coloured text.
Usage:
{{color|some colour|some text}}
Example:
Normal text. {{color|red|text in red.}} Normal text.
Expands to:
Normal text. text in red. Normal text.
Shortcuts are available for colours: red, blue, magenta, and green.
For example:
Normal text {{magenta|magenta text}} Normal text
Gives:
Normal text magenta text Normal text
User
Template:User is use to create a link to a user of the CruisersWiki.
Example:
{{User|Istioploos}}
Expands to: Istioploos Note: this is a proper link to the user.
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:
Position marking
POI
This template is used to list POIs (POI stands for point of interest).
In a wiki article a POI 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.
Usage
{{poi
| lat= | lon=
| portofentry=
| type=
| name=
| image=
| imagetext=
| imagewidth=
| text=
}}
The coordinates are defined by lat and lon parameters represented in decimal degrees (negative values denote either S or W hemispheres). Alternatively coordinates could be written in a compound form like:
{{poi
| lat= DD.dd | lon= DDD.dd
| type=
| name=
| text=
}}
where degrees, decimal minutes and hemisphere symbol (N, S, E, W) are separated by a single space. Coordinates in this format are quite useful when Template:Coord locations are converted into Template:Poi and similar templates.
Type
A value of the type parameter should be one of:
- anchorage
- accommodation
- attention
- beach
- berth (for marinas and other moorings at harbour quays, piers, etc.)
- buoy (for mooring buoys)
- chandler (for yacht's stores)
- danger
- eatingout (for restaurants, caffes, eateries, etc.)
- facilities
- fuel
- harbour
- provisions (for grocery stores, markets and supermarkets)
- officials
- service
- waypoint
- other
Examples
{{poi
| lat=41.23762| lon=9.1968
| type=berth
| name=Lega Navale di Santa Teresa Gallura
| url=http://www.leganavale.it/strutture/s_teresa_di_gallura/s_teresa_di_gallura
| text= A private yacht club located at the small Eastern inlet just before the marina
}}
Gives:
Lega Navale di Santa Teresa Gallura [[Help:Embeddable templates#Lega Navale di Santa Teresa Gallura|Lega Navale di Santa Teresa Gallura]] 41°14.257'N, 009°11.808'E
{{poi| lat=41.18005| lon=9.3881| zoom=15
| type=buoy
| name=Palau buoy field
| text=Just SE entrance to the marina. When the marina is full the yachts are sent to moor there. {{Note}} anchorage in the bay is not allowed.
The buoy field is operated by the marina. A dinghy doc is located at the port side of the entrance to the marina.
}}
Produces:
Palau buoy field
Palau buoy field [[Help:Embeddable templates#Palau buoy field|Palau buoy field]] 41°10.803'N, 009°23.286'E Just SE entrance to the marina. When the marina is full the yachts are sent to moor there. Note: anchorage in the bay is not allowed.
The buoy field is operated by the marina. A dinghy doc is located at the port side of the entrance to the marina.
{{Poi | lat=37.12665 | lon=26.85269 | type= harbour
| name= Lakki |altname= Λακκί | zoom= 15
| portofentry= Yes
| image= Greece_Leros_Lakki_m.jpg
| imagetext= Chart of Lakki Harbor
| imagewidth= 300px
| text= This is the main harbor of the island. It is located on the W side of the island. [http://www.hri.org/infoxenios/english/dodecanese/leros/towns.html#Laki Lakki] is a deep inlet and it is the largest harbor of the Dodecanese, affording all-round protection. On the NW side of the harbor there is small [[Agmar_Lakki_Marina|marina]] operated by [http://www.agmar.gr/ ''Agmar'']. ''See [[Agmar Lakki Marina]]''.
}}
Gives:
Lakki
... and compound style:
{{poi
| lat = 41 14.633 N | lon= 009 08.904 E
| type= anchorage
| name= Cala Spinosa
| text= A narrow bay W of Baia di Santa Reparata, good holding on sandy patches.
}}
Expands to:
Cala Spinosa
See CruisersWiki:Chartlet.config for the list of respective map icons.
POI inline
Contact
This template creates a standard contact form.
To include it into an article copy & paste:
{{contact |DD|M.M|N|DDD|M.M|E|
| type= officials
| name= Harbour office
| address=
| VHF=
| phone=
| fax=
| email=
| web=
| hours=
}}
Example:
{{contact |41|55.068|N|008|44.554|E|
| type= officials
| name= Harbour office
| address= Ajaccio, Pays Ajaccien, PORT AJACCIO TINO ROSSI, Quai de la Citadelle, 20000
| VHF= Ch 09
| phone= +33 4 95 51 93 28
| fax= +33 4 95 51 93 28
| mobil=+33 695 2017
| email= [email protected]
| web= http://www.2a.cci.fr/port-de-plaisance-et-de-peche-tino-rossi/
| hours= Summer: 8h00 - 21h00, Winter: 8h00 - 12h00 and 14h00 - 18h00
}}
Gives:
Harbour office [[Help:Embeddable templates#Harbour office|Harbour office]] 41°55.068′N, 008°44.554′E
- VHF: Ch 09
- Phone: +33 4 95 51 93 28
- Fax: +33 4 95 51 93 28
- Mobile: +33 695 2017
- Email: [email protected]
- Web: http://www.2a.cci.fr/port-de-plaisance-et-de-peche-tino-rossi/
- Address: Ajaccio, Pays Ajaccien, PORT AJACCIO TINO ROSSI, Quai de la Citadelle, 20000
- Working hours: Summer: 8h00 - 21h00, Winter: 8h00 - 12h00 and 14h00 - 18h00
Article information
TOCleft
This template puts an article's table of content at the left of the top of a page.
Usage:
{{TOCleft}}
Infobox family
This set of templates is used to put some standard information at the right of the top of an article page.
Infobox
This template was 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
| lat=
| lon=
| zoom=
| portofentry=
| image=
| imagetext=
| notes=
| news=
| summary=
}}
Example 1:
| Embeddable templates Port of Entry
| |
 The port of Santa Teresa | |
 Latest News
| |
| The latest on Santa Teresa |
{{infobox
| lat= 41.245667
| lon= 9.198833
| portofentry= y
| image= SantaTeresa.jpg
| imagetext= The port of Santa Teresa
| news=The latest on Santa Teresa
}}
Example 2: compound coordinates and the optional name parameter
| Santa Teresa
| |
| The port of Santa Teresa | |
| Notes on Santa Teresa |
{{infobox
| name= Santa Teresa
| lat= 41 14.74 N | lon= 09 11.93 E
| zoom=13
| image= SantaTeresa.jpg
| imagetext= The port of Santa Teresa
| notes = Notes on Santa Teresa
}}
Example 3:
| Fourni
| |
   
|
maplat and maplon parameters could be used to centre a chartlet at some other location than the location of the subject of an article.
{{infobox
| lat= 37 34.7 N | lon= 26 28.5 E
| name= Fourni
| maplat= 37.564
| maplon= 26.477
| zoom= 15
| chartlet=yes
}}
Note: The title of table is automatically created from this page title hence it reads here as "Embeddable templates".
Infobox marina
| The port of Santa Teresa | |
| Radio | VHF channel 12 |
|---|---|
| Phone | +39 (789) 751936 |
| Fax | +39 (789) 751936 |
| [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 | ? |
| some notes | |
This template was designed to create an infobox that is specific to an article about a marina:
{{infobox marina
|||N|||E
| name=
| lat=
| lon=
| zoom=
| vhf=
| phone=
| mobile=
| fax=
| email=
| web=
| berths=
| maxlength=
| maxbeam=
| maxdraft=
| elect=
| water=
| fuel=
| toilets=
| showers=
| laundry=
| internet=
| cabletv=
| hours=
| image=
| imagetext=
| imagewidth=
| address=
| notes=
}}
Example:
{{infobox marina
|41|14.159|N|9|11.671|E
| gallery=
| chartlet=
| 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 protected]
| web= http://www.portosantateresa.com
| hours=
| image= SantaTeresa.jpg
| imagetext= The port of Santa Teresa
| notes=some notes
}}
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).
Infobox canal
| Embeddable templates
| |
West Entrance
| |
East Entrance
| |
 Corinth Canal - Photo: NASA |
This template was designed to create an infobox that is specific to an article about a canal:
{{infobox canal
|||N|||E
| entrance1=
|||N|||E
| entrance2=
| image=
| imagetext=
}}
Example:
{{infobox canal
|37|57.2|N|22|57.44|E
| entrance1= West Entrance
|37|54.91|N|23|0.61|E
| entrance2= East Entrance
| zoom=13
| image= Corinth_Canal.jpg
| imagetext= Corinth Canal - Photo: ''NASA''
}}
Note: maplat and maplon parameters could be used to centre a chartlet at some other location than one of the entance's ends.
Infobox country
| Italy
| |
| Location of Italy (dark green) in Europe | |
  Flag | |
| Capital | Rome |
|---|---|
| Language | Italian |
| Currency | Euro € |
| Time zone | CET (UTC+1) , DST: CEST (UTC+2) |
| Calling code | +39 |
| Embeddable templates
| |
 Map | |
 Flag | |
| Capital | Rome |
|---|---|
| Language | Italian |
| Currency | Euro € |
| Time zone | CET (UTC+1) , DST: CEST (UTC+2) |
| Calling code | +39 |
| Some notes | |
| Latest News
| |
| Some news | |
This template was designed to create an infobox that is specific to an article about a country or an island country:
{{infobox country
| lat=
| lon=
| zoom=
| chartlet=
| image=
| imagewidth=
| flag=
| capital=
| language=
| currency=
| timezone=
| dsttimezone=
| code=
| notes=
| news=
}}
Example:
{{infobox country
| lat=41 54.00 N
| lon=012 29.00 E
| inage= Italymap.gif
| inagewidth= 330px
| flag= Italyflag.gif
| capital= Rome
| language= Italian
| currency= Euro €
| timezone= CET (UTC + 1)
| dsttimezone= CEST (UTC + 2 summer)
| code= +39
| notes= Some notes
| news= Some 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.
Contributors
This template is used to place a contributor's bar at the bottom of an article:
{{Contributors|~~~}}
Example:
{{Contributors|[[User:Vadp|Vadp]], [[User:Istioploos|Istioploos]]}}
Expands to:
 Contributors to this page |
|---|
|
Names: Vadp, Istioploos |
This template is used to place a navigation bar at the bottom of an article:
{{Navbar| }}
Example:
{{Navbar| [[Mediterranean]] | [[Italy]] | [[Sicily]] | [[Trapani]] }}
Expands to:
| Cruising Wiki Navigation
|
|---|
| | HOMEPAGE | Wiki Contents | Mediterranean | Italy | Sicily | Trapani | |
