Template:Abundance: Difference between revisions

From Horizon Wiki Mirror
← Older edit
imported>Aramachus
Content deleted Content added
imported>Spiffly
No edit summary
imported>Aramachus
added additional parameter for quested items and special option for af coffer items
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly><onlyinclude>{{#switch:{{lc:{{{1}}}}}
<includeonly><onlyinclude>{{#switch:{{lc:{{{1}}}}}
| map = <span style="display:none">101%</span>''Received if not previously obtained''
| map = <span style="display:none">101%</span>''Received if not previously obtained''
| quested = <span style="display:none">101%</span>''Received with quest active''
| quest | quested = <span style="display:none">101%</span>''Received with {{#if:{{{2|}}}|[[{{{2}}}|quest]]|quest}} active {{{quest add text|}}}''
| af coffer = <span style="display:none">101%</span>''Received only on {{#if:{{{job|}}}|[[{{{job}}}]]|the corresponding job}} with {{#if:{{{2|}}}|[[{{{2}}}|Artifact Hands quest]]|Artifact Hands quest}} active or finished''
| #default = <span style="display:none">{{#switch:{{{2|}}}||0=0|#default={{#expr:{{{1}}} / {{{2}}} * 100 round 1}}}}%</span><!-- Invisible key for sort order
| #default = <span style="display:none">{{#switch:{{{2|}}}||0=0|#default={{#expr:{{{1}}} / {{{2}}} * 100 round 1}}}}%</span><!-- Invisible key for sort order


If sample size is 0 display message unless asb is given
-->{{#ifexpr:{{default|{{{2|}}}|0}}<=0|{{ht|No data.|[[File:Unknown.png|20px|Unknown|link=HorizonXIwiki:Drop Rate Policy]]<sup>(0%)</sup>|gray}}|{{ht<!--
-->{{#ifexpr:{{default|{{{2|}}}|0}}<=0|<!--
check if asb is given
-->{{#if:{{{asb|}}}|<!--
display asb text and tooltip
-->{{ht|No sample data. AirSkyBoat Abundance is displayed.|{{Abundance/Get Tier|{{#explode:{{{asb}}}|/|0}}|{{#explode:{{{asb}}}|/|1}}}}<sup>({{#expr:{{{asb}}}*100 round 1}}%)</sup>}}<!--
-->|{{ht|No data.|[[File:Unknown.png|20px|Unknown|link=HorizonXI:Drop Rate Policy]]<sup>(0%)</sup>|gray}}}}<!--


-->|<!--
-->|{{#ifexpr:{{{2}}} < 100|({{{1}}}/{{{2}}}). Insufficient data for accurate Abundance. More information is needed.<!--

-->{{ht<!--

-->|<!--
--- First part: the tooltip: Evaluate the tooltip infotext based on sample size ---

-->{{#ifexpr:{{{2}}} < 100<!--
less than 100 samples
-->|{{#if:{{{asb|}}}|Insufficient data for accurate Abundance. AirSkyBoat Abundance is displayed.|({{{1}}}/{{{2}}}). Insufficient data for accurate Abundance. More information is needed.}}<!--
more than 100 but less than 500 samples
-->|{{#ifexpr:{{{2}}} < 500|({{{1}}}/{{{2}}}). Low data; Abundance may be inaccurate.<!--
-->|{{#ifexpr:{{{2}}} < 500|({{{1}}}/{{{2}}}). Low data; Abundance may be inaccurate.<!--
more than 500 samples
-->|({{{1}}}/{{{2}}}). High data; Abundance should be accurate.}}}}<!--
-->|({{{1}}}/{{{2}}}). High data; Abundance should be accurate.}}}}<!--


-->|<!--
-->|{{#ifexpr:{{{2}}} < 100|[[File:Warning.png|20px|More data needed.|link=HorizonXIwiki:Drop Rate Policy]]<!--
--- second part, the base text ---
-->|{{#ifexpr:({{{1}}} / {{{2}}} * 100) <= 1|[[FFXIclopedia:Drop Rate Policy|Extremely Rare]]<!--

-->|{{#ifexpr:({{{1}}} / {{{2}}} * 100) <= 5|[[FFXIclopedia:Drop Rate Policy|Very Rare]]<!--
If sample size too low, display asb if given as abundance tier, otherwise display warning. for large sample size display abundance tier
-->|{{#ifexpr:({{{1}}} / {{{2}}} * 100) <= 10|[[FFXIclopedia:Drop Rate Policy|Rare]]<!--
-->|{{#ifexpr:({{{1}}} / {{{2}}} * 100) <= 15|[[FFXIclopedia:Drop Rate Policy|Uncommon]]<!--
-->{{#ifexpr:{{{2}}} < 100|<!--
if asb, display as abundance tier, otherwise display warning
-->|{{#ifexpr:({{{1}}} / {{{2}}} * 100) <= 20|[[FFXIclopedia:Drop Rate Policy|Common]]<!--
-->|{{#ifexpr:({{{1}}} / {{{2}}} * 100) <= 50|[[FFXIclopedia:Drop Rate Policy|Very Common]]<!--
-->{{#if:{{{asb|}}}|{{Abundance/Get Tier|{{#explode:{{{asb}}}|/|0}}|{{#explode:{{{asb}}}|/|1}}}}|[[File:Warning.png|20px|More data needed.|link=HorizonXI:Drop Rate Policy]]}}<!--
high droprate, display abundance tier
-->|[[FFXIclopedia:Drop Rate Policy|Extremely Common]]<!--
-->}}}}}}}}}}}}}}<!--
-->|{{Abundance/Get Tier|{{{1}}}|{{{2}}}}}}}<!--


Evaluate and display the percentage as suptext
--><sup>({{#expr:{{{1}}} / {{{2}}} * 100 round 1}}%)</sup><!--
--><sup>({{#ifexpr:{{{2|0}}} < 100|<!--
if less than 100 samples, check if asb is given
-->{{#if:{{{asb|}}}|<!--
if asb is given, display it
-->{{#expr:{{{asb}}}*100 round 1}}%<!--
if asb is not given, display samples
-->|{{#expr:{{{1}}} / {{{2}}} * 100 round 1}}{{#if: {{{CI|}}}|{{ConfidenceInterval|{{{1}}}|{{{2}}}}}|}}%}}<!--
if more than 100 samples, display samples
-->|{{#expr:{{{1}}} / {{{2}}} * 100 round 1}}{{#if: {{{CI|}}}|{{ConfidenceInterval|{{{1}}}|{{{2}}}}}|}}%}})</sup><!--


hovertext color. does not work at the moment, see Template:ht
-->|{{#ifexpr:{{{2}}} < 500|gray}}<!--
-->|{{#ifexpr:{{{2}}} < 500|gray}}<!--


Line 29: Line 57:
[[Category:Templates|{{PAGENAME}}]]
[[Category:Templates|{{PAGENAME}}]]
==Usage==
==Usage==
''This section describes how the Abundance template works. If you are looking for rules and guidelines on use, see [[HorizonXIwiki:Drop Rate Policy]].''
''This section describes how the Abundance template works. If you are looking for rules and guidelines on use, see [[HorizonXI:Drop Rate Policy]].''
<pre>
<pre>
{{Abundance|total items obtained|total attempts to obtain}}
{{Abundance|total items obtained|total attempts to obtain}}
Line 61: Line 89:
|}
|}
*The abundance is also displayed as a percent value after the text (in superscript) and the exact number of items obtained and attempts to obtain the item are displayed in the hovertext, as well as a message describing the data's current reliablity.
*The abundance is also displayed as a percent value after the text (in superscript) and the exact number of items obtained and attempts to obtain the item are displayed in the hovertext, as well as a message describing the data's current reliablity.
*If the data is too low to be considered reliable (less than 50 attempts), the abundance percent will be colored gray and [[File:Warning.png|20px|More data needed|link=HorizonXIwiki:Drop Rate Policy]] will be displayed in place of the usual text.
*If the data is too low to be considered reliable (less than 50 attempts), the abundance percent will be colored gray and [[File:Warning.png|20px|More data needed|link=HorizonXI:Drop Rate Policy]] will be displayed in place of the usual text.
*If the data is low, but not completely unreliable (less than 500 attempts), the abundance percent will simply be colored gray.
*If the data is low, but not completely unreliable (less than 500 attempts), the abundance percent will simply be colored gray.
*"Map" (case-insensitive) can be used as the "number of items" value to display "''Received if not previously obtained''".
*"Map" (case-insensitive) can be used as the "number of items" value to display "''Received if not previously obtained''".
*"Quest" (case-insensitive) can be used as the "number of items" value to display "''Received with quest active''".
*"Quest" / "Quested" (case-insensitive) can be used as the "number of items" value to display "''Received with quest active''". An optional second parameter allows to specify the name of the quest.
*optional parameter CI has been added to display a 95% confidence interval. Setting it to true, e.g. <nowiki>{{Abundance|98|232|CI=true}}</nowiki> will display the confidence interval in the output.


===Examples===
===Examples===
{|border="1"
{|border="1"
|- BGCOLOR="e3e3e3"
|- BGCOLOR="e3e3e3"
! Code !! Result
! Code !! Result !! Result with CI
|-
|-
|<pre style="white-space:pre-line">{{Abundance|map}}</pre>
|<pre style="white-space:pre-line">{{Abundance|map}}</pre>
|{{Abundance|map}}
|{{Abundance|map}}
|{{Abundance|map|CI=true}}
|-
|-
|<pre style="white-space:pre-line">{{Abundance|quested}}</pre>
|<pre style="white-space:pre-line">{{Abundance|quested}}</pre>
|{{Abundance|quested}}
|{{Abundance|quested}}
|{{Abundance|quested|CI=true}}
|-
|<pre style="white-space:pre-line">{{Abundance|quested|Borghertz's Harmonious Hands}}</pre>
|{{Abundance|quested|Borghertz's Harmonious Hands}}
|{{Abundance|quested|Borghertz's Harmonious Hands|CI=true}}
|-
|<pre style="white-space:pre-line">{{Abundance|quested|quest add text=([[Borghertz's Healing Hands|WHM]], [[Borghertz's Striking Hands|MNK]])}}</pre>
|{{Abundance|quested|quest add text=([[Borghertz's Healing Hands|WHM]], [[Borghertz's Striking Hands|MNK]])}}
|{{Abundance|quested|quest add text=([[Borghertz's Healing Hands|WHM]], [[Borghertz's Striking Hands|MNK]])|CI=true}}
|-
|<pre style="white-space:pre-line">{{Abundance|af coffer|Borghertz's Harmonious Hands|job=Bard}}</pre>
|{{Abundance|af coffer|Borghertz's Harmonious Hands|job=Bard}}
|{{Abundance|af coffer|Borghertz's Harmonious Hands|job=Bard|CI=true}}
|-
|-
|<pre style="white-space:pre-line">{{Abundance||}}</pre>
|<pre style="white-space:pre-line">{{Abundance||}}</pre>
|{{Abundance||}}
|{{Abundance||}}
|{{Abundance|||CI=true}}
|-
|-
|<pre style="white-space:pre-line">{{Abundance|0|0}}</pre>
|<pre style="white-space:pre-line">{{Abundance|0|0}}</pre>
|{{Abundance|0|0}}
|{{Abundance|0|0}}
|{{Abundance|0|0|CI=true}}
|-
|-
|<pre style="white-space:pre-line">{{Abundance|0|5}}</pre>
|<pre style="white-space:pre-line">{{Abundance|0|5}}</pre>
|{{Abundance|0|5}}
|{{Abundance|0|5}}
|{{Abundance|0|5|CI=true}}
|-
|-
|<pre style="white-space:pre-line">{{Abundance|1|10}}</pre>
|<pre style="white-space:pre-line">{{Abundance|1|10}}</pre>
|{{Abundance|1|10}}
|{{Abundance|1|10}}
|{{Abundance|1|10|CI=true}}
|-
|<pre style="white-space:pre-line">{{Abundance|2|1503}}</pre>
|{{Abundance|2|1503}}
|{{Abundance|2|1503|CI=true}}
|-
|-
|<pre style="white-space:pre-line">{{Abundance|24|153}}</pre>
|<pre style="white-space:pre-line">{{Abundance|24|153}}</pre>
|{{Abundance|24|153}}
|{{Abundance|24|153}}
|{{Abundance|24|153|CI=true}}
|-
|-
|<pre style="white-space:pre-line">{{Abundance|100|344}}</pre>
|<pre style="white-space:pre-line">{{Abundance|100|344}}</pre>
|{{Abundance|100|344}}
|{{Abundance|100|344}}
|{{Abundance|100|344|CI=true}}
|-
|-
|<pre style="white-space:pre-line">{{Abundance|443|562}}</pre>
|<pre style="white-space:pre-line">{{Abundance|443|562}}</pre>
|{{Abundance|443|562}}
|{{Abundance|443|562}}
|{{Abundance|443|562|CI=true}}
|-
|-
|<pre style="white-space:pre-line">{{Abundance|11|625}}</pre>
|<pre style="white-space:pre-line">{{Abundance|11|625}}</pre>
|{{Abundance|11|625}}
|{{Abundance|11|625}}
|{{Abundance|11|625|CI=true}}
|-
|<pre style="white-space:pre-line">{{Abundance|108|110}}</pre>
|{{Abundance|108|110}}
|{{Abundance|108|110|CI=true}}
|-
|<pre style="white-space:pre-line">{{Abundance|0|0|asb=242/1000}}</pre>
|{{Abundance|0|0|asb=242/1000}}
|{{Abundance|0|0|CI=true|asb=242/1000}}
|-
|<pre style="white-space:pre-line">{{Abundance|0|5|asb=242/1000}}</pre>
|{{Abundance|0|5|asb=242/1000}}
|{{Abundance|0|5|CI=true|asb=242/1000}}
|-
|<pre style="white-space:pre-line">{{Abundance|1|10|asb=242/1000}}</pre>
|{{Abundance|1|10|asb=242/1000}}
|{{Abundance|1|10|CI=true|asb=242/1000}}
|-
|<pre style="white-space:pre-line">{{Abundance|2|1503|asb=242/1000}}</pre>
|{{Abundance|2|1503|asb=242/1000}}
|{{Abundance|2|1503|CI=true|asb=242/1000}}
|-
|<pre style="white-space:pre-line">{{Abundance|24|153|asb=242/1000}}</pre>
|{{Abundance|24|153|asb=242/1000}}
|{{Abundance|24|153|CI=true|asb=242/1000}}
|-
|<pre style="white-space:pre-line">{{Abundance|100|344|asb=242/1000}}</pre>
|{{Abundance|100|344|asb=242/1000}}
|{{Abundance|100|344|CI=true|asb=242/1000}}
|-
|<pre style="white-space:pre-line">{{Abundance|443|562|asb=242/1000}}</pre>
|{{Abundance|443|562|asb=242/1000}}
|{{Abundance|443|562|CI=true|asb=242/1000}}
|-
|<pre style="white-space:pre-line">{{Abundance|11|625|asb=242/1000}}</pre>
|{{Abundance|11|625|asb=242/1000}}
|{{Abundance|11|625|CI=true|asb=242/1000}}
|-
|<pre style="white-space:pre-line">{{Abundance|108|110|asb=242/1000}}</pre>
|{{Abundance|108|110|asb=242/1000}}
|{{Abundance|108|110|CI=true|asb=242/1000}}
|}
|}

Latest revision as of 22:19, 4 June 2025

Usage

This section describes how the Abundance template works. If you are looking for rules and guidelines on use, see HorizonXI:Drop Rate Policy. 

{{Abundance|total items obtained|total attempts to obtain}}
  • This template is used to collect and present rarity/abundance data. It is intended to collect data from multiple users and keep a running total (new results are added to the existing totals rather than replacing them), thus becoming more accurate over time.
  • The template automatically displays the general rarity of the item using the following ranges:
Abundance Range
Extremely Rare 0 - 1%
Very Rare 1 - 5%
Rare 5 - 10%
Uncommon 10 - 15%
Common 15 - 20%
Very Common 20 - 50%
Extremely Common 50 - 100%
  • The abundance is also displayed as a percent value after the text (in superscript) and the exact number of items obtained and attempts to obtain the item are displayed in the hovertext, as well as a message describing the data's current reliablity.
  • If the data is too low to be considered reliable (less than 50 attempts), the abundance percent will be colored gray and More data needed will be displayed in place of the usual text.
  • If the data is low, but not completely unreliable (less than 500 attempts), the abundance percent will simply be colored gray.
  • "Map" (case-insensitive) can be used as the "number of items" value to display "Received if not previously obtained".
  • "Quest" / "Quested" (case-insensitive) can be used as the "number of items" value to display "Received with quest active". An optional second parameter allows to specify the name of the quest.
  • optional parameter CI has been added to display a 95% confidence interval. Setting it to true, e.g. {{Abundance|98|232|CI=true}} will display the confidence interval in the output.

Examples

Code Result Result with CI 
{{Abundance|map}}
 101%Received if not previously obtained 101%Received if not previously obtained 
{{Abundance|quested}}
 101%Received with quest active 101%Received with quest active 
{{Abundance|quested|Borghertz's Harmonious Hands}}
 101%Received with quest active 101%Received with quest active 
{{Abundance|quested|quest add text=([[Borghertz's Healing Hands|WHM]], [[Borghertz's Striking Hands|MNK]])}}
 101%Received with quest active (WHM, MNK) 101%Received with quest active (WHM, MNK) 
{{Abundance|af coffer|Borghertz's Harmonious Hands|job=Bard}}
 101%Received only on Bard with Artifact Hands quest active or finished 101%Received only on Bard with Artifact Hands quest active or finished 
{{Abundance||}}
 0%Unknown(0%) 0%Unknown(0%) 
{{Abundance|0|0}}
 0%Unknown(0%) 0%Unknown(0%) 
{{Abundance|0|5}}
 0%More data needed.(0%) 0%More data needed.(0+/-60%) 
{{Abundance|1|10}}
 10%More data needed.(10%) 10%More data needed.(10+/-30%) 
{{Abundance|2|1503}}
 0.1%Extremely Rare(0.1%) 0.1%Extremely Rare(0.1+/-0.2%) 
{{Abundance|24|153}}
 15.7%Common(15.7%) 15.7%Common(15.7+/-5.8%) 
{{Abundance|100|344}}
 29.1%Very Common(29.1%) 29.1%Very Common(29.1+/-4.8%) 
{{Abundance|443|562}}
 78.8%Extremely Common(78.8%) 78.8%Extremely Common(78.8+/-3.4%) 
{{Abundance|11|625}}
 1.8%Very Rare(1.8%) 1.8%Very Rare(1.8+/-1%) 
{{Abundance|108|110}}
 98.2%Extremely Common(98.2%) 98.2%Extremely Common(98.2+/-2.7%) 
{{Abundance|0|0|asb=242/1000}}
 0%Expression error: Unrecognized punctuation character "{".(24.2%) 0%Expression error: Unrecognized punctuation character "{".(24.2%) 
{{Abundance|0|5|asb=242/1000}}
 0%Expression error: Unrecognized punctuation character "{".(24.2%) 0%Expression error: Unrecognized punctuation character "{".(24.2%) 
{{Abundance|1|10|asb=242/1000}}
 10%Expression error: Unrecognized punctuation character "{".(24.2%) 10%Expression error: Unrecognized punctuation character "{".(24.2%) 
{{Abundance|2|1503|asb=242/1000}}
 0.1%Extremely Rare(0.1%) 0.1%Extremely Rare(0.1+/-0.2%) 
{{Abundance|24|153|asb=242/1000}}
 15.7%Common(15.7%) 15.7%Common(15.7+/-5.8%) 
{{Abundance|100|344|asb=242/1000}}
 29.1%Very Common(29.1%) 29.1%Very Common(29.1+/-4.8%) 
{{Abundance|443|562|asb=242/1000}}
 78.8%Extremely Common(78.8%) 78.8%Extremely Common(78.8+/-3.4%) 
{{Abundance|11|625|asb=242/1000}}
 1.8%Very Rare(1.8%) 1.8%Very Rare(1.8+/-1%) 
{{Abundance|108|110|asb=242/1000}}
 98.2%Extremely Common(98.2%) 98.2%Extremely Common(98.2+/-2.7%)
Retrieved from "http://horizonwiki.lol/index.php?title=Template:Abundance&oldid=99258"