4 Copyright 2023 Soren Stoutner <soren@stoutner.com>.
6 This file is part of Privacy Browser PC <https://www.stoutner.com/privacy-browser-pc>.
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.
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/>. -->
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>">
21 <!ENTITY Soren.Stoutner "<personname><firstname>Soren</firstname><surname>Stoutner</surname></personname>">
22 <!ENTITY Soren.Stoutner.mail "<email>soren@stoutner.com</email>">
24 <!-- Set the language of this documentation. -->
25 <!ENTITY % English "INCLUDE">
27 <!-- Default entries. May not be needed. -->
28 <!ENTITY i18n-translatable-entity "<application>Translatable Entity</application>">
29 <!ENTITY % addindex "IGNORE">
32 <book id="privacybrowser" lang="&language;">
34 <title>The &privacybrowser; Handbook</title>
37 <author>&Soren.Stoutner; &Soren.Stoutner.mail;</author>
39 <!-- Add translators here. TRANS:ROLES_OF_TRANSLATORS -->
43 <year>2016-2017, 2021-2023</year>
44 <holder>&Soren.Stoutner;</holder>
47 <!-- Documentation license. -->
48 <legalnotice>&FDLNotice;</legalnotice>
51 <date>2023-02-22</date>
53 <!-- The version of Privacy Browser this documentation is written for. -->
54 <releaseinfo>&privacybrowser; version 0.1</releaseinfo>
57 <!-- Abstract about this handbook -->
60 &privacybrowser; is a web browser that respects your privacy.
64 <!-- This is a set of Keywords for indexing by search engines. -->
66 <keyword>KDE</keyword>
67 <keyword>privacy</keyword>
68 <keyword>browser</keyword>
72 <!-- Introduction. -->
73 <chapter id="introduction">
74 <title>Introduction</title>
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.
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.
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.
98 <!-- Using Privacy Browser. -->
99 <chapter id="using-privacy-browser">
100 <title>Using &privacybrowser;</title>
104 <screeninfo>Here's a screenshot of &privacybrowser;</screeninfo>
107 <imagedata fileref="screenshot.png" format="PNG"/>
110 <phrase>Screenshot</phrase>
116 <sect1 id="kapp-features">
117 <title>More &privacybrowser; features</title>
120 It slices! It dices! and it comes with a free toaster!
124 The Squiggle Tool <guiicon><inlinemediaobject>
126 <imagedata fileref="squiggle.png" format="PNG"/>
129 <phrase>Squiggle</phrase>
131 </inlinemediaobject></guiicon> is used to draw squiggly lines all over the &privacybrowser; main window. It's not a bug, it's a feature!
137 <chapter id="commands">
138 <title>Command Reference</title>
140 <sect1 id="kapp-mainwindow">
141 <title>The main &privacybrowser; window</title>
144 <title>The File Menu</title>
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"
157 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
159 <guimenu>File</guimenu>
160 <guimenuitem>New</guimenuitem>
166 <action>Creates a new document</action>
171 <varlistentry id="file-save">
175 <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
177 <guimenu>File</guimenu>
178 <guimenuitem>Save</guimenuitem>
184 <action>Saves the document</action>
189 <varlistentry id="file-quit">
193 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
195 <guimenu>File</guimenu>
196 <guimenuitem>Quit</guimenuitem>
202 <action>Quits</action> &privacybrowser;
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>
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.
222 <sect2 id="help-menu1">
223 <title>The Help Menu</title>
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.
231 <sect2 id="menu-commands">
232 <title>Menu Items</title>
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:
240 <sect2 id="help-menu2">
241 <title>The Help Menu</title>
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:
254 <title>Questions and Answers</title>
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. -->
266 <qandaset id="faqlist">
269 <para>My Mouse doesn't work. How do I quit &privacybrowser;?</para>
273 <para>You silly goose! Check out the <link linkend="commands">Commands Section</link> for the answer.</para>
279 <para>Why can I not twiddle my documents?</para>
284 You can only twiddle your documents if you have the foobar.lib installed.
292 <chapter id="credits">
293 <title>Credits and License</title>
296 Program copyright 2016-2017,2021-2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
302 <listitem><para>Translations will be added in a future release.</para></listitem>
306 <!-- The program license. -->
310 Documentation copyright 2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
313 <!-- The documentation license. -->