Template:Aboutfile/doc: Difference between revisions

From the Super Mario Wiki, the Mario encyclopedia
Jump to navigationJump to search
(Created page with "== About == This template is used to document basic information about files uploaded to the wiki. While its use could be considered optional for things like project or personal images, an effort should be made to use it for all files included in articles and galleries. The preloaded syntax automatically appears when uploading a new file. The template should either be formatted correctly or rem...")
 
mNo edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
== About ==
This template is used to document basic information about files uploaded to the wiki. While its usage is optional for [[:Category:Personal files|personal]] and  [[:Category:Project files|project]] files, an effort should be made to use it for all files included in articles and galleries. The preloaded syntax automatically appears when [[Special:Upload|uploading]] a new file.
This template is used to document basic information about files uploaded to the wiki. While its use could be considered optional for things like [[:Category:Project images|project]] or [[:Category:Personal images|personal]] images, an effort should be made to use it for all files included in articles and galleries. The preloaded syntax automatically appears when [[Special:Upload|uploading]] a new file.


The template should either be formatted correctly or removed before uploading. Otherwise, it will look like {{plain link|[{{fullurl:File:MALSS_SMB_Qblock.gif|oldid=1257973}}#Summary this]}}. If a user repeatedly uploads files without correctly formatting the template, a {{tem|reminder}} or {{tem|aboutfile-reminder}} should be issued.
The template should either be formatted correctly or removed before uploading. Otherwise, it will look like {{plain link|[{{fullurl:File:MALSS_SMB_Qblock.gif|oldid=1257973}}#Summary this]}}. If a user repeatedly uploads files without correctly formatting the template, a {{tem|reminder}} or {{tem|aboutfile-reminder}} should be issued.
Line 26: Line 25:


The first two parameters are the most commonly used ones. A description should always be included, even if it's just a couple words. Files that need a description added can be found in [[:Category:Files with missing Aboutfile description|this maintenance category]].
The first two parameters are the most commonly used ones. A description should always be included, even if it's just a couple words. Files that need a description added can be found in [[:Category:Files with missing Aboutfile description|this maintenance category]].
<includeonly>[[Category:File notices]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 12:40, December 29, 2024

This template is used to document basic information about files uploaded to the wiki. While its usage is optional for personal and project files, an effort should be made to use it for all files included in articles and galleries. The preloaded syntax automatically appears when uploading a new file.

The template should either be formatted correctly or removed before uploading. Otherwise, it will look like this. If a user repeatedly uploads files without correctly formatting the template, a {{reminder}} or {{aboutfile-reminder}} should be issued.

Credit to Wookieepedia for the design inspiration.

Parameters

This template has five parameters:

  • 1 is the description of the subject. It can be a descriptive sentence or two about what's in the image, or even a mere link to the subject that's pictured.
  • 2 is the source, such as an external link to where you originally found the image. If you generated the image yourself, i.e. with a capture card or scanner, you can put the game (or manual, film, etc.) itself as the source. Otherwise, the name of the game should be in the description, rather than the source.
  • 3 is the artist, if you know who made it (maybe yourself).
  • 4 is edited. If the image has been altered from the original, describe the modifications.
  • 5 is other version(s). If there is another image on the same subject, try to link to it using [[:File:Filename.ext]].

To use some but not all of the parameters, the syntax should look something like this:

{{aboutfile
|1=[[Beezo|Shy Away]]
|2=[[Super Mario RPG: Legend of the Seven Stars]]
|5=Similar artwork: [[:File:SMRPG NS Shy Away.png|Updated variant]]
}}

The first two parameters are the most commonly used ones. A description should always be included, even if it's just a couple words. Files that need a description added can be found in this maintenance category.