Definition list

[fred-atherden]

A list of definitions

User Stories

Author

1. As an author, I want to be able to create a definition list so that I can define the terms used in an article.
2. As an author, I want to be able to add a term and its definition to a definition list so that I can expand the terms it covers.
3. As an author, I want to be able to edit a term and its definition from a definition list so that I can correct any errors.
4. As an author, I want to be able to remove a term and its definition from a definition list so that I can correct any errors.
5. As an author, I want to be able to move a definition list from one place to another so that I can correct errors in its positioning.
6. As an author, I want to be able to delete a definition list so that I can correct an error.
7. As an author, I want to be able to start a definition list within a definition so that I can add sub-definitions.

Production staff

-

But what if . . . ?

Considerations

• Definition lists can be placed at any point in the article text, including in paragraphs, normal lists, and figure and table legends.

XML requirements

Érudit Examples:

Example 1: https://www.erudit.org/fr/revues/ltp/2012-v68-n1-ltp0139/1010219ar/

<glossary>
    <def-list>
    <def-item>
        <term>Florian Philippot (Front national, FN), Extrême droite</term>
        <def>36,06</def>
    </def-item>
    <def-item>
        <term>Philippe Richert (Union de la droite, UD), Droite</term>
        <def>25,83</def>
    </def-item>
    <def-item>
        <term>Jean-Pierre Masseret (Union de la gauche, UG), Gauche</term>
        <def>16,11</def>
    </def-item>
    <def-item>
        <term>Sandrine Bélier (Europe Ecologie Les Verts, EELV), Ecologistes</term>
        <def>6,70</def>
    </def-item>
        ...
    </def-list>
<glossary>

<def-list>
  <def-item>
    <term>§ 1 Consequenter, queritur de interiectione utrum sit pars orationis.</term>
    <def><bold>§ 1 </bold>[Question 1.1] Conséquemment, on se demande si l’interjection est une partie du discours.</def>
  </def-item>
  <def-item>
    <term>§ 2 Et uidetur quod non, quia omnis pars orationis inponitur1 a ratione ad significandumA ; set interiectio non
        inponitur a ratione ad significandum, ergo non est pars orationis. Maior patet de se. .IIII.2 enim3 manifestatur sic, nam si interiectio inponeretur a ratione
        ad significandum, non proferetur uoce incondita nec uoce irrationali ; set profertur uoce incondita, sicut dicit PriscianusB, ergo non est inposita a ratione &lt;ad significandum&gt;4.</term>
    <def><bold>§ 2</bold> [Argument 1 de la question 1.1] Et il semble que ce n’est pas le cas, parce que toute partie du discours est imposée par une propriété de signification ; or l’interjection n’est
        pas imposée par une propriété de signification, donc elle n’est pas une partie du discours. La majeure va de soi. En effet, le fait que l’interjection ne soit pas imposée par une propriété de signification est montré ainsi :
        si l’interjection était imposée par une propriété de signification, elle ne serait pas proférée par un son vocal inconnu ni par un son vocal irrationnel ; or elle est proférée par un son vocal inconnu, comme le dit Priscien,
        donc elle n’est pas imposée par une propriété de signification.</def>
  </def-item>
  ...
</def-list>

Érudit require the ability to add def-list in the following elements:

• p
• sec
• disp-quote
• list-item
• caption
• def
• term
• notes
• fn
• abstract
• ref

Note that list-item, def, and term are included in this list, so it is necessary to be able to nest def-list inside other types of list.

Taken from: https://github.com/elifesciences/TextureRequirements/issues/101

[fred-atherden]

I think there could be scope for eLife to use definition lists (for abbreviations).