Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use of boxed-text for piece of texts #542

Closed
fabiobatalha opened this issue May 25, 2018 · 12 comments
Closed

Use of boxed-text for piece of texts #542

fabiobatalha opened this issue May 25, 2018 · 12 comments
Labels
erudit Érudit Issues feature-request A formal Texture feature specification

Comments

@fabiobatalha
Copy link
Collaborator

In some articles the authors highlight a piece of text for different purposes. It seems the boxed-text fits well for this need.

Sample of articles in Érudit:

References:

JATS Reference: https://jats.nlm.nih.gov/publishing/tag-library/1.2d1/element/boxed-text.html

Érudit Article:
@fabiobatalha
Copy link
Collaborator Author

Sample:

<boxed-text id="bx1">
    <sec>
        <title>Box 1 Use of antidepressants and suicidality in young individuals</title>
        <p>In 2004, the FDA made the decision to include a black box warning about the risk of suicidality associated with antidepressant use among individuals under 25 years of age<xref ref-type="bibr" rid="B26">26</xref>.</p>
        <p>Based on the fact that for the treatment of depressive disorders the number needed to treat (NNT) in this age group is at least 10 and the number needed to harm (number needed to harm, NNH) is 112, it was concluded that the benefits associated with the use of antidepressants outweigh the potential risks.</p>
    </sec>
    <attrib>source: .....</attrib>
</boxed-text>
<boxed-text id="bx1">
    <fig id="f12">
        <label>Figure</label>
        <caption>
            <title>Diagnostic algorithm for depressive episodes in children and adolescents</title>
        </caption>
        <graphic xlink:href="figure.jpg"/>
    </fig>
</boxed-text>

In the same way of <disp-quote> element, the <boxed-text> should support the element <attrib>

@michael
Copy link
Member

michael commented Jun 26, 2018

Would be good to fine out what the semantic uses are here. Like boxed-text is just a visual encoding. We can use the tag but I'd like to internally decide what this type of content means. I'm against wrapping fig elements in boxed text. That's strange semantics to me. Thoughts?

@Melissa37
Copy link
Collaborator

@michael we at eLife will need the ability for figures to be within boxes. This is different to the use case above, but it's the same basic requirement.
I'll get some examples

@Melissa37
Copy link
Collaborator

HI there, here is an elife example: https://elifesciences.org/articles/05519

@michael
Copy link
Member

michael commented Jul 24, 2018

@Melissa37 I'm not sure I understand the requirement for boxed figures. What's the difference of using a figure directly? It seems like a more visual clue. So we could also add some flag to the figure element like boxed="true" or more semantically highlighted="true" to make it appear differently.

@fabiobatalha boxed text is like a quote with a different style? Does the box have any semantical meaning or is it just visual?

@Melissa37
Copy link
Collaborator

@michael the figure in the box is part of/linked to this section of text (which is not directly a part of the main narrative). It's different to a figure within the main text as it's associated with the text in the box.

@obuchtala
Copy link
Member

obuchtala commented Sep 6, 2018 •
edited
Loading

Ok, understood. From the JATS specification:

Supplementary text that stands on its own or that is related to but not directly tied to material in the text, can be tagged using the element.

<boxed-text> seems to be kind of a mixture of <body>, <disp-quote> and <fig>. That means, it can have content with sections, and may have a caption, attribution and permissions.

@obuchtala
Copy link
Member

obuchtala commented Sep 6, 2018 •
edited
Loading

@Melissa37 @fabiobatalha would figures inside <boxed-text> be labeled using the labelling scheme of the main narrative, or independently, e.g. with an internal counter, or not at all?
Should it be possible to reference a 'boxed' figure from the main narrative?

@obuchtala
Copy link
Member

obuchtala commented Sep 6, 2018 •
edited
Loading

@Melissa37 the example you have provided suggests that boxes have a counter like tables, and can be referenced from the narrative.

@Melissa37
Copy link
Collaborator

Hi there

The XML of that example is old and wrong, but here is what we do:

                        <!-- UPDATE: DOI prefix removed from XML but must be added for display--> 
                        <object-id pub-id-type="doi">10.7554/eLife.00666.018</object-id>
                        <label>Box 2.</label>
                        <caption>
                            <p>Example of a large box</p>
                        </caption>
                        <p>This box contains a <xref ref-type="fig" rid="box2fig1">figure</xref>. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vel rhoncus lorem. Suspendisse posuere non enim vel tempor. Fusce quis sem sed nulla tincidunt faucibus. 
                            Vivamus dictum magna in ante porttitor faucibus. Aenean lobortis, sem in viverra dignissim, odio purus vestibulum libero, in eleifend lacus metus id tortor. Phasellus tincidunt
                            ipsum ut ornare hendrerit. Praesent lobortis consectetur egestas. Curabitur viverra lectus eu venenatis sagittis. Aliquam lobortis metus mauris, in tincidunt diam ullamcorper ac.
                            Phasellus sagittis, leo eget lacinia commodo, eros justo mattis eros, quis dapibus ipsum ex sit amet sapien. Quisque consequat arcu ut efficitur tincidunt. Ut convallis, 
                            ex maximus aliquam tempor, lorem elit fermentum ipsum, nec volutpat velit sem a lectus. Morbi sed mauris vel purus interdum consectetur dapibus vel velit. Nam pellentesque, 
                            ipsum vel euismod mattis, turpis augue mattis nunc, ac aliquam dolor massa non mi. Vestibulum sit amet elit a augue semper facilisis interdum quis nibh. Mauris consectetur 
                            nisi aliquam urna lobortis, eu efficitur nisl lobortis; <xref ref-type="bibr" rid="bib2">Bates et al., 2016</xref> and <xref ref-type="bibr" rid="bib32">Patterson et al., 2011</xref>.</p>
                        <fig id="box2fig1" position="float">
                            <!-- UPDATE: DOI prefix removed from XML but must be added for display--> 
                            <object-id pub-id-type="doi">10.7554/eLife.00666.036</object-id>
                            <label>Box 2—Figure 1.</label>
                            <caption>
                                <title>Box figure</title>
                            </caption>
                            <!--  NOTE: file type must be included in the file description. -->
                            <graphic mimetype="image" mime-subtype="tiff" xlink:href="elife-00666-box2-fig1.tif"/>
                            </fig>
                        <p>Donec rhoncus in odio non vulputate. Donec vitae enim at erat tincidunt tincidunt in nec arcu. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac 
                            turpis egestas. Aliquam id nunc id arcu maximus rutrum. Praesent bibendum nisl orci, ac sollicitudin purus aliquam in. Duis eu fermentum arcu. Fusce eget dolor augue. 
                            Nulla facilisi. Suspendisse eu nisl vitae neque ullamcorper imperdiet. Vestibulum ultrices vehicula nibh, a ullamcorper dui semper suscipit. Etiam in sem augue.</p>
                    </boxed-text>```

They have an internal count to the box.

@obuchtala
Copy link
Member

Ok. Thanks. This makes sense.

@obuchtala obuchtala added this to the 1.0.0 milestone Sep 6, 2018
@michael michael modified the milestones: 1.0.0, 2.0.0 Sep 9, 2018
@fabiobatalha fabiobatalha added the erudit Érudit Issues label Oct 31, 2018
@michael michael modified the milestones: 2.0, 3.0 Nov 8, 2018
@michael michael added feature-request A formal Texture feature specification and removed next labels Jan 21, 2019
@michael michael removed this from the 3.0 milestone Mar 19, 2019
@michael michael removed the proposal label Apr 17, 2019
@fabiobatalha
Copy link
Collaborator Author

Continue at: #1327

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
erudit Érudit Issues feature-request A formal Texture feature specification
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@michael @obuchtala @fabiobatalha @Melissa37