Article Notes

[Maelplaine]

Problem / Motivation

- WHO: reader - WHAT: a section including notes text that can be linked from the main text - WHEN: while reading the article page - WHY: give additional context to unclear or short passages in the text, without interrupting the flow for all readers ## Proposed solution - Notes will be included in a new expandable section like the references on the eLife journal - A simple number will be added inside the text. It won’t be a link and the corresponding number in the expandable section won’t link back to the text where the note number is located. ## Tasks - Article schema must be expanded to allow for notes to be stored in the XML - Journal has to render the new section and insert links to it ## Tasks

• [ ] A descriptive of a task
• [ ] A description

Clarification needed and assumptions

• Check with UX designer is happy with the proposed solution
• How do we call this section? Notes

  Yes

• Is IJM happy with the proposed solution?

  Yes

• Is this common in other journals?

  Yes they are referred as footnotes or endnotes depending on the journal

• Is there going to be a link from the text to the footnote, and back?

  We won't build this for the MVP and IJM don’t need this

• The section auto-expands when a footnote is followed?

  We won't build this for the MVP and IJM don’t need this

Assumptions

• Notes can have inline styles, links, bibliography references like any other part of the text
• Simple notes numbers like on Nautilus website are suitable for the MVP (see UI section)

Technical notes

• Typesetter suggestions for the JATS model: https://github.com/microsimulation/ijm-xml/blob/master/ijm-00666.xml#L2273-L2281
• In the HTML delivered to the browser, the relationship between the note callout and the note text should be made using the aria-describedby attribute.

User interface / Wireframes

• See the link below for an example of article with notes in the text http://nautil.us/issue/62/systems/eating-for-peace

• Existing design pattern we could use for the notes

[thewilkybarkid]

Bit unclear what JATS should be supported. Looking at IJM kitchen sink and DAR, maybe the first:

<article>
  <back>
    <fn-group>
      <title>[optional title]</title>
      <fn id="[id]">
        <label>[label]</label>
        [one or more paragraphs]
      </fn>
    </fn-group>
  </back>
</article>

and

<xref ref-type="fn" rid="[id]">[text]</xref>

Could support multiple <fn-group> if they have <title> and certain @content-type (like we do with kwd-group).

[thewilkybarkid]

Also need a design.

[Maelplaine]

@NickDuf Can you have a look at the design proposition. Does that work for the MVP?

[NickDuf]

@thewilkybarkid I will put some designs together on Monday for you.

[NickDuf]

@Maelplaine do we have any examples of footnote content that I can use for my visual?

[Maelplaine]

@NickDuf You can find some at the bottom of this IJM pdf: https://www.microsimulation.org/IJM/V11_3/IJM_11_3_1.pdf They are just named "Notes"

[NickDuf]

@thewilkybarkid the approved notes is design is here. Let me know if you need anything else.