[Feature] Figure Attachments (WIP)

[michael]

Description

We want a flexible solution for various kind of content to be attached to a figure for the purpose of supporting the content of a main figure (e.g. an additional supplementary figure, dataset, table, etc.)

Work in progress to address user stories from #1282 and #1281.

XML Source Format (TextureJATS)

<sec sec-type="supplementary-figures">
  <title>Supplementary Figures</title>
  <p>Below are the supplementary figures of this article:</p>
  <fig id="suppfig1">
    <label>Supplementary figure 1</label>
    <caption id="suppfig1-caption">
      <title>Supplementary figure title (optional)</title>
      <p id="suppfig1-caption-p1">Supplementary figure caption. </p>
    </caption>
    <graphic id="suppfig1-graphic" mime-subtype="jpeg" mimetype="image" xlink:href="suppfig1.jpg" />
  </fig>
</sec>

When referenced from a main figure xref is used:

<fig id="fig2">
  <label>Figure 2</label>
  ...
  <xref ref-type="fig" rid="suppfig1" />
</fig>

Proposal

After typesetting we have a list of supplementary figures inside a dedicated section in the backmatter (e.g. "Supplementary figure").

Create supplementary figure

When cursor is in side supplementary figures section, "Insert > Figure". This inserts a regular figure into the according section, providing a label derived from context such as 'Supplementary figure 3'.

Create a supplementary file

When cursor is inside the supplementary materials section, "Insert > File" will create Supplementary file 3 (as described above).

Add attachments to a figure

3 examples that are considered a figure supplement:

• user assigns a supplementary figure to a main figure
• user assigns a supplementary file (source data, PDF) to a main figure
• user assigns a supplementary table to a main figure

Mockup to be discussed:

Custom case: eLife figure supplements (in XML)

eLife figure supplements need to be part of the main figure in XML using a fig-group element. Therefore a translation step needs to be applied:

• main figures with supplementary figures attached, are converted to a fig-goup and each xref is replaced with a fig element
• labels are replaced according to eLife's labelling schema. Supplementary figure 1 is turned into "Figure 1 - figure supplement 1".
• supplementary figures section is removed from the backmatter

Precondition for this transformation to work:

• Every supplementary figure is assigned to exactly one main figure
• Same with supplementary files..