doc/index.docbook

   1 <?xml version="1.0" ?>
   2
   3 <!--
   4   Copyright 2023 Soren Stoutner <soren@stoutner.com>.
   5
   6   This file is part of Privacy Browser PC <https://www.stoutner.com/privacy-browser-pc>.
   7
   8   Permission is granted to copy, distribute and/or modify this document
   9   under the terms of the GNU Free Documentation License, Version 1.3
  10   or any later version published by the Free Software Foundation;
  11   with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
  12
  13   You should have received a copy of the GNU Free Documentation License
  14   along with Privacy Browser PC.  If not, see <http://www.gnu.org/licenses/>. -->
  15
  16 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
  17   <!-- Privacy Browser’s name -->
  18   <!ENTITY privacybrowser "<application>Privacy Browser</application>">
  19
  20   <!-- People. -->
  21   <!ENTITY Soren.Stoutner "<personname><firstname>Soren</firstname><surname>Stoutner</surname></personname>">
  22   <!ENTITY Soren.Stoutner.mail "<email>soren@stoutner.com</email>">
  23
  24   <!-- Set the language of this documentation. -->
  25   <!ENTITY % English "INCLUDE">
  26
  27   <!-- Default entries.  May not be needed. -->
  28   <!ENTITY i18n-translatable-entity "<application>Translatable Entity</application>">
  29   <!ENTITY % addindex "IGNORE">
  30 ]>
  31
  32 <book id="privacybrowser" lang="&language;">
  33   <bookinfo>
  34     <title>The &privacybrowser; Handbook</title>
  35
  36     <authorgroup>
  37       <author>&Soren.Stoutner; &Soren.Stoutner.mail;</author>
  38
  39       <!-- Add translators here.  TRANS:ROLES_OF_TRANSLATORS -->
  40     </authorgroup>
  41
  42     <copyright>
  43       <year>2016-2017, 2021-2023</year>
  44       <holder>&Soren.Stoutner;</holder>
  45     </copyright>
  46
  47     <!-- Documentation license. -->
  48     <legalnotice>&FDLNotice;</legalnotice>
  49
  50     <!-- Last update. -->
  51     <date>2023-02-22</date>
  52
  53     <!-- The version of Privacy Browser this documentation is written for. -->
  54     <releaseinfo>&privacybrowser; version 0.1</releaseinfo>
  55
  56
  57     <!-- Abstract about this handbook -->
  58     <abstract>
  59       <para>
  60         &privacybrowser; is a web browser that respects your privacy.
  61       </para>
  62     </abstract>
  63
  64     <!-- This is a set of Keywords for indexing by search engines. -->
  65     <keywordset>
  66       <keyword>KDE</keyword>
  67       <keyword>privacy</keyword>
  68       <keyword>browser</keyword>
  69     </keywordset>
  70   </bookinfo>
  71
  72   <!-- Introduction. -->
  73   <chapter id="introduction">
  74     <title>Introduction</title>
  75
  76     <para>
  77       &privacybrowser; is currently in an early alpha state.
  78       Most of the features are not yet implemented, but I thought it would be useful to publish it so that users can track the progress and submit feedback.
  79     </para>
  80
  81     <para>
  82       To distinguish between the Android and the PC version, the website, issue tracker,
  83       and code base refer to this version as <ulink url="https://www.stoutner.com/privacy-browser-pc/">Privacy Browser PC</ulink>.
  84       There is a list of feature requests and known bugs at <ulink url="https://redmine.stoutner.com/projects/privacy-browser-pc/issues">redmine.stoutner.com</ulink>.
  85       Users should anticipate that all the current features of <ulink url="https://www.stoutner.com/privacy-browser-android/">Privacy Browser Android</ulink>
  86       will also be implemented in Privacy Browser PC.
  87       There is no need at this point to create features requests for these as they will be added as I start working on each feature and have a better idea of how they will be implemented.
  88       However, each feature that has already been implemented should be bug free.
  89       If you discover a bug that is not already documented at <ulink url="https://redmine.stoutner.com/projects/privacy-browser-pc/issues">redmine.stoutner.com</ulink> please add it.
  90     </para>
  91
  92     <para>
  93       The best place to discuss the development of Privacy Browser is <ulink url="https://redmine.stoutner.com/projects/privacy-browser-pc/boards">on the forum</ulink>.
  94       I also frequently post on my <ulink url="https://fosstodon.org/@privacybrowser">Mastodon account</ulink> regarding the development status.
  95     </para>
  96   </chapter>
  97
  98   <!-- Using Privacy Browser. -->
  99   <chapter id="using-privacy-browser">
 100     <title>Using &privacybrowser;</title>
 101
 102     <para>
 103       <screenshot>
 104         <screeninfo>Here's a screenshot of &privacybrowser;</screeninfo>
 105         <mediaobject>
 106           <imageobject>
 107             <imagedata fileref="screenshot.png" format="PNG"/>
 108           </imageobject>
 109           <textobject>
 110             <phrase>Screenshot</phrase>
 111           </textobject>
 112         </mediaobject>
 113       </screenshot>
 114     </para>
 115
 116     <sect1 id="kapp-features">
 117       <title>More &privacybrowser; features</title>
 118
 119       <para>
 120         It slices! It dices! and it comes with a free toaster!
 121       </para>
 122
 123       <para>
 124         The Squiggle Tool <guiicon><inlinemediaobject>
 125           <imageobject>
 126             <imagedata fileref="squiggle.png" format="PNG"/>
 127           </imageobject>
 128           <textobject>
 129             <phrase>Squiggle</phrase>
 130           </textobject>
 131         </inlinemediaobject></guiicon> is used to draw squiggly lines all over the &privacybrowser; main window. It's not a bug, it's a feature!
 132       </para>
 133     </sect1>
 134   </chapter>
 135
 136   <!-- Commands. -->
 137   <chapter id="commands">
 138     <title>Command Reference</title>
 139
 140     <sect1 id="kapp-mainwindow">
 141       <title>The main &privacybrowser; window</title>
 142
 143       <sect2>
 144         <title>The File Menu</title>
 145
 146         <para>
 147           <variablelist>
 148             <varlistentry  id="file-new">
 149   <!-- Tip: With id's here, then you can use them like
 150   "select <xref linkend="file-new"/> to open the file dialog"
 151   which will be expanded to:
 152   "select File->New (Ctrl+N) to open the file dialog"
 153   -->
 154               <term>
 155                 <menuchoice>
 156                   <shortcut>
 157                     <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
 158                   </shortcut>
 159                   <guimenu>File</guimenu>
 160                   <guimenuitem>New</guimenuitem>
 161                 </menuchoice>
 162               </term>
 163
 164               <listitem>
 165                 <para>
 166                   <action>Creates a new document</action>
 167                 </para>
 168               </listitem>
 169             </varlistentry>
 170
 171             <varlistentry  id="file-save">
 172               <term>
 173                 <menuchoice>
 174                   <shortcut>
 175                     <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
 176                   </shortcut>
 177                   <guimenu>File</guimenu>
 178                   <guimenuitem>Save</guimenuitem>
 179                 </menuchoice>
 180               </term>
 181
 182               <listitem>
 183                 <para>
 184                   <action>Saves the document</action>
 185                 </para>
 186               </listitem>
 187             </varlistentry>
 188
 189             <varlistentry  id="file-quit">
 190               <term>
 191                 <menuchoice>
 192                   <shortcut>
 193                     <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 194                   </shortcut>
 195                   <guimenu>File</guimenu>
 196                   <guimenuitem>Quit</guimenuitem>
 197                 </menuchoice>
 198               </term>
 199
 200               <listitem>
 201                 <para>
 202                   <action>Quits</action> &privacybrowser;
 203                 </para>
 204               </listitem>
 205             </varlistentry>
 206           </variablelist>
 207         </para>
 208       </sect2>
 209
 210       <!-- Examples how to use the common menus Settings and Help -->
 211       <sect2 id="settings-help-menu">
 212         <title>The Settings and Help Menu</title>
 213
 214         <para>
 215           &privacybrowser; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
 216           menu items, for more information read the sections about the <ulink url="help:/fundamentals/ui.html#menus-settings"
 217           >Settings Menu</ulink> and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>
 218           of the &kde; Fundamentals.
 219         </para>
 220       </sect2>
 221
 222       <sect2 id="help-menu1">
 223         <title>The Help Menu</title>
 224
 225         <para>
 226           &privacybrowser; has the common &kde; <guimenu>Help</guimenu> menu item, for more information read the section
 227           about the <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
 228         </para>
 229       </sect2>
 230
 231       <sect2 id="menu-commands">
 232         <title>Menu Items</title>
 233
 234         <para>
 235           Apart from the common &kde; menus described in the <ulink url="help:/fundamentals/ui.html#menus">Menu</ulink>
 236           chapter of the &kde; Fundamentals documentation &privacybrowser; has these application specific menu entries:
 237         </para>
 238       </sect2>
 239
 240       <sect2 id="help-menu2">
 241         <title>The Help Menu</title>
 242
 243         <para>
 244           &privacybrowser; has a default &kde; <guimenu>Help</guimenu> menu as described in the
 245           <ulink url="help:/fundamentals/ui.html#menus-help">&kde; Fundamentals</ulink>
 246           with two additional entries:
 247         </para>
 248       </sect2>
 249     </sect1>
 250   </chapter>
 251
 252   <!-- FAQ. -->
 253   <chapter id="faq">
 254     <title>Questions and Answers</title>
 255
 256     <!-- (OPTIONAL but recommended) This chapter should include all of the silly
 257     (and not-so-silly) newbie questions that fill up your mailbox. This chapter
 258     should be reserved for BRIEF questions and answers! If one question uses more
 259     than a page or so then it should probably be part of the
 260     "Using this Application" chapter instead. You should use links to
 261     cross-reference questions to the parts of your documentation that answer them.
 262     This is also a great place to provide pointers to other FAQ's if your users
 263     must do some complicated configuration on other programs in order for your
 264     application work. -->
 265
 266     <qandaset id="faqlist">
 267       <qandaentry>
 268         <question>
 269           <para>My Mouse doesn't work. How do I quit &privacybrowser;?</para>
 270         </question>
 271
 272         <answer>
 273           <para>You silly goose! Check out the <link linkend="commands">Commands Section</link> for the answer.</para>
 274         </answer>
 275       </qandaentry>
 276
 277       <qandaentry>
 278         <question>
 279           <para>Why can I not twiddle my documents?</para>
 280         </question>
 281
 282         <answer>
 283           <para>
 284             You can only twiddle your documents if you have the foobar.lib installed.
 285           </para>
 286         </answer>
 287       </qandaentry>
 288     </qandaset>
 289   </chapter>
 290
 291   <!-- Credits. -->
 292   <chapter id="credits">
 293     <title>Credits and License</title>
 294
 295     <para>
 296       Program copyright 2016-2017,2021-2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
 297     </para>
 298
 299     <para>
 300       Translators:
 301       <itemizedlist>
 302         <listitem><para>Translations will be added in a future release.</para></listitem>
 303       </itemizedlist>
 304     </para>
 305
 306     <!-- The program license. -->
 307     &underGPL;
 308
 309     <para>
 310       Documentation copyright 2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
 311     </para>
 312
 313     <!-- The documentation license. -->
 314     &underFDL;
 315   </chapter>
 316 </book>