From 5be950507b6767f04f5862e1ae254aab4fbc5952 Mon Sep 17 00:00:00 2001 From: Christian Krause <christian.krause@idiv.de> Date: Tue, 7 May 2019 15:43:07 +0200 Subject: [PATCH] updates pandoc papers --- pandoc-papers.md | 56 +++++++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 27 deletions(-) diff --git a/pandoc-papers.md b/pandoc-papers.md index 72f575f..a08a076 100644 --- a/pandoc-papers.md +++ b/pandoc-papers.md @@ -1,17 +1,18 @@ -% pandoc papers +% pandoc papers workshop % Christian Krause # intro ## goals -- focus on content/writing -- version control -- next generation communication +- **focus** on content/writing +- use **version control** with all its benefits +- next generation **communication** - avoid emails with attachments, right? - - reviews! -- automated publishing + - early and frequent reviews improve quality +- **automated** publishing - high quality typesetting +- get rid of MS Word, Google Docs, Dropbox # tools @@ -20,11 +21,11 @@ ### source: markup - usually **Markdown** -- less powerful than LaTeX, but inline LaTeX can be used +- less powerful than \LaTeX, but inline \LaTeX\ can be used ### target**s** -- high quality PDF via LaTeX +- high quality PDF via \LaTeX - others: html, epub, docx, odt ### templates @@ -39,14 +40,14 @@ - **easy to learn**, read and write - no distractions to *procrastinate* -- inline LaTeX if needed: $a^2 + b^2 = c^2$ +- inline \LaTeX\ if needed, e.g. $a^2 + b^2 = c^2$ ### source ``` - **easy to learn**, read and write - no distractions to *procrastinate* -- inline LaTeX if needed: $a^2 + b^2 = c^2$ +- inline \LaTeX\ if needed, e.g. $a^2 + b^2 = c^2$ ``` ## git & GitLab @@ -68,14 +69,12 @@ - graph visualization language - define flowcharts with code -- **dot** handles rendering -- use **make** to build +- **dot** handles rendering to **SVG** ### R scripts - add results as CSV to repository - visualize data in CSV to charts -- use **make** to build ## make @@ -101,7 +100,7 @@ ### writing - start writing the main document in Markdown -- use good text editor you're comfortable with +- use text editor you're comfortable with ## workflow #2 @@ -129,17 +128,7 @@ - use git sub-module to include - share with all@idiv / world -# misc - -## helpful commands - -```bash -# better diff command for text -git diff -w --ignore-blank-lines --word-diff - -# watch source and build if changes -watchexec -w paper.md -- make paper.pdf -``` +# community ## community #1 @@ -147,11 +136,12 @@ watchexec -w paper.md -- make paper.pdf - `README.md` with instructions how to build - `Makefile` with general build instructions -- include pandoc LaTeX themes via sub-module +- include pandoc \LaTeX\ themes via sub-module - CD pipeline instructions - `main.md` with hello world document using includes for chapters - example **dot** file for flowchart - example **CSV** and **R script** to generate charts +- example **BibTeX** integration - `.gitignore` with default products ## community #2 @@ -170,9 +160,21 @@ watchexec -w paper.md -- make paper.pdf ### others -- repository with LaTeX templates for pandoc +- repository with \LaTeX\ templates for pandoc - **review-able** PDF template with link to join discussion at every paragraph +## community #3 + +### helpful commands + +```bash +# better diff command for text +git diff -w --ignore-blank-lines --word-diff + +# watch source and build if changes +watchexec -w paper.md -- make paper.pdf +``` + # your turn ## discussion -- GitLab