diff --git a/Makefile b/Makefile index ec69fec63cc47162d46fc430442960c76165ff60..64f311334c4e730f4400477ffd222e37047e7ace 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,13 @@ pandoc-papers.pdf: pandoc-papers.md -V institute=iDiv \ -V theme=Frankfurt \ -V navigation=horizontal \ - -s pandoc-papers.md -t beamer -o pandoc-papers.pdf + -V titlegraphic=img/idiv-black.png \ + -V logo=img/idiv-black-logo.png \ + --pdf-engine=xelatex \ + -s \ + -t beamer \ + -o pandoc-papers.pdf \ + pandoc-papers.md all: subdirs diff --git a/img/idiv-black-logo.png b/img/idiv-black-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..489454819b1a5855a42c5538b3e48b57609fc539 Binary files /dev/null and b/img/idiv-black-logo.png differ diff --git a/img/idiv-black.png b/img/idiv-black.png new file mode 100644 index 0000000000000000000000000000000000000000..c6f1ac8765e12ea5654c2c088b661d978e4f8e6a Binary files /dev/null and b/img/idiv-black.png differ diff --git a/pandoc-papers.md b/pandoc-papers.md index 467935dea1f90ce75ee1db6c9a2c2554feae3325..6e4c38eb1cb6d5ca70aee94a3b04c49f8232b527 100644 --- a/pandoc-papers.md +++ b/pandoc-papers.md @@ -1,15 +1,19 @@ -% pandoc papers workshop -% Christian Krause +--- +title: pandoc papers +subtitle: a future proof way to write +author: +- Christian Krause +... # intro -## goals +## motivation - **focus** on content/writing - use **version control** with all its benefits -- next generation **communication** +- **communication** - avoid emails with attachments, right? - - early and frequent reviews improve quality + - early and frequent reviews - **automated** - spell checking - high quality typesetting @@ -17,6 +21,15 @@ - get rid of MS Word, Google Docs, Dropbox - **future proof** way of doing things +## agenda + +- short presentation +- demo +- tool installation +- your first project +- learn tools and workflows +- establish community + # tools ## pandoc @@ -29,7 +42,7 @@ ### target**s** - high quality PDF via \LaTeX -- others: html, epub, docx, odt +- others: html web page, epub, docx, odt ### templates @@ -39,19 +52,19 @@ ## Markdown -### rendered +### source +``` - **easy to learn**, read and write - no distractions to *procrastinate* - inline \LaTeX\ if needed, e.g. $a^2 + b^2 = c^2$ +``` -### source +### rendered -``` - **easy to learn**, read and write - no distractions to *procrastinate* - inline \LaTeX\ if needed, e.g. $a^2 + b^2 = c^2$ -``` ## git & GitLab @@ -79,14 +92,15 @@ - add results as CSV to repository - visualize data in CSV to charts -## make +## build tool -### simple build tool +### make - glues everything together - automated build - render images from **dot** and **CSV** sources - build PDF + - run spell check # workflow @@ -178,6 +192,16 @@ git diff -w --ignore-blank-lines --word-diff watchexec -w paper.md -- make paper.pdf ``` +## community #4 + +### [https://git.idiv.de/publishing](https://git.idiv.de/publishing) + +- contribute to project template +- contribute to pandoc templates +- contribute to bibliography + +# demo + # your turn ## discussion @@ -189,10 +213,25 @@ watchexec -w paper.md -- make paper.pdf - How do you communicate, collaborate and review? - What annoys you the most? (i.e. how can we improve) -## let's use it +## installation + +### tools + +- git +- pandoc, pandoc-citeproc +- \LaTeX +- make +- [watchexec](https://github.com/watchexec/watchexec/releases) +- xspell +- graphviz +- R + +### editor + +- Atom + +## workflow -- install tools -- install editor - set up git project - convert existing documents to Markdown - build with pandoc