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

updates pandoc papers

parent 52d2f1e8
Branches
Tags
No related merge requests found
% pandoc papers % pandoc papers workshop
% Christian Krause % Christian Krause
# intro # intro
## goals ## goals
- focus on content/writing - **focus** on content/writing
- version control - use **version control** with all its benefits
- next generation communication - next generation **communication**
- avoid emails with attachments, right? - avoid emails with attachments, right?
- reviews! - early and frequent reviews improve quality
- automated publishing - **automated** publishing
- high quality typesetting - high quality typesetting
- get rid of MS Word, Google Docs, Dropbox
# tools # tools
...@@ -20,11 +21,11 @@ ...@@ -20,11 +21,11 @@
### source: markup ### source: markup
- usually **Markdown** - usually **Markdown**
- less powerful than LaTeX, but inline LaTeX can be used - less powerful than \LaTeX, but inline \LaTeX\ can be used
### target**s** ### target**s**
- high quality PDF via LaTeX - high quality PDF via \LaTeX
- others: html, epub, docx, odt - others: html, epub, docx, odt
### templates ### templates
...@@ -39,14 +40,14 @@ ...@@ -39,14 +40,14 @@
- **easy to learn**, read and write - **easy to learn**, read and write
- no distractions to *procrastinate* - 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 ### source
``` ```
- **easy to learn**, read and write - **easy to learn**, read and write
- no distractions to *procrastinate* - 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 ## git & GitLab
...@@ -68,14 +69,12 @@ ...@@ -68,14 +69,12 @@
- graph visualization language - graph visualization language
- define flowcharts with code - define flowcharts with code
- **dot** handles rendering - **dot** handles rendering to **SVG**
- use **make** to build
### R scripts ### R scripts
- add results as CSV to repository - add results as CSV to repository
- visualize data in CSV to charts - visualize data in CSV to charts
- use **make** to build
## make ## make
...@@ -101,7 +100,7 @@ ...@@ -101,7 +100,7 @@
### writing ### writing
- start writing the main document in Markdown - start writing the main document in Markdown
- use good text editor you're comfortable with - use text editor you're comfortable with
## workflow #2 ## workflow #2
...@@ -129,17 +128,7 @@ ...@@ -129,17 +128,7 @@
- use git sub-module to include - use git sub-module to include
- share with all@idiv / world - share with all@idiv / world
# misc # community
## 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 #1 ## community #1
...@@ -147,11 +136,12 @@ watchexec -w paper.md -- make paper.pdf ...@@ -147,11 +136,12 @@ watchexec -w paper.md -- make paper.pdf
- `README.md` with instructions how to build - `README.md` with instructions how to build
- `Makefile` with general build instructions - `Makefile` with general build instructions
- include pandoc LaTeX themes via sub-module - include pandoc \LaTeX\ themes via sub-module
- CD pipeline instructions - CD pipeline instructions
- `main.md` with hello world document using includes for chapters - `main.md` with hello world document using includes for chapters
- example **dot** file for flowchart - example **dot** file for flowchart
- example **CSV** and **R script** to generate charts - example **CSV** and **R script** to generate charts
- example **BibTeX** integration
- `.gitignore` with default products - `.gitignore` with default products
## community #2 ## community #2
...@@ -170,9 +160,21 @@ watchexec -w paper.md -- make paper.pdf ...@@ -170,9 +160,21 @@ watchexec -w paper.md -- make paper.pdf
### others ### 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 - **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 # your turn
## discussion ## discussion
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment