diff --git a/README.org b/README.org index 77fa3fd..ed10586 100644 --- a/README.org +++ b/README.org @@ -5,9 +5,43 @@ 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. +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: -To see how this works check out both the thesis pdf under [[./thesis/thesis.pdf]] and an individual manuscript as a standalone under [[./research-chapter/manuscript.pdf]]. +- 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 thesis pages: +#+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 diff --git a/screenshots/manuscript-example.png b/screenshots/manuscript-example.png new file mode 100644 index 0000000..5bb3936 Binary files /dev/null and b/screenshots/manuscript-example.png differ diff --git a/screenshots/thesis-example.png b/screenshots/thesis-example.png new file mode 100644 index 0000000..4921e4d Binary files /dev/null and b/screenshots/thesis-example.png differ