Please remember that WiKirby contains spoilers, which you read at your own risk! See our general disclaimer for details.

Help:Formatting file pages: Difference between revisions

From WiKirby, your independent source of Kirby knowledge.
Jump to navigationJump to search
m (→‎Description: Renamed)
mNo edit summary
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
After learning [[Help:File uploading|the basics of file uploading]], an editor should next wish to learn more about what to place in the summary box of any uploaded files. This is a basic guide on '''formatting file pages'''.
After learning [[Help:File uploading|the basics of file uploading]], an editor should next wish to learn more about what to place in the summary box of any uploaded files (referred to from here on out as the '''[[Template:Aboutfile|Aboutfile]]''' template). This is a basic guide on '''formatting file pages''', and using the aboutfile template in particular.


There are only three major pieces regarding what to place in a summary box. They are as follows:
==How to use aboutfile==
*'''Description''' - a basic description of what the file is and, where appropriate, where it was retrieved.
===I've never used this template before===
*'''Categories''' - which categories to use in the summary.
Aboutfile is the primary image template WiKirby uses to provide information on its File pages. This template does a lot in order to help organize files on your behalf, instead of you having to manually write a lot of things on your own. An example of the empty aboutfile template (which appears automatically in the summary box when uploading a new file) is as follows:
*'''License''' - any appropriate license which should be placed on the file.
<pre>{{aboutfile
|description=
|game=
|media=
|modified=
|type=
|type2=
|source=
|license=
}}</pre>
Now, when actually filling out these parameters, you will almost certainly not need all of them, and many should be deleted when going through the template upon uploading. Lets look at each parameter and what they mean, and how each should be filled out.


==Description==
*'''|description=''': This parameter is for writing a summary of what the file contains. A file description should be short and concise, requiring no more than one sentence to explain. For example, a piece of artwork of Kirby from ''Kirby Super Star Ultra'' could simply be described as "Artwork of [[Kirby]] from ''[[Kirby Super Star Ultra]]''."
A file description should be short and concise, requiring no more than one sentence to explain. For an example, take this image:
{{clear}}
[[File:KBR Wallpaper.jpg|thumb|left|600px]]
{{clear}}
The description for this file reads as follows:


''"Large promotional poster for ''[[Kirby Battle Royale]]'' used on the box art of the game depicting Kirbys battling in the [[Battle Arena]]."''
*'''|game=''' and '''|media=''': These two parameters are an either/or situation. Primarily, |game should be used for any single-game images. Only the direct American name of the game should be entered into this parameter (IE |game=Kirby Super Star) with no additional formatting. Entering a game into the |game= parameter will do two main things: An italicized link will be generated pointing to the game, and the file will be added to the appropriate game category. A file with "|game=Kirby & The Amazing Mirror" will display "''[[Kirby & The Amazing Mirror]]''" and it will be added to the [[:Category:Kirby & The Amazing Mirror images|Kirby & The Amazing Mirror images]] category. If a game is not the subject, multiple games are the subject, or automatic links won't work/aren't wanted, use the |media= parameter instead. Regardless of what parameter is selected, the other should be removed.


The description explains what type of image it is, which game it belongs to, and what is contained in the image. Excessive detail is not necessary (and discouraged) in most cases.
*'''|modified=''': This parameter is optional, and if not used should be deleted. This is primarily for files with significant edits or changes to them. Was a background removed? Is the image upscaled? Were arrows and numbers made for an informational diagram? If so, say so in this parameter. Filling this parameter will automatically place the file in the [[:Category:Doctored images|doctored images]] category.


===File sourcing===
*'''|type=''' and '''|type2=''': This parameter covers a lot of things at once. Primarily, this parameter is to indicate what type of file it is! The list of types is the following:
If it is not obvious where a file came from (i.e. if a file is not readily associable with a game or did not come from one), it is often necessary to source the file. This is done differently depending on where the file is sourced from. For example, an illustration from a manual or artbook ought to be cited by referencing the full title of the book and the page the illustration appears on.  
**audio (For audio files)
**photo (For real-world images)
**sprite (For sprites)
**screenshot (For user-generated screenshots for video games or web pages)
**officialscreenshot (For officially released screenshots, usually promotional material)
**officialmiiverse (For any Miiverse posts by official Kirby sources)
**officialaudio (For any audio published by HAL or Nintendo)
**map (For maps)
**flag (For real-world country flags)
**model (For 3D Models)
**artwork (For any artwork)
**boxart (For any physical box art, or cover art that serves as a substitute–particularly for online-only games)
**albumart (For any physical cover art for released CD soundtracks or other music release)
**logo (For game or series logos)
**user (For user images)
**tv (For screenshots of television or video media, particularly of the Anime series)
**scan (For scans of physical media or digital copies of printed work)
**wiki (For images relating to Wikirby as a platform)
**food (For real-world images involving Kirby Café)
**commemorative (for Kirby JP Twitter commemorative illustrations)
**ppp (For Channel PPP Twitter posts)
**directory (For Dedede Directory Twitter posts)
**gamereports (For all other Twitter posts)
**rating (For real-world game ratings, such as ESRB or CERO)
**video (For video clips created by the uploader)
:Filling out this section will do several things in addition to specifying the file type. First, it will add the file into its respective category. A |type=screenshot will add the file to the [[:Category:Screenshots]]. Additionally, filling out this parameter automatically gives the file a license, which is extremely important for [[WiKirby:Copyrights|fair use purposes]]. If two types are necessary, |type2= can be used. If not, |type2= can be deleted.


For another example, a file that is taken directly from another website should have a URL linking back to that source site. This is generally not necessary for images from other wikis, but is still encouraged.
*'''|source=''': This is a very important parameter. If you have a file that wasn't directly taken by yourself, it needs to be written or linked here. If you captured the file yourself, use |source=self. For images captured by other people, use |source=user and fill the next parameter below. You can read more about sourcing files on the [[WiKirby:Sourcing standards|Sourcing standards page]].


==Categories==
*'''|user=''': This parameter is unlikely to be used. It should only be filled with the name of the user for people that use |source=user or |type=user. For example, if [[User:Samwell|Samwell]] was the source of an image, you would enter |source=user and user=Samwell.
At the bottom of the summary page, the editor can add categories for the uploaded file to appear in. All files must belong to at least one category, preferably more if the file is from a ''Kirby'' game or other source. The following are some of the more common categories to use:
 
*'''[[:Category:Artwork|Artwork]]''' - a catch-all category for artwork.
*'''|license=''': This parameter is unlikely to be used. It is automatically filled in if the |type= parameter is filled out, and can usually be deleted. The only reason this parameter should be filled out is if a file should be licensed in any way other than fair use, such as public domain, creative commons, or something else.
*'''[[:Category:Screenshots|Screenshots]]''' - a catch-all category for screenshots.
 
*'''[[:Category:Sprites|Sprites]]''' - a catch-all category for ripped sprites.
Keep in mind that this is page is not an exhaustive list of every parameter or item that can be used for this template. For more information, see the {{t|Aboutfile}} template documentation and/or contact an Administrator on proper usage.
*'''[[:Category:Audio|Audio]]''' - a catch-all category for audio files.
 
*'''[[:Category:Kirby's Dream Land images|Kirby's Dream Land images]]''' - a category for any image pertaining to ''[[Kirby's Dream Land]]''.
===I used Aboutfile 1.0 before===
*'''[[:Category:Anime|Anime]]''' - a category for any image pertaining to the anime series ''[[Kirby: Right Back at Ya!]]''.
The Aboutfile 2.0 update brings a lot of new changes to the table, making the template a multi-use tool, where most components are controlled through the Aboutfile template instead of the former system of Aboutfile and Licensing templates and manually written categories.
 
The formatting to writing the template is the same, there are just new parameters from before.
 
*'''|description=''' Still functions the exact same as before. Describe the file here.
 
*'''|game=''' and '''|media=''' function relatively the same, but have a critical change from before. Aboutfile 2.0 automatically will link and italicize a file written in the '''|game=''' parameter, as well as automatically categorize the file to the game written. '''|media''' will do none of these things and media/categories will need to be manually written.
 
*'''|modified=''' Still the same as before, except that filling this parameter will now place the image automatically in the Doctored images category. Are there significant edits to the photo done? Add it here.
 
*'''|type=''' and '''|type2=''' This is the largest new addition to Aboutfile 2.0. This parameter replaces the former licensing templates like <nowiki>{{game screenshot}}</nowiki> or <nowiki>{{artwork}}</nowiki> by integrating it directly into the template. Most of the names of the types are identical to the old licensing templates. |type=artwork is the same as <nowiki>{{artwork}}</nowiki>. Type will also automatically categorize the file based off of its type, so |type=artwork will add to [[:Category:Artwork]]. In cases where a file might apply to two different types, type2= enables a second type+category to be added. There is no priority or hierarchy to the order types are entered (IE type= is not more important than |type2=). '''This section should ALWAYS be filled out'''. If there is no type given, the file will be added to a maintenance category to be fixed as soon as possible.


For more information about categories, see the [[WiKirby:Category policy|Category policy]] page.
*'''|source=''' works the same way as before, with some new additions. For self-ripped or generated uploads, use |source=self. For files sourced from Kirby Wiki FANDOM, use |source=fandom (which will add to maintenance category). '''If there is no known source, leave this section blank!''' It will automatically be added to the unsourced files category, in lieu of using the old <nowiki>{{File Source}}</nowiki> template. Lastly, if a user uploads a new revision of a file but isn't the source (IE optimizations or new re-takes of a file), utilize |source=user and read the following parameter.


==Licensing==
*'''|user=''' This is a somewhat rare and optional parameter that should only be used for |source=user sources, ''or'' for type=user files. This is how to indicate User images with a file search, in replacement of the former <nowiki>{{Personal Media}}</nowiki> template.
When uploading a file, it is often necessary to apply an appropriate license to it. There are several different copyright licensing templates, three non-copyright license templates, and one other to choose from. They are as follows:


===Copyright licenses===
*'''|license''' ''is an optional parameter''. In most circumstances, this will automatically be filled out as copyrighted fair use if anything is entered for the type= parameter. If a file needs a different type of license, such as Public Domain or Creative Commons, only then should this parameter be filled out.
*'''Copyrighted artwork''' - a template for use on artwork taken from official video game promotional material.
**'''Commemorative Kirby JP Twitter Artwork''' - variant of the artwork template that should be used when uploading commemorative art from the [[Kirby JP Twitter]].
**'''Miscellaneous Kirby JP Twitter Artwork''' - variant of the artwork template that should be used when uploading miscellaneous art from the Kirby JP Twitter.
**'''Dedede Directory Post''' - variant of the artwork template that should be used when uploading an image from the [[List of Dedede Directory posts|Dedede Directory]].
*'''Copyrighted audio''' - a template for use on audio files taken from official video game material, in-game or otherwise.
*'''Game cover art''' - a template for use on uploaded game cover/box artwork.
*'''Ripped in-game model''' - a template for use on images of isolated video game [[model]]s.
*'''In-game screenshot''' - a template for use on screenshots from video games and other media.
**'''Official game screenshot''' - variant of the game screenshot template to be used if the screenshot was one used on an official Nintendo or HAL-endorsed page.
**'''Game screenshots from Kirby JP Twitter''' - variant of the game screenshot template to be used if the screenshot came directly from the Kirby JP Twitter.
*'''Ripped in-game sprite''' - a template for use on isolated object [[sprite]]s from video games.
*'''Television screenshot''' - a template for use on images taken from television programs, such as ''[[Kirby: Right Back at Ya!]]''.
*'''Scanned page''' - a template for use on images based on scans of printed material, such as books, manuals, documents, and the like.
*'''Photographs''' - a template for use on copyrighted photographs of real world subjects.
*'''Other copyrighted images''' - a general purpose copyright template that can be used for any image. This is preferably used for images whose type cannot be clearly discerned.


===Non-Copyright licenses===
==Categories==
*'''Entirely your own work''' - a template for material the editor created personally.
At the bottom of the summary page, the editor can add additional categories for the uploaded file to appear in. If the Aboutfile box was properly filled in, the image will already be added to appropriate categories for the source game, type of file, or other utility categories as mentioned above. Often, however, other categories should be added at the bottom of the edit window outside of the Aboutfile template itself. Here are a few examples of extraneous categories that are fairly commonly used:
*'''Another individual's work''' - a template for material the editor retrieved from an individual (non-corporate or government) entity. (permission must be obtained to upload such material)
*'''[[:Category:Animated images]]''' - a category for images that are animated, such as a .gif or an APNG.
*'''Public domain''' - a template for material that is officially in the public domain.
*'''[[:Category:Composite images]]''' - a category for images that are a product of multiple images combined together. These are distinct from doctored images.
*'''[[:Category:Kirby images]]''' - a category where images of [[Kirby]] without a [[Copy Ability]] belong. Other prominent characters have their own galleries on WiKirby that should be considered.
*'''[[:Category:Beam Kirby images]]''' - a category for images that predominantly feature Kirby with the [[Beam]] Copy Ability. Nearly every Copy Ability has a gallery page devoted to it.
*'''[[:Category:Game covers]]''' - a category for the box art and other cover artwork of games.
*'''[[:Category:Enemy Info Card images]]''' - a category for the [[Enemy Info Card]]s in ''[[Kirby 64: The Crystal Shards]]''. Other large collections of like images will often have their own categories.
*'''[[:Category:Anime episode 001 images]]''' - a category for all images relating to the first episode of ''[[Kirby: Right Back at Ya!]]''. All episodes have categories like this.
*'''[[:Category:Kirby Portal images]]''' - a category for images that come from Kirby's official Japanese home website: [[Kirby Portal]].
*'''[[:Category:Beta content]]''' - a category for files that were created for a game and left in the game data, but never used in the final product.
*'''[[:Category:Non-Kirby images]]''' - a category for files from things explicitly outside the ''Kirby'' series.


===Other===
For more information about categories, see the [[WiKirby:Category policy|Category policy]] page.
*'''Taken off a Wikimedia site''' - a template for material retrieved from Wikipedia and other related official Wikimedia sites.


{{clear}}
{{clear}}

Latest revision as of 23:34, 25 December 2023

After learning the basics of file uploading, an editor should next wish to learn more about what to place in the summary box of any uploaded files (referred to from here on out as the Aboutfile template). This is a basic guide on formatting file pages, and using the aboutfile template in particular.

How to use aboutfile

I've never used this template before

Aboutfile is the primary image template WiKirby uses to provide information on its File pages. This template does a lot in order to help organize files on your behalf, instead of you having to manually write a lot of things on your own. An example of the empty aboutfile template (which appears automatically in the summary box when uploading a new file) is as follows: 

{{aboutfile
|description=
|game=
|media=
|modified=
|type=
|type2=
|source=
|license=
}}

Now, when actually filling out these parameters, you will almost certainly not need all of them, and many should be deleted when going through the template upon uploading. Lets look at each parameter and what they mean, and how each should be filled out.

  • |description=: This parameter is for writing a summary of what the file contains. A file description should be short and concise, requiring no more than one sentence to explain. For example, a piece of artwork of Kirby from Kirby Super Star Ultra could simply be described as "Artwork of Kirby from Kirby Super Star Ultra."
  • |game= and |media=: These two parameters are an either/or situation. Primarily, |game should be used for any single-game images. Only the direct American name of the game should be entered into this parameter (IE |game=Kirby Super Star) with no additional formatting. Entering a game into the |game= parameter will do two main things: An italicized link will be generated pointing to the game, and the file will be added to the appropriate game category. A file with "|game=Kirby & The Amazing Mirror" will display "Kirby & The Amazing Mirror" and it will be added to the Kirby & The Amazing Mirror images category. If a game is not the subject, multiple games are the subject, or automatic links won't work/aren't wanted, use the |media= parameter instead. Regardless of what parameter is selected, the other should be removed.
  • |modified=: This parameter is optional, and if not used should be deleted. This is primarily for files with significant edits or changes to them. Was a background removed? Is the image upscaled? Were arrows and numbers made for an informational diagram? If so, say so in this parameter. Filling this parameter will automatically place the file in the doctored images category.
  • |type= and |type2=: This parameter covers a lot of things at once. Primarily, this parameter is to indicate what type of file it is! The list of types is the following:
    • audio (For audio files)
    • photo (For real-world images)
    • sprite (For sprites)
    • screenshot (For user-generated screenshots for video games or web pages)
    • officialscreenshot (For officially released screenshots, usually promotional material)
    • officialmiiverse (For any Miiverse posts by official Kirby sources)
    • officialaudio (For any audio published by HAL or Nintendo)
    • map (For maps)
    • flag (For real-world country flags)
    • model (For 3D Models)
    • artwork (For any artwork)
    • boxart (For any physical box art, or cover art that serves as a substitute–particularly for online-only games)
    • albumart (For any physical cover art for released CD soundtracks or other music release)
    • logo (For game or series logos)
    • user (For user images)
    • tv (For screenshots of television or video media, particularly of the Anime series)
    • scan (For scans of physical media or digital copies of printed work)
    • wiki (For images relating to Wikirby as a platform)
    • food (For real-world images involving Kirby Café)
    • commemorative (for Kirby JP Twitter commemorative illustrations)
    • ppp (For Channel PPP Twitter posts)
    • directory (For Dedede Directory Twitter posts)
    • gamereports (For all other Twitter posts)
    • rating (For real-world game ratings, such as ESRB or CERO)
    • video (For video clips created by the uploader)
Filling out this section will do several things in addition to specifying the file type. First, it will add the file into its respective category. A |type=screenshot will add the file to the Category:Screenshots. Additionally, filling out this parameter automatically gives the file a license, which is extremely important for fair use purposes. If two types are necessary, |type2= can be used. If not, |type2= can be deleted.
  • |source=: This is a very important parameter. If you have a file that wasn't directly taken by yourself, it needs to be written or linked here. If you captured the file yourself, use |source=self. For images captured by other people, use |source=user and fill the next parameter below. You can read more about sourcing files on the Sourcing standards page.
  • |user=: This parameter is unlikely to be used. It should only be filled with the name of the user for people that use |source=user or |type=user. For example, if Samwell was the source of an image, you would enter |source=user and user=Samwell.
  • |license=: This parameter is unlikely to be used. It is automatically filled in if the |type= parameter is filled out, and can usually be deleted. The only reason this parameter should be filled out is if a file should be licensed in any way other than fair use, such as public domain, creative commons, or something else.

Keep in mind that this is page is not an exhaustive list of every parameter or item that can be used for this template. For more information, see the {{Aboutfile}} template documentation and/or contact an Administrator on proper usage.

I used Aboutfile 1.0 before

The Aboutfile 2.0 update brings a lot of new changes to the table, making the template a multi-use tool, where most components are controlled through the Aboutfile template instead of the former system of Aboutfile and Licensing templates and manually written categories.

The formatting to writing the template is the same, there are just new parameters from before.

  • |description= Still functions the exact same as before. Describe the file here.
  • |game= and |media= function relatively the same, but have a critical change from before. Aboutfile 2.0 automatically will link and italicize a file written in the |game= parameter, as well as automatically categorize the file to the game written. |media will do none of these things and media/categories will need to be manually written.
  • |modified= Still the same as before, except that filling this parameter will now place the image automatically in the Doctored images category. Are there significant edits to the photo done? Add it here.
  • |type= and |type2= This is the largest new addition to Aboutfile 2.0. This parameter replaces the former licensing templates like {{game screenshot}} or {{artwork}} by integrating it directly into the template. Most of the names of the types are identical to the old licensing templates. |type=artwork is the same as {{artwork}}. Type will also automatically categorize the file based off of its type, so |type=artwork will add to Category:Artwork. In cases where a file might apply to two different types, type2= enables a second type+category to be added. There is no priority or hierarchy to the order types are entered (IE type= is not more important than |type2=). This section should ALWAYS be filled out. If there is no type given, the file will be added to a maintenance category to be fixed as soon as possible.
  • |source= works the same way as before, with some new additions. For self-ripped or generated uploads, use |source=self. For files sourced from Kirby Wiki FANDOM, use |source=fandom (which will add to maintenance category). If there is no known source, leave this section blank! It will automatically be added to the unsourced files category, in lieu of using the old {{File Source}} template. Lastly, if a user uploads a new revision of a file but isn't the source (IE optimizations or new re-takes of a file), utilize |source=user and read the following parameter.
  • |user= This is a somewhat rare and optional parameter that should only be used for |source=user sources, or for type=user files. This is how to indicate User images with a file search, in replacement of the former {{Personal Media}} template.
  • |license is an optional parameter. In most circumstances, this will automatically be filled out as copyrighted fair use if anything is entered for the type= parameter. If a file needs a different type of license, such as Public Domain or Creative Commons, only then should this parameter be filled out.

Categories

At the bottom of the summary page, the editor can add additional categories for the uploaded file to appear in. If the Aboutfile box was properly filled in, the image will already be added to appropriate categories for the source game, type of file, or other utility categories as mentioned above. Often, however, other categories should be added at the bottom of the edit window outside of the Aboutfile template itself. Here are a few examples of extraneous categories that are fairly commonly used:

For more information about categories, see the Category policy page.

Basic help
Getting started • Categories • Colors • Disambiguation • File uploading • Formatting • Formatting file pages • Moving pages • Protected Page • Redirects • References • Tables • Talk pages • Templates • User Navigation Bar • Userboxes
Advanced help
Advanced tables • Creating navmaps • Creating templates • Custom Signatures • HTML • Page history • Special pages • Tabs • Template documentation • Using infoboxes
Policies
Abbreviations • Article creation • Article manipulation • Audio standards • Blocking of users • Categories • Citing • Community polls • Conjecture • Cookies • Copyrights • Deletion of content • Disputes • Featured content • File use • Formatting specifics • General content • General disclaimer • Glitch disclaimer notes • Glitches • Image standards • Infoboxes and Navboxes • Interwiki • Language • Layout • Localization • Long pages • Naming • Non-Kirby content • Personal content • Privacy • Sourcing standards • Stubs • Talk pages • Trivia sections • User accounts • Videos • Writing style • Writing specifics
Useful links
About WiKirby • Affiliates • April Fools • Archive • Current events • Dedication • Discord • Featured Article Nomination • Featured Picture Nomination • Good recommendations • IPA • Maintenance (Project Clean-Up) • Proposals • Ranks (Bots • Check user • Editor-in-Chief • System Admin) • Sandbox • Social media • Special pages
KSA Parasol Waddle Dee Pause Screen Artwork.png
Retrieved from "https://wikirby.com/w/index.php?title=Help:Formatting_file_pages&oldid=454786"