STL icon indicating copy to clipboard operation
STL copied to clipboard

Documentation: convert G191E.docx to Latex/Markdown/...?

Open dennisguse opened this issue 9 years ago • 4 comments

Usage of docx/pdf has three drawbacks:

  1. files are binary and thus diff does not work (only reports file has changed),
  2. some people might not have the correct version of Microsoft Office at hand, and
  3. it is not readable from the command line (at least not as easy as a text file).

I suggest converting it to A) Latex (nicer PDF) or B) Markdown (automatically available as HTML).

Integrating it into Doxygen might also be possible.

#2 and #9 are related.

dennisguse avatar Apr 05 '17 06:04 dennisguse

G.191 itself is an official publication of ITU, so we must use WinWord.

Fortunately, we only need to update its Annex A and only once a snapshot of the library is agreed by ITU-T SG12 to be included in a revised version of G.191 (official ITU release). We could have a version of Annex A produced and maintained in LaTeX or HTML that could then, when time comes, be converted to Word. HTML is fairly easy to convert; LaTeX, maybe if we still have a reliable LaTeX to RTF converter.

simaocampos avatar Apr 05 '17 06:04 simaocampos

For the sake of completeness I think it would be nice to have the latest version of G.191 in the Git, as LaTeX or Markdown. Obviously, the official release will be at http://itu.int/ITU-T/G.191 in docx/pdf

maadolph avatar Apr 06 '17 07:04 maadolph

Well the easiest would be to save the DOCX as HTML, but it be marked as NOT the official version, to avoid confusion.

simaocampos avatar Apr 06 '17 08:04 simaocampos

I found the DOC/DOCX policy always irritating and never fully understood the reason for sticking with them - but it is probably something not going to be changed quickly.

So, we could also go for some document converters, such as Pandoc. It can convert Markdown to DOCX, but we would need to check how to apply formatting correctly. I use Pandoc regularly to convert Markdown to HTML+CSS as a replacement for Word...

dennisguse avatar Apr 06 '17 08:04 dennisguse