Translating SGML to org-mode
Oct. 7th, 2013 11:55 amSunday I worked on translating the Docbook form of the GNU Privacy Handbook to Emacs org-mode. I didn't try to script it or parse the SGML at all, but just copied the original manual.sgml file to manual.org and began whacking
away at it in Emacs, doing search-and-replaces and manual editing to translate between the two markups.
Docbook provides minutely detailed markup. In a code example, you can mark the system prompt by <prompt></prompt> and the user's typing by <userinput>. All these details are discarded by the translation to org-mode, which only offers the basic formatting of emphasis, italic, monospace, and a few other styles.
I'm working on a branch called akuchling-modernize in my new gph repository on github. The next step will be to apply a patch to make various small updates that's been sent to me. The patch is probably old enough that it's slightly out of date, so then I'll start reading through the document
and consider what revisions I want to make. I also need to figure out what to do for a glossary; the Docbook has a <firstterm> element marking the first use of a term. For now I've left them in. I don't know if I should add a glossary section or just link to the new FAQ.
away at it in Emacs, doing search-and-replaces and manual editing to translate between the two markups.
Docbook provides minutely detailed markup. In a code example, you can mark the system prompt by <prompt></prompt> and the user's typing by <userinput>. All these details are discarded by the translation to org-mode, which only offers the basic formatting of emphasis, italic, monospace, and a few other styles.
I'm working on a branch called akuchling-modernize in my new gph repository on github. The next step will be to apply a patch to make various small updates that's been sent to me. The patch is probably old enough that it's slightly out of date, so then I'll start reading through the document
and consider what revisions I want to make. I also need to figure out what to do for a glossary; the Docbook has a <firstterm> element marking the first use of a term. For now I've left them in. I don't know if I should add a glossary section or just link to the new FAQ.