Difference between revisions of "Template:Image captions for cleanup/doc"

From blackwiki
Jump to navigation Jump to search
imported>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
imported>Funandtrvl
(add template demos, copy edit)
 
Line 1: Line 1:
{{cleanup|reason=Should use Lua.|date=July 2017}}
+
{{Documentation subpage}}
{{documentation subpage}}<!--  
+
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
 
 
Please place categories and interwikis at the bottom of this page; where they normally go; And see: [[Wikipedia:Wikidata]]
 
 
 
-->
 
 
{{Nosubst}}
 
{{Nosubst}}
 
{{tsh|Cuic|Clean caption}}
 
{{tsh|Cuic|Clean caption}}
  
 
== Usage ==
 
== Usage ==
 +
The {{tlx|Image captions for cleanup|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} template helps track articles with '''image captions in need of cleanup'''. This template will auto-categorize tagged articles into [[:Category:Image captions for cleanup]], and the subsequent bot edit will place it into a dated subcategory, as well. The auto-categorization includes variations, like [[:Category:Image captions for cleanup/With examples]] and [[:Category:Image captions for cleanup/Without examples]], and dated variants, like [[:Category:Image captions for cleanup from November 2020]].
  
{{'''[[Template:Image captions for cleanup|Image captions for cleanup]]'''}}
+
See all of the scheme's categories below:
 
 
This template helps '''[[:Category:Tracking categories|track articles]]''' with '''''image captions in need of cleanup'''''. It places pages it tags into a categorization scheme born of '''the template''' and its '''parent category''':
 
  
'''''[[:Category:Image captions for cleanup|Image captions for cleanup]]'''''
+
{{Category tree|Image captions for cleanup}}
 
 
It includes variations like [[:Category:Image captions for cleanup/With examples|'''''Parent''/With examples''']] and [[:Category:Image captions for cleanup/Without examples|'''''Parent''/Without examples''']] and dated variants like [[:Category:Image captions for cleanup from June 2017|'''''Parent'' from June 2017''']] as well.
 
 
 
The pages are ''auto-categorized'' by the template; through its parameters (depending on their use or omission). See all of the scheme's categories below:
 
 
 
<center>{{Category tree|Image captions for cleanup}}</center>
 
  
 
== Syntax ==
 
== Syntax ==
 +
The basic syntax uses {{tlc|Image captions for cleanup|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} with the current month and year.
  
'''{{tlx|Image captions for cleanup}}''' is the main template. Along with '''{{tlx|Cuic}}''' and '''{{tlx|Clean caption}}''' (its two aliases), the three may be used ''interchangeably'', to identical ends. Without parameter modification, they produce:
 
 
{{Clean caption|date=June 2017}}
 
 
 
== Parameters ==
 
== Parameters ==
 
+
'''| date =''' is the only '''required parameter''' – dated subcategories depend on its use; for example: ''[[:Category:Image captions for cleanup from December 2020|Image captions for cleanup from December 2020]]'' – if the template is used without "|date=", a bot will append it in place and correct the omission
'''| date =''' is the only '''required parameter''' – dated subcategories depend on its use; for example: ''[[:Category:Image captions for cleanup from June 2017|Image captions for cleanup from June 2017]]'' – if the template is used without "|date=", a bot will append it in place and correct the omission
 
  
 
=== Required ===
 
=== Required ===
 
 
* '''| date =''' value should be set in "Month year" form; for example: "{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}" –  if missing or blank a bot will add it later  
 
* '''| date =''' value should be set in "Month year" form; for example: "{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}" –  if missing or blank a bot will add it later  
  
 
=== Optional ===  
 
=== Optional ===  
 
 
The following parameters are available for optional use, subject to the user's best '''[[Wikipedia:Editorial discretion|discretion]]''' and '''[[WP:CLUE|clue]]''' (parameters shown on the same line are aliases and may be used interchangeably):
 
The following parameters are available for optional use, subject to the user's best '''[[Wikipedia:Editorial discretion|discretion]]''' and '''[[WP:CLUE|clue]]''' (parameters shown on the same line are aliases and may be used interchangeably):
  
Line 85: Line 68:
  
 
== Examples ==
 
== Examples ==
 +
'''Example 1'''
  
'''Example one'''
+
This example assumes an article has two or more image captions spread over two or more sections of the article, some of which are needing cleanup, and that the tag will be placed atop the article without giving specific examples. The syntax added atop the page would appear, in edit mode, as:
  
This example assumes an article has two or more image captions spread over two or more sections of the article, some of which are needing cleanup, and that the tag will be placed atop the article without giving specific examples. The syntax added atop the page would appear, in edit mode, as:
+
{{nowiki template demo|code=<nowiki>{{Image captions for cleanup |date=December 2020}}</nowiki>}}
  
<code><nowiki>{{Image captions for cleanup
+
'''Example 2'''
|date=June 2017
 
}}</nowiki></code>
 
 
 
And renders as:
 
 
 
{{cuic|date=June 2017}}
 
 
 
'''Example two'''
 
  
 
This example assumes that a section of the article has only one file within, and its caption needs cleanup. The tag uses generalized language, is placed atop the section, and shrunk in size. The syntax atop the section appears in edit mode as:
 
This example assumes that a section of the article has only one file within, and its caption needs cleanup. The tag uses generalized language, is placed atop the section, and shrunk in size. The syntax atop the section appears in edit mode as:
 
   
 
   
<code><nowiki>{{Image captions for cleanup
+
{{nowiki template demo|code=<nowiki>{{Image captions for cleanup |onefile=yes |subset=section |shrink=yes |date=December 2020}}</nowiki>}}
|onefile=yes
 
|subset=section
 
|shrink=yes
 
|date=June 2017
 
}}</nowiki></code>
 
 
 
And renders as:
 
 
 
{{Cleanup image captions|of=y|su=section|shrink=y|date=June 2017}}
 
  
'''Example three'''
+
'''Example 3'''
  
 
This example assumes a section of the article has three or more captions where at least two, given as examples, are in need of cleanup and they specifically are problematic for being trivial. The syntax placed atop the section appears, in edit mode, as:
 
This example assumes a section of the article has three or more captions where at least two, given as examples, are in need of cleanup and they specifically are problematic for being trivial. The syntax placed atop the section appears, in edit mode, as:
 
   
 
   
<code><nowiki>{{Image captions for cleanup
+
{{nowiki template demo|code=<nowiki>{{Image captions for cleanup |subset=section |wording=trivial |examples=Example 1 ''''' and''''' Example 2 |date=December 2020}}</nowiki>}}
|subset=section
 
|wording=trivial
 
|examples=Example 1 ''''' and''''' Example 2
 
|date=June 2017
 
}}</nowiki></code>
 
 
 
And renders as:
 
  
{{Clean caption|su=section|w=t|Example 1 ''''' and''''' Example 2|date=June 2017}}
+
'''Example 4'''
 
 
'''Example four'''
 
  
 
This example assumes an article has two or more captions within and that they all are problematic. Using generalized terms, the syntax placed atop the article appears, in edit mode, as:
 
This example assumes an article has two or more captions within and that they all are problematic. Using generalized terms, the syntax placed atop the article appears, in edit mode, as:
  
<code><nowiki>{{{Image captions for cleanup
+
{{nowiki template demo|code=<nowiki>{{Image captions for cleanup |allfiles=yes |date=December 2020}}</nowiki>}}
|allfiles=yes
 
|date=June 2017
 
}}</nowiki></code>
 
 
 
And renders as:
 
 
 
{{cuic|all=y|date=June 2017}}
 
  
'''Example five'''
+
'''Example 5'''
  
 
This example assumes the tag, using "generalized verbiage", will be placed in the caption field of a file whose caption needs cleanup (other files in the article can also be tagged as is appropriate). The syntax appears, in edit mode, as:
 
This example assumes the tag, using "generalized verbiage", will be placed in the caption field of a file whose caption needs cleanup (other files in the article can also be tagged as is appropriate). The syntax appears, in edit mode, as:
  
<code><nowiki>[[File:1976 Fender Stratocaster.jpg |thumb |center |{{Image captions for cleanup |shrink=file |date=June 2017}} Guitar]]</nowiki></code>
+
{{nowiki template demo|code=<nowiki>[[File:1976 Fender Stratocaster.jpg |thumb |center |{{Image captions for cleanup |shrink=file |date=December 2020}} Guitar]]</nowiki>}}
 
 
And renders as:
 
 
 
[[File:1976 Fender Stratocaster.jpg|thumb|center|{{cuic|shrink=file|date=June 2017}}Guitar]]
 
  
'''Example six'''
+
'''Example 6'''
  
 
This example assumes the tag, using "criteria specific verbiage", will be placed in the caption field of a file whose caption uses trivial wording. The syntax appears, in edit mode, as:
 
This example assumes the tag, using "criteria specific verbiage", will be placed in the caption field of a file whose caption uses trivial wording. The syntax appears, in edit mode, as:
  
<code><nowiki>[[File:1976 Fender Stratocaster.jpg |thumb |center |{{Image captions for cleanup |shrink=file |wording=trivial |date=June 2017}} Guitar]]</nowiki></code>
+
{{nowiki template demo|code=<nowiki>[[File:1976 Fender Stratocaster.jpg |thumb |center |{{Image captions for cleanup |shrink=file |wording=trivial |date=December 2020}} Guitar]]</nowiki>}}
 
 
And renders as:
 
 
 
[[File:1976 Fender Stratocaster.jpg|thumb|center|{{cuic|shrink=file|w=t|date=June 2017}}Guitar]]
 
  
 
== Tracking categories ==
 
== Tracking categories ==
Line 172: Line 115:
 
* {{tl|Cleanup gallery}}
 
* {{tl|Cleanup gallery}}
 
* {{tl|Cleanup images}}
 
* {{tl|Cleanup images}}
* [[Wikipedia:Template messages/Cleanup]]
+
* [[Wikipedia:Template index/Cleanup]]
 
 
  
<includeonly>{{Sandbox other||
+
<includeonly>{{sandbox other||
[[Category:Image captions for cleanup|{{PAGENAME}}]]
+
<!-- Categories below this line; interwikis at Wikidata -->
 +
[[Category:Image captions for cleanup| ]]
 +
[[Category:Cleanup templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 01:46, 16 December 2020

Usage

The {{Image captions for cleanup|date=September 2025}} template helps track articles with image captions in need of cleanup. This template will auto-categorize tagged articles into Category:Image captions for cleanup, and the subsequent bot edit will place it into a dated subcategory, as well. The auto-categorization includes variations, like Category:Image captions for cleanup/With examples and Category:Image captions for cleanup/Without examples, and dated variants, like Category:Image captions for cleanup from November 2020.

See all of the scheme's categories below:

Click on "►" below to display subcategories:

Syntax

The basic syntax uses {{Image captions for cleanup|date=September 2025}} with the current month and year.

Parameters

| date = is the only required parameter – dated subcategories depend on its use; for example: Image captions for cleanup from December 2020 – if the template is used without "|date=", a bot will append it in place and correct the omission

Required

  • | date = value should be set in "Month year" form; for example: "September 2025" – if missing or blank a bot will add it later

Optional

The following parameters are available for optional use, subject to the user's best discretion and clue (parameters shown on the same line are aliases and may be used interchangeably):

  • | link = using "y" or "yes" turns the camera icon into an active link to its File:page – all other values transclude through {{{link}}} which allows for a custom URL
  • | shrink = any value reduces the {{ambox}}'s size, location, and text rendered – from a width of 80%, centered on page, to a width of 25% aligned left, the image icon reduces from 40px to 20px, the output of "| fix =" is hidden, and Category:Articles using small message boxes is added to page. Set this parameter's value to "file" to tag a specific image's caption and place the tag directly before the caption itself (the "criteria specific" parameters may also be used). See "examples five and six" for more information
  • | onefile =, | of =, and | o = when the article, or section thereof (when tag is placed therein), has only one image, this parameter, using any value, modifies the prose to speak of the caption as being the only one and places the tagged page in Category:Image captions for cleanup/With examples
  • | allfiles =, | all =, and | af = when all of the files in the article, or section thereof (when tag is placed therein), have problematic captions, this parameter modifies the prose to speak of the captions as all being in need and places the tagged page in Category:Image captions for cleanup/With examples
  • | subset =, | sub =, and | su = using any value which is a subset of an article, (for example, "section", "list", or "gallery"), changes the tag's prose from article specific to section, list, or gallery specific verbiage
  • | example =, | 1 =, and | e = for listing only one example, add its file page name without "File:" or extension to show the file name as an example of a caption in need of the clean-up specified and places the tagged page in Category:Image captions for cleanup/With examples

The following parameters modify the tag's prose from "generalized verbiage" to "criteria specific verbiage"; for example: where the default text says: "... to comply with Wikipedia guidelines, the parameters modify it as shown:

  • | succinct =, | sc =, and | s = using any value adds: for succinctness. ..."
  • | wording =, | wo =, and | w = using any value adds: for trivial wording. ..."

Examples

Example 1

This example assumes an article has two or more image captions spread over two or more sections of the article, some of which are needing cleanup, and that the tag will be placed atop the article without giving specific examples. The syntax added atop the page would appear, in edit mode, as:

Template:Nowiki template demo

Example 2

This example assumes that a section of the article has only one file within, and its caption needs cleanup. The tag uses generalized language, is placed atop the section, and shrunk in size. The syntax atop the section appears in edit mode as:

Template:Nowiki template demo

Example 3

This example assumes a section of the article has three or more captions where at least two, given as examples, are in need of cleanup and they specifically are problematic for being trivial. The syntax placed atop the section appears, in edit mode, as:

Template:Nowiki template demo

Example 4

This example assumes an article has two or more captions within and that they all are problematic. Using generalized terms, the syntax placed atop the article appears, in edit mode, as:

Template:Nowiki template demo

Example 5

This example assumes the tag, using "generalized verbiage", will be placed in the caption field of a file whose caption needs cleanup (other files in the article can also be tagged as is appropriate). The syntax appears, in edit mode, as:

Template:Nowiki template demo

Example 6

This example assumes the tag, using "criteria specific verbiage", will be placed in the caption field of a file whose caption uses trivial wording. The syntax appears, in edit mode, as:

Template:Nowiki template demo

Tracking categories

Redirects

See also