Template:ImageNoteControl/doc: Difference between revisions

Content deleted Content added
Created page with '{{Documentation subpage}} See commons:Template:ImageNoteControl for a description. <includeonly> <!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> </includeonly>'
 
Templates should be self-contained, and should not force users to refer to other wikis for documentation
Line 1:
{{Documentation subpage}}
This template can be used to wrap image inclusions through <tt style="background:#cccccc;"><nowiki>[[File:Example.jpg|...]]</nowiki></tt> to control the behavior of [[Help:Gadget-ImageAnnotator|image annotations]] locally for a single image use. This also works for thumbnails.
See [[commons:Template:ImageNoteControl]] for a description.
 
== Usage ==
{{tlx|ImageNoteControl|img= |notes= |caption= |type= }}
 
=== Template parameters ===
 
{| class="wikitable"
! style="width:15%"|Parameter
! style="width:65%"|Description
! style="width:10%"|Default
! style="width:10%"|Status
|-
|<code>img</code>
|The image inclusion, for instance <code><nowiki>[[File:Example.jpg]]</nowiki></code>, or <code><nowiki>[[File:Example.jpg|200px|thumb|right|Some text here]]</nowiki></code>.
|empty
|required
|-
|<code>notes</code>
|Defines how notes shall be displayed. If set to <code>none</code> or <code>off</code>, no image annotation will be displayed at all; the feature is switched off completely for this image use. If set to <tt>icon</tt>, only an indication icon will be displayed, but not the notes themselves. Any other value defaults to notes being displayed, subject to more global configurations within the article (see [[Template:ImageAnnotations]])
|empty
|optional
|-
|<code>caption</code>
|If notes are shown, there is normally an additional image caption indicating the presence of notes. If this parameter is set to <code>off</code>, <code>false</code>, or <code>none</code>, this caption is suppressed. If only an indication icon is shown instead of the notes themselves, no caption is added anyway.
|on
|optional
|-
|<code>type</code>
|If set to <code>inline</code> or <code>span</code>, the image is wrapped with a &lt;span> HTML tag, which does not break text flow. This is useful for the rare case where a large image flows directly within the text, but notes should be switched off. Any other value defaults to the image use being wrapped in a &lt;div> HTML tag, which does break text flow (but that is normally not a problem, because most images are ''not'' flowing within the text. Note that image notes can also switched off by wrapping the image use in an inline-only tag such as e.g. &lt;em>, or by setting the <code>link</code> parameter of the image use to nothing (as in <code><nowiki>[[File:Example.jpg|link=]]</nowiki></code>). Image notes are deactivated anyway on images smaller than 60×60 pixels.
|empty
|optional
|}
 
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->