]> gitweb.stoutner.com Git - PrivacyBrowserPC.git/blobdiff - doc/index.docbook
Add a default folder icon to the edit folder dialog. https://redmine.stoutner.com...
[PrivacyBrowserPC.git] / doc / index.docbook
index fd5d5362b53ca674b7e2a69bad33db278e8869ff..27ee1fc310350518021857851bb41de99bcee7c6 100644 (file)
@@ -1,7 +1,7 @@
 <?xml version="1.0" ?>
 
 <!--
-  Copyright 2023 Soren Stoutner <soren@stoutner.com>.
+  Copyright 2023-2024 Soren Stoutner <soren@stoutner.com>.
 
   This file is part of Privacy Browser PC <https://www.stoutner.com/privacy-browser-pc>.
 
@@ -36,7 +36,7 @@
         </authorgroup>
 
         <copyright>
-            <year>2016-2017, 2021-2023</year>
+            <year>2016-2017, 2021-2024</year>
             <holder>&Soren.Stoutner;</holder>
         </copyright>
 
@@ -44,7 +44,7 @@
         <legalnotice>&FDLNotice;</legalnotice>
 
         <!-- Last update. -->
-        <date>2023-10-10</date>
+        <date>2024-01-06</date>
 
         <!-- The version of Privacy Browser this documentation is written for. -->
         <releaseinfo>&privacybrowser; version 0.5</releaseinfo>
                         </listitem>
                     </varlistentry>
 
+                    <!-- Save Archive. -->
+                    <varlistentry id="file-save-archive">
+                        <term>
+                            <menuchoice>
+                                <shortcut>
+                                    <keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo>
+                                </shortcut>
+
+                                <guimenu>File</guimenu>
+
+                                <guimenuitem>Save Archive</guimenuitem>
+                            </menuchoice>
+                        </term>
+
+                        <listitem>
+                            <para>
+                                Save the webpage as an MHT (MIME encapsulation of aggregate HTML documents) archive.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+
                     <!-- Print. -->
                     <varlistentry  id="file-print">
                         <term>
                 <title>View</title>
 
                 <variablelist>
+                    <!-- Zoom Default. -->
+                    <varlistentry id="zoom-default">
+                        <term>
+                            <menuchoice>
+                                <shortcut>
+                                    <keycombo action="simul">&Ctrl;<keycap>0</keycap></keycombo>
+                                </shortcut>
+
+                                <guimenu>View</guimenu>
+
+                                <guimenuitem>Zoom Default</guimenuitem>
+                            </menuchoice>
+                        </term>
+
+                        <listitem>
+                            <para>
+                                Return to either the app or the domain default zoom factor.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+
                     <!-- Zoom In. -->
                     <varlistentry id="zoom-in">
                         <term>
 
                         <listitem>
                             <para>
-                                Reload the website in the current tab.
+                                Reload the website in the current tab.  When Refresh is visible, <xref linkend="view-stop"/> is hidden.
                             </para>
                         </listitem>
                     </varlistentry>
                         </listitem>
                     </varlistentry>
 
+                    <!-- Stop. -->
+                    <varlistentry id="view-stop">
+                        <term>
+                            <menuchoice>
+                                <shortcut>
+                                    <keycombo action="simul">&Ctrl;&Shift;<keycap>X</keycap></keycombo>
+                                </shortcut>
+
+                                <guimenu>View</guimenu>
+
+                                <guimenuitem>Stop</guimenuitem>
+                            </menuchoice>
+                        </term>
+
+                        <listitem>
+                            <para>
+                                Stop the loading of the website in the current tab.  When Stop is visible, <xref linkend="view-refresh"/> is hidden.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+
                     <!-- View Source. -->
                     <varlistentry id="view-source">
                         <term>
                         </listitem>
                     </varlistentry>
 
+                    <!-- Developer Tools. -->
+                    <varlistentry id="view-developer-tools">
+                        <term>
+                            <menuchoice>
+                                <shortcut>
+                                    <keycap>F12</keycap>
+                                </shortcut>
+
+                                <guimenu>View</guimenu>
+
+                                <guimenuitem>Developer Tools</guimenuitem>
+                            </menuchoice>
+                        </term>
+
+                        <listitem>
+                            <para>
+                                Display the developer tools, which are used to debug websites.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+
                     <!-- Full Screen Mode. -->
                     <varlistentry id="view-full-screen-mode">
                         <term>
 
                 <variablelist>
                     <!-- Edit Bookmarks. -->
-                    <varlistentry id="edit-bookmarks">
+                    <varlistentry id="bookmarks-edit-bookmarks">
                         <term>
                             <menuchoice>
                                 <shortcut>
                         </listitem>
                     </varlistentry>
 
-                    <!-- Add Bookmark. -->
-                    <varlistentry id="add-bookmark">
+                    <!-- View Bookmarks Toolbar. -->
+                    <varlistentry id="bookmarks-view-bookmarks-toolbar">
                         <term>
                             <menuchoice>
                                 <shortcut>
-                                    <keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo>
+                                    <keycombo action="simul">&Ctrl;&Alt;<keycap>B</keycap></keycombo>
                                 </shortcut>
 
                                 <guimenu>Bookmarks</guimenu>
 
-                                <guimenuitem>Add Bookmark</guimenuitem>
+                                <guimenuitem>View Bookmarks Toolbar</guimenuitem>
                             </menuchoice>
                         </term>
 
                         <listitem>
                             <para>
-                                Add a new bookmark.
+                                Toggle the visibility of the bookmarks toolbar.
                             </para>
                         </listitem>
                     </varlistentry>
 
-                    <!-- Add Folder. -->
-                    <varlistentry id="add-folder">
+                    <!-- Add Bookmark. -->
+                    <varlistentry id="bookmarks-add-bookmark">
                         <term>
                             <menuchoice>
                                 <shortcut>
-                                    <keycombo action="simul">&Meta;<keycap>F</keycap></keycombo>
+                                    <keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo>
                                 </shortcut>
 
                                 <guimenu>Bookmarks</guimenu>
 
-                                <guimenuitem>Add Folder</guimenuitem>
+                                <guimenuitem>Add Bookmark</guimenuitem>
                             </menuchoice>
                         </term>
 
                         <listitem>
                             <para>
-                                Add a bookmark folder.  The meta key on most keyboards is the Windows key.
+                                Add a new bookmark.
                             </para>
                         </listitem>
                     </varlistentry>
 
-                    <!-- View Bookmarks Toolbar. -->
-                    <varlistentry id="view-bookmarks-toolbar">
+                    <!-- Add Folder. -->
+                    <varlistentry id="bookmarks-add-folder">
                         <term>
                             <menuchoice>
                                 <shortcut>
-                                    <keycombo action="simul">&Ctrl;&Alt;<keycap>B</keycap></keycombo>
+                                    <keycombo action="simul">&Meta;<keycap>F</keycap></keycombo>
                                 </shortcut>
 
                                 <guimenu>Bookmarks</guimenu>
 
-                                <guimenuitem>View Bookmarks Toolbar</guimenuitem>
+                                <guimenuitem>Add Folder</guimenuitem>
                             </menuchoice>
                         </term>
 
                         <listitem>
                             <para>
-                                Toggle the visibility of the bookmarks toolbar.
+                                Add a bookmark folder.  The meta key on most keyboards is the Windows key.
                             </para>
                         </listitem>
                     </varlistentry>
             </sect2>
         </sect1>
 
-    <!-- Cookies Dialog. -->
-    <sect1 id="cookies-dialog">
-        <title>Cookies Dialog</title>
+        <!-- Cookies Dialog. -->
+        <sect1 id="cookies-dialog">
+            <title>Cookies Dialog</title>
 
-        <para>
-            The cookies dialog is accessed through <xref linkend="settings-cookies"/> (see <xref linkend="cookies"/>).
-        </para>
+            <para>
+                The cookies dialog is accessed through <xref linkend="settings-cookies"/> (see <xref linkend="cookies"/>).
+            </para>
 
-        <sect2 id="cookies-dialog-commands">
-            <title>Commands</title>
+            <sect2 id="cookies-dialog-commands">
+                <title>Commands</title>
 
-            <variablelist>
-                <!-- Add Cookie. -->
-                <varlistentry id="add-cookie">
-                    <term>
-                        <command>
-                            <keycap>A</keycap>
-                        </command>
-                    </term>
+                <variablelist>
+                    <!-- Add Cookie. -->
+                    <varlistentry id="add-cookie">
+                        <term>
+                            <command>
+                                <keycap>A</keycap>
+                            </command>
+                        </term>
 
-                    <listitem>
-                        <para>
-                            Open the add cookie dialog.
-                        </para>
-                    </listitem>
-                </varlistentry>
+                        <listitem>
+                            <para>
+                                Open the add cookie dialog.
+                            </para>
+                        </listitem>
+                    </varlistentry>
 
-                <!-- Edit Cookie. -->
-                <varlistentry id="edit-cookie">
-                    <term>
-                        <command>
-                            <keycap>E</keycap>
-                        </command>
-                    </term>
+                    <!-- Edit Cookie. -->
+                    <varlistentry id="edit-cookie">
+                        <term>
+                            <command>
+                                <keycap>E</keycap>
+                            </command>
+                        </term>
 
-                    <listitem>
-                        <para>
-                            Open the edit cookie dialog. This command is only valid if a cookie is currently selected.
-                        </para>
-                    </listitem>
-                </varlistentry>
+                        <listitem>
+                            <para>
+                                Open the edit cookie dialog. This command is only valid if a cookie is currently selected.
+                            </para>
+                        </listitem>
+                    </varlistentry>
 
-                <!-- Delete Cookies. -->
-                <varlistentry id="delete-cookies">
-                    <term>
-                        <command>
-                            <keycap>D</keycap> or <keycap>&Del;</keycap>
-                        </command>
-                    </term>
+                    <!-- Delete Cookies. -->
+                    <varlistentry id="delete-cookies">
+                        <term>
+                            <command>
+                                <keycap>D</keycap> or <keycap>&Del;</keycap>
+                            </command>
+                        </term>
 
-                    <listitem>
-                        <para>
-                            Delete the currently selected cookies. A dialog will confirm the deletion before it is processed.
-                        </para>
-                    </listitem>
-                </varlistentry>
+                        <listitem>
+                            <para>
+                                Delete the currently selected cookies. A dialog will confirm the deletion before it is processed.
+                            </para>
+                        </listitem>
+                    </varlistentry>
 
-                <!-- Delete All Cookies. -->
-                <varlistentry id="delete-all-cookie">
-                    <term>
-                        <command>
-                            <keycap>L</keycap>
-                        </command>
-                    </term>
+                    <!-- Delete All Cookies. -->
+                    <varlistentry id="delete-all-cookie">
+                        <term>
+                            <command>
+                                <keycap>L</keycap>
+                            </command>
+                        </term>
 
-                    <listitem>
-                        <para>
-                            Delete all the cookies. A dialog will confirm the deletion before it is processed.
-                        </para>
-                    </listitem>
-                </varlistentry>
+                        <listitem>
+                            <para>
+                                Delete all the cookies. A dialog will confirm the deletion before it is processed.
+                            </para>
+                        </listitem>
+                    </varlistentry>
 
-                <!-- Close. -->
-                <varlistentry id="close-cookies-dialog">
-                    <term>
-                        <command>
-                            <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
-                        </command>
-                    </term>
+                    <!-- Close. -->
+                    <varlistentry id="close-cookies-dialog">
+                        <term>
+                            <command>
+                                <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
+                            </command>
+                        </term>
 
-                    <listitem>
-                        <para>
-                            Close the cookies dialog.
-                        </para>
-                    </listitem>
-                </varlistentry>
-            </variablelist>
-        </sect2>
-    </sect1>
+                        <listitem>
+                            <para>
+                                Close the cookies dialog.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+                </variablelist>
+            </sect2>
+        </sect1>
 
-    <!-- Save Dialog. -->
-    <sect1 id="save-dialog">
-        <title>Save Dialog</title>
+        <!-- Save Dialog. -->
+        <sect1 id="save-dialog">
+            <title>Save Dialog</title>
 
-        <para>
-            The save dialog pops up when a download is initiated.
-        </para>
+            <para>
+                The save dialog pops up when a download is initiated.
+            </para>
 
-        <sect2 id="save-dialog-commands">
-            <title>Commands</title>
+            <sect2 id="save-dialog-commands">
+                <title>Commands</title>
 
-            <variablelist>
-                <!-- Save. -->
-                <varlistentry id="save-dialog-save">
-                    <term>
-                        <command>
-                            <keycap>S</keycap>
-                        </command>
-                    </term>
+                <variablelist>
+                    <!-- Save. -->
+                    <varlistentry id="save-dialog-save">
+                        <term>
+                            <command>
+                                <keycap>S</keycap>
+                            </command>
+                        </term>
 
-                    <listitem>
-                        <para>
-                            Save the file.
-                        </para>
-                    </listitem>
-                </varlistentry>
+                        <listitem>
+                            <para>
+                                Save the file.
+                            </para>
+                        </listitem>
+                    </varlistentry>
 
-                <!-- Close. -->
-                <varlistentry id="save-dialog-close">
-                    <term>
-                        <command>
-                            <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
-                        </command>
-                    </term>
+                    <!-- Close. -->
+                    <varlistentry id="save-dialog-close">
+                        <term>
+                            <command>
+                                <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
+                            </command>
+                        </term>
 
-                    <listitem>
-                        <para>
-                            Close the save dialog without saving the file.
-                        </para>
-                    </listitem>
-                </varlistentry>
-            </variablelist>
-        </sect2>
-    </sect1>
+                        <listitem>
+                            <para>
+                                Close the save dialog without saving the file.
+                            </para>
+                        </listitem>
+                    </varlistentry>
+                </variablelist>
+            </sect2>
+        </sect1>
     </chapter>
 
     <!-- Changelog. -->
     <chapter id="changelog">
         <title>Changelog</title>
 
+        <!-- Version 0.5. -->
+        <sect1 id="version_0.5">
+            <title><ulink url="https://www.stoutner.com/privacy-browser-pc-0-5/">0.5</ulink> -
+                <ulink url="https://gitweb.stoutner.com/?p=PrivacyBrowserPC.git;a=commitdiff;h=a385ca128cb7bcc34ab5467edf21eb5e5664471a;ds=sidebyside">12 October 2023</ulink></title>
+
+            <itemizedlist>
+                <listitem><para>Add <ulink url="https://redmine.stoutner.com/issues/968">bookmarks</ulink>.</para></listitem>
+                <listitem><para>Add <ulink url="https://redmine.stoutner.com/issues/1031">zoom controls</ulink> to the status bar and a
+                        <ulink url="https://redmine.stoutner.com/issues/1044">default zoom shortcut</ulink>.</para></listitem>
+                <listitem><para>Add <ulink url="https://redmine.stoutner.com/issues/1037">keyboard shortcuts</ulink> for the URL toolbar actions.</para></listitem>
+                <listitem><para>Add an action to <ulink url="https://redmine.stoutner.com/issues/1022">view page source</ulink>.</para></listitem>
+                <listitem><para>Change the <ulink url="https://redmine.stoutner.com/issues/1019">domain settings combo boxes</ulink> to list
+                        <code>enabled</code> above <code>disabled</code>.</para></listitem>
+                <listitem><para>File downloads can now <ulink url="https://redmine.stoutner.com/issues/869">show the size</ulink> before the download begins.</para></listitem>
+                <listitem><para>Add PIE (<ulink url="https://redmine.stoutner.com/issues/1021">Position Independent Executable</ulink>) compiler flags.</para></listitem>
+                <listitem><para>Fix a bug that sometimes allowed <ulink url="https://redmine.stoutner.com/issues/1018">multiple domain settings to be created</ulink>.</para></listitem>
+                <listitem><para>Fix the download notification <ulink url="https://redmine.stoutner.com/issues/1017">not being cleared on Xfce</ulink>.</para></listitem>
+            </itemizedlist>
+        </sect1>
+
         <!-- Version 0.4. -->
         <sect1 id="version_0.4">
             <title><ulink url="https://www.stoutner.com/privacy-browser-pc-0-4/">0.4</ulink> -
         <title>Credits and License</title>
 
         <para>
-            Privacy Browser PC copyright 2016-2017,2021-2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
+            Privacy Browser PC copyright 2016-2017,2021-2024 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
         </para>
 
         <!-- Program. -->