Skip to content

Document the complete Settings parameter catalogue and add localized includes - #54

Merged
Sgw32 merged 2 commits into
masterfrom
codex/add-parameter-descriptions-in-latex
Sep 19, 2026
Merged

Sgw32 merged 2 commits into
masterfrom
codex/add-parameter-descriptions-in-latex

Conversation

@Sgw32

@Sgw32 Sgw32 commented Sep 19, 2026

Copy link
Copy Markdown
Collaborator

Motivation

  • Provide a single canonical, machine-parseable firmware parameter catalogue for the Digifiz Next "Settings" tab so language editions cannot drift apart.
  • Make it explicit that each Settings entry must be loaded before editing and edited one at a time to avoid user mistakes when changing firmware values.
  • Avoid confusion between similarly named legacy parameter command IDs and the firmware Settings entries by documenting exact internal identifiers and UI labels verbatim.

Description

  • Add a new canonical table file chapters/ParameterCatalogue.tex containing 124 parameter rows with identifier, UI label, description, type/default and limits/notes.
  • Replace the large inlined English parameter longtable in chapters/Appendix.tex by a short guidance paragraph plus \input{chapters/ParameterCatalogue} and localized macro definitions for caption/column headings.
  • Insert localized guidance and localised caption/column label definitions plus an \input{chapters/ParameterCatalogue} include into each language appendix (chapters_de/Appendix.tex, chapters_es/Appendix.tex, chapters_fr/Appendix.tex, chapters_hu/Appendix.tex, chapters_ru/Appendix.tex) so every language reuses the same canonical table while showing localized surrounding text.
  • Preserve firmware UI strings verbatim in the canonical table and add notes for firmware constants, runtime-only values and reboot requirements where applicable.

Testing

  • Ran git diff --check to ensure no whitespace/index errors and it passed.
  • Executed a Python validation that parsed chapters/ParameterCatalogue.tex and asserted exactly 124 rows, each with five columns, and verified every localized appendix contains the \input{chapters/ParameterCatalogue} include and the one-at-a-time editing guidance; this validation succeeded.
  • Attempted to run PDF builds with latexmk -pdf -interaction=nonstopmode -halt-on-error ... but build could not be performed in this environment because latexmk is not installed (document compilation was therefore not executed).

Codex Task

@Sgw32
Sgw32 merged commit 65bbe87 into master Sep 19, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant