Jump to content

Template:Infobox Ferret/doc: Difference between revisions

From Ferret Software Wiki
← Older editNewer edit →
VisualWikitext
Add fake ferret to test unknown mugshot fallback image
Gorasuhl (talk | contribs)
trusted
1,040 edits
reworked documentation for updated Template
Line 1: Line 1:
{{Doc/start}}
{{Doc/start}}
<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==
<pre>
<pre>
{{Infobox Ferret
{{Infobox Ferret
| name =
| nickname =
| image =
| shayename =
| gender =
| gender =
| arrivaldate =
| arrivaldate =
Line 23: Line 27:
! Parameter !! Data Type !! Default Value !! Description
! Parameter !! Data Type !! Default Value !! Description
|-
|-
| name || String || <nowiki>{{PAGENAME}}</nowiki> || The ferret's name
| name || String || <nowiki>{{PAGENAME}}</nowiki> || The ferret's name. <ref group ="note"><code>name</code> parameter is used for internal linking on the wiki. Make sure the title of the ferret's page matches it's name. Don't try to define <code>name</code> by any other than using the default value, any difference between <code>name</code> and page title ([https://www.mediawiki.org/wiki/Manual:Page_title External Link: MediaWiki Manual - Page Title]) will cause broken broken internal links for the ferret's page!</ref>
|-
| nickname || String || || The ferret's nicknames by Chat
|-
|-
| image || String || <nowiki>{{{name}}}.png or {{PAGENAME}}.png</nowiki> || The image to be used, without the File: prefix but with the extension. For example, if you wanted to use [[:File:Badger_Mugshot.png]], you'd input Badger_Mugshot.png. If not given, the page will be added to [[:Category:Ferret lacking infobox images]].
| shayename || String || || The ferret's nicknames by Shaye
|-
|-
| gender || String || || The ferret's gender
| gender || String || || The ferret's gender
Line 47: Line 53:
| 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.
|}
|}
=== 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]].
Image size should be approx. 190x230 px
==== <u>Notes</u> ====
<references group ="note" />


==Example==
==Example==
<div class="infobox-ferret-doc-example">
<div class="infobox-ferret-doc-example-textbox">
=== Ferret without Mugshot ===
<pre style="overflow:auto;">
{{Infobox Ferret
{{Infobox Ferret
| noCategories = 1
| noCategories = 1 [*]
| name = Yoghurt
| name = Yoghurt   [*]
| image = Yoghurt_Mugshot.png
| gender = Male
| gender = Male
| arrivaldate = 2024/02/26
| arrivaldate = 2024/02/26
Line 62: Line 80:
| arrivallink =
| arrivallink =
}}
}}
</pre>
====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]].
</div>


<pre style="overflow:auto;">
<div class="infobox-ferret-doc-example-infobox">
{{Infobox Ferret
{{Infobox Ferret
| noCategories = 1
| noCategories = 1
| name = Yoghurt
| name = Yoghurt
| image = Yoghurt_Mugshot.png
| gender = Male
| gender = Male
| arrivaldate = 2024/02/26
| arrivaldate = 2024/02/26
Line 77: Line 99:
| arrivallink =
| arrivallink =
}}
}}
</pre>
</div>
</div>


<div class="infobox-ferret-doc-example">
<div class="infobox-ferret-doc-example-textbox">
=== Ferret with Mugshot ===
<pre style="overflow:auto;">
{{Infobox Ferret
{{Infobox Ferret
| noCategories = 1
| noCategories = 1 [*]
| name = Badger
| name = Badger     [*]
| image = Badger_Mugshot.png
| gender = Male
| gender = Male
| arrivaldate = 2024/02/26
| arrivaldate = 2024/02/26
Line 92: Line 118:
| arrivallink =
| arrivallink =
}}
}}
</pre>
====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]].
</div>


<pre style="overflow:auto;">
<div class="infobox-ferret-doc-example-infobox">
{{Infobox Ferret
{{Infobox Ferret
| noCategories = 1
| noCategories = 1
| name = Badger
| name = Badger
| image = Badger_Mugshot.png
| gender = Male
| gender = Male
| arrivaldate = 2024/02/26
| arrivaldate = 2024/02/26
Line 107: Line 137:
| arrivallink =
| arrivallink =
}}
}}
</pre>
</div>
</div>
 
 
 


{{clear}}
{{clear}}
{{Doc/end}}
{{Doc/end}}

Revision as of 23:37, 20 March 2025

Documentation
[purge]

An infobox for use on Ferret pages. It stores data to Special:CargoTables/Ferret.

Known Issue - Spaces in ferret names
Currently name parameter must be set manually for ferrets with spaces in their name. Spaces must be replaced by underscores.
Example: For Mai Tai you have to add | name = Mai_Tai to her Infobox


Usage

{{Infobox Ferret
| nickname =
| shayename =
| gender =
| arrivaldate =
| birthday =
| valhalla =
| playgroup =
| age =
| isinquarantine=
| valhallalink =
| arrivallink =
}}

Parameters

Parameter Data Type Default Value Description
name String {{PAGENAME}} The ferret's name. [note 1]
nickname String The ferret's nicknames by Chat
shayename String The ferret's nicknames by Shaye
gender String The ferret's gender
arrivaldate String The date the ferret arrived at the shelter
birthday String The confirmed known date of birth of the ferret
valhalla String The date the ferret passed away
playgroup String The ferret's playgroup
Age Integer The ferret's age
isinquarantine Boolean The ferret is in quarantine
valhallalink String The ferret's link of its passed away on.
arrivallink String The ferret's link of when it arrival to snail house
noCategories Boolean Optional. If given any value, the page will not be auto-categorized.

Mugshot Image

Filename Ferretname_Mugshot.png 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.

Image size should be approx. 190x230 px

Notes

  1. ↑ name parameter is used for internal linking on the wiki. Make sure the title of the ferret's page matches it's name. Don't try to define name by any other than using the default value, any difference between name and page title (External Link: MediaWiki Manual - Page Title) will cause broken broken internal links for the ferret's page!


Example

Ferret without Mugshot

{{Infobox Ferret
| noCategories = 1  [*]
| name = Yoghurt    [*]
| gender = Male
| arrivaldate = 2024/02/26
| valhalla =
| playgroup = BePeepo
| isinquarantine = False
| age = 3
| valhallalink =
| arrivallink =
}}

Notes

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

Yoghurt



Missing: File:Yoghurt Mugshot.png

General details
Name Yoghurt
Gender Male
Arrival date 2024/02/26
Playgroup BePeepo
Age 3

Ferret with Mugshot

{{Infobox Ferret
| noCategories = 1  [*]
| name = Badger     [*]
| gender = Male
| arrivaldate = 2024/02/26
| valhalla =
| playgroup = BePeepo
| isinquarantine = False
| age = 3
| valhallalink =
| arrivallink =
}}

Notes

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

Badger

General details
Name Badger
Gender Male
Arrival date 2024/02/26
Playgroup BePeepo
Age 3



This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.

Retrieved from "https://ferrets.piratesoftware.wiki/w/index.php?title=Template:Infobox_Ferret/doc&oldid=1309"