diff --git a/Makefile b/Makefile index 64f311334c4e730f4400477ffd222e37047e7ace..ea9486b7d520900722659880ab0cc7cb83fd1adb 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,6 @@ pandoc-papers.pdf: pandoc-papers.md -V institute=iDiv \ -V theme=Frankfurt \ -V navigation=horizontal \ - -V titlegraphic=img/idiv-black.png \ -V logo=img/idiv-black-logo.png \ --pdf-engine=xelatex \ -s \ diff --git a/pandoc-papers.md b/pandoc-papers.md index 6e4c38eb1cb6d5ca70aee94a3b04c49f8232b527..c8007c4d710a67500752e74e221cab855fceb26a 100644 --- a/pandoc-papers.md +++ b/pandoc-papers.md @@ -5,7 +5,8 @@ author: - Christian Krause ... -# intro +intro +===== ## motivation @@ -23,16 +24,17 @@ author: ## agenda -- short presentation -- demo +- short presentation including demo - tool installation - your first project - learn tools and workflows - establish community -# tools -## pandoc +tools +===== + +## pandoc -- Swiss Army Knife of Text Conversion ### source: markup @@ -97,22 +99,22 @@ author: ### make - glues everything together -- automated build +- automates build - render images from **dot** and **CSV** sources - build PDF - run spell check -# workflow + +workflow +======== ## workflow #1 -### project +### [set up new project in GitLab](https://git.idiv.de/projects/new) -- set up project in GitLab - - use **pandoc papers** project template - - project template is managed by our community - - contains Makefile, README, themes, CD, etc. -- add contributors / collaborators +- use **pandoc papers** project template +- project template is managed by our community +- contains Makefile, README, themes, CD, etc. ### writing @@ -123,29 +125,29 @@ author: ### communication +- add contributors / collaborators to GitLab project - use GitLab project as main communication platform - discuss and review in - commit comments - issues - merge requests -- invite collaborators: send link to GitLab project ## workflow #3 ### continuous deployment +- some parts are done automatically with the project template - deploy PDF to cloud storage: [https://portal.idiv.de/nextcloud/](https://portal.idiv.de/nextcloud/) -- use template with **DRAFT** watermark if commit not tagged +- uses **DRAFT** watermark if commit not tagged -### templates +## demo + +(demo here only if all tools are already installed) -- manage templates in our community -- keep in separate git repository -- use git sub-module to include -- share with all@idiv / world -# community +community +========= ## community #1 @@ -163,6 +165,15 @@ author: ## community #2 +### templates + +- manage templates in our community +- keep in separate git repository +- use git sub-module to include +- share with all@idiv / world + +## community #3 + ### prose diff tool - these issues might help: @@ -180,7 +191,7 @@ author: - repository with \LaTeX\ templates for pandoc - **review-able** PDF template with link to join discussion at every paragraph -## community #3 +## community #4 ### helpful commands @@ -192,7 +203,7 @@ git diff -w --ignore-blank-lines --word-diff watchexec -w paper.md -- make paper.pdf ``` -## community #4 +## community #5 ### [https://git.idiv.de/publishing](https://git.idiv.de/publishing) @@ -200,9 +211,9 @@ watchexec -w paper.md -- make paper.pdf - contribute to pandoc templates - contribute to bibliography -# demo -# your turn +your turn +========= ## discussion @@ -225,6 +236,7 @@ watchexec -w paper.md -- make paper.pdf - xspell - graphviz - R +- for Windows: use [chocolatey](https://chocolatey.org/install) ### editor