FS#30045 - [documentation] use pandoc instead of markdown in make-doc.sh

Attached to Project: Release Engineering
Opened by Dario Giovannetti (kynikos) - Monday, 28 May 2012, 13:39 GMT
Last edited by Felix Yan (felixonmars) - Tuesday, 13 October 2015, 12:48 GMT
Task Type Feature Request
Category Hardware Issues
Status Closed
Assigned To Dieter Plaetinck (Dieter_be)
Gerardo Exequiel Pozzi (djgera)
Architecture All
Severity Medium
Priority Normal
Reported Version 2011.08.19
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 2
Private No

Details

(I started this discussion in arch-releng ( http://mailman.archlinux.org/pipermail/arch-releng/2012-May/002539.html ) but I need this bug report to attach the patch; note that the patch attached here is more up to date than the one posted in the ML!)

I would like to propose using pandoc ( http://johnmacfarlane.net/pandoc/ ) instead of markdown in the make-doc.sh script for converting the installation guide (Markdown syntax) to the document hosted in the wiki (MediaWiki syntax).

The patched script makes use of a Python script which performs several adaptations that are much more up to date than those performed by the current make-doc.sh and they are easily adaptable in case new translations of the guide are added.

In my opinion the result looks pretty good: instead of the current script, which produces an HTML
document, we would get a correctly-formed, much neater MediaWiki document.

NOTE 1: the "pandoc" package is required, it's currently in the AUR: http://aur.archlinux.org/packages.php?ID=32490
NOTE 2: the patch has been committed on the "develop" branch

Thank you,

Dario
   automatic-guide-converter2.pa... (9 KiB)
This task depends upon

Closed by  Felix Yan (felixonmars)
Tuesday, 13 October 2015, 12:48 GMT
Reason for closing:  None
Comment by Dario Giovannetti (kynikos) - Tuesday, 29 May 2012, 22:36 GMT
Just some other very minor refinements...
   automatic-guide-converter3.pa... (8.7 KiB)
Comment by Dario Giovannetti (kynikos) - Wednesday, 13 June 2012, 11:02 GMT
I've updated the patch to the latest ArchWiki internationalization standards
   automatic-guide-converter4.pa... (9.2 KiB)
Comment by Felix Yan (felixonmars) - Tuesday, 13 October 2015, 08:02 GMT
I am re-opening this issue as the pandoc package is now available in [community]. Would it be a feasible request now?
Comment by Dario Giovannetti (kynikos) - Tuesday, 13 October 2015, 12:33 GMT
I don't think this request is useful anymore, now the opposite conversion is done: the install.txt in the image is a lynx dump of the installation guide in the wiki. [1]

[1]: https://projects.archlinux.org/archiso.git/tree/configs/releng/build.sh#n91
Comment by Felix Yan (felixonmars) - Tuesday, 13 October 2015, 12:48 GMT
Ah, I see. Really sorry for the noise!

Loading...