Badge time.png   The Paragon Wiki Archive documents the state of City of Heroes/Villains as it existed on December 1, 2012.

Difference between revisions of "Template:BadgeHunter Badge/doc"

From Paragon Wiki Archive
Jump to: navigation, search
(moving documentation here from template page)
 
 
Line 2: Line 2:
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
  
A template that can be used to link to badge listings at [http://www.Badge-Hunter.com/ Badge-Hunter.com]
+
A template that can be used to link to badge listings at [http://www.Badge-Hunter.com/ Badge-Hunter.com].
 +
 
 +
This template should ideally be provided with two parameters:
 +
* '''ID=''', the internal ID used by Badge Hunter
 +
* '''type=''', the internal category type ID used by Badge Hunter
 +
The template optionally accepts an additional parameter:
 +
* '''name=''', the badge's name; this defaults to the current page's name
 +
 
 +
If all of the parameters are correct, the link will lead to the badge listing page of the appropriate type and will anchor them to the point in the page where the badge is located. If the parameters aren't correct, the link will at least lead to the badge listings.
 +
 
 +
In order to determine the proper '''type=''' value, select the appropriate category at http://www.badge-hunter.com/index.php?/page/view_badge_bytype.php and see what type= value ends up in the URL.
 +
 
 +
In order to determine the proper '''ID=''' value, you'll have to view the page source. Each badge is in a table, and each of those tables is stored in a list item (<nowiki><li></nowiki>). The list items will have an "id" attribute that is formatted as "s3_123" where "123" is the ID you'll need to use.
  
By default will use the article's PAGENAMEE (converts spaces to underscores and makes it URL friendly), however in the event that PAGENAMEE does not match what badge-hunter is using, can be replaced by the name parameter.  As a last resort, should the name search feature at Badge-Hunter fail completely, the ID parameter can be used, however, this requires the page editor to verify the badge id at badge-hunter.
 
 
:{{tl|BadgeHunter Badge}}
 
:{{tl|BadgeHunter Badge}}
:{{BadgeHunter Badge}}
+
:{{BadgeHunter Badge}}
:{{tl|BadgeHunter Badge|name&#61;Other_Badge_Name}}
+
:{{tl|BadgeHunter Badge|ID&#61;117|type&#61;11|name&#61;Man / Woman in Black}}
:{{BadgeHunter Badge|name=Other_Badge_Name}}
+
:{{BadgeHunter Badge|ID=117|type=11|name=Man / Woman in Black}}
:{{tl|BadgeHunter Badge|ID&#61;0}}
+
:{{BadgeHunter Badge|ID=0}}
+
  
 
''Please see [[Template talk:BadgeHunter Badge]] for troubleshooting info.''
 
''Please see [[Template talk:BadgeHunter Badge]] for troubleshooting info.''
 +
 
<includeonly><!--
 
<includeonly><!--
 
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
 
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
 
[[Category:External Link Templates|{{PAGENAME}}]]
 
[[Category:External Link Templates|{{PAGENAME}}]]
 
</includeonly>
 
</includeonly>

Latest revision as of 10:03, 28 June 2012

This is a documentation subpage for Template:BadgeHunter Badge (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

A template that can be used to link to badge listings at Badge-Hunter.com.

This template should ideally be provided with two parameters:

  • ID=, the internal ID used by Badge Hunter
  • type=, the internal category type ID used by Badge Hunter

The template optionally accepts an additional parameter:

  • name=, the badge's name; this defaults to the current page's name

If all of the parameters are correct, the link will lead to the badge listing page of the appropriate type and will anchor them to the point in the page where the badge is located. If the parameters aren't correct, the link will at least lead to the badge listings.

In order to determine the proper type= value, select the appropriate category at http://www.badge-hunter.com/index.php?/page/view_badge_bytype.php and see what type= value ends up in the URL.

In order to determine the proper ID= value, you'll have to view the page source. Each badge is in a table, and each of those tables is stored in a list item (<li>). The list items will have an "id" attribute that is formatted as "s3_123" where "123" is the ID you'll need to use.

{{BadgeHunter Badge}}
{{BadgeHunter Badge|ID=117|type=11|name=Man / Woman in Black}}

Please see Template talk:BadgeHunter Badge for troubleshooting info.