Create documentation for simple library toolkit
Original idea from https://www.vipm.io/posts/01b17b9b-b230-4b89-8db4-7edaa057abdd/
A first version could work like that:
- Inputs:
- Toolkit name
- Version number
- main menu file (*.mnu)
- adoc file describing the purpose of the toolkit (optional)
- Document generated:
- Title: Toolkit name (and version number)
- Description Section -> adoc file content if provided
- Functions Palette Section
- one section for each palette/subpalette with the following content
- Palette image
- one subsection for each function with vi image + vi description
- one section for each palette/subpalette with the following content
- Controls Palette Section
- one section for each palette/subpalette with the following content
- Palette image
- one subsection for each control with control icon + control description
- one section for each palette/subpalette with the following content
NOTES:
- No handling of examples and tools provided by the toolkit
- The output needs to be rendered as HTML/PDF before being provided with the toolkit