Template:Figure/doc

This documentation subpage contains instructions, categories, or other information for Template:Figure. [<Edit> Template:Figure]

[⧼Purge⧽ Template:Figure/doc]

The {{figure}} (or {{caption}}) OEIS Wiki utility template is intended for captioning diagrams, images, ....

Usage

{{figure|diagram, image, ...|caption text|tooltip text|left, center or right}}

or

{{figure|image = diagram, image, ...|caption = caption text|title = tooltip text|float = left, center or right}}

where

• image (first argument): is the diagram, image, ... to be captioned;
• caption (second argument): is the text caption (shown below diagram, image, ...);
• title (optional): is the tooltip text (shown on mouse over);
• float (last argument): is either left, center or right (default).

Notes:

• If the caption or the title include an equal sign you must use the {{=}} template to 'hide' the = from the template parser. Similarly, if you want to include a pipe character |, you must use either the {{pipe}} or {{!}} templates.
• The {{figure}} template must be called before the text that you want to flow right of a float left figure, left of a float right figure, or below a float center figure.

Examples

This shows the runtime of Eudlid’s algorithm for gcd (m, n) with m, n   ≤   361.

Example 1:

{{figure|[[File:Euclidean algorithm running time X Y 361×361.png]]|This shows the runtime of Eudlid{{'}}s algorithm for {{mathfont|gcd{{sp|1}}(''m'', ''n'')}} with {{mathfont|''m'', ''n'' {{rel|le}} 361}}.|title = Float right (as default).}}

yields the captioned figure on the right.

Example 2:

This shows the runtime of Eudlid’s algorithm for gcd (m, n) with m, n   ≤   361.

{{figure|[[File:Euclidean algorithm running time X Y 361×361.png]]|This shows the runtime of Eudlid{{'}}s algorithm for {{mathfont|gcd{{sp|1}}(''m'', ''n'')}} with {{mathfont|''m'', ''n'' {{rel|le}} 361}}.|title = Float left.|left}}

yields the captioned figure on the left.

Example 3:

This shows the runtime of Eudlid’s algorithm for gcd (m, n) with m, n   ≤   361.

{{figure|[[File:Euclidean algorithm running time X Y 361×361.png]]|This shows the runtime of Eudlid{{'}}s algorithm for {{mathfont|gcd{{sp|1}}(''m'', ''n'')}} with {{mathfont|''m'', ''n'' {{rel|le}} 361}}.|title = Float center.|center}}

yields the captioned figure centered.