-
Notifications
You must be signed in to change notification settings - Fork 15
Build & Deploy
! Caution: This is work-in-progress and taxonomy is not final yet, see todo at the end !
| Branch | Description | Rulebook Versions/Files |
|---|---|---|
| current | Current Rulebook | iuf-rulebook-current.pdf iuf-rulebook-current-de.pdf, ... |
| Rulebook Version of the |
iuf-rulebook-$branch$.pdf iuf-rulebook-$branch$-de.pdf, ... |
Each branch contains a file with other branch names it will be diffed with. The file contains one branch name per line.
Example:
In the branch 2015 the file ${diff-filename} may contain these lines:
2013
2011
And the diff will run against the branches 2013 and 2011 and will create iuf-rulebook-2015-diff-2013.pdf and iuf-rulebook-2015-diff-2011.pdf.
Note: For nice colors, you should of course diff a newer to an older version ;)
...
Since the 2015 rulebook reorganization it is possible to have competition specific and audience related rulebook verisons. E.g. a rulebook with only x-style rules only for participants and x-style rules for all audiences, including organizers. It should be possible to tell the build script, which version for which audience. These introduces two new variables: ${edition} and ${audience}.
// I'm not happy with the word "edition" here
Build with make. Available targets:
make pdf
-> Generates the rulebook in english
=> iuf-rulebook-$branch.pdf
# Translations
make translation
-> Generates rulebook in all available translations
=> iuf-rulebook-$branch-de.pdf, iuf-rulebook-$branch-ja.pdf, ...
make translation $lang=de
-> Generates a translated rulebook in german
=> iuf-rulebook-$branch-de.pdf
# diffs
make diff
-> Generates diffs for all diffs in english (see above)
=> iuf-rulebook-$branch-diff-2013.pdf, iuf-rulebook-$branch-diff-2011.pdf
make diff $diff=2013
-> Generates diff for the given version in english
=> iuf-rulebook-$branch-diff-2013.pdf
make diff $lang=de
-> Generates diff for all diffs in the given language
=> iuf-rulebook-$branch-diff-2013-de.pdf and iuf-rulebook-$branch-diff-2011-de.pdf
make diff $diff=2013 $lang=de
-> Generates diff for the given version in the given language
=> iuf-rulebook-$branch-diff-2013-de.pdf
# Tailored editions
make tailored $comp=xstyle
-> Generates the rulebook only for the given competition in english
=> iuf-rulebook-$branch-xstyle.pdf
make tailored $comp=xstyle $lang=de
-> Generates the rulebook only for the given competition in the given language
=> iuf-rulebook-$branch-xstyle-de.pdf
make tailored $comp=xstyle $audience=competitors
-> Generates the rulebook only for the given competiton and the given audience in english
=> iuf-rulebook-$branch-xstyle-competitors.pdf
make tailored $comp=xstyle $audience=competitors $lang=de
-> Generates the rulebook only for the given competition, given audience and given language:
=> iuf-rulebook-$branch-xstyle-competitors-de.pdf
Some naming conventions need to be agreed on:
- Diff-filename: Currently
diff-branches. Comments gossi: Sounds a bit weird and not very belonging to the rulebook generation process at all - Tailored: Don't know if tailored is the correct term here
- $audience: Comment gossi: I really like it, though it needs some predefined values I guess (there only is competitors, but could also be organizers, etc. which will be the default)
- $competition: Comment gossi: Not quite sure about comp or maybe also section/chapter which may be better.