Commonly Used Templates: Difference between revisions

From HorizonXI Wiki
Tag: Manual revert
 
(10 intermediate revisions by 2 users not shown)
Line 10: Line 10:
|}
|}
-->
-->
= Commonly Used Templates =
This page is a list of all the templates we commonly use on the Wiki. In each section you will find categorised lists of our most commonly used templates, an example page where they are in use and a description of their use cases. Some templates may have multiple use cases and as such may appear multiple times.
This page is a list of all the templates we commonly use on the Wiki. In each section you will find categorised lists of our most commonly used templates, an example page where they are in use and a description of their use cases. Some templates may have multiple use cases and as such may appear multiple times.


The page is still a work in progress so please bear with us.
The page is still a work in progress so please bear with us.
 
<br><br><br><br><br><br><br><br><br><br>
== Templates to Assist Editing ==
== Templates to Assist Editing ==
{| class="horizon-table editing-table table-md"
{| class="horizon-table editing-table table-lg"
! width="20%" | Name
! width="20%" | Name
! width="20%" | Example Page
! width="20%" | Example Page
Line 24: Line 23:
| <ul><li>[[Template:Mission Header|Mission Header]]</li><li>[[Template:Command|Command]]</li></ul>
| <ul><li>[[Template:Mission Header|Mission Header]]</li><li>[[Template:Command|Command]]</li></ul>
| '''This template only works in 'preview mode' whilst editing.''' The template can be attatched to the 'Usage' section of any '''other template''', which will then display instructions on how to fill out each parameter.
| '''This template only works in 'preview mode' whilst editing.''' The template can be attatched to the 'Usage' section of any '''other template''', which will then display instructions on how to fill out each parameter.
|-
| [[Special:Boilerplates|Boilerplates]]
| <ul><li>[[Template:Boilerplate/Regular Mob|Regular Mob]]</li><li>[[Template:Boilerplate/Job Abilities|Job Abilities]]</li></ul>
| Boilerplate templates are a special type of template which provide an editor with a full page template to work from. They are really useful in ensuring that all page types (eg. regular monster pages) use the same regular templates, table styles, have the same section headers etc.
<br>These can be accessed when creating a new page and via the boilerplate drop down box, found directly above the editing window.
|}
|}


Line 57: Line 61:
|}
|}


== Item/ Item Pages ==
== Item / Item Pages ==
{| class="horizon-table editing-table table-lg"
{| class="horizon-table editing-table table-lg"
! width="20%" | Name
! width="20%" | Name
! width="20%" | Example Page
! width="20%" | Example Page
! width="60%" | Description
! width="60%" | Description
|-
| [[:Template:Item Statistics|Item Statistics]]
| <ul><li>[[Bronze Dagger]]</li><li>Any item page</li></ul>
| The basic template for all items.
|-
| [[:Template:Item Image|Item Image]]
| <ul><li>[[Bronze Dagger]]</li><li>Any item page</li></ul>
| Used to generate the images at the top of each item page so they all have the same size
|-
|-
| [[:Template:AuctionHouseNavigation|AuctionHouseNavigation]]
| [[:Template:AuctionHouseNavigation|AuctionHouseNavigation]]
Line 78: Line 90:
| <ul><li>[[Coarse Boomerang]]</li><li>Any item page</li></ul>
| <ul><li>[[Coarse Boomerang]]</li><li>Any item page</li></ul>
| For use on all item pages, under the "Other Uses" heading. Commonly used alongside the [[:Template:Used In|Used In]] template. '''Please see the examples on on the "Used In" template page for correct template formatting, it can also be a little wonky!'''
| For use on all item pages, under the "Other Uses" heading. Commonly used alongside the [[:Template:Used In|Used In]] template. '''Please see the examples on on the "Used In" template page for correct template formatting, it can also be a little wonky!'''
|-
| [[:Template:Synthesis Recipe|Synthesis Recipe]] &<br>[[:Template:Synthesis Recipes|Synthesis Recipe'''s''']]
| <ul><li>Any item page with a recipe on it.</li></ul>
| To be used on any item page with a synthesis recipe listed. [[:Template:Synthesis Recipes|Synthesis Recipe'''s''']] is used to stack multiple recipes together.
|}
|}


* AH - used on item pages 'how to obtain' via AH.
* [[:Template:AH]] - used on item pages 'how to obtain' via AH.
* Synthesis Recipes
* [[:Template:rl]] - use to show "can be used in these recipes" on item pages.
* rl - use to show "can be used in these recipes" on item pages.
* Item Statistics
* Item Image (used to generate the images at the top of each item page so they all have the same size)


== Monster/Notorious Monster Pages ==
== Monster/Notorious Monster Pages ==
Line 91: Line 104:
! width="20%" | Example Page
! width="20%" | Example Page
! width="60%" | Description
! width="60%" | Description
|-
| [[:Template:Infobox Monster|Infobox Monster]]
| <ul><li>[[Leaping Lizzy]]</li><li>[[Lesser Manticore]]</li></ul>
| To be used on '''ALL''' regular monster and notorious monster pages.
|-
|-
| [[:Template:Hxi Drop Rate|Hxi Drop Rate]]
| [[:Template:Hxi Drop Rate|Hxi Drop Rate]]
| <ul><li>[[Balloon]]</li><li>[[Behemoth]]</li></ul>
| <ul><li>[[Balloon]]</li><li>[[Behemoth]]</li></ul>
| This is an upgrade on the original [[:Template:Drop Rate|Drop Rate]] template. Please use this template instead. It allows the user to include drop rates found in the ASB code and also overwrite them if hard data is available too.
| This is an upgrade of the original and deprecated Template:Drop Rate. Please use this template instead. It allows the user to include drop rates found in the ASB code and also overwrite them if hard data is available too.
|}
|}


Line 113: Line 130:


== Tooltips ==
== Tooltips ==
* Location - used to generate maps on hover with coordinate square highlighted. Calls template:position to achieve this, which calls template:Location Tooltip... its a mess
* [[:Template:Location]] - used to generate maps on hover with coordinate square highlighted. Calls template:position to achieve this, which calls template:Location Tooltip... its a mess
* Location Tooltip - similar to Location but with more funcationality I think. Calls Template:tooltip
* [[:Template:Location Tooltip]] - similar to Location but with more funcationality I think. Calls Template:tooltip
* Tooltip - this seems to be the base template used by all tooltip functionality. Assigns html id and css classes so some javascript function can pick it up and display a tooltip.
* [[:Template:Tooltip]] - this seems to be the base template used by all tooltip functionality. Assigns html id and css classes so some javascript function can pick it up and display a tooltip.
 
== Miscellaneous ==
* [[:Template:Hxi_Drop_Rate]] - used for drop rates.  Has an ASB drop rate. Please read how to use it on its page for horizonXI.
* [[:Template:Item Tooltip]] - not used commonly but Ill mention here. I built that one to generate the tooltips on the [[:Template:ArmorTable]] and [[:Template:WeaponsTable]]. Can be used on any Item really. Uses a dpl call to get the icon from the item page by looking into the Item Image template on that page and grabbing the filename. calls [[:Template:Tooltip]] to generate the tooltip.
* [[:Template:Stat]] - used to display stats in a uniform manner on item pages, capital letters, link, bold, ...
* [[:Template:Used In]] - appears on most if not all item pages and outputs the uses of items in a uniform manner.
* [[:Template:Item Statistics]] - the basic template for all items.
* [[:Template:NPC]] - the basic template for all NPCs.
* Changes - comes with the tooltip.
* [[:Template:Verification]] - adds a warning triangle that information may not be accurate.
* [[:Template:Command]] - to be used on any Command/??? pages.
* See [[Elemental Colors and Icons]] for templates to generate colored text and elemental icons.


== Miscellaneous ==
== Miscellaneous ==
Line 138: Line 143:
| Examples should be all deleted, see Template page.
| Examples should be all deleted, see Template page.
| Simply add <nowiki>" {{Delete}} "</nowiki> to any page that you feel needs to be deleted. Administators will occassionally check the list this generates and delete as they feel appropriate. Feel free to add your reasoning alongside it.
| Simply add <nowiki>" {{Delete}} "</nowiki> to any page that you feel needs to be deleted. Administators will occassionally check the list this generates and delete as they feel appropriate. Feel free to add your reasoning alongside it.
|-
| [[:Template:Construction|Construction]]
| N/A
| This template can be added to any page that is under construction. It is commonly used on pages from upcoming content that is yet to be released.
|-
| [[:Template:Dat Mined|Dat Mined]]
|
| To be used on any page that has created with the use of dat mined information, or pages with sections of dat mined information. Please see the [[Editing Guidelines#Dat-Mining|editing guidelines]] page for further information and guideance.
|}
|}
* [[:Template:Hxi_Drop_Rate]] - used for drop rates.  Has an ASB drop rate. Please read how to use it on its page for horizonXI.
* [[:Template:Item Tooltip]] - not used commonly but Ill mention here. I built that one to generate the tooltips on the [[:Template:ArmorTable]] and [[:Template:WeaponsTable]]. Can be used on any Item really. Uses a dpl call to get the icon from the item page by looking into the Item Image template on that page and grabbing the filename. calls Template:Tooltip to generate the tooltip. (''Note: The use of this template is a bit more memory intensive than most others. Please don't use excessively on a page.'')
* [[:Template:Stat]] - used to display stats in a uniform manner on item pages, capital letters, link, bold, ...
* [[:Template:NPC]] - the basic template for all NPCs.
* Changes - comes with the tooltip.
* [[:Template:Verification]] - adds a warning triangle that information may not be accurate.
* [[:Template:Command]] - to be used on any Command/??? pages.
* See [[Elemental Colors and Icons]] for templates to generate colored text and elemental icons.
* [[:Template:Icon]] - used to display commonly used icons. The template page also serves as an overview on available icons.


== Out of Era Content ==
== Out of Era Content ==

Latest revision as of 13:44, 21 March 2024

This page is a list of all the templates we commonly use on the Wiki. In each section you will find categorised lists of our most commonly used templates, an example page where they are in use and a description of their use cases. Some templates may have multiple use cases and as such may appear multiple times.

The page is still a work in progress so please bear with us.









Templates to Assist Editing

Name Example Page Description
Preview Only Infobox This template only works in 'preview mode' whilst editing. The template can be attatched to the 'Usage' section of any other template, which will then display instructions on how to fill out each parameter.
Boilerplates Boilerplate templates are a special type of template which provide an editor with a full page template to work from. They are really useful in ensuring that all page types (eg. regular monster pages) use the same regular templates, table styles, have the same section headers etc.


These can be accessed when creating a new page and via the boilerplate drop down box, found directly above the editing window.

DPL Templates

These tables allow an editor to easily create a table for a list of items from it's corresponding category. An editor can also create a custom list from the names of desired items only. Any item page that uses the Item Statistics template (most do and need converting if not) are eligble for use. I cannot stress enough how amazing and simple these templates are, please try them.

Name Example Page Description
WeaponsTable Used to easily create a table for weapons. Editors can filter the table to display certain jobs, weapon types or a custom list of weapons.
ArmorTable Used to easily create a table for armor. Editors can filter the table to dsiplay certain jobs, armor types or a custom list of armor.
InstrumentTable Used to easily create a table for instruments. Editors can filter to display string instruments, wind instruments or a custom list of intruments.

Infoboxes

Name Example Page Description
Infobox Magic Displays an infobox on the right of a page, designed for the spells of FFXI. Editors shouldn't need to use this template from scratch as spell pages have all been added but they may find the template page useful if editing is required.

Item / Item Pages

Name Example Page Description
Item Statistics The basic template for all items.
Item Image Used to generate the images at the top of each item page so they all have the same size
AuctionHouseNavigation Used to specify the succession of auction house categories to display the appropriate box.
Used In For use on all item pages, under the "Other Uses" heading. Commonly used alongside other templates such as Guild Points Value and Resale Price.
Resale Price For use on all item pages, under the "Other Uses" heading. Commonly used alongside the Used In template. Please see the examples on on the "Used In" template page for correct template formatting, it can be a little wonky!
Guild Points Value For use on all item pages, under the "Other Uses" heading. Commonly used alongside the Used In template. Please see the examples on on the "Used In" template page for correct template formatting, it can also be a little wonky!
Synthesis Recipe &
Synthesis Recipes
  • Any item page with a recipe on it.
 To be used on any item page with a synthesis recipe listed. Synthesis Recipes is used to stack multiple recipes together.
  • Template:AH - used on item pages 'how to obtain' via AH.
  • Template:rl - use to show "can be used in these recipes" on item pages.

Monster/Notorious Monster Pages

Name Example Page Description
Infobox Monster To be used on ALL regular monster and notorious monster pages.
Hxi Drop Rate This is an upgrade of the original and deprecated Template:Drop Rate. Please use this template instead. It allows the user to include drop rates found in the ASB code and also overwrite them if hard data is available too.

Job Related

Name Example Page Description
Job Ability Used on any "Job Ability" pages.
Pet Command Used on any "Pet Command" pages.

Tooltips

  • Template:Location - used to generate maps on hover with coordinate square highlighted. Calls template:position to achieve this, which calls template:Location Tooltip... its a mess
  • Template:Location Tooltip - similar to Location but with more funcationality I think. Calls Template:tooltip
  • Template:Tooltip - this seems to be the base template used by all tooltip functionality. Assigns html id and css classes so some javascript function can pick it up and display a tooltip.

Miscellaneous

Name Example Page Description
Delete Examples should be all deleted, see Template page. Simply add " {{Delete}} " to any page that you feel needs to be deleted. Administators will occassionally check the list this generates and delete as they feel appropriate. Feel free to add your reasoning alongside it.
Construction N/A This template can be added to any page that is under construction. It is commonly used on pages from upcoming content that is yet to be released.
Dat Mined To be used on any page that has created with the use of dat mined information, or pages with sections of dat mined information. Please see the editing guidelines page for further information and guideance.
  • Template:Hxi_Drop_Rate - used for drop rates. Has an ASB drop rate. Please read how to use it on its page for horizonXI.
  • Template:Item Tooltip - not used commonly but Ill mention here. I built that one to generate the tooltips on the Template:ArmorTable and Template:WeaponsTable. Can be used on any Item really. Uses a dpl call to get the icon from the item page by looking into the Item Image template on that page and grabbing the filename. calls Template:Tooltip to generate the tooltip. (Note: The use of this template is a bit more memory intensive than most others. Please don't use excessively on a page.)
  • Template:Stat - used to display stats in a uniform manner on item pages, capital letters, link, bold, ...
  • Template:NPC - the basic template for all NPCs.
  • Changes - comes with the tooltip.
  • Template:Verification - adds a warning triangle that information may not be accurate.
  • Template:Command - to be used on any Command/??? pages.
  • See Elemental Colors and Icons for templates to generate colored text and elemental icons.
  • Template:Icon - used to display commonly used icons. The template page also serves as an overview on available icons.

Out of Era Content

  • TOAU, WOTG, SOA, afterera, noera

Uncategorised (so far)

Retrieved from "https://horizonffxi.wiki/w/index.php?title=Commonly_Used_Templates&oldid=38162"