Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dangom/org-thesis

Writing a Ph.D. thesis with Org Mode
https://github.com/dangom/org-thesis

Last synced: about 1 month ago
JSON representation

Writing a Ph.D. thesis with Org Mode

Awesome Lists containing this project

README 

        
#+TITLE: Org-thesis

#+AUTHOR: Daniel Gomez



* Introduction



This repository contains the skeleton of a Ph.D. thesis written in Org Mode. It does not aim to be an authoritative guide on writing thesis with Org Mode, i.e.,  it only represents the solution that I found most convenient within the time frame of my Ph.D.



The goal of this setup was to allow the seamless inclusion of research chapters into the thesis *without* having to modify the included files at all. In other words, chapters can live as standalone repositories with completely different export settings. In other words, this setup separates content from form and allows content to move freely between the thesis and a chapter. In order to achieve that, the setup relies on intermediate and possibly advanced Org features such as:



- Usage of org-local variables through =#+BIND=

- Usage of =#+INCLUDE= and multiple =#+SETUPFILE=

- Advanced usage of =#+INCLUDE= for partial file inclusion

- Usage of org-macros

- Reference management with org-ref

- References to equations via the =\label= and =eqref= combo from org-ref

- Aesthetical changes to the export engine such as table improvements

- Multiple documented =#+LATEX_HEADER=

- Extensive usage of the ox-extra =:ignore:= tag

- Selective use of the =#+EXCLUDE_TAGS= to power-up the =#+INCLUDE= mechanism

- Use of ox-latex properties such as =ALT_TITLE= and =UNNUMBERED= to modify the TOC

- Seamless usage of latex environments via Org mode blocks

- Definition of new =#+LATEX_CLASS= for the Org export

- The usage of =COMMENT= blocks for personal notes (differs from =:noexport:=!)

- Inclusion of a pretty much pure LaTeX title page into the Org document

- Export of src blocks with highlighting via minted all natively from Org Mode

- Showcase of the usage of figures and their captions

- Showcase on how to define new latex environments and access them from Org

- A series of documented commonly used LaTeX tricks in the setupfile



To see how an example of what the final pdf exports could look like check out both the thesis pdf under  [[./thesis/thesis.pdf]] and an individual manuscript as a standalone under [[./research-chapter/manuscript.pdf]]. Notice how the same content from the same file is used in both pdf exports and end up with completely different formatting.



* Mandatory Screenshots

Example Org file with content to be exported:

#+ATTR_HTML: :style margin-left: auto; margin-right: auto;

#+name: thesis-screenshot

#+caption: Screenshot of what the Org file look like.

[[screenshots/org-example.png]]



Content exported to thesis:

#+ATTR_HTML: :style margin-left: auto; margin-right: auto;

#+name: thesis-screenshot

#+caption: Screenshot of what thesis pages could look like.

[[screenshots/thesis-example.png]]



Same content but exported as manuscript:

#+ATTR_HTML: :style margin-left: auto; margin-right: auto;

#+name: thesis-screenshot

#+caption: Screenshot of what manuscript pages could look like.

[[screenshots/manuscript-example.png]]



* Installation & Requirements



You will need at least Emacs 26 and Org 9.2 for this to work because it relies on Org's #+INCLUDE derivative, which is broken for files containing relative paths and links in earlier versions. You will also need a recent version of LaTeX. Details on my LaTeX setup are described in the [[./latex-setup.org]] file in the root of this repository. The information was extracted automatically using =scimax-latex.el=. Information about scimax-latex is also described in the end of the latex setup file.

You will also need org-ref for links to equations and citations to work as expected.

And to compile the thesis as is you'd require the [[https://github.com/Pseudomanifold/latex-mimosis][mimosis]] latex class. It'll probably work if  you change class, but YMMV.



* Usage



More usage details can be found under [[https://write.as/dani/writing-a-phd-thesis-with-org-mode][this blog post.]] For more information, feel free to open an issue.



* Possible improvements



** Repository maybe tied to my class choices?



The setup files and LaTeX classes seen here are those that I use. It'd be nice to have a more minimalistic example that didn't require such dependencies.



** Bibliography management



Currently the bibliography management is not properly modular. I use Zotero for bibliography management and I have Zotero export a master file for the thesis and individual files for each chapter. It works well, but I cannot simply include a new chapter into the thesis without first adapting Zotero as well



** Manual management of lines to skip



For each included file, I skip LaTeX derivatives by constraining the number of lines to be included. This is manual work and couple probably be improved.