rootstock icon indicating copy to clipboard operation
rootstock copied to clipboard
verified publisher icon manubot

webpage: consider adding a header, footer, etcetera for navigation, branding, and metadata

Open dhimmel opened this issue 6 years ago • 2 comments

Currently, HMTL manuscripts appear without a header or footer (example):

image

Note the frontmatter text which contains some content that is not the manuscript and may fit in one of the following elements:

  • header: a band on the top of the page
  • footer: a band on the bottom of the page
  • table: some element elsewhere that links metadata keys to values

@vincerubinetti and I brainstormed different pieces of content that might fit in any of the above elements. In parentheses are possible locations where the content would fit, which are just ideas and not final. We don't need all 3 elements necessarily.

First, pieces of information currently not available from the HMTL manuscript:

  1. manuscript source homepage, e.g. https://greenelab.github.io/meta-review/ (table, footer)
  2. copyright information, e.g. CC BY declaration. (table, footer)
  3. PDF link (header, table)
  4. link to the version directory to see a list of manuscript versions, e.g. https://greenelab.github.io/meta-review/v/, page does not exist yet. (header)
  5. software versions. see https://github.com/manubot/rootstock/issues/282#issuecomment-559564472 (table, footer)
  6. manubot branding such as a the logo or "made with manubot" (header, footer)

Second, pieces of information available in manuscript currently that maybe should be relocated:

  1. link to repo at source commit, e.g. "generated from" (table, footer)
  2. permalink to the versioned HTML (header, footer, table, also hotkey)
  3. date generated on (table, footer, header). Possibly switching to multiple dates: built on, edited on (better than built on for citation date).

dhimmel avatar Dec 02 '19 19:12 dhimmel

I see a lot of this information being useful to include in a header or footer. We should make it easy to disable so that if authors submit their PDFs to preprint servers like bioRxiv that automatically add a header the Manubot information isn't overwritten.

agitter avatar Dec 03 '19 12:12 agitter

Once we have a header / footer / table design for the HTML, we can decide which parts (if any) we want to retain while printing to PDF.

dhimmel avatar Dec 03 '19 14:12 dhimmel