Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#11124 closed task (implemented)

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

Reported by: lunar Owned by: lunar
Priority: Medium Milestone:
Component: Applications/Tor bundles/installation Version:
Severity: Keywords: SponsorO
Cc: Actual Points:
Parent ID: #10978 Points:
Reviewer: Sponsor:

Description

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.

Child Tickets

Attachments (1)

tor-browser-user-manual-mallard-poc.tar (160.0 KB) - added by lunar 6 years ago.
Proof of concept of using Mallard for the Tor Browser User Manual

Download all attachments as: .zip

Change History (7)

comment:1 Changed 6 years ago by lunar

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.

comment:2 Changed 6 years ago by lunar

Status: newneeds_review

comment:3 Changed 6 years ago by lunar

Resolution: implemented
Status: needs_reviewclosed

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

comment:4 Changed 6 years ago by lunar

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

comment:5 Changed 6 years ago by lunar

Another small issue:

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

Changed 6 years ago by lunar

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

comment:6 Changed 6 years ago by lunar

Uploaded fixed archive.

Note: See TracTickets for help on using tickets.