Difference between revisions of "Template:Ribbon"

From Geohashing
imported>ChromeCrusaders
(Undo revision 442124 by ChromeCrusaders (talk))
imported>Fippe
m (example which actually exists)
Line 21: Line 21:
 
*category    = ''The category name where users having gained this achievement will be put.''
 
*category    = ''The category name where users having gained this achievement will be put.''
 
*image      = ''The usual photographic proof'' (Note: you may want to use the value <nowiki>{{{image|}}}</nowiki> to pass through the possibly blank image parameter from your own ribbon template.)
 
*image      = ''The usual photographic proof'' (Note: you may want to use the value <nowiki>{{{image|}}}</nowiki> to pass through the possibly blank image parameter from your own ribbon template.)
*expedition  = ''the expedition link, as used by the mini templates'' (e.g. "2008-05-22 33 -44")
+
*expedition  = ''the expedition link, as used by the mini templates'' (e.g. "2005-05-26 37 -122")
 
Rarely used Parameters:
 
Rarely used Parameters:
 
*customtitle = ''replaces the words 'earned the' in the title of the ribbon.''
 
*customtitle = ''replaces the words 'earned the' in the title of the ribbon.''
Line 38: Line 38:
 
|color = darkgreen
 
|color = darkgreen
 
|user = Mr. Stickman
 
|user = Mr. Stickman
|achievement = [[Lost in Thought Achievement]]
+
|achievement = Pilgrimage achievement
|action = hurting himself while concentrating on the display of his GPS
+
|action = reaching the coordinates of the original comic
|category = Lost in Thought Achievement
+
|category = Pilgrimage achievement
|expedition = [[2008-05-22 33 -44]]
+
|expedition = [[2005-05-26 37 -122]]
 
}}</nowiki></pre>
 
}}</nowiki></pre>
 
will display, depending on the theme you have selected, as:
 
will display, depending on the theme you have selected, as:
Line 49: Line 49:
 
|color = darkgreen
 
|color = darkgreen
 
|user = Mr. Stickman
 
|user = Mr. Stickman
|achievement = [[Lost in Thought Achievement]]
+
|achievement = Pilgrimage achievement
|action = hurting himself while concentrating on the display of his GPS
+
|action = reaching the coordinates of the original comic
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
}}
 
}}
Line 59: Line 59:
 
|color = darkgreen
 
|color = darkgreen
 
|user = Mr. Stickman
 
|user = Mr. Stickman
|achievement = [[Lost in Thought Achievement]]
+
|achievement = Pilgrimage achievement
|action = hurting himself while concentrating on the display of his GPS
+
|action = reaching the coordinates of the original comic
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
}}
 
}}
Line 69: Line 69:
 
|color = darkgreen
 
|color = darkgreen
 
|user = Mr. Stickman
 
|user = Mr. Stickman
|achievement = [[Lost in Thought Achievement]]
+
|achievement = Pilgrimage achievement
|action = hurting himself while concentrating on the display of his GPS
+
|action = reaching the coordinates of the original comic
|expedition = [[2008-05-22 33 -44]]
+
|expedition = [[2005-05-26 37 -122]]
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
}}
 
}}
Line 89: Line 89:
 
|color = darkgreen
 
|color = darkgreen
 
|user = Mr. Stickman
 
|user = Mr. Stickman
|achievement = [[Lost in Thought Achievement]]
+
|achievement = Pilgrimage achievement
|action = hurting himself while concentrating on the display of his GPS
+
|action = reaching the coordinates of the original comic
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
}}
 
}}
Line 99: Line 99:
 
|color = darkgreen
 
|color = darkgreen
 
|user = Mr. Stickman
 
|user = Mr. Stickman
|achievement = [[Lost in Thought Achievement]]
+
|achievement = Pilgrimage achievement
|action = hurting himself while concentrating on the display of his GPS
+
|action = reaching the coordinates of the original comic
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
}}
 
}}
Line 109: Line 109:
 
|color = darkgreen
 
|color = darkgreen
 
|user = Mr. Stickman
 
|user = Mr. Stickman
|achievement = [[Lost in Thought Achievement]]
+
|achievement = Pilgrimage achievement
|action = hurting himself while concentrating on the display of his GPS
+
|action = reaching the coordinates of the original comic
|expedition = [[2008-05-22 33 -44]]
+
|expedition = [[2005-05-26 37 -122]]
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
|category = Templates <!-- you may want to use a more sensible category here. But I'm not going to invent one that will mess up the existing list -->
 
}}
 
}}
 
</noinclude>
 
</noinclude>

Revision as of 12:34, 19 August 2019

This template displays a generic ribbon, which can be customized using the following parameters. It can be used to simplify existing ribbon pages, and to create new ribbons more easily. It also helps us to maintain a common layout for all ribbons.

  • icon = The icon image to display in the ribbon.
  • color = The border colour of the ribbon.
  • achievement = Achievement or consolation prize name.
  • action = A free form description of the achieved feature. "reaching the x,y hash..."

Optional parameters:

  • user = The user name to be displayed in the ribbon. (Defaults to "This user". use {{{name|}}} as value to pass through the possibly blank name parameter as user name)
  • category = The category name where users having gained this achievement will be put.
  • image = The usual photographic proof (Note: you may want to use the value {{{image|}}} to pass through the possibly blank image parameter from your own ribbon template.)
  • expedition = the expedition link, as used by the mini templates (e.g. "2005-05-26 37 -122")

Rarely used Parameters:

  • customtitle = replaces the words 'earned the' in the title of the ribbon.
  • bgcolor = replaces the background color of the ribbon.
  • fontcolor = replaces the font color of the ribbon.
  • iconcode = replaces the whole display code for the icon image.

Themes

  • Use the code
{{#vardefine:ribbontheme|themename}}

on any page to make all subsequent ribbons appear in the selected theme.

Example

{{Ribbon
|icon = Landgeohash.png
|color = darkgreen
|user = Mr. Stickman
|achievement = Pilgrimage achievement
|action = reaching the coordinates of the original comic
|category = Pilgrimage achievement
|expedition = [[2005-05-26 37 -122]]
}}

will display, depending on the theme you have selected, as:

#default

Landgeohash.png
Mr. Stickman earned the Pilgrimage achievement
by reaching the coordinates of the original comic.

mini

Landgeohash.pngPilgrimage achievement by reaching the coordinates of the original comic.

micro

Landgeohash.pngPilgrimage achievement: 2005-05-26 37 -122

Width

  • By default, the ribbon box will be sized to fit its contents. Use the code
{{#vardefine:ribbonwidth|width}}

on any page to make all subsequent ribbons appear with the selected width, to make them line up prettily. Use either a pixel width e.g. "50px" or a percentage such as "100%", as per the CSS width attribute.

Example The above ribbon, in the default theme, will display differently depending on the ribbonwidth variable:


default width

Landgeohash.png
Mr. Stickman earned the Pilgrimage achievement
by reaching the coordinates of the original comic.

600px

Landgeohash.png
Mr. Stickman earned the Pilgrimage achievement
by reaching the coordinates of the original comic.

100%

Landgeohash.png
Mr. Stickman earned the Pilgrimage achievement
by reaching the coordinates of the original comic.