cogProvides the User Interface for Numbered Figures.
Recommended
TypeXAR
CategoryApplication
Developed by

Manuel Leduc, Michael Hamann

Active Installs26
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

14.2+

Installable with the Extension Manager

Description

Provides the User Interface for Numbered Figures. This application is part of the Numbered Content.

Numbering Activation

To activate figures numbering on a Space or a Page, a NumberedFigures.Code.NumberedFiguresClass XObject can be added, and its status field set to Activated.
To deactivate figures numbering, the same steps can be followed, but the status field must be set to Deactivated.

Example

Once figures numbering activated, nothing specific is required. Every figureCaption contained in a figure will be prefixed with Figure X: where is in a integer value, incremented for each figure macro. In other word, every figureCaption contained in the same figure will have the same number.
1.4+ Figures containing a single table are now automatically identified and are prefixed with Table Y, where Y is incremented using a counter independent of the one used to number the other figures.

Note: The prefixes can be translated.

== Image ==

Using the figure and figureCaption macros:

{{figure}}
[[image:http://www.clker.com/cliparts/3/m/v/Y/E/V/small-red-apple-md.png||width="100"]]

{{figureCaption}}An image{{/figureCaption}}
{{/figure}}

Or using the links syntax:

[[An image>>image:http://www.clker.com/cliparts/3/m/v/Y/E/V/small-red-apple-md.png||width="100"]]

== Table ==

{{figure}}
|a|b
|c|d

{{figureCaption}}A table{{/figureCaption}}
{{/figure}}

Figure Macro

figure_macro.png

1.6+ 

The figure macro allows to define its type using the type parameter. Three values are allowed:

  • Automatic: (default value) The type of the figure is based on the content of the figure (i.e., if the figure contains a single table, the "table" type is used, the "figure" type is used otherwise).
  • Figure: Forces the figure to the "figure" type.
  • Table: Forces the figure to the "table" type.

Examples

Type "figure":

{{figure}}
[[An image>>image:http://www.clker.com/cliparts/3/m/v/Y/E/V/small-red-apple-md.png||width="100"]]
{{/figure}}

{{figure type="figure"}}{{/figure}}

Type "table":

{{figure}}
|a|b
|c|d
{{/figure

{{figure type="table"}}{{/figure}}

Known Limitations

<13.4-rc1 

Numbered Headings can be installed on XWiki 13.10+ but has some limitations when used on version lower than 13.4-rc-1.

Numbering on WYSIWYG

While numbering works fine in the in-place editor, it is not the case when editing in WYSIWYG mode. This means that while numbering will work fine on view mode, no visual feedback is shown to the user.

Translations

The Numbered Figure transformation generate some labels which can be can be internationalized. The following translation keys are used:

  • numbered.figures.codeSpace.title
  • numbered.figures.codeSpace.description
  • Figure type prefix translation keys:
    • numbered.figures.numbered.figureCaption.label
    • numbered.figures.numbered.tableCaption.label

Default English translations:

numbered.figures.codeSpace.title=Code
numbered.figures.codeSpace.description=This is the place where the Numbered Figures application code is located.
numbered.figures.numbered.figureCaption.label=Figure
numbered.figures.numbered.tableCaption.label=Table

Release Notes

1.7

1.6

1.5

1.4

1.3

1.2

Breaking change The parameter used to skip numbering (data-numbered-headings-skip) is now replaced by data-xwiki-rendering-protected.

1.1

1.0

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.contrib.numbered.content:application-numbered-content-figures-ui 1.7):

Tags:
    

Get Connected