search

manubot / rootstock

Clone me to create your Manubot manuscript
https://manubot.github.io/rootstock/
Other
453 stars 178 forks source link

Fix author list when no author metadata is present #477

Closed miltondp closed 2 years ago

miltondp commented 2 years ago

This PR adds a small change in front-matter to fix the author list when no author metadata (ORCID, Github, Twitter, etc) is given for an author. Below, I show an example of the current code and problem in this manuscript:

image

As you can see, when metadata is no present for an author, an unnecessary line break is added leaving an empty blank line. This PR fixes this, producing this output:

image

AppVeyorBot commented 2 years ago

AppVeyor build 1.0.288 for commit 10b6db5c907c7276d0003aaa67c701b6421beaa1 is now complete.

Found 51 potential spelling error(s). Preview:content/02.delete-me.md:44:adipiscing content/02.delete-me.md:44:aliqua content/02.delete-me.md:44:amet content/02.delete-me.md:44:consectetur content/02.delete-me.md:44:dolore content/02.delete-me.md:44:eiusmod content/02.delete-me.md:44:elit content/02.delete-me.md:44:incididunt content/02.delete-me.md:44:ipsum content/02.delete-me.md:44:labore content/02.delete-me.md:44:Lorem content/02.delete-me.md:44:magna content/02...
The rendered manuscript from this build is temporarily available for download at:

miltondp commented 2 years ago

Another potential change is to add a new author in rootstock to add an example of this problem.

agitter commented 2 years ago

First we can discuss the desired behavior and then look at the code changes.

We originally didn't account for this behavior because Manubot considers the ORCID to be mandatory metadata. However, we can't control what users actually do, so it probably is a good idea to be more robust to violations of that requirement.

add a new author in rootstock to add an example of this problem

I do think we would still want to strongly encourage ORCIDs, so we do not need to modify the example manuscript.

miltondp commented 2 years ago

Good point, @agitter. I also think the code should be more robust to violations of the requirements. I agree with not changing the author list in rootstock.

miltondp commented 2 years ago

I've added the suggested changes. Find below the differences in the author list with and without this patch.

output

I've added the diff to metadata.yml below in case you want to test it.

Maybe it doesn't matter, but just in case, John Doe and Jane Roe have Github and/or Twitter accounts.

diff --git a/content/metadata.yaml b/content/metadata.yaml
index d24da43..beacc34 100644
--- a/content/metadata.yaml
+++ b/content/metadata.yaml
@@ -16,6 +16,9 @@ authors:
       - Department of Something, University of Whatever
     funders:
       - Grant XXXXXXXX
+  - name: Another Author
+    affiliations:
+      - Department of Whatever, University of Something
   - github: janeroe
     name: Jane Roe
     initials: JR
AppVeyorBot commented 2 years ago

AppVeyor build 1.0.289 for commit 04114b60f09c128fa99e4bc6789c924542e660ce is now complete.

Found 51 potential spelling error(s). Preview:content/02.delete-me.md:44:adipiscing content/02.delete-me.md:44:aliqua content/02.delete-me.md:44:amet content/02.delete-me.md:44:consectetur content/02.delete-me.md:44:dolore content/02.delete-me.md:44:eiusmod content/02.delete-me.md:44:elit content/02.delete-me.md:44:incididunt content/02.delete-me.md:44:ipsum content/02.delete-me.md:44:labore content/02.delete-me.md:44:Lorem content/02.delete-me.md:44:magna content/02...
The rendered manuscript from this build is temporarily available for download at:

AppVeyorBot commented 2 years ago

AppVeyor build 1.0.290 for commit 924d352101fb0a88bb33efe72f1863c4864b07c2 is now complete.

Found 51 potential spelling error(s). Preview:content/02.delete-me.md:44:adipiscing content/02.delete-me.md:44:aliqua content/02.delete-me.md:44:amet content/02.delete-me.md:44:consectetur content/02.delete-me.md:44:dolore content/02.delete-me.md:44:eiusmod content/02.delete-me.md:44:elit content/02.delete-me.md:44:incididunt content/02.delete-me.md:44:ipsum content/02.delete-me.md:44:labore content/02.delete-me.md:44:Lorem content/02.delete-me.md:44:magna content/02...
The rendered manuscript from this build is temporarily available for download at:

AppVeyorBot commented 2 years ago

AppVeyor build 1.0.291 for commit 75c45f007e28dbd8ff9e373db9fa69ba0b3f160a is now complete.

Found 51 potential spelling error(s). Preview:content/02.delete-me.md:44:adipiscing content/02.delete-me.md:44:aliqua content/02.delete-me.md:44:amet content/02.delete-me.md:44:consectetur content/02.delete-me.md:44:dolore content/02.delete-me.md:44:eiusmod content/02.delete-me.md:44:elit content/02.delete-me.md:44:incididunt content/02.delete-me.md:44:ipsum content/02.delete-me.md:44:labore content/02.delete-me.md:44:Lorem content/02.delete-me.md:44:magna content/02...
The rendered manuscript from this build is temporarily available for download at: