Generating PDF artefacts of the website

Authors: orcid logoAvatarBérénice Batut
Overview
Questions:
  • How to generate PDF of the different tutorials and slides?

Objectives:
  • Generating PDFs

Time estimation: 10 minutes
Supporting Materials:
Last modification: Oct 20, 2022
License: Tutorial Content is licensed under Creative Commons Attribution 4.0 International License The GTN Framework is licensed under MIT

Introduction

The website with the training material can be run locally. Sometimes, it is also interesting to freeze the tutorials or to get PDFs of the tutorials.

Agenda

In this tutorial, you will learn how to run a local instance of the GTN website:

  1. Introduction
  2. Generate PDFs artifact

Generate PDFs artifact

To generate the PDFs, a command make pdf is given. This command:

  • Launches a detached Jekyll server to serve the website
  • Generates the PDFs of the tutorials by calling Chrome via command line
  • Generates the PDFs of the slide decks by calling decktape
Hands-on: Checking the website generation locally
  1. Install a browser
  2. Generate the PDFs: make pdf
  3. Check the generated PDFs in _pdf folder
Key points
  • PDFs can be easily generated for the different tutorials to share with learnees or to keep a fixed version of a tutorial

Frequently Asked Questions

Have questions about this tutorial? Check out the tutorial FAQ page or the FAQ page for the Contributing to the Galaxy Training Material topic to see if your question is listed there. If not, please ask your question on the GTN Gitter Channel or the Galaxy Help Forum

Feedback

Did you use this material as an instructor? Feel free to give us feedback on how it went.
Did you use this material as a learner or student? Click the form below to leave feedback.

Click here to load Google feedback frame

Citing this Tutorial

  1. Bérénice Batut, Generating PDF artefacts of the website (Galaxy Training Materials). https://training.galaxyproject.org/training-material/topics/contributing/tutorials/generating-pdf/tutorial.html Online; accessed TODAY
  2. Batut et al., 2018 Community-Driven Data Analysis Training for Biology Cell Systems 10.1016/j.cels.2018.05.012



@misc{contributing-generating-pdf,
author = "Bérénice Batut",
title = "Generating PDF artefacts of the website (Galaxy Training Materials)",
year = "",
month = "",
day = ""
url = "\url{https://training.galaxyproject.org/training-material/topics/contributing/tutorials/generating-pdf/tutorial.html}",
note = "[Online; accessed TODAY]"
}
@article{Hiltemann_2023,
	doi = {10.1371/journal.pcbi.1010752},
	url = {https://doi.org/10.1371%2Fjournal.pcbi.1010752},
	year = 2023,
	month = {jan},
	publisher = {Public Library of Science ({PLoS})},
	volume = {19},
	number = {1},
	pages = {e1010752},
	author = {Saskia Hiltemann and Helena Rasche and Simon Gladman and Hans-Rudolf Hotz and Delphine Larivi{\`{e}}re and Daniel Blankenberg and Pratik D. Jagtap and Thomas Wollmann and Anthony Bretaudeau and Nadia Gou{\'{e}} and Timothy J. Griffin and Coline Royaux and Yvan Le Bras and Subina Mehta and Anna Syme and Frederik Coppens and Bert Droesbeke and Nicola Soranzo and Wendi Bacon and Fotis Psomopoulos and Crist{\'{o}}bal Gallardo-Alba and John Davis and Melanie Christine Föll and Matthias Fahrner and Maria A. Doyle and Beatriz Serrano-Solano and Anne Claire Fouilloux and Peter van Heusden and Wolfgang Maier and Dave Clements and Florian Heyl and Björn Grüning and B{\'{e}}r{\'{e}}nice Batut and},
	editor = {Francis Ouellette},
	title = {Galaxy Training: A powerful framework for teaching!},
	journal = {PLoS Comput Biol} Computational Biology}
}

                   

Congratulations on successfully completing this tutorial!
Developing GTN training material
This tutorial is part of a series to develop GTN training material, feel free to also look at:
  1. Creating a new tutorial
  2. Contributing with GitHub via command-line
  3. Creating Slides
  4. Overview of the Galaxy Training Material
  5. Tools, Data, and Workflows for tutorials
  6. Running the GTN website online using GitPod
  7. GTN Metadata
  8. Generating PDF artefacts of the website
  9. Updating diffs in admin training
  10. Principles of learning and how they apply to training and teaching
  11. Running the GTN website locally
  12. Design and plan session, course, materials
  13. Teaching Python
  14. Contributing with GitHub via its interface
  15. Adding auto-generated video to your slides
  16. Including a new topic
  17. Creating content in Markdown
  18. Adding Quizzes to your Tutorial
  19. Creating Interactive Galaxy Tours