Boxes

[fred-atherden]

Boxes are more common in Feature content than research content but have been known to occur in both kinds of article.

User Stories

Author

• [ ] As an author, I want to be able see box content for my article so that I can check this is correct
• [ ] As an author, I want to be able to add a box to my article so that I can include information to support the main text.
• [ ] As an author, I want to be able to add a title, text and sub-headings to the box so that I can add content.
• [ ] As an author, I want to be able to cite assets and references in the text in a box so that I can refer to other articles or content.
• [ ] As an author, I want to be able to add a list to a box so that I can organise the content.
• [ ] As an author, I want to be able to add an attribution to a box so that I can give credit for the content.
• [ ] As an author, I want to be able to edit the attribution for a box so that I can correct errors.
• [ ] As an author, I want to be able to remove the attribution from a box so that I can correct errors.
• [ ] As an author, I want to be able to convert a piece of information to a box so that I can set it as information to support the main text.

Production staff

• [ ] As production staff, I want to be able to add a figure to a box so that I can illustrate the content.
• [ ] As production staff, I want to be able to remove a figure from a box on behalf of an author so that I can correct any errors.
• [ ] As production staff, I want to be able to add a table to a box so that I can include data.
• [ ] As production staff, I want to be able to remove a table from a box on behalf of an author so that I can correct any errors.
• [ ] As production staff, I want to be able to add permissions information to a box so that I can accommodate content that must be published under a license different from the article-level license.
• [ ] As production staff, I want to be able to edit the permissions information associated with a box so that I can correct errors.
• [ ] As production staff, I want to be able to remove permissions information from a box so that I can correct errors.
• [ ] As production staff, I want to be able to add multiple sets of permissions information (copyright statements and license paragraphs) to a box so that I can properly license content compiled from multiple sources.
• [ ] As production staff, I want to be able to remove a box from an article so that I can correct errors.
• [ ] As production staff, I want to be able to edit the label for a box so that I can correct any errors.

But what if . . . ?

Considerations

• Boxes are contained bits of content that act as asides to the main text. They can contain figures and multiple sections.
• Figures and tables within boxes should have the same functionality as figures in the main article, see #38, #46.
• Boxes can have a label, which should probably be automatically generated; however it's possible that an article may include both labelled and unlabelled boxes, so an ability to chose whether a label is applied and to edit the label will likely be required.
• At eLife, boxes and figures/tables in boxes follow this labelling scheme:
  • Box 1
  • Box 1—figure 1
  • Box 1—table 1
  • Box 2
  • Box 2—figure 1
  • Box 2—figure 2
• eLife Insights contain a use of boxed text, an unlabelled box containing the bibliographical information for the related research articles. This is in contrast to our normal use of boxes, where every box is assigned a label.

• eLife allows boxes at different widths in the PDFs for its articles (e.g. page width, column width, half-column width).

XML requirements

<boxed-text>
  <p>...</p>
  <sec>...</sec>
    <p>...</p>   
  <fig>...</fig>
</boxed-text>

eLife allows the following child elements:

• p
• label
• caption
• sec
• list
• table-wrap
• fig
• permissions
• fig-group
• media

Example of permissions for boxed-text

<boxed-text id="box2">
    <object-id pub-id-type="doi">10.7554/eLife.27041.004</object-id>
    <label>Box 2:</label>
    <caption>
        <p>On Exactitude in Science. Jorge Luis Borges (1946)</p>
    </caption>
    <p>“.. . In that Empire, the Art of Cartography attained such Perfection that the map of a
        single Province occupied the entirety of a City, and the map of the Empire, the entirety of
        a Province. In time, those Unconscionable Maps no longer satisfied, and the Cartographers
        Guilds struck a Map of the Empire whose size was that of the Empire, and which coincided
        point for point with it. The following Generations, who were not so fond of the Study of
        Cartography as their Forebears had been, saw that that vast map was Useless, and not without
        some Pitilessness was it, that they delivered it up to the Inclemencies of Sun and Winters.
        In the Deserts of the West, still today, there are Tattered Ruins of that Map, inhabited by
        Animals and Beggars; in all the Land there is no other Relic of the Disciplines of
        Geography.”</p>
    <p>Purportedly from Suárez Miranda, Travels of Prudent Men, Book Four, Ch. XLV, Lérida, 1658.</p>
    <permissions>
        <copyright-statement>© 1998 Maria Kodama; translation © 1998 Penguin Random House LLC.</copyright-statement>
        <copyright-year>1998</copyright-year>
        <copyright-holder>Maria Kodama</copyright-holder>
        <copyright-holder>Penguin Random House LLC.</copyright-holder>
        <license>
            <license-p>&#x00022;On Exactitude in Science&#x00022; from Collected Fictions: Volume 3 by
                Jorge Luis Borges, translated by Andrew Hurley. Used by permission of Viking Books,
                an imprint of Penguin Publishing Group, a division of Penguin Random House LLC. All
                rights reserved.</license-p>
        </license>
    </permissions>
</boxed-text>

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

[NickDuf]

See inVision design proposal