Table footnotes

[fred-atherden]

Footnotes appended to table content.

User Stories

Author

1. As an author, I want to see any footnotes associated with a table so that I can check they are correct.
2. As an author, I want to be able to add a new footnote to a table so that I can append additional information to the content.
3. As an author, I want to be able to cite a footnote within a table cell so that I can point readers to this information.
4. As an author, I want to be able to delete a footnote citation from a table cell so that I can correct errors.
5. As an author, I want to be able to delete a footnote from a table so that I can correct errors.

Production staff

But what if . . . ?

Considerations

• Each footnote of this kind will be specific to one table.
• These footnotes can be cited or just attached, uncited, to the table.
• If they are cited, the citation usually takes the form of a linked superscript character in a table cell.
• eLife specifies using a symbol set for this kind of footnote (*,†, ‡, §,#, ¶,**,††, ‡‡,§§,##,¶¶), this will presumably need to be configurable per publisher.

XML requirements

Any footnotes to tables should be captured in a table-wrap-foot element. They should be contained in an fn-group element.

Footnote indicators in the fn element should be captured in a label element. The indicators in the table itself should be linked (using xref) to the appropriate footnote.

<table-wrap id="table2" position="float">
    <label>Table 2.</label>
    <caption>
        <title>Statistics for the top 20 NMR structures of Dec.</title>
    </caption>
    <table frame="hsides" rules="groups">
        <thead>
            ...
        </thead>
        <tbody>
            <tr>
              <td valign="top"><italic>RMSD from experimental restraints</italic><xref rid="t-fn-1" ref-type="fn"><sup>*</sup><xref></td>
              <td valign="top"/>
              <td valign="top"/>
            </tr>
            ...
            <tr>
              <td valign="top"><italic>RMSD from mean NMR structure</italic></td>
              <td valign="top"><italic>Backbone</italic><xref rid="t-fn-2" ref-type="fn"><sup>†</sup></xref></td>
              <td valign="top"><italic>All Heavy Atoms</italic></td>
            </tr>
            ...
            <tr>
              <td valign="top"><italic>Procheck Ramachandran Plot Statistics</italic><xref rid="t-fn-3" ref-type="fn"><sup>§</sup></xref></td>
              <td valign="top"/>
              <td valign="top"/>
            </tr>
          </tbody>
        </table>
        <table-wrap-foot>
          <fn-group>
            <fn id="table1-fn1"><label><sup>*</sup></label><p>Structures had no NOE violations &gt; 0.5 Å nor dihedral violations &gt; 5 degrees.</p></fn>
            <fn id="table1-fn2"><label><sup>†</sup></label><p>Atoms: Cα, N, C, O.</p></fn>
            <fn id="table1-fn3"><label><sup>§</sup></label><p>Calculated with the PSVS server (<ext-link ext-link-type="uri" xlink:href="http://psvs-1_5-dev.nesg.org">http://psvs-1_5-dev.nesg.org</ext-link>) using only the folded parts of Dec (residues 12–89).</p></fn>
          <fn-group>
        </table-wrap-foot>
</table-wrap>

There may be cases where an unlinked footnote is needed in a table, for example, if the body of the table is captured as an image or for an overall footnote for the table:

<table-wrap id="table2" position="float">
    ...
    <table frame="hsides" rules="groups">
        <thead>
           ...
        </thead>
        <tbody>
           ...
        </tbody>
    </table>
    <table-wrap-foot>
        <fn>
            <p>Note: Behavior assessments used the same animals of the 5 week groups (IF and ELISA).
                Abbreviations: AAV, adeno-associated virus, serotype 2; ELISA, enzyme-linked
                immunosorbent assay; GFP, green fluorescent protein; IF, immunofluorescence; NT-3,
                neurotrophin-3.</p>
        </fn>
    </table-wrap-foot>
</table-wrap>

Example published

Érudit example

Érudit capture tables as images, therefore all their footnotes are unlinked:

<table-wrap id="ta2" position="float">
    <label>TABLEAU 2</label>
    <caption>
        <title>Résultats des régressions Tobit</title>
    </caption>
    <graphic xlink:href="table2_figure_1.png">...</graphic>
    <table-wrap-foot>
        <fn-group>
            <fn>
               <label><sup>a</sup></label>
               <p>Pharmacie, CLSC et organismes communautaires collectant les seringues à moins de 100 mètres (variable muette).</p>
            </fn>
            <fn>
               <label><sup>b</sup></label>
               <p>Poste de quartier à moins de 100 mètres (variable muette).</p>
            </fn>
            <fn>
               <label><sup>c</sup></label>
               <p>Autoroute, nationale, collectrice ou artère.</p>
            </fn>
        </fn-group>
    </table-wrap-foot>
</table-wrap>

Published HTML

Mock ups

This is not required, but if you have mock ups of what you would like to see please provide them here.

Proposal

This will be added by the Texture team after the feature request is discussed and agreed.