Editing Template:MissingFilesHelp/doc

= Missing Files Template =

'''Purpose:'''  
This template displays a notice for missing files on a wiki page, it is typically used on pages where images or other media are missing, prompting editors to contribute by uploading the required files.

The notice features a bordered, colored box with a table layout containing an icon on the left and the message text on the right.

Optionally, it has parameters to edit the contents and icons of the notiece to best fit the wiki page it is being used in.

== Example ==
=== Genders ===
<syntaxhighlight lang="html">
{{MissingFilesHelp
 |gender=male
}}
</syntaxhighlight>

Will render a notice with:
{{MissingFilesHelp
|g=male
}}


<syntaxhighlight lang="html">
{{MissingFilesHelp
 |g=female
}}
</syntaxhighlight>

Will render a notice with:
{{MissingFilesHelp
|g=female
}}

=== Using custom icons, title and text ===

<syntaxhighlight lang="html">
{{MissingFilesHelp
 |title=Character Images Missing
 |t=We are missing some images for this character. Please help by uploading them!
 |i=crab.png
}}
</syntaxhighlight>

This will render a notice with:
{{MissingFilesHelp
 |title=Character Images Missing
 |t=We are missing some images for this character. Please help by uploading them!
 |i=crab.png
}}
* The custom icon (if provided) or the default icon based on gender.
* A bold title ("Character Images Missing").
* A description message ("We are missing some images...").

== Parameters ==

{| class="wikitable"
! Parameter !! Type !! Description !! Default !! Aliases
|-
| gender || string || Determines which default image is shown: "female" for Crush Crush wiki pages (Q-Piddy icon), "male" for Blush Blush wiki pages (Chibi Nimh icon), or "bean" for the detective job icon (used for event- or system-related pages). || bean || g
|-
| text || string || Overrides the default notice text. If unset, the default text "Some files for this section are missing. You can help improve the wiki by uploading the missing files!" will be shown. || Default text as above || t
|-
| icon || wiki-file-name || Overrides the icon shown next to the notice. This takes precedence over the gender parameter. || Depends on gender || i
|-
| title || string || Overrides the title displayed in the notice. Defaults to "Missing Files!" || Missing Files! || —
|}

== Usage Notes ==

* If both '''icon''' and '''gender''' are set, the '''icon''' parameter takes priority.   
* Titles should remain relevant to the context of missing files.  

=== Icon Suggestion ===
You can use whatever icon you prefer, but some suggestions are:
{| class="article-table"
|+
! Crush Crush !! Blush Blush !! Beans !! Misc
|-
| [[File:Icon qpiddy.png|x80px|thumb]]|| [[File:ChibiEli.png|x80px|thumb]] || [[File:JOB writer01.png|x80px|thumb]] || [[File:QbaeExcited.png|x80px|thumb]]
|-
| || || || 
|-
| || || ||
|}

== See also ==

* [[wp:Help:Templates]] – general documentation for creating and using templates in MediaWiki.  
* [[wp:Help:Files#Uploading files]] – information on uploading missing files to the wiki.

<noinclude>[[Category:Template documentation]]</noinclude>