Ferret Software Wiki

Template:Infobox Ferret/doc: Difference between revisions

← Older edit
VisualWikitext
m 1 revision imported: PS to FS migration
Gorasuhl (talk | contribs)
trusted
1,040 edits
update linked category
 
(2 intermediate revisions by 2 users not shown)
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>
|-
|-
| 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]].
| nickname || String || || The ferret's nicknames by Chat
|-
| 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:Ferrets lacking infobox image]].
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
| noCategories = 1  [*]
| name = Yoghurt    [*]
| gender = Male
| arrivaldate = 2024/02/26
| valhalla =
| playgroup = BePeepo
| isinquarantine = False
| age = 3
| valhallalink =
| 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>
<div class="infobox-ferret-doc-example-infobox">
{{Infobox Ferret
{{Infobox Ferret
| noCategories = 1
| noCategories = 1
| name = Badger
| name = Yoghurt
| image = Badger_Mugshot.png
| gender = Male
| gender = Male
| arrivaldate = 2024/02/26
| arrivaldate = 2024/02/26
Line 62: Line 99:
| arrivallink =
| arrivallink =
}}
}}
</div>
</div>


<div class="infobox-ferret-doc-example">
<div class="infobox-ferret-doc-example-textbox">
=== Ferret with Mugshot ===
<pre style="overflow:auto;">
<pre style="overflow:auto;">
{{Infobox Ferret
| noCategories = 1  [*]
| name = Badger    [*]
| gender = Male
| arrivaldate = 2024/02/26
| valhalla =
| playgroup = BePeepo
| isinquarantine = False
| age = 3
| valhallalink =
| 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>
<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 77: Line 137:
| arrivallink =
| arrivallink =
}}
}}
</pre>
</div>
</div>
 
 
 


{{clear}}
{{clear}}
{{Doc/end}}
{{Doc/end}}
Retrieved from "https://ferrets.piratesoftware.wiki/wiki/Template:Infobox_Ferret/doc"