docu

Question 1

what is the workflow for creating customer docu

Answer 1

copy PROJECT-SPECIFIC-DATA_copyMeAndRemoveThisSuffix to project directory and remove Suffix
copy DOCU.tex into your docu folder
parse gui configs through python ~/docu/gui-config-to-tex “gui cfg” “OPERATING RECALSYS.tex”
open docu.tex
get rid of all yellow
create customer branch and extensions if necessary
run ~/docu/finalize
bring extensions to master

Question 2

what is the workflow for adding custom changes to the documentation?

Answer 2

• check, what file the changes need to be made in
• check how this file is loaded into the documentation -> 2 possibilities
  1. \inputCellTypeSpecificWithFallback -> copy file from ~/docu to project directory
  2. normally -> create new ~/docu working branch
  -> create flag for new changes -> ensure backward compatibility through use of \inputCellTypeSpecificWithFallback, \withDefault etc. if possible

Question 3

What is the name of the LaTeX function, that loads a file from project directory if it exists there, and if not loads it from ~/docu?

Answer 3

\inputCellTypeSpecificWithFallback

Question 4

For the customer documentation, which files lie in ~/docu and which in the project directory?

Answer 4

all custom files in project directory, all others in ~/docu

Question 5

Which files shall be customized and which not in the customer docu?

Answer 5

all ALL_CAPS files are meant to be customized.
Also check Wiki for the exact list

Question 6

what does one have to do when adding a new define to the docu to ensure backward compatibility?

Answer 6

/withdefautl{name}