New Ways of Publishing: A Roadmap to Authoring Online Training Material

This website provides a set of guidelines to publish online training material using state-of-the-art web authoring tools, and also serves as an example authored using the Jupyter Book framework for producing documents from computational content. It has been prepared as a deliverable of the TAILOR Network of Trustworthy AI through Integrating Learning, Optimisation and Reasoning as part of Work Package 9: Network Collaboration, and is made freely available to the academic community.

These new authoring and formatting tools give rise to new ways of working and publishing. For example, Jupyter Notebooks1 can be used in teaching, for self-study, as lab notebooks, for research collaborations, and in a host of other ways. But there are many other recent developments that open further avenues for authoring and publishing dynamic and interactive training material. Knowing about these developments and opportunities helps academic writers to publish their training material in the best possible forms.

This roadmap therefore has twin objectives:

• to chart the ever-growing landscape of publishing workflows, formatting tools and authoring tools;

• to provide some itineraries through this landscape, such as converting an existing LaTeX Beamer presentation to Quarto.

The companion website https://tailor-uob.github.io/training-material/ shows the rendered results. The content can be viewed in a variety of ways, following the Single-In-Multi-Out paradigm.

Who should read this

We prepared this material for an audience with experience in authoring AI-related training material using well-established tools such as LaTeX, Overleaf, Google Docs etc. You will learn about the latest tools and frameworks such as Jupyter Book and Quarto. These tools make it easier to deliver content in a variety of ways, and also offer the opportunity to add interactive elements. We give examples of possible workflows to get you started.

How to read this

The structure of the document is fairly self-explanatory.

• If your main experience is with tools such as LaTex and Google Docs, you probably want to read the whole document.

• If you already have experience with Jupyter Book and the markdown format, you may want to skip to Formatting tools which describes the most recent developments, and follow on from there with the From static and dynamic to interactive content section which gives many examples of static, dynamic and interactive content.

• If you are particularly interested in how to produce Quarto content, head to Some itineraries through the landscape which provides concrete use cases of authoring training material using Quarto, the rendered output of which can be viewed on the companion website.

The full table of contents is given in the panel on the left, each element of which is a separate webpage. You can step through these pages in order by following the Next link at the bottom of each page. If the page has an internal heading structure this is indicated in a panel on the top-right. The Jupyter Book button at the top downloads the entire website as a single PDF file.

Note

This is a near-final draft currently under review.

---

1

Jupyter Book and Jupyter Notebook are related but different, see Dynamic content.