Figuremark documentation (source for the Figuremark Docs space)
1. Getting started
- Write captions the way you would in a document:
- Under an image, use the image caption:
Figure: Login screen, or justLogin screen(image captions without a label count as figures). - For a table, code block or macro, type a paragraph right above or below it:
Table: Monthly costs,Listing: Setup script.
- Under an image, use the image caption:
- In the text, refer to them with a token:
see [[fig:login]],as in [[tab:costs]]. - Open More actions (...) > Number captions. The preview lists every caption before and after, and every reference with what it becomes. Nothing changes until you click Number captions.
- The page is saved once, as a new version. Captions read "Figure 1: Login screen"; references become links reading "Figure 1" that jump to the caption.
2. What counts as a caption
- An image caption (the caption field under an image).
- A paragraph that starts with a sequence word, an optional number and
:or., sitting right above or below an image, table, code block, embed or macro. - Prose such as "Table 3 shows the results" is never touched: it has no separator. You can turn off "must sit next to" in the options if your captions are elsewhere.
3. References
| Token | Becomes | Matches |
|---|---|---|
[[fig:login]] | Figure 3 | a figure whose anchor is fig-login, whose number is login, or whose caption contains words starting with "login" |
[[tab:monthly costs]] | Table 2 | same rules, several words allowed |
[[fig:3]] | Figure 3 | the figure currently numbered 3 (the link then follows that figure, not the number) |
[[eq:energy]] | Equation (2) | a Texwell equation labelled energy, or an "Equation:" caption |
[[sec:storage]] | Section 2.3 | a heading on this page; the number comes from the heading text (Sectionmark writes it) |
Tokens that match nothing are left as typed and listed as Not found in the preview. Tokens inside code are ignored. Once linked, a reference is an ordinary Confluence link; you can restyle it, and Figuremark keeps its text in step with the number.
4. Sequences and options
- Built in: Figure (
fig), Table (tab), Equation (eq), Listing (lst). Rename the word ("Fig.", "Abbildung"), change the word used in references, switch a sequence off, or number with letters (A, B) or roman numerals (i, ii). - Add up to six more sequences: Exhibit, Chart, Diagram, Box, Map, Note.
- Separator:
Figure 1: Title,Figure 1. Title,Figure 1 - Title,Figure 1 | Title. - Bold "Figure 1" if you like.
5. Chapter numbers
- By heading: Figure 2.1, 2.2 under the second chapter heading (Heading 1 by default). If the heading carries a number (Sectionmark writes "2 Design"), that number is used, so captions always agree with your section numbers. Without numbers, headings are counted.
- By page in a tree: the page's position under the tree root is the chapter: every figure on the third chapter page is Figure 3.x.
6. A whole page tree as one document
Paste the root page link into Page tree. Numbers then continue across every page under the
root in tree order (Figure 7 on page 3 follows Figure 6 on page 2), and [[fig:...]] can point
at a figure on any numbered page in the tree. Renumber the whole tree updates every page in
one run (up to 300 pages), with a progress bar; pages you can't edit are listed and skipped.
Numbering a single page in the tree also continues from the earlier pages. After adding a figure to an early chapter, run Renumber the whole tree so later chapters move up.
7. List of figures and tables
Insert List of figures (Figuremark) and choose what to list (figures, tables, equations, listings, a custom sequence, or everything) and from where (this page, or the whole tree). Each entry links to its caption. In PDF and Word exports the list becomes a linked bulleted list.
8. Working with Sectionmark and Texwell
- Sectionmark numbers headings; Figuremark reads those numbers for chapter numbering and section references. Run either one first; the other follows.
- Texwell numbers its own equations. On pages with Texwell equations, Figuremark leaves the
equation sequence to Texwell and
[[eq:label]]uses Texwell's numbers.
9. Keeping numbers current
- Keep numbers and references up to date (on by default) renumbers the page when it is published. Each change is one page version named "Caption numbers and references updated by Figuremark".
- Space admins can turn on numbering for every page in the space (Space settings > Numbered captions) and set the defaults.
10. Moving from Data Center
Pages migrated with another app's "Captioned item" and "Caption reference" macros: open Number captions. The preview says how many macros will be converted. The content inside each macro stays; it gets a Figuremark caption paragraph and its references become links.
11. Remove numbers and uninstalling
Remove numbers takes the numbers off ("Figure: Login screen" again), turns references back into tokens, and removes anchors Figuremark added. Labels you typed stay. Do this before uninstalling if you do not want to keep the numbers; otherwise they stay as normal text.
12. Known limits
- Every change is a page version (Confluence has no silent edit).
- Links from pages outside the tree to a caption keep working (anchors are stable), but their text is only updated on pages Figuremark numbers.
- Section references point at headings on the same page.