PDFs

UKRN · Oct 14, 2024 · 140355c · 140355c
1 parent 810d72b
commit 140355c
Show file tree

Hide file tree

Showing 28 changed files with 96 additions and 15 deletions.
diff --git a/.github/workflows/pdf.yaml b/.github/workflows/pdf.yaml
@@ -0,0 +1,38 @@
+name: Render PDFs
+# manual trigger
+on:
+  workflow_dispatch:
+
+jobs:
+  build-deploy:
+      runs-on: ubuntu-latest
+      permissions:
+        contents: write
+      steps:
+        - name: Check out repository
+          uses: actions/checkout@v4
+
+        - name: Set up Quarto
+          uses: quarto-dev/quarto-actions/setup@v2
+          with:
+            version: 1.5.57
+            tinytex: true
+
+        - name: Render individual PDFs
+          uses: quarto-dev/quarto-actions/render@v2
+          with:
+            to: pdf
+            target: gh-pages
+          env:
+            QUARTO_PROFILE: guide
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        - name: Render Guide PDF
+          uses: quarto-dev/quarto-actions/render@v2
+          with:
+            to: pdf
+            target: gh-pages
+            output: or4-guide.pdf
+          env:
+            QUARTO_PROFILE: pages
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/Makefile b/Makefile
@@ -1,5 +1,2 @@
 all: index.qmd
 	Rscript -e 'quarto::quarto_render(output_format="html", profile="website"); browseURL("docs/index.html")'
-
-pdf: guide-intro.qmd
-  Rscript -e 'quarto::quarto_render("guide-intro.qmd", output_format="pdf", profile="guide");'
diff --git a/R/pdf.R b/R/pdf.R
@@ -1,8 +1,15 @@
-# pages <- list.files(pattern = "(case-study|guide)-.*\\.qmd") |>
-#   setdiff("guide-contents.qmd")
-#
-# for (page in pages) {
-#   quarto::quarto_render(page, output_format = "pdf", profile = "guide")
-# }
+# individual pages
+pages <- list.files(pattern = "(case-study|guide)-.*\\.qmd") |>
+  setdiff("guide-contents.qmd")
 
-quarto::quarto_render(output_format = "pdf", profile = "guide")
+for (page in pages) {
+  quarto::quarto_render(page, output_format = "pdf", profile = "pages")
+}
+
+
+# full guide
+file.rename("guide/index.md", "index.md")
+quarto::quarto_render(output_format = "pdf",
+                      profile = "guide",
+                      output_file = "or4-guide.pdf")
+file.rename("index.md", "guide/index.md")
diff --git a/_quarto-guide.yml b/_quarto-guide.yml
@@ -1,9 +1,11 @@
 project:
-  output-dir: resources
+  output-dir: guide
+  type: book
+  title: A toolkit for recognising and rewarding open research
 
 book:
   chapters:
-  - guide-contents.qmd
+  - index.md
   - guide-summary.qmd
   - guide-intro.qmd
   - guide-01-commitment.qmd
@@ -19,13 +21,14 @@ book:
 
 format:
   pdf:
-    documentclass: article
-    toc: false
+    toc: true
     number-sections: false
     colorlinks: true
     include-in-header: pdf-header.tex
     margin-left: 20mm
     margin-right: 20mm
     margin-top: 30mm
     margin-bottom: 30mm
-    mainfont: Roboto
+#    mainfont: Roboto
+    output-file: "or4-guide"
+    output-ext:  "pdf"
diff --git a/_quarto_pages.yml b/_quarto_pages.yml
@@ -0,0 +1,15 @@
+project:
+  output-dir: resources
+
+format:
+  pdf:
+    documentclass: article
+    toc: false
+    number-sections: false
+    colorlinks: true
+    include-in-header: pdf-header.tex
+    margin-left: 20mm
+    margin-right: 20mm
+    margin-top: 30mm
+    margin-bottom: 30mm
+#    mainfont: Roboto
diff --git a/about.pdf b/about.pdf
diff --git a/case-studies.pdf b/case-studies.pdf
diff --git a/case-study-bristol.pdf b/case-study-bristol.pdf
diff --git a/glossary.pdf b/glossary.pdf
diff --git a/guide-01-commitment.pdf b/guide-01-commitment.pdf
diff --git a/guide-02-leadership.pdf b/guide-02-leadership.pdf
diff --git a/guide-03-strategy.pdf b/guide-03-strategy.pdf
diff --git a/guide-04-communication.pdf b/guide-04-communication.pdf
diff --git a/guide-05-policy.pdf b/guide-05-policy.pdf
diff --git a/guide-06-support.pdf b/guide-06-support.pdf
diff --git a/guide-07-training.pdf b/guide-07-training.pdf
diff --git a/guide-08-monitoring.pdf b/guide-08-monitoring.pdf
diff --git a/guide-09-planning.pdf b/guide-09-planning.pdf
diff --git a/guide-contents.pdf b/guide-contents.pdf
diff --git a/guide-intro.pdf b/guide-intro.pdf
diff --git a/guide-summary.pdf b/guide-summary.pdf
diff --git a/guide/index.md b/guide/index.md
@@ -0,0 +1,21 @@
+# Overview
+
+The implementation guide provides detailed guidance for institutions on implementing effective recognition and reward for open research in researcher assessment. It can be used by a group of stakeholders to develop a shared understanding of the rationale for recognising and rewarding open research practice and to explore different aspects of implementation in greater depth, in order to support informed planning and implementation. It can be consulted in conjunction with the [maturity framework](maturity-framework.qmd) and as part of an institutional self-assessment exercise.
+
+An [executive summary](guide-summary.qmd) provides a high-level overview of the context and rationale for strategic action and the main areas of implementation covered by the guide. This is a a useful one-pager for those who want a summary of the essentials.
+
+The introductory section, [Why recognise and reward open research practice?](guide-intro.qmd) explains the rationale for strategic action with reference to the wider sector context in more detail. This is a more developed treatment of the subject and can be used by members of a stakeholder group to establish a shared understanding and sense of purpose.
+
+The nine sections mapped to the action areas of the maturity framework are designed to enable members of the stakeholder group to develop a more in-depth understanding of the key areas in which action may be required, and to create a practical plan of action to develop institutional maturity. Links to [case studies](case-studies.qmd) illustrating different aspects of implementation are provided. 
+
+A [Glossary of key terms](glossary.qmd) is also included.
+
+Each of the nine main sections of the guide follows a standard format:
+
+- **Why is this important?**
+- **Maturity scale**: the maturity scale for this action area
+- **Progress actions**: suggested key actions to move from one level of the maturity scale to the next
+- **Main areas of activity**: in-depth guidance
+- **Case studies**: links to [case studies](case-studies.qmd) illustrating different aspects of implementation at UK institutions
+
+
diff --git a/guide/or4-guide.pdf b/guide/or4-guide.pdf
diff --git a/images/logos/.DS_Store b/images/logos/.DS_Store
diff --git a/maturity-framework.pdf b/maturity-framework.pdf
diff --git a/overview.pdf b/overview.pdf
diff --git a/resources/guide-04-communication.pdf → resources/OR4.pdf b/resources/guide-04-communication.pdf → resources/OR4.pdf
diff --git a/self-assessment.pdf b/self-assessment.pdf