Difference between revisions of "Template:Ribbon"

From Geohashing
imported>Relet
m
imported>Relet
(expanded on the example section)
Line 9: Line 9:
 
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.
 
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.''
+
*icon       = ''The icon image to display in the ribbon.''
*color = ''The border colour of the ribbon.''
+
*color       = ''The border colour of the ribbon.''
 
*achievement = ''Achievement or consolation prize name.''
 
*achievement = ''Achievement or consolation prize name.''
*action = ''A free form description of the achieved feature. "reaching the x,y hash..."''
+
*action     = ''A free form description of the achieved feature. "reaching the x,y hash..."''
Optional Parameters:
+
Optional marameters:
*user = ''The user name to be displayed in the ribbon.'' (Defaults to "This user". use <nowiki>{{{name|}}}</nowiki> as value to pass through the possibly blank ''name'' parameter as user name)
+
*user       = ''The user name to be displayed in the ribbon.'' (Defaults to "This user". use <nowiki>{{{name|}}}</nowiki> 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.''
+
*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.)
 +
Optional modifiers:
 +
*Use the code <pre>{{#vardefine:smalltemplates|1}}</pre> on any page to make all subsequent ribbons appear more compact.
 
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.''
 +
*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.''
  
 
'''Example'''
 
'''Example'''
Line 30: Line 35:
 
}}</nowiki></pre>
 
}}</nowiki></pre>
 
will display as:
 
will display as:
 +
{{Ribbon
 +
|icon = Landgeohash.png
 +
|color = darkgreen
 +
|user = Mr. Stickman
 +
|achievement = [[Lost in Thought Achievement]]
 +
|action = hurting himself while concentrating on the display of his GPS
 +
|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 -->
 +
}}
 +
or, with small templates:
 +
{{#vardefine:smalltemplates|1}}
 
{{Ribbon
 
{{Ribbon
 
|icon = Landgeohash.png
 
|icon = Landgeohash.png

Revision as of 15:15, 16 January 2010

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

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

Optional modifiers:

  • Use the code
    {{#vardefine:smalltemplates|1}}
    on any page to make all subsequent ribbons appear more compact.

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.

Example

{{Ribbon
|icon = Landgeohash.png
|color = darkgreen
|user = Mr. Stickman
|achievement = [[Lost in Thought Achievement]]
|action = hurting himself while concentrating on the display of his GPS
|category = Lost in Thought Achievement
}}

will display as:

Landgeohash.png
Mr. Stickman earned the Lost in Thought Achievement
by hurting himself while concentrating on the display of his GPS.

or, with small templates:

Landgeohash.png
Mr. Stickman earned the Lost in Thought Achievement
by hurting himself while concentrating on the display of his GPS.