substance / texture

A visual editor for research.
MIT License
1k stars 83 forks source link

Equation groups #1338

Open JGilbert-eLife opened 5 years ago

JGilbert-eLife commented 5 years ago

Description

A group of display-equations (see #1318) collected together. The group and individual equations within it may be labelled.

User stories

Érudit

  1. As production staff, I want to be able to group display equations so that I can associate linked sets of equations.
  2. As production staff, I want to be able to add and edit a label to a display equation group so that I can refer to them collectively.
  3. As production staff, I want to be able to add and edit a caption to a display equation group so that I can describe the group.
  4. As production staff, I want to be able to add an equation to a display equation group so that I can include missing information.
  5. As production staff, I want to be able to remove equations from a display equation group so that I can correct errors.
  6. As production staff, I want to be able to add labels to the equations within a display equation group so that I can refer to them individually.

But what if . . . ?

Consideration

XML requirements

disp-formula-group should be used. These may have a child label or not. They may have a child caption element or not. They should contain more than one disp-formula. As with disp-formula, these should always be captured in a p element.

  1. Group of equations

    <disp-formula-group id="geq1">
        <disp-formula id="eq1">
            <tex-math>...</tex-math>
        </disp-formula>
        <disp-formula id="eq2">
            <tex-math>...</tex-math>
        </disp-formula>
    </disp-formula-group>
  2. Group of equations (graphic) + labels for each equation

    <disp-formula-group id="geq2">
        <disp-formula id="eq3">
            <label>(1.a)</label>
            <graphic xlink:href="1919993n.jpg"/>
        </disp-formula>
        <disp-formula id="eq4">
            <label>(1.b)</label>
            <graphic xlink:href="1919994n.jpg"/>
        </disp-formula>
    </disp-formula-group>
  3. Group of equations (graphic) + label for the group and a label for each equation

    <disp-formula-group id="geq3">
        <label>(1)</label>
        <disp-formula id="eq5">
            <label>(a)</label>
            <graphic xlink:href="1919995n.jpg"/>
        </disp-formula>
        <disp-formula id="eq6">
            <label>(b)</label>
            <graphic xlink:href="1919996n.jpg"/>
        </disp-formula>
    </disp-formula-group>
  4. Group of equations (graphic) + caption

    <disp-formula-group id="geq4">
        <caption><p>caption for the following group of equations</p></caption>
        <disp-formula id="eq7">
            <graphic xlink:href="1919997n.jpg"/>
        </disp-formula>
        <disp-formula id="eq8">
            <graphic xlink:href="1919998n.jpg"/>
        </disp-formula>
    </disp-formula-group>

Mock ups

Proposal