మూస:FreedImg/span/doc పేజీ సోర్సు చూడండి

{{Documentation subpage}}
{{uses TemplateStyles|Template:FreedImg/styles.css}}
{{lua|Module:FreedImg}}

* Use this image container template to display INLINE OFFSET images.
* Resizes the container dynamically and provides additional image related features.
* When used to display an offset image, the surrounding text flows around the container.

{{Dhr}}

{{TOCcenter}}

==Usage==

* Always please use the shortcut to FreedImg/span, {{tl|FIS}}, rather than the long template name.

<pre>{{FIS
 | type         =
 | file         =
 | width        =
 | height       =
 | cclass       =
 | cstyle       =
 | float        =
 | margin-left  =
 | margin-right =
 | clear        =
 | caption      =
 | top-caption  =
 | tmleft       =
 | indent       =
 | tstyle       =
 | talign       =
 | alt          =
 | link         =
 | page         =
}}</pre>

For true block element usage, please see FreedImg, {{tl|FI}}, instead.

===Parameters===

; For the Image itself
* {{parameter|file}}: The file name (without the "File:" prefix) (optional; if lacking, a caption-only block is created.)
** {{parameter|alt}}: Image alt-text, ie. for mouse-over text box or for use with a screenreader for the visually impaired (optional)
** {{parameter|link}}: link redirect for image (default no redirect) 
** {{parameter|page}}: Select individual image page within a multi-page file (PDF/DJVU etc.; optional); when ( {{parameter|type}}=user ) is present & set
* {{parameter|imgwidth}}: request this size of image from the server, rather than computing a guess. This can help to reduce file size, for example, when you know the image will be used in a narrow container.

* Images generated by certain wikicode extensions (e.g. the default &lt;math&gt; User preference, &lt;score&gt;, etc.) may be entered in the named {{parameter|file}} parameter instead.

; Primary DIV container
* {{parameter|width}}: The width of the primary container, by percentage (present, variable, ''default 100%'')
* {{parameter|cclass}}: The class for the primary container, (present, variable, ''default floatnone'' [a null undefined classname just for placeholder purposes])
* {{parameter|cstyle}}: Any special overall styles to apply to primary container (default: no extra CSS).
* {{parameter|float}}: The alignment of the primary container (not present; must be added, options are "left" or "right"; ''otherwise remains centered'').
* {{parameter|clear}}: The margin(s) of the primary container to be cleared (not present; must be added, options are "left", "right" or "both").
* {{parameter|margin-left}},{{parameter|margin-right}} : Any special margins to be applied to the primary container (defaults appropriate for centered result).

; Image Caption
* {{parameter|caption}}: The image caption below the image, if any.<!-- Do not use any <nowiki><div></nowiki> or div-based templates such as {{tl|smaller block}} if the template is located in the middle of a paragraph as Mediwiki will add a paragraph break.-->
* {{parameter|top-caption}}:an  image caption above the image, if any
* {{parameter|tstyle}}, {{parameter|talign}}: Any special text style or alignment to apply to caption block (if present).
* {{parameter|tmleft}}, {{parameter|tmright}}, {{parameter|indent}}: Any special text-flow (e.g. margins, indent, hanging indent etc.) control to apply to caption (if present).

=== Examples ===
==== Example 1: Simple inline image ====

When used with default parameters, the image is inlined into the surrounding paragraph.

<pre>
text before{{FIS
 | file     = Iceberg.jpg
 | width    = 100px
 | alt      = WS Iceberg
 | link     = w:Iceberg{{!}}Iceberg article at Wikipedia
}}text after
</pre>

text before{{FIS
 | file     = Iceberg.jpg
 | width    = 100px
 | alt      = WS Iceberg
 | link     = w:Iceberg{{!}}Iceberg article at Wikipedia
}}text after

==== Example 2: Simple inline image, with caption ====

<pre>
text before{{FIS
 | file         = Iceberg.jpg
 | width        = 100px
 | top-caption  = An iceberg
 | caption      = Still an iceberg
}}text after
</pre>

text before{{FIS
 | file         = Iceberg.jpg
 | width        = 100px
 | top-caption  = An iceberg
 | caption      = Still an iceberg
}}text after


==== Example 3: Musical Score ====
This example does not currently render properly owing to limitations in the Score extension.<ref>Namely the fact that the image is always wrapped in a div.</ref>

<pre>
text before{{FIS
 | type  = user
 | file  = <score inline=yes>{ \clef bass \time 3/4 g,4 (b,4 [d4 f4 a4]) r4 \bar "|." }</score>
}}text after
</pre>

text before{{FIS
 | type  = user
 | file  = <score inline=yes>{ \clef bass \time 3/4 g,4 (b,4 [d4 f4 a4]) r4 \bar "|." }</score>
}}text after

==== Example 4: Mathematical Equation ====

{{smaller|N.B. This only works if the user's Preferences are set to the default (''i.e.'' Preference/Appearance/Math is "Always render PNG". Choice "[http://www.mathjax.org/ MathJax]" causes any formulæ to be rendered entirely in text, completely bypassing any effect {{tl|FreedImg}} may have.)}}

<pre>
text before {{FIS
 | type  = math
 | file  = <math>sin x = {e^{ix} - e^{-ix} \over 2i}</math>
}} text after
</pre>

text before {{FIS
 | type  = math
 | file  = <math>sin x = {e^{ix} - e^{-ix} \over 2i}</math>
}} text after

==== Example 5: Floating centred image ====

This is a very common use of the template: to provide an image that "floats" in the centre of the page, but does not cause a hard paragraph break at the image location.

For this to work, {{parameter|float}} must be set to "left" or "right", and the {{Parameter|width}}, {{parameter|margin-left}} and {{parameter|margin-right}} ''must'' sum to 100%, otherwise this template will not take up a full width, and some surrounding text may creep into the same line (as in example 1).

<div>
<pre style="overflow:auto;">
{{FIS
 | file     = Iceberg.jpg
 | width    = 20%
 | margin-right=40%
 | margin-left=40%
 | float    = right
 | alt      = WS Iceberg
 | link     = w:Iceberg
 | caption  = {{Sc|An Iceberg. Plaintiff alleges that she participated in a group training program conducted by Lifespring in Philadelphia, Pennsylvania during April 1981.}}
}}
</pre>

<p style="text-align:justify">Plaintiff alleges that she participated in a group training program conducted by Lifespring in Philadelphia, Pennsylvania during April 1981. She contends that she was subjected to psychological manipulation resulting in psychological and emotional injuries. She contends that Lifespring, [FIS here!] {{FIS
 | file     = Iceberg.jpg
 | width    = 20%
 | margin-right=40%
 | margin-left=40%
 | float    = right
 | alt      = WS Iceberg
 | link     = w:Iceberg
 | caption  = {{Sc|An Iceberg. Plaintiff alleges that she participated in a group training program conducted by Lifespring in Philadelphia, Pennsylvania during April 1981.}}
}}under whose auspices the program was conducted, is liable to her essentially in tort. She further contends that Hanley is individually liable to her because he controlled the training offered by Lifespring. She contends that he was personally involved in the development and operation of the training program.  Service of the complaint was made upon Hanley by registered mail. He states in an affidavit that he lacks any personal contact with Pennsylvania other than through his affiliation with Lifespring in his corporate capacity. Plaintiff argues that such contact is sufficient.</p>
</div>

==== Example 6: Single page of a multi-page document ====

<pre>
{{FIS
 | file     = Character of Renaissance Architecture.djvu
 | width    = 15%
 | alt      = Plate III: Cvpola Di S Pietro
 | link     = Character of Renaissance Architecture
 | page     = 91
}}
</pre>

{{FIS
 | file     = Character of Renaissance Architecture.djvu
 | width    = 15%
 | alt      = Plate III: Cvpola Di S Pietro
 | link     = Character of Renaissance Architecture
 | page     = 91
}}

=== See also ===

* {{tl|FreedImg}}: block-based equivalent. Note: this template ''always'' breaks a paragraph.

<includeonly>
<!-- CATEGORIES HERE; INTERWIKIS TO WIKIDATA, THANKS -->
[[Category:Formatting templates|Dynamic image]]
</includeonly>