Research if Mallard would be a good candidate for the Tor Browser User Manual

Project Mallard looks like an interesting format to create documentation. Let's hack a proof-of-concept to see if it fits the Tor Browser User Manual requirements.

added SponsorO component::applications/tor bundles/installation owner::lunar parent::10978 priority::medium resolution::implemented status::closed type::task labels

Ok, I'm sold!

I think Mallard is a very nice markup language and has all the features we want:

• The language is well designed. Its principles are sound and likely to create good documentation.
• Helping translators creating nice translations is all integrated thanks to W3C ITS.
• It supports conditional text for different platforms.
• It supports integrating outside element pretty easily (like the Tor Browser version).

The only thing we might miss, but I'm not sure, is a single HTML file. We could already ship EPUB easily and a single HTML file is only some XSLT hacking away.

Please have a look at the proof-of-concept and comment.

Trac:
Status: new to needs_review

Actually the research is done. Closing the ticket. Let's discuss in #10978 (closed).

Trac:
Status: needs_review to closed
Resolution: N/A to implemented

On Debian, it needs the following packages: autoconf yelp-tools yelp-xsl intltool

Another small issue:

sed -e 's/Tor Browser User Manual/tor-browser-user-manual/' -i configure.ac

Trac:
tor-browser-user-manual-mallard-poc.tar

Proof of concept of using Mallard for the Tor Browser User Manual

Uploaded fixed archive.

closed