Plan for a help page wiki

Desiderata:

• Allow viewing ohrhelp pages on the web
• Allow cross links between pages which work both online and in Custom
• Allow linking between ohrhelp pages and the wiki
• Allow other markup. So far, syntax for templates is implemented
• Ideally, allow users to edit the help pages online and submit changes as easily as possible

The first plan was to import help pages onto the wiki for easy linking and editing, but this has major drawbacks, such as difficulty of getting changes back off the wiki to the source files, and needing to write a wiki bot. A much simpler plan is to have separate html pages not part of the wiki for the help pages, and just link from/to them from the wiki.

• Add a mediawiki "#"-style title to the top of every help page. Use submenu titles like "# Hero editor -> Browser".
• Write a script that processes each ohrhelp file and produces a very simple html page. Ideally write it in php so it can run live to display edited .txt files.
• Create one or more .html pages which provide a sidebar index of pages and probably just uses an iframe for the current ohrhelp page's html. Write a script, probably in python, which generates the page index by scanning ohrhelp/
  • Alternatively we can try to reuse some existing tool for generating nice looking documentation, eg Sphinx.
• Write a script to regenerate everything and upload these to someplace like https://rpg.hamsterrepublic.com/ohrhelp/ ?
• Add templates on this wiki for linking to the ohrhelp
• Add ohrhelp markup for linking to other ohrhelp pages, and for linking to the wiki
  • At first Custom can strip these out, but of course they should work in Custom too
• Add an Edit button to each page that redirects to the source .txt on github.
  • Eventually, maybe add a real but simple 'Edit' function. Maybe we can reuse login authentication from the wiki so that we can trust edits enough to display them live immediately, and create and push a git commit to a separate repo which we can then easily manually pull, review, and push to the main ohrrpgce repo.

Note: currently TMC has a major rewrite of show_help on his rendertext branch, so we shouldn't make changes to it. (The rewrite is complete, and the rest of the branch is quite complete, but best double check it before merging).