open-nuclear-ops/starter-kit
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions

Choose document template tech #3

New issue
Open
opened 2025-09-24 09:48:06 -04:00 by nick · 0 comments
nick commented 2025-09-24 09:48:06 -04:00
Owner
Copy link

Similar but easier than #2, we need a technology for defining document templates. These will be the starting point for any new document, i.e. a new procedure for the kit, a new engineering calculation, a new system design description, etc. They will include sections, content hints, a cover page, headers and footers, etc. Ideally they'd incorporate glossary and reference tooling.

Throughout a project, cover pages, headers, and footers get changed a lot by administrators.

Typical options include:

  • Manually-prepared docx files
  • Manually-prepared LaTeX files
  • Some combination of markdown/reST and LaTex with pandoc
  • Procedurally-generated docx files (i.e. from python-docx)
  • structured text with a template engine like Jinja2

Most engineers and managers are comfortable writing documents in MS Word, so it's probably essential to have a Word option one way or another.

Similar but easier than #2, we need a technology for defining document templates. These will be the starting point for any new document, i.e. a new procedure for the kit, a new engineering calculation, a new system design description, etc. They will include sections, content hints, a cover page, headers and footers, etc. Ideally they'd incorporate glossary and reference tooling. Throughout a project, cover pages, headers, and footers get changed a lot by administrators. Typical options include: * Manually-prepared docx files * Manually-prepared LaTeX files * Some combination of markdown/reST and LaTex with pandoc * Procedurally-generated docx files (i.e. from python-docx) * structured text with a template engine like Jinja2 Most engineers and managers are comfortable writing documents in MS Word, so it's probably essential to have a Word option one way or another.
nick self-assigned this 2025-09-24 09:48:06 -04:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
nick
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: open-nuclear-ops/starter-kit#3
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?