View source for Template:License migration/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{High-risk|109,000+}}
=== Description ===
This is the root of the "license migration" template system.  By sending it an appropriate keyword it allows GFDL images to be automatically retagged and sorted into one of several categories based on whether the file is [[Wikipedia:Licensing_update#Media_file_relicensing_criteria|eligible to participate]] in the [[Wikipedia:Licensing_update|licensing update]] effort.

This template is intended to be appended to {{tl|GFDL}} and similar templates that indicate a possibly eligible licensing status.  A parameter will be added to {{tl|GFDL}} that passes through the keyword used here allowing for calls to GFDL to take the new form {{tl2|GFDL|migration<nowiki>=</nowiki>''keyword''}}.

Templates transcluding {{tl|license migration}} are automatically added to [[:Category:Wikipedia license migration templates]], and may have already been configured to pass through the ''migration='' keyword.

=== Usage ===

The action taken depends on the keyword specified:
* '''Empty string''' or not recognized:
*:An "announcement" highlighting the current relicensing effort is appended below the GFDL.<br>
{{license migration announcement}}
* '''relicense''': 
*: This keyword should be used when a media file does meet the relicensing criteria.  The {{tl|cc-by-sa-3.0-migrated}} tag will be appended after the GFDL tag.
* '''not-eligible''': 
*: This keyword should be used if the media file does not meet the [[Wikipedia:Image license migration#Media file relicensing criteria|relicensing criteria]].  It removes the notice and categorizes the image in [[:Category:Wikipedia license migration not eligible]].
* '''redundant''': 
*: This keyword should be used if the media file is already dual licensed under CC-BY-3.0 or CC-BY-SA-3.0 and hence relicensing is not necessary.  It removes the notice and categorizes the image in [[:Category:Wikipedia license migration redundant]].
* '''needs-review''':
*: This keyword should be used if cursory inspection of the image cannot determine whether it is eligible for relicensing or not.  These images are categorized for further attention in [[:Category:Wikipedia license migration needs review]] and the announcement message remains in place.
* '''opt-out''':
*: This keyword should only be used if the copyright holder for the image explicitly requests that they do not wish for this image to participate in the license migration.  Doing this will remove the announcement and categorize the image in [[:Category:Wikipedia license migration opt-out]].  Choosing to opt-out is discouraged, as it will generally make the material less reusable.  The opt-out option will be available for a limited time only, and copyright holder wishing to exercise this option should act in an expeditious manner.  For further discussion see [[Wikipedia:Image license migration#The opt-out provision]].

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
</includeonly>