$$ \newcommand{\tp}{\thinspace .} $$

Directory and file structure

Hans Petter Langtangen [1, 2]

[1] Center for Biomedical Computing, Simula Research Laboratory
[2] Department of Informatics, University of Oslo

Dec 20, 2015


Table of contents

Directory structure
Principles and conventions
      Mathematical notation and newcommands
      Label conventions
      Programming style
      Degree of modularization
      Student guide (slides) style
      Style in exercises, problems, and projects
Assembling different pieces to a book
      Organization of a chapter
      Figures and source code
      Assembly of chapters to a book
Tools
      Making a new chapter
      Compiling the chapter to LaTeX and PDF
      Automatic spell checking
      Compiling the chapter to HTML
      Compiling the chapter to a notebook
      About figures when publishing HTML
      Compiling the book
Cross-referencing across chapters (or books)
Study guides and slides
      Slide directory
      Generating slides from running text
      Slides as IPython/Jupyter notebooks
      Compiling slides
      IPython/Jupyter notebooks
Writing in private repository while publishing in public
Book versions with and without solutions to exercises
      Password protected files
      Separating the source files from published documents
Special features for teaching material
      Admonitions
      Simple box
      Embedded interactive code
      Exercises
      Quote
      Quiz
      What about a video lecture?
References

This document describes the file structure of book projects. The setup can of course be used for proceedings and theses as well.