Difference between revisions of "Template:Infobox CharData/doc"
m (New page: <noinclude>{{DocSubpage}}</noinclude> Please note: this template depends on external APIs that are not yet finalized, and thus will almost...) |
m (revamped docs) |
||
| Line 4: | Line 4: | ||
I'm mostly just trying to see if I can even do this Semantic Wiki stuff. -- [[User:Danaris|Anaris]] 13:20, 25 March 2009 (UTC) | I'm mostly just trying to see if I can even do this Semantic Wiki stuff. -- [[User:Danaris|Anaris]] 13:20, 25 March 2009 (UTC) | ||
| − | < | + | == Intro == |
| + | This template uses the BattleMaster external data API to grab your character data from the game database and display it on a wiki page. That way you don't need to continually update your character info on the wiki every time something changes. | ||
| + | |||
| + | == Usage == | ||
| + | |||
| + | The most basic usage of the template is to provide only the world number and your character ID number. You can get both of these by hovering your mouse over the Play link for that cahracter, and noting the URL, like this: | ||
| + | * <nowiki>http://battlemaster.org/stable/playchar.php?ID=9258&World=1</nowiki> | ||
| + | ** The character ID is the part that follows "ID=", in this case it is: 9258 | ||
| + | ** The world is the number that follows "World=", in this case it is: 1 | ||
| + | Substitute these into the template, using the inline format, like this: | ||
| + | :<nowiki>{{Infobox CharData|(World)|(ID)}}</nowiki> | ||
| + | Like this: | ||
| + | :<nowiki>{{Infobox CharData|1|9258}}</nowiki> | ||
| + | |||
| + | Usage of the character ID number is preferred, as it uses less server resources than using the character name. If, however, you cannot for some reason get the character ID number (like if it's not your character you're putting up a box for), then you can use the character name, like this (nopte the extra pipe ('''|''') character): | ||
| + | :<nowiki>{{Infobox CharData|(World)||(Name)}}</nowiki> | ||
| + | Like this: | ||
| + | :<nowiki>{{Infobox CharData|1||Balkeese}}</nowiki> | ||
| + | |||
| + | == Colors == | ||
| + | You can optionally specify background colors by adding extra parameters on the end. Make sure you add extra pipe characters as needed, as shown below. | ||
| + | :<nowiki>{{Infobox CharData|1|9258||grey|blue|green}}</nowiki> | ||
| + | :<nowiki>{{Infobox CharData|1||Balkeese|#eeeeee|#dddddd|#cccccc}}</nowiki> | ||
| + | Experiment with the different colors to get the effect desired. | ||
Revision as of 18:35, 19 May 2009
 Page Information
|
| This is a documentation subpage for the Infobox CharData template. It contains usage information, categories and other content that is not part of the original template page. |
Please note: this template depends on external APIs that are not yet finalized, and thus will almost certainly break in the near future.
I'm mostly just trying to see if I can even do this Semantic Wiki stuff. -- Anaris 13:20, 25 March 2009 (UTC)
Intro
This template uses the BattleMaster external data API to grab your character data from the game database and display it on a wiki page. That way you don't need to continually update your character info on the wiki every time something changes.
Usage
The most basic usage of the template is to provide only the world number and your character ID number. You can get both of these by hovering your mouse over the Play link for that cahracter, and noting the URL, like this:
- http://battlemaster.org/stable/playchar.php?ID=9258&World=1
- The character ID is the part that follows "ID=", in this case it is: 9258
- The world is the number that follows "World=", in this case it is: 1
Substitute these into the template, using the inline format, like this:
- {{Infobox CharData|(World)|(ID)}}
Like this:
- {{Infobox CharData|1|9258}}
Usage of the character ID number is preferred, as it uses less server resources than using the character name. If, however, you cannot for some reason get the character ID number (like if it's not your character you're putting up a box for), then you can use the character name, like this (nopte the extra pipe (|) character):
- {{Infobox CharData|(World)||(Name)}}
Like this:
- {{Infobox CharData|1||Balkeese}}
Colors
You can optionally specify background colors by adding extra parameters on the end. Make sure you add extra pipe characters as needed, as shown below.
- {{Infobox CharData|1|9258||grey|blue|green}}
- {{Infobox CharData|1||Balkeese|#eeeeee|#dddddd|#cccccc}}
Experiment with the different colors to get the effect desired.
