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.

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

Simplifying authors.tsv to manuscript conversion #7

Closed
dhimmel opened this issue Jul 7, 2017 · 2 comments
Closed

Simplifying authors.tsv to manuscript conversion #7

dhimmel opened this issue Jul 7, 2017 · 2 comments

Comments

@dhimmel
Copy link
Member

dhimmel commented Jul 7, 2017

Currently author parsing is disabled in this repo. I'm thinking of simplifying the TSV format and how it gets added to the manuscript. Basically, here would be the columns:

  • github_username
  • full_name
  • initials (possibly)
  • orcid
  • affiliations
  • funding
  • email
  • symbols (superscript symbols to add next to name). Could be symbol for corresponding or contributed equally. Or anything. The symbols would be manually defined in the mardown doc.

I was thinking of removing the approve column, and going for each author submits a PR to add their name, hence approving.

Unlike the system for the deep review, the build system, would not try to condense affiliations or funding across authors. In other words, each author would get their details printed next to their name. There would be more duplication of text, but this system will be more reliable. Additionally, we may eventually move to putting much of this info in tooltips for the HTML version.

@agitter what do you think. Feel free to disagree!

@dhimmel
Copy link
Member Author

dhimmel commented Jul 8, 2017

Another consideration is that we should fill out the pandoc author metadata as discussed in #4 (comment). We can do this through either a yaml_metadata_block or pandoc_title_block. It's still unclear to me whether we want the author details section automatically generated in pandoc or inserted as a section at the top of the manuscript. We should feel unconstrained here and do what causes the least technical problems, rather than say what produces the most canonical authorship section.

@agitter
Copy link
Member

agitter commented Jul 9, 2017

I support a simplified system. In deep-review I was working backwards, trying to automate a complicated process that I had been executing semi-manually. That made it harder (for me) to implement in a clean pandas style. I was also leaving room to extend that initial pull request to do things like more complicated multi-affiliation processing and author ordering. We don't want to support that here.

Initials can be derived fairly reliably. However, eventually there will be authors with the same initials so resolving that manually in the table could be a good idea.

Implicit approval by adding information to the table makes sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants