Figure Float

A floating figure can be created using the figure environment.

Example

source

\begin{figure}[label='fig1'
caption='This is the caption of the figure.']
Body of the figure.
\end{figure}

Body of the figure.

Figure 1: This is the caption of the figure.

results

floats module

\begin{figure}[label=name
              caption=text
              style=cssname       -> plain - to omit the label
              note=text
              width=#
              align=left|right}  -> Figure #. caption-text 
    . . .
 \begin{caption}
  Caption text.
 \end{caption}
\end{figure}

Similar to a LaTeX figure. Figure blocks are numbered sequentially on a given page. If label is omitted, then only the caption text is displayed without the number. The note argument is used to add HTML comments to the figure. This can be used to provide copy right information or notes you want to share and/or remember about the contents of the figure. A caption or description of the figure can be provided in either the optional caption key or the caption child environment.

  \begin{caption}
  This is the caption of the figure.
  \end{caption}

The latter is used for more complex text that may contain wiki styles.

Keys:

label: Defines a reference label or name for the figure. The label can be used with the \ref{label} command to create a reference link to the figure.
caption: The description or caption of the figure. The text of this argument should be simple and not include any other plugin elements. If styling or plugin elements are needed, the caption environment can be used instead.
style: The name of one or more block specific css class names for modifying the default style of the figure. There are two styles currently defined, plain is used for omitting the Figure label from the caption and flush is used to remove the top margin.
note: Adds text to the image as a HTML comment which can be used to denote a copyright or other relevant information about the figure.
width: The horizontal size of the figure block. By default, the figure is the full width of the parent container.
align: Whether the figure box should be aligned left or right on the page. This argument is only useful if the width is also set. By default, the figure is the full width of the parent container and thus, can not float left or right.

Plugin: FigureFloat

☰ Click for Table of Contents	BookWiki Documentation	Wiki Plugin Reference