ubcgif / appliedgeophysics.org

1 stars 1 forks source link

publication statement in myst.yml #11

Open lheagy opened 1 month ago

lheagy commented 1 month ago

A question for @rowanc1 and @stevejpurves: would it be possible to include a publication_statement or similar in the myst.yml. Most journals require this when self-archiving. e.g. GJI requires a statement like the following

This is a pre-copyedited, author-produced PDF of an article accepted for publication in [insert journal title] following peer review. The version of record [insert complete citation information here] is available online at: xxxxxxx [insert URL that the author will receive upon publication here].

The exact verbage varies a little from journal to journal, but I wouldn't get too hung up on that. I suspect that we could automate this as long as the essential pieces are included: Journal Name, citation, doi. Or if for now, it is simpler just to manually enter the statement, that would work too.

stevejpurves commented 1 month ago

Hi @lheagy sounds like the best way to handle this to start with is to add it as a part in the main manuscript. Initially it will appear as is on the main content, but we can then add handling for that part to get it to where it should be placed.

would that live frontmatter section of the page (like above abstract) or in the backmatter, beside data availability? or in the sidebar?

+++ { "part": "publication_statement" }

This is a pre-copyedited, author-produced PDF of an article accepted for publication in [insert journal title] following peer review. The version of record [insert complete citation information here] is available online at: xxxxxxx [insert URL that the author will receive upon publication here].

+++

In terms of the myst.yml we are about to do some more dynamic parts handling where we can point to different sources (e..g files) for parts form the myst.yml. @rowanc1 have we also considered doing something to extend the "known parts" for a project e.g.?

project:
  parts:
    - name: publication_statement
      title: Publication Statement
      placement: backmatter
      class: ...
      content: pubstat.md      

cc @fwkoch

rowanc1 commented 1 month ago

There is a bit of a complication as @lheagy is writing in LaTeX, so parts are hard. Maybe we need a top level part, and that is the first way through?

lheagy commented 1 month ago

Thank you both! And sorry for my late reply here.

In terms of placement, I think it would be best if it is right above the abstract. I think it is important that it is upfront, as this is where journals request it.

Ideally, it would be great not to have to edit the source latex... but if we needed to point to a separate file that contains the needed markdown, that could work. e.g. in the myst.yml, pointing to a file publication_statement.md (this could actually be handy, as I would just create one template file per journal that we could copy-paste around)