Website notes

[debruine]

Collated implementation guide PDF

• 1.1 Links to other pages in website: These currently render as qmd links, e.g. link to Support systems and processes at bottom of this page: https://recognition.ukrn-openresearch.ac.uk/guide-09-planning.html. IN PDF this is rendered as file:///C:/Users/bm907633/Downloads/guide-06-support.qmd. These links should render as html links, i.e. https://recognition.ukrn-openresearch.ac.uk/guide-06-support.html. This means that where pages are included in the PDF the links will go not to the relevant part of the PDF but to the web page. I think this is the best solution if you can apply a rule that will implement it
• 1.2 Title page: Add title page before table of contents. Title page components: UKRN logo: top left, suggest approx. x2 size of header logo but adjust for presentation) Title: Recognising and rewarding open research: implementation guide (middle of page)Copyright and license notice: © 2024 University of Bristol  (towards bottom of page)
• 1.3 UKRN logo in header: Remove
• 1.4 Copyright and licence in footer: Remove
• 1.5 Page numbers: Page numbers should appear on all pages after title page. only seem to appear on the first page of a GitHub page, I think because of the  copyright and licensing text in the footers.
• 1.6 Header font: Check all headers are in Roboto font. Level 1, 2 and 3 headers do not appear to be Roboto
• 1.7 Link to PDF: To display above left-hand side navigation bar. Use pink PDF graphic.

Individual guide page PDFs

• 2.1 Links to other pages in the website: Links to other pages in the website render as qmd links as described in 1.1. See e.g. link to maturity framework in first paragraph of https://recognition.ukrn-openresearch.ac.uk/resources/guide-intro.pdf. This gives the URL: https://recognition.ukrn-openresearch.ac.uk/resources/maturity-framework.qmd. These should render as html links to relevant web pages.
• 2.2 UKRN logo in header: Display on p. 1 only. Make slightly bigger if possible.
• 2.3 Title in header: This should read: Recognising and rewarding open research
• 2.4 Copyright and licensing in footer: Display on p. 1 only. Right justify both copyright and licensing to read: © University of Bristol. Licensed CC-BY
• 2.5 Page numbers: To display on all pages after p. 1

Case study PDFs

• 3.1 Links to other pages in website: These to render as .html links as per 1.1
• 3.2 UKRN logo in header: Display on p. 1 of guide only. Make slightly bigger if possible. As per 2.2.
• 3.3 Title in header: This should read: Recognising and rewarding open research
• 3.4 Copyright and licensing in footer: Display on p. 1 only. Right justify both copyright and licensing to read: © University of Bristol. Licensed CC-BY
• 3.5 Page numbers: To display on all pages after p. 1

Presentation

• 4.1 Icons for page PDF downloads in guide and case studies: Where there are page PDFs there is a larger pink icon at top to the right of the title, then under Other Links ‘This page as PDF’. See e.g. https://recognition.ukrn-openresearch.ac.uk/guide-02-leadership.html. My feeling is that we should avoid displaying links for the same thing in 2 separate styles on one page, so we could remove the Other Links link.
• 4.2 PDF icon colour: Pink or would aqua fit better? Can’t decide. Perhaps see what aqua looks like.
• 4.3 Other Links: Could this be renamed Downloads?  

[debruine]

• 1.1 I changed all links from "page.qmd" to "https://recognition.ukrn-openresearch.ac.uk/page.html" on pages that will be rendered as PDFs. This isn't ideal, but the only way to have a website also render as a PDF with working links
• 1.2 I added CC-BY because there was no license notice in that text, the logo is the best I can do for now

[debruine]

2.4/3.4: Different headers and footers on page 1 isn't straightforward and I can't justify the effort to figure it out (I've already spent several hours on it)

[debruine]

2.2/3.2 - A bigger logo is not actually possible (it starts to run into the top of the page)

All of the header issues can be solved if you want to learn a lot about how LaTeX headers work and add the appropriate code to the include-in-header option in the _quarto-guide.yml file, but it will take a LOT of expertise or time.

[debruine]

4.2: The PDF icon is at https://github.com/UKRN/OR4/blob/master/images/pdf.png and you can replace it with any image (don't have to be the same size, just same name).

You can control what image shows for the PDF download in https://github.com/UKRN/OR4/blob/master/www/style.scss (search for "pdf-full-download")

[debruine]

4.3: Not straightforwardly, but not much of an issue because of the change in 4.1

[robertd17]

Re 1.1. Some links in https://recognition.ukrn-openresearch.ac.uk/resources/guide-intro.pdf are not working, e.g. for text in first paragraph which is coded like this:

This introductory section explains the rationale for recognising and rewarding open research in the assessment of researchers, with reference to the open research and responsible research assessment agendas that have evolved in recent years. It can be used as a reference text for a group of stakeholders undertaking a self-assessment exercise using the OR4 maturity framework

The links in the web page work fine, but in the PDF they are rendered as e.g. https://recognition.ukrn-openresearch.ac.uk/resources/glossary.html#recognition-and-reward - there is a 'resources/' inserted between 'https://recognition.ukrn-openresearch.ac.uk/' and 'glossary.html.

This also happens in the collated PDF, e.g. links in https://recognition.ukrn-openresearch.ac.uk/guide-contents.html work from the web page but not the PDF, e.g. in first paragraph the link https://recognition.ukrn-openresearch.ac.uk/maturity-framework.html becomes in the PDF https://recognition.ukrn-openresearch.ac.uk/guide/maturity-framework.html