[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:  #10974
------------------------------------------+--------------------------------

Comment (by mttp):

 Replying to [comment:8 mcs]:


 > I tend to agree that PDF might be the best choice... but are the common
 PDF readers (e.g., Adobe Reader) trustworthy from an anonymity point of
 view?

 Evince, which is free software, is available for Mac and Windows, as well
 as Linux, so the Tor Project does not necessarily have to endorse
 proprietary, closed source software.

 Replying to [comment:9 lunar]:


 > Understood. How about having a specific HTML file to offer the manual
 outside the Tor Browser that
 > would contain an `<iframe>` surrounded with “Tor Browser User Manual”
 and a big fat warning “This is only the manual, not the actual Tor
 Browser. This browser provides no anonymity.”? I guess we could even
 [https://developer.mozilla.org/en-US/docs/Web/API/window.onbeforeunload
 use JavaScript to provide a warning] if users try to browse somewhere
 else.
 >

 This will require the user to process additional information than if the
 manual were presented as a pdf. It would also require additional work to
 implement. What benefit do you think we would we get in exchange for this
 additional cost?

 > I'm not necessarily opposed to a PDF, but I fear that it will be far
 less convenient to read given Mallard's design goals.
 >

 I've looked at a few different applications for generating PDF files.
 Using [http://wkhtmltopdf.org/ wkhtmltopdf] seems like a pretty good
 option to me. Once the Mallard .page files are built to html, they can be
 fed into wkhtmltopdf as arguments. The output pdf file is fully linked
 according to Mallard's design. I'm attaching an example pdf file for your
 consideration. Note that for the PDF file to be linked, one must create it
 using the version of wkhtmltopdf available from the project's website, NOT
 the one available in the Ubuntu or Debian repositories.

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