diff --git a/paper.md b/paper.md index 0d98b927759c5de5dbb230aa14a10a4bff3960a8..5d7dbb021a3ff0fe2f501549d4761e7a0e8a0b11 100644 --- a/paper.md +++ b/paper.md @@ -1,17 +1,77 @@ -## branching model +% pandoc papers +% Christian Krause -### multi master +# intro + +## goals + +- focus on content/writing +- next generation communication + - avoid emails with attachments, right? + - reviews! +- automated publishing + +# tool overview + +## markdown + +- easy to learn, read and write +- no distractions to procrastinate +- no fiddling with WYSIWYG + +## git + +- version control +- free backup +- easy revert + +## GitLab + +- self-hosted, full control +- communication: discussion and reviews +- continuous deployment to e.g. cloud storage + +## pandoc + +- render markup source to high quality PDF +- markup usually less powerful than LaTeX, but inline LaTeX can be used +- supports templates e.g. for different journals or iDiv branding + +## make + +- automate build +- create images with visualization tools (see below) + +# optional tools + +## Graphviz/dot + +- graph visualization language +- define flowcharts with code +- **dot** handles rendering +- use **make** to automatically build + +## R scripts + +- turn scientific computing results (CSV) to charts +- use **make** to automatically build + +# branching model + +## multi master - paper with many journals, different paper text - one branch per journal - carefully **cherry-pick** additions to all masters -### trunk based development +## trunk based development - same paper text - different themes for journals - journal-themes via sub-module --> make them reusable +# misc + ## helpful commands Better diff command for text: @@ -19,3 +79,8 @@ Better diff command for text: ```bash git diff -w --ignore-blank-lines --word-diff ``` + +## unsolved problems + +- to wrap or not to wrap +- true paragraph-based diff