From d56956f0b915fcbc1158f7e6eca4b8fa6c7d82aa Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 3 Sep 2020 11:41:20 +0200 Subject: [PATCH] Add ADR-0005 (and fix lint at other ADR) --- ...0004-use-lualatex-for-correct-ligatures.md | 12 ++--- docs/adr/0005-use-pdflatex-as-default.md | 22 +++++++++ docs/adr/template.md | 45 +++++++++---------- 3 files changed, 49 insertions(+), 30 deletions(-) create mode 100644 docs/adr/0005-use-pdflatex-as-default.md diff --git a/docs/adr/0004-use-lualatex-for-correct-ligatures.md b/docs/adr/0004-use-lualatex-for-correct-ligatures.md index 67697058..902c78cd 100644 --- a/docs/adr/0004-use-lualatex-for-correct-ligatures.md +++ b/docs/adr/0004-use-lualatex-for-correct-ligatures.md @@ -13,9 +13,9 @@ See also the last lines in . ### More readings -- -- Questions on ligatures: -- Disable ligatures in headings: +* +* Questions on ligatures: +* Disable ligatures in headings: ## Considered Options @@ -41,9 +41,9 @@ Found going from to -- java-based solution: (used by @sieversmartin) -- C-based solution (working for German documents only): +* perl-based solution: +* java-based solution: (used by @sieversmartin) +* C-based solution (working for German documents only): * Good, because proven solutions * Good, because pdflatex can be used diff --git a/docs/adr/0005-use-pdflatex-as-default.md b/docs/adr/0005-use-pdflatex-as-default.md new file mode 100644 index 00000000..86206757 --- /dev/null +++ b/docs/adr/0005-use-pdflatex-as-default.md @@ -0,0 +1,22 @@ +# Use pdflatex as default + +## Context and Problem Statement + +Which latex compiler to use? + +* pdflatex +* xelatex +* lualatex + +## Decision Outcome + +Chosen option: "pdflatex", because compiles faster and correct ligatures are required at the final typesetting step only. + +### Positive Consequences + +* Faster compile time + +### Negative Consequences + +* Using lualatex just before publication might lead to a different layout and additional effort +* lualatex's power might not be used at all diff --git a/docs/adr/template.md b/docs/adr/template.md index 9429ad8d..25696bbe 100644 --- a/docs/adr/template.md +++ b/docs/adr/template.md @@ -1,75 +1,72 @@ # [short title of solved problem and solution] -* Status: [accepted | superseeded by [ADR-0005](0005-example.md) | deprecated | ...] +* Status: [proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)] * Deciders: [list everyone involved in the decision] * Date: [YYYY-MM-DD when the decision was last updated] Technical Story: [description | ticket/issue URL] - ## Context and Problem Statement -[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] +[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] ## Decision Drivers -* [driver 1, e.g., a force, facing concern, ...] -* [driver 2, e.g., a force, facing concern, ...] -* ... - +* [driver 1, e.g., a force, facing concern, …] +* [driver 2, e.g., a force, facing concern, …] +* … ## Considered Options * [option 1] * [option 2] * [option 3] -* ... - +* … ## Decision Outcome -Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | ... | comes out best (see below)]. +Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)]. + +### Positive Consequences -Positive Consequences: -* [e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...] -* ... +* [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …] +* … -Negative consequences: -* [e.g., compromising quality attribute, follow-up decisions required, ...] -* ... +### Negative Consequences +* [e.g., compromising quality attribute, follow-up decisions required, …] +* … ## Pros and Cons of the Options ### [option 1] -[example | description | pointer to more information | ...] +[example | description | pointer to more information | …] * Good, because [argument a] * Good, because [argument b] * Bad, because [argument c] -* ... +* … ### [option 2] -[example | description | pointer to more information | ...] +[example | description | pointer to more information | …] * Good, because [argument a] * Good, because [argument b] * Bad, because [argument c] -* ... +* … ### [option 3] -[example | description | pointer to more information | ...] +[example | description | pointer to more information | …] * Good, because [argument a] * Good, because [argument b] * Bad, because [argument c] -* ... - +* … ## Links * [Link type] [Link to ADR] -* ... +* …