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

updates pandoc papers

parent 52d2f1e8
No related branches found
No related tags found
No related merge requests found
% 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
......
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