Template:Infobox Ferret/doc: Difference between revisions

Gorasuhl (talk | contribs)
reworked documentation for updated Template
m Removed fixed issue notice
 
(3 intermediate revisions by one other user not shown)
Line 2: Line 2:
<templatestyles src="Template:Infobox_Ferret/doc/styles.css" />
<templatestyles src="Template:Infobox_Ferret/doc/styles.css" />
An infobox for use on Ferret pages. It stores data to [[Special:CargoTables/Ferret]].
An infobox for use on Ferret pages. It stores data to [[Special:CargoTables/Ferret]].
{{notice|file=Warning.png|header=Known Issue - Spaces in ferret names|content=Currently <code>name</code> parameter must be set manually for ferrets with spaces in their name. Spaces must be replaced by underscores. <br>Example: For '''Mai Tai''' you have to add <code>{{!}} name = Mai_Tai</code> to her Infobox|color=orange|colorBack=orange}}


==Usage==
==Usage==
Line 52: Line 49:
|-
|-
| noCategories || Boolean ||  || Optional. If given any value, the page will not be auto-categorized.
| noCategories || Boolean ||  || Optional. If given any value, the page will not be auto-categorized.
|-
| noCargo || Boolean ||  || Optional. If given any value, no content will be added into [[Special:CargoTables/Ferret]].
|}
|}


=== Mugshot Image ===
=== Mugshot Image ===
Filename <code>Ferretname_Mugshot.png</code> for the Image will be created automatically. If the File doesn't exist, [[:File:Unknown_Mugshot.png]] will be used as a placeholder, the Infobox will display the missing file below the placeholder and the page will be added to [[:Category:Ferret lacking infobox images]].
Filename <code>Ferretname_Mugshot.png</code> for the Image will be created automatically. If the File doesn't exist, [[:File:Unknown_Mugshot.png]] will be used as a placeholder, the Infobox will display the missing file below the placeholder and the page will be added to [[:Category:Ferrets lacking infobox image]].


Image size should be approx. 190x230 px
Image size should be approx. 190x230 px
Line 83: Line 82:


====Notes====
====Notes====
[*] marked Parameters are used to create examples for this documentation. Don't set <code>name</code> on the ferret page manually. A <code>name</code> that differs from the page title will cause broken internal links. <code>noCategories = 1</code> will prevent categories been added to the page and also prevent data written into [[Special:CargoTables/Ferret]].
[*] marked Parameters are used to create examples for this documentation. Don't set <code>name</code> on the ferret page manually. A <code>name</code> that differs from the page title will cause broken internal links. <code>noCategories = 1</code> prevent categories been added to the page.
</div>
</div>


Line 121: Line 120:


====Notes====
====Notes====
[*] marked Parameters are used to create examples for this documentation. Don't set <code>name</code> on the ferret page manually. A <code>name</code> that differs from the page title will cause broken internal links. <code>noCategories = 1</code> will prevent categories been added to the page and also prevent data written into [[Special:CargoTables/Ferret]].
[*] marked Parameters are used to create examples for this documentation. Don't set <code>name</code> on the ferret page manually. A <code>name</code> that differs from the page title will cause broken internal links. <code>noCategories = 1</code> prevent categories been added to the page.
  </div>
  </div>