[tor-bugs] #11698 [Tor bundles/installation]: Decide how to incorporate Tor Browser Manual pages into Tor Browser

[Tor Bug Tracker & Wiki]

#11698: Decide how to incorporate Tor Browser Manual pages into Tor Browser
------------------------------------------+--------------------------------
     Reporter:  mttp                      |      Owner:
         Type:  defect                    |     Status:  new
     Priority:  normal                    |  Milestone:
    Component:  Tor bundles/installation  |    Version:
   Resolution:                            |   Keywords:  tbb-manual,
Actual Points:                            |  SponsorO
       Points:                            |  Parent ID:
------------------------------------------+--------------------------------

Comment (by mttp):

 In https://trac.torproject.org/projects/tor/ticket/11124 we decided on
 using the mallard markup language to build the Tor Browser User Manual.

 Mallard pages can be opened with a program called yelp. One option might
 be to ship yelp with the Tor Browser, and let the user open the manual
 with yelp. The advantage is that this takes full advantage of Mallard's
 capabilities and intuitive workflow. I do not know if there are working
 Windows and Mac yelp packages, or how big they are. If someone finds this
 out before I do, please post the answer here.

 Another option is to compile the mallard pages into html format. An
 advantage is that these pages could be linked to from the about:tor page
 and viewed in the browser. The drawback is that users need to be able to
 find and access the manual in the event that Tor Browser fails somehow,
 which means we'll need an alternative to the in-browser experience.
 Encouraging users to open the Tor Browser manual in Firefox or Chrome
 leads to grave security issues.

 It's been suggested the manual be converted to pdf format either using
 html2pdf or compiling the mallard files to Latex and converting to pdf.
 The advantage is that we would have one file which would be intuitive to
 click on and read. The drawback is that a pdf file would detract from some
 of the interactive aspects of mallard that influenced us to select it as
 the user manual framework in the first place.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/11698#comment:2>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online