User:Willscrlt/Information/doc

This template combines the basic function of the standard Information template with the functionality of several other common templates (see related information below for a complete list). Most notably it combines several licensing tags together into a single, space-saving template (compared to adding each license tag seperately). Since each license option is required to be separately specified by the template, it allows for easy auditing of any license changes simply by reviewing the file history.

This template was created and is maintained by Willscrlt. Due to its extremely complex template syntax and multiple layers of parser functions, this template is edited off-line and updates completely overwrite the existing template. For that reason, it is important that you discuss all changes on Will's talk page (not this template's talk page, because Will probably won't see it) instead of making changes in the template itself (which will be overwritten in the next update). You are welcome to fork this template and modify your copy. You can also experiment by copying it to the template sandbox, making changes, and then discussing the changes with Will.

Usage
Capitalization is very important. Option names can be entered exactly as shown or in all lower-case. Option values are generally entered in all lower-case. You may copy and paste, but you will need to edit the results. The order in which options appear does not matter, though it is helpful for other editors to keep all the basic information together, licensing information together, and everything else near the end of the template.

Options
The template options are grouped into basic information (required), licensing information (required), and other information (optional).

Other options
| Source_Details = - used only with " "; see below for details'' | Retouched = y | n - use with " " to indicate a modified image | Permission = specify any additional permissions | Person = y | n - recognizable person; adds Personality rights | User = y | n - a userpage image; adds Userpageimage | Honored = wikilink to a where the honor is listed; multiple links may be added | Used = y | n - add attributes shown below to specify where the file is used | Animated_SVG = y | n - for animated SVG files | Inkscape_Hand = y | n - for Inkscape SVG files subsequently modified by hand | AI = y | n - for Adobe Illustrator images | Gimp = y | n - for Gimp images | Panorama = y | n - for multiple images stitched into a Panorama | Published = y | n - for images later used by a media organization; add attributes shown below | Other_fields = - part of Information so it's included here for completeness

Acceptable values

 * Most options accept either yes (" ") or no (" ") as an acceptable value. Generally, blank or omitted options are ignored or treated as "no" values.
 * Options that expect a wikilink as a value should be left blank if not applicable (or omitted entirely) or include a properly formatted internal wiki link.
 * Options that expect a hyperlink as a value should be left blank if not applicable (or omitted entirely) or include a full URL to the resource, which includes the initial "http://" but does not include any wikitext.
 * Some options only accept certain values and are shown below.

Acceptable values for " "
" " is a required standard option that accepts any one of the following values:
 * - The generic default; please use something more specific if possible.
 * - A photograph
 * - Any type of image other than a photograph
 * - A video file
 * - An audio file

Acceptable values for " " (Relationship)
" " is a required standard option that accepts any one of the following values:
 * - A self-made work (default)
 * - A modified version of some other work; use with " "
 * - The file is not related to the uploader

Acceptable values for " "
" " is a required standard option that accepts any one of the following values:
 * - Outputs "Self-made work" (default)
 * - Requires additional parameters shown below
 * - A hyperlink to the original source (not a wikilink, but a plain, full URL)
 * - If the source is not available online, enter add " " to provide detailed information concerning the source, such as a citation template or a narrative description of the source

Attributes
The following options are attributes that provide additional detail when certain other options are enabled. If the related option is enabled, the additional attributes must be provided or an error may appear or the template's logic might break.

Attributes that are required if " "
Flickr images are a little tricky to properly attribute. You can use the Flinfo tool to help gather some of this information.


 * Example image URLs
 * 1) http:// www.flickr.com/photos/ 23918957@N00 / 151898652 /
 * 2) http:// www.flickr.com/photos/ flominator / 151898652 /
 * 3) http:// www.flickr.com/photo.gne?id= 151898652 

In the examples,  151898652  is the,  23918957@N00  is the  , and  flominator  is the. The  is the title of the Flickr media file and can be found using Flinfo or on the description page of the image. is the Flickr user's real name (and alias in parentheses) or alias (by itself if no real name is given). , if available, is the physical location of the Flickr user. and  can both be found using Flinfo or on the user's profile page.

Note that either the  or   is required, not both. If both are given, the  will be used for hyperlinking, and the   will be displayed to humans. Theoretically, the  could change, but the   would remain the same; therefore the   is desired whenever possible. (If it is your own username and you know you won't ever change it, feel free to use the username instead.)

| Flickr_ImageID = | Flickr_ImageTitle = | Flickr_UserID = | Flickr_UserName = | Flickr_UserLocation = | Author = - This is the Flickr user's name, probably not your name
 * The required attributes

Attributes that are required if " " and the file is an image
| Ret_Mods = A summary or list of the modifications made | Ret_Editor = Who made the edits (if not the author) | Ret_Orig = wikilink - original source image on Commons; "Image:" is prepended | Ret_OrigOff = hyperlink - URL to an off-Commons source

Attributes that should be added if " "
Wikilink to the specific page (or the best usage if used in multiple places) where the file appears. | Used_en.books = | Used_en.wiki = | Used_commons = | Used_meta =

Attributes that are required if " "
| Pub_Author = | Pub_Date = | Pub_Url = | Pub_Title = | Pub_Org =

Important licensing notes

 * 1) The default license selection is Willscrlt's default licensing choices. You probably will need to make changes, unless you are equally permissive with the use of media you upload.
 * 2) It is important that all individual license options be specifically identified (  or  ) to make it possible to track any licensing changes that may occur in the future.
 * 3) " " indicates that the file is public domain.
 * 4) By placing a work into the Public Domain, you give up all copyrights to it, thus no other license is valid thereafter. Thus, " " overrides all of the following licensing options: ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,   and.
 * 5) " " (the full word "Yes" with a capital letter "Y" rather than " ") was deliberately chosen for this option in order to be more difficult to accidentally select, thus helping to protect the author from accidentally giving away all copyrights.
 * 6) " " indicates that the file is licensed under one or more Creative Commons licenses. Broad categories of licenses are listed next (,  , etc.), followed by specific license versions ( ,  , etc.). " " indicates that future versions of cc-by and cc-by-sa (as applicable) are permitted. Note that " " indicates that NO Creative Commons licenses apply; thus all CC-related license options must also be set to " " to avoid confusion. Likewise, if a broad category is disabled (e.g. " "), then all related licenses must be set to " ".
 * 7) " " indicates that the file is licensed under one or more GNU licenses (specifically the GFDL, GPL, LGPL). Files from wikis like the English Wikipedia that license all submissions exclusively under the GFDL should be set to " " and set all the other license options to " ", unless the user has multi-licensed his/her contributions (check the user page). Note that   indicates that NO GNU licenses apply; thus all GNU-related license options must also be set to " " to avoid confusion.
 * 8) " " indicates that the file is released under the Free Art License.
 * 9) " " indicates that the Wikimedia Foundation is authorized to relicense the media however future needs require, so long as any new licenses remain true to the spirit of free use (specifically the ideas set forth in the GFDL).

Removing the licensing warning message
If you notice a warning about an invalid license option, please take a moment to fix the problem if you can. If you have any questions, please leave Willscrlt a message, and he will be happy to assist you.

As mentioned above, it is important that you explicitly specify each of the possible licensing options available in this template. That means that each option needs either a "y" (for yes) or "n" (for no) added. Missing or omitted options are flagged with warning messages. Capitalization is important, too. The "y" or "n" should be in lower case, as should the option name itself. Also, if new license options or versions are added after an image has been tagged, a warning will appear. In that case, just add the missing option with an "n" value (or "y" if that's more appropriate).

| cc-by-3.0 = y   - Option and value are both lower case | pd = Yes        - A deliberate exception to y/n; see note 3.2 above | CC-BY-3.0 = y  - The option must be lower case ("cc-by-3.0") | cc-by-3.0 = Y  - The value must also be lower case ("y") | cc-by-3.0 = Y  - The value must also be lower case ("y") | pd = y         - Only "Yes" (not just "y") works with "pd" | pd = yes       - Only "Yes" (with a capital "Y") works with "pd"
 * Examples of correct usage
 * Examples of incorrect usage

Certain options are mutually exclusive. If Creative Commons licenses are not available, then any of the specific CC licenses set to yes would be invalid (and would not appear in the description). Likewise, anything in the public domain automatically excludes all other license options, so they should all be set to no (though no error message will appear to warn you of this problem!).
 * Examples of invalid combinations
 * with any other type of license (see note 3.1 above)
 * when
 * when either  or
 * when either, or both   and
 * when

Related information
The following templates are incorporated into this template or their functionality is approximated:
 * Animated SVG
 * Attribution
 * Cc, Cc-by-2.0, and other similar Creative Commons templates
 * Copyright by Wikimedia
 * Created with Adobe Illustrator
 * Created with GIMP
 * Created with Inkscape
 * FAL
 * GFDL-CC-triple
 * GFDL (and others), GPL, LGPL, and similar GNU templates
 * Information
 * Inkscape-hand
 * Kopimi
 * PD-self and Cc-pd
 * Panorama
 * Personality rights
 * Published
 * RetouchedPicture
 * Userpageimage
 * ValidSVG