elifesciences / schematron-wiki

This contains the markdown from gitbook for schematron.
MIT License
2 stars 0 forks source link

Create article assets page #135

Closed naushinthomson closed 4 years ago

naushinthomson commented 4 years ago

Definition of done

JGilbert-eLife commented 4 years ago

@FAtherden-eLife - probably a question for you: am I remembering correctly that we want the IDs for Chemical structures and Schema to be c1 and s1 respectively, but they're stuck as C1 and S1 due to Kriya?

Also, both currently used elife-12345-fig1 style filenames for the main text but e.g. elife-57824-app1-chem1 in the appendices. I presume our preference would be to make this consistent as elife-12345-chem1 and elife-12345-scheme1 for the main text too?

fred-atherden commented 4 years ago

@JGilbert-eLife yeah, we're stuck with what we have for Kriya 1. What we want in Kriya 2 is:

There's a ticket open for this on the Kriya 2 board.

Also, both currently used elife-12345-fig1 style filenames for the main text but e.g. elife-57824-app1-chem1 in the appendices. I presume our preference would be to make this consistent as elife-12345-chem1 and elife-12345-scheme1 for the main text too?

Yeah, I agree, consistency would be best.

JGilbert-eLife commented 4 years ago

Ta! I realised my mistake with the labels just now!

JGilbert-eLife commented 4 years ago

@naushinthomson @FAtherden-eLife @bcollins14 @Melissa37 - OK, I've completed the list of allowed assets. I don't think we need much else on this page, do we?

fred-atherden commented 4 years ago

A full stop is needed at the end of almost all labels. Should we include the full stops in the tables here?

fred-atherden commented 4 years ago

I think it would be helpful to provide a few of XML examples on this page, even though they're likely to be included elsewhere as well.

fred-atherden commented 4 years ago

I think (in rare cases) we also allow Audio file 1?

[Edit: or at least have done in the past]

fred-atherden commented 4 years ago

If we want to add audio file 1, I'll very likely need to update the Schematron I think.

fred-atherden commented 4 years ago

Do we need to include inline-graphics in this page too?

Melissa37 commented 4 years ago

The term 'asset' refers to a figure, video, table or file associated with an article. These items are used to enhance the text of the article, providing illustration, raw data or the means to replicate the research.

Needs comma before the 'or'?

Melissa37 commented 4 years ago

eLife is relatively unique in allowing multiple supplements to 'top level' assets in order to provide more information to a reader. For example, a figure may be supplemented with additional sub-figures (figure supplements), source data files and/or videos.

Oxford comma required?

Melissa37 commented 4 years ago

The following assets appear within the main text of an article. Most of these should be placed after the paragraph in which their first citation in the text appears

I wonder whether it could be made clearer that a sub-asset is always grouped/part of its parent.

Melissa37 commented 4 years ago

The following assets are allowed with boxes.

Would it be clearer to say 'within" instead of "with"?

Melissa37 commented 4 years ago

Is it worth putting some XML examples at the bottom?

Melissa37 commented 4 years ago

Looks good! Thanks :-)

JGilbert-eLife commented 4 years ago

OK, I've updated this page in response to the comments and have added XML samples. Let me know if I've missed anyone's favourite forty-asset pile-up for those!

@FAtherden-eLife I've added audio files based on how we've handled them before. Are you happy with this?

fred-atherden commented 4 years ago

Thanks @JGilbert-eLife, looks good. Only question left from my perspective is this one.

JGilbert-eLife commented 4 years ago

Ah! Yes, sorry, I think I was under the impression that we'd discussed that and decided not to include them, but I suspect I was thinking of another context. Let me add those in ASAP.

[EDIT: sorted]

fred-atherden commented 4 years ago

Thanks!

naushinthomson commented 4 years ago

Looks good to me!

bcollins14 commented 4 years ago

Thanks! It looks very swish, love the table usage 👍