Skip to content
Snippets Groups Projects
Verified Commit a112ee05 authored by ck85nori's avatar ck85nori :railway_track:
Browse files

updates pandoc papers

parent 9f5ae7cc
No related branches found
No related tags found
No related merge requests found
...@@ -10,7 +10,6 @@ pandoc-papers.pdf: pandoc-papers.md ...@@ -10,7 +10,6 @@ pandoc-papers.pdf: pandoc-papers.md
-V institute=iDiv \ -V institute=iDiv \
-V theme=Frankfurt \ -V theme=Frankfurt \
-V navigation=horizontal \ -V navigation=horizontal \
-V titlegraphic=img/idiv-black.png \
-V logo=img/idiv-black-logo.png \ -V logo=img/idiv-black-logo.png \
--pdf-engine=xelatex \ --pdf-engine=xelatex \
-s \ -s \
......
...@@ -5,7 +5,8 @@ author: ...@@ -5,7 +5,8 @@ author:
- Christian Krause - Christian Krause
... ...
# intro intro
=====
## motivation ## motivation
...@@ -23,16 +24,17 @@ author: ...@@ -23,16 +24,17 @@ author:
## agenda ## agenda
- short presentation - short presentation including demo
- demo
- tool installation - tool installation
- your first project - your first project
- learn tools and workflows - learn tools and workflows
- establish community - establish community
# tools
## pandoc tools
=====
## pandoc -- Swiss Army Knife of Text Conversion
### source: markup ### source: markup
...@@ -97,22 +99,22 @@ author: ...@@ -97,22 +99,22 @@ author:
### make ### make
- glues everything together - glues everything together
- automated build - automates build
- render images from **dot** and **CSV** sources - render images from **dot** and **CSV** sources
- build PDF - build PDF
- run spell check - run spell check
# workflow
workflow
========
## workflow #1 ## 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
- use **pandoc papers** project template - project template is managed by our community
- project template is managed by our community - contains Makefile, README, themes, CD, etc.
- contains Makefile, README, themes, CD, etc.
- add contributors / collaborators
### writing ### writing
...@@ -123,29 +125,29 @@ author: ...@@ -123,29 +125,29 @@ author:
### communication ### communication
- add contributors / collaborators to GitLab project
- use GitLab project as main communication platform - use GitLab project as main communication platform
- discuss and review in - discuss and review in
- commit comments - commit comments
- issues - issues
- merge requests - merge requests
- invite collaborators: send link to GitLab project
## workflow #3 ## workflow #3
### continuous deployment ### continuous deployment
- some parts are done automatically with the project template
- deploy PDF to cloud storage: - deploy PDF to cloud storage:
[https://portal.idiv.de/nextcloud/](https://portal.idiv.de/nextcloud/) [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 ## community #1
...@@ -163,6 +165,15 @@ author: ...@@ -163,6 +165,15 @@ author:
## community #2 ## 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 ### prose diff tool
- these issues might help: - these issues might help:
...@@ -180,7 +191,7 @@ author: ...@@ -180,7 +191,7 @@ author:
- repository with \LaTeX\ templates for pandoc - repository with \LaTeX\ templates for pandoc
- **review-able** PDF template with link to join discussion at every paragraph - **review-able** PDF template with link to join discussion at every paragraph
## community #3 ## community #4
### helpful commands ### helpful commands
...@@ -192,7 +203,7 @@ git diff -w --ignore-blank-lines --word-diff ...@@ -192,7 +203,7 @@ git diff -w --ignore-blank-lines --word-diff
watchexec -w paper.md -- make paper.pdf watchexec -w paper.md -- make paper.pdf
``` ```
## community #4 ## community #5
### [https://git.idiv.de/publishing](https://git.idiv.de/publishing) ### [https://git.idiv.de/publishing](https://git.idiv.de/publishing)
...@@ -200,9 +211,9 @@ watchexec -w paper.md -- make paper.pdf ...@@ -200,9 +211,9 @@ watchexec -w paper.md -- make paper.pdf
- contribute to pandoc templates - contribute to pandoc templates
- contribute to bibliography - contribute to bibliography
# demo
# your turn your turn
=========
## discussion ## discussion
...@@ -225,6 +236,7 @@ watchexec -w paper.md -- make paper.pdf ...@@ -225,6 +236,7 @@ watchexec -w paper.md -- make paper.pdf
- xspell - xspell
- graphviz - graphviz
- R - R
- for Windows: use [chocolatey](https://chocolatey.org/install)
### editor ### editor
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment