Comments on initial work #1
Description
Hi, sorry it has taken me so long to get back to this. This has been a great first effort, but I am seeing a number of things to discuss and I'm not sure how to take this forward. I really like a lot of things that have been done here. Breaking up the very large files into much shorter files is a really good thing and the appearance of the files from mkdocs is really nice.
Some things that need to be considered in order to move forward:
-
The anchors from the original HTML files are lost. These are needed so that GSAS-II can open the right page. Originally the help was all in a single file and when I broke things up into three files, I put in some code that selects the right file -- somehow. I'm anticipating that I'll need to add a look-up table based on anchor name that will select the right file. However, a fair amount from the some code that will translate the anchor previously used to the file & anchor in the new files, but at present this will require a lot of manual work to duplicate this. More on anchors here.
-
I have worked on the mkdocs.yml file and with changes got static html files to work properly.
Other tasks:
-
Links to both anchors and external pages have been lost and need to be added to the .md files.
-
Images need to be copied from HTML to MD.
-
mathjax works nicely on equations, but it might be easier to copy the equation images than to generate all the equations in LaTeX
-
Minor, but what I assume are kanji characters for Japanese show up in the upper left, regardless of the language selection:
English selected:
Japanese selected:
I will assume that at this point there is a lot of manual work already put into the files in this repo, so looking at the .html->.md translation process will not help much and we need to discuss how to move forward with the files that exist here. Tomorrow I plan to take a stab at revising one or two .md files by hand to see how that goes, but for now I'll check in what I have done.