JGilbert-eLife commented 5 years ago

Description

Text intended to be pulled out as a quote.

User stories

Author

As an author, I want to be able to distinguish quoted content from non-quote content so that I can check the status has been applied correctly.
As an author, I want to be able to see any attribution applied to a quote so that I can check this is correct.

Production staff

As production staff, I want to be able to designate a piece of content as a quote so that I can call it out for special display.
As production staff, I want to be able to edit a quote so that I can correct any errors.
As production staff, I want to be able to remove quote status from a piece of text so that I can turn it back to normal text.
As production staff, I want to be able to delete a quote so that I can correct any errors.
As production staff, I want to be able to set a type for a quote so that I can specify the kind of quote it is.
As production staff, I want to be able to change the type for a quote so that I can correct errors.
As production staff, I want to be able to move a quote to a specific point in the article so that I can increase the visual impact of the quote.
As production staff, I want to be able to add an attribution to a quote so that I can credit the original source.
As production staff, I want to be able to edit the attribution for a quote so that I can correct errors.
As production staff, I want to be able to remove the attribution for a quote so that I can correct errors.

But what if . . . ?

Consideration

These stories are written on the basis that a display-quote can contain any kind of content - paragraphs, tables, equations and so on. display-quote acts as a container for this content, to distinguish it from the non-quoted content around it.
At eLife, our Features team needs the ability to place a quote, edit it and move it if the placement needs updating. This has implications for the generation of article PDFs.
At eLife, we use disp-quote for pull quotes in Feature articles and in the author response sub-article to capture quotes from the decision letter sub-article.

XML requirements

Display quotes are captured in the element disp-quote.

<disp-quote>
    <p>Biological concepts – no matter how loosely defined – are always embedded in broader theoretical perspectives on how nature works.</p>
</disp-quote>

PKP example:

<p>
    <disp-quote id="dispquote8">
        <p>Display Quote <italic>Italic text</italic></p>
    </disp-quote>
</p>

Erudit examples:

<disp-quote content-type="example">
        <label>3</label>
          <p>…les standards sont encore une fois si bas, on se contente d’un français
          médiocre, entrecoupé par des expressions et même des phrases en anglais, ce qui prouve le
          manque d’aisance en français…</p>
</disp-quote>

<disp-quote content-type="epigraph">
    <p>Un jour, tout sera bien, voilà notre espérance :</p>
    <p>Tout est bien aujourd’hui, voilà l’illusion.</p>
    <attrib>Voltaire, <italic>Le désastre de Lisbonne</italic></attrib>
  </disp-quote>

In eLife content disp-quote can be captured as a child of:

body
sec

eLife allows the following child elements:

p
attrib

A @content-type attribute should be allowed for extra semantic capture. Examples include following values (which are essential for Érudit):

content-type="verbatim"
content-type="dedication"
content-type="epigraph"
content-type="example"
content-type="editor-report"

This should be set up in the configuration.

Érudit allows the following children of disp-quote (including all variations):

attrib
verse-group
disp-quote
fig
graphic
list
def-list
disp-formula
disp-formula-group
table-wrap
p

Mock ups

Proposal

fabiobatalha commented 5 years ago

@JGilbert-eLife

Last minute considerations. In some of our articles we have grouped examples, as for example:

<disp-quote content-type="group">
    <disp-quote content-type="example">
            <label>1</label>
            <p>example 1</p>
    </disp-quote>
    <disp-quote content-type="example">
            <label>2</label>
            <p>example 2</p>
    </disp-quote>
</disp-quote>