substance / texture

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

Notes #1340

Open JGilbert-eLife opened 5 years ago

JGilbert-eLife commented 5 years ago

Description

Miscellaneous notes appearing in frontmatter or backmatter of an article, intended to capture information related to the publication or translation of an article (or to the issue in which it appears). Can also cover 'Notes added in proof', where an author wishes to append additional content to their article based on, for example, a recently published article that might have bearing on their results.

User stories

Production staff

  1. As production staff, I want to be able to add one or more notes to the frontmatter for an article so that I can capture miscellaneous information.
  2. As production staff, I want to be able to add one or more notes to the backmatter for an article so that I can capture miscellaneous information.
  3. As production staff, I want to be able to set the type for a note so that I can distinguish between different kinds of information.
  4. As production staff, I want to be able to edit the title and content for a note so that I can correct errors.
  5. As production staff, I want to be able to remove a note so that I can correct errors.
  6. As production staff, I want to be able to apply style formatting to text in a note so that I can add emphasis.

But what if . . . ?

Consideration

XML requirements

Overall notes on the article should be captured in a notes element placed in the front or the back. If this section contains numerous notes, these can be captured with different secs, each with an appropriate @sec-type.

...
<front>
  <journal-meta> ... </journal-meta>
  <article-meta> ...  </article-meta>
  <notes>
    <sec sec-type="issue-note">
      <title>Issue Editorial Note</title>
      <p>Issue editorial note....</p>
    </sec>
    <sec sec-type="article-note">
      <title>Article Editorial Note</title>
      <p>Article editorial note...</p>
    </sec>
    <sec sec-type="translation-note">
      <title>Translation Note</title>
      <p>Translation note...</p>
    </sec>
  </notes>
</front>
...

Another example:

<back>
...
        <notes>
            <p>The views expressed herein do not necessarily reflect the views of the United
                Nations.</p>
        </notes>
...
</back>

The attribute @notes-type can be used for further semantic capture, examples include:

<notes notes-type="disclaimer">
<notes notes-type="editor-note">
<notes notes-type="after-epub">
<notes notes-type="conflict-interest">

Mock ups

Proposal