Documentation framework

[matortheeternal]

Requirements

• Searchable
• Can jump to links
• Can display images
• Easily maintainable

  Approach

So the approach to this is really uncertain.

• We could make our own document browser... which would be absolutely insane.
• We could try to integrate a CHM file, which Delphi seems to already have some stuff built for.
• We could just go the route of a web page which could be locally stored on the user's machine and then opened either inside Delphi (through some kind of pre-existing HTML document display component) or in the user's internet browser.
• We could see if there's a way to open PDFs linking to certain sections/pages

  Assessment

I think the best choice is a web page, because I want to make the documentation available on the web anyways, and that also allows us to easily try the CHM file methodology. The real question is whether or not there's an easy way to convert my already-existing ODT documentation to a web page without too much trouble, or some way of automatically digesting and processing the documentation from one format to the other.

[matortheeternal]

Made further progress on this in 2136da3. Going to refer to automation tools html formatting to do tidying up and styling. Once that's done, I'll compile it into a CHM and get started on linking the CHM to the exe through help contexts and whatever else.

[matortheeternal]

62b1f89 has a working CHM of the documentation. Now I just need to integrate it with the application through RAD Studio.

Documentation also needs to be updated with the changes that have happened since I last edited it.