diff options
Diffstat (limited to 'doc/index.docbook')
| -rw-r--r-- | doc/index.docbook | 170 |
1 files changed, 82 insertions, 88 deletions
diff --git a/doc/index.docbook b/doc/index.docbook index e7c39a13..3089ed3c 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,6 +1,6 @@ <?xml version="1.0" ?> <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ - <!ENTITY rekonq "<application>rekonq</application>"> + <!ENTITY rekonq "<application>rekonq</application>"> <!ENTITY kappname "&rekonq;"> <!ENTITY Andrea.Diamantini "<personname> <firstname>Andrea</firstname> @@ -28,7 +28,7 @@ <!ENTITY The.rekonq.Team.mail "<email>rekonq@kde.org</email>"> <!ENTITY package "playground-network"> <!ENTITY % addindex "IGNORE"> - <!ENTITY % English "INCLUDE"> + <!ENTITY % English "INCLUDE"> ]> <book lang="&language;"> @@ -53,8 +53,8 @@ <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> <legalnotice>&FDLNotice;</legalnotice> -<date>2010-11-13</date> - <releaseinfo>0.6.1 (&kde; SC 4.5)</releaseinfo> +<date>2012-04-07</date> + <releaseinfo>0.9.0 (&kde; SC 4.8)</releaseinfo> <abstract> <para></para> </abstract> @@ -66,7 +66,7 @@ </keywordset> </bookinfo> -<chapter id="introduction"><title>Introduction</title> +<chapter id="introduction"><title>Introduction</title> <para>Based initially on <emphasis>qtwebkit</emphasis> (and currently on <emphasis>kdewebkit</emphasis>), &rekonq; is a lightweight browser designed to use the <guilabel>WebKit</guilabel> rendering engine in combination with various &kde; technologies, allowing it to integrate seamlessly into the &kde; desktop. The name is a throwback to the venerable khtml-based <ulink url="help:/konqueror/index.html">&konqueror;</ulink> which is currently the default &kde; web browser. </para> <para>&rekonq; has already replaced &konqueror; as the default browser in Chakra and Kubuntu, with more distributions expressing similar intent for their future releases. @@ -91,20 +91,20 @@ <para> &rekonq; can be started in the following ways <itemizedlist> - <listitem><para>From the application launcher select + <listitem><para>From the application launcher select <menuchoice> <guimenuitem>Applications</guimenuitem> <guisubmenu>Internet</guisubmenu> <guimenuitem>rekonq</guimenuitem> </menuchoice> </para></listitem> - <listitem><para><keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo> will open + <listitem><para><keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo> will open &krunner;, type <userinput>rekonq</userinput> (lower case) and press &Enter; to start &rekonq;</para></listitem> </itemizedlist> </para> </sect1> </chapter> -<chapter id="interface"><title>Interface</title> +<chapter id="interface"><title>Interface</title> <para> <screenshot> <screeninfo></screeninfo> @@ -180,17 +180,17 @@ <para>Further configuration options activate several other UI elements hidden by default. These include a toolbar for bookmarks, a panel (a panel, being a mini-window that can be resized, detached or re-docked in the main window) each for bookmarks and history and a web inspector panel (handy for web development). </para> </chapter> -<chapter id="features"><title>Features</title> +<chapter id="features"><title>Features</title> <para>Under its minimalist appearance, &rekonq; packs a full set of powerful features. Some of them are described below: </para> -<sect1 id="kde-integration"><title>&kde; integration</title> +<sect1 id="kde-integration"><title>&kde; integration</title> <para>&rekonq; is designed with the aim of being a &kde; browser. And it shows this. </para> -<sect2 id="appearance"><title>Appearance</title> -<para>It obeys your themes, fonts, window decoration, menu highlighting, and many personalization options you set for your desktop. +<sect2 id="appearance"><title>Appearance</title> +<para>It obeys your themes, fonts, window decoration, menu highlighting, and many personalization options you set for your desktop. </para> </sect2> -<sect2 id="applications"><title>Applications</title> +<sect2 id="applications"><title>Applications</title> <para> <screenshot> <screeninfo></screeninfo> @@ -263,8 +263,8 @@ </para> </sect2> </sect1> -<sect1 id="services"><title>Services</title> -<sect2 id="kio-support"><title>KIO support</title> +<sect1 id="services"><title>Services</title> +<sect2 id="kio-support"><title>KIO support</title> <para> <screenshot> <screeninfo></screeninfo> @@ -284,7 +284,7 @@ <para>&rekonq; supports KIO services, including cookies, cache, proxies and network settings. <emphasis>KIO-slaves</emphasis> like file:/, ftp:/, man:/, help:/, info:/ &etc; will work in &rekonq;, too. </para> </sect2> -<sect2 id="dialogs"><title>Dialogs</title> +<sect2 id="dialogs"><title>Dialogs</title> <para>In addition to all this, &rekonq; uses &kde;'s own file dialog for opening/saving documents. This means, you have access to the <emphasis>Places</emphasis> sidebar from &dolphin; while you open or save documents. </para> <para>Thus, &rekonq; looks, feels and behaves like a part of your &kde; desktop. @@ -292,11 +292,11 @@ </sect2> </sect1> </chapter> -<chapter id="webkit-engine"><title>Webkit engine</title> +<chapter id="webkit-engine"><title>Webkit engine</title> <para>&rekonq; uses the open source <guilabel>WebKit</guilabel> rendering engine which incidentally began life as a branch of the khtml/kjs libraries from the &kde; project. <guilabel>WebKit</guilabel> is fast, powerful and used by many other popular browsers today including <trademark class="registered">Google</trademark>'s <trademark class="registered">Chrome</trademark>, <trademark class="registered">Apple</trademark>'s <trademark class="registered">Safari</trademark> and others. </para> </chapter> -<chapter id="auto-load-click-to-load-plugins"><title>Auto-load/click-to-load plugins</title> +<chapter id="auto-load-click-to-load-plugins"><title>Auto-load/click-to-load plugins</title> <para> <screenshot> <screeninfo></screeninfo> @@ -316,7 +316,7 @@ <para>One of the benefits of using the <guilabel>WebKit</guilabel> engine, is that plugins can be disabled from automatically loading. This comes in handy to surf websites fast, without being bogged down by <guilabel>flash</guilabel> plugins. In the so-called <emphasis>Click-to-load</emphasis> mode, you will instead see a button that you can click on to activate the plugin. </para> </chapter> -<chapter id="adblock-support"><title>Adblock support</title> +<chapter id="adblock-support"><title>Adblock support</title> <para> <screenshot> <screeninfo></screeninfo> @@ -336,11 +336,11 @@ <para>&rekonq; comes with an automatic subscription to the Easylist filter, which is updated every week. Additionally, you can set up manual filters to block loading of elements from webpages that match your criteria. You can even download and import additional published filterlists or export your list for backup. </para> </chapter> -<chapter id="web-shortcuts-support"><title>Web shortcuts support</title> +<chapter id="web-shortcuts-support"><title>Web shortcuts support</title> <para>&rekonq; allows you to pick from an extensive list of web shortcuts – these are keywords that allow you to search the web quickly. For instance, entering <userinput>gg:&kde;</userinput> in the location bar will search <emphasis>Google</emphasis> for <quote>&kde;</quote>, while <userinput>wp:&kde;</userinput> will search <emphasis>Wikipedia</emphasis> for <quote>&kde;</quote>. There are dozens of these defined by default. You can edit these or even define custom shortcuts to search on your favorite websites. </para> </chapter> -<chapter id="privacy-and-security-features"><title>Privacy and security features</title> +<chapter id="privacy-and-security-features"><title>Privacy and security features</title> <para> <screenshot> <screeninfo></screeninfo> @@ -378,7 +378,7 @@ <para>When viewing webpages over a secure connection, you can also view SSL information straight from the URL bar by clicking on the <guiicon>yellow lock</guiicon> icon. </para> </chapter> -<chapter id="advanced-tab-handling"><title>Advanced tab handling</title> +<chapter id="advanced-tab-handling"><title>Advanced tab handling</title> <para> <screenshot> <screeninfo></screeninfo> @@ -400,15 +400,16 @@ <para>A <emphasis>context menu</emphasis> (right-click menu) gives access to more tab-related functions such as the ability to detach, clone, reload the tab. </para> </chapter> -<chapter id="session-restore-feature"><title>Session restore feature</title> +<chapter id="session-restore-feature"><title>Session restore feature</title> <para>If &rekonq; crashes, it will automatically attempt to restore your session, complete with all the tabs the next time you start it. If for some reason, the browser continues to crash upon restoring the session, &rekonq; will automatically start with a fresh session the second time. </para> </chapter> -<chapter id="full-screen-mode"><title>Full screen mode</title> +<chapter id="full-screen-mode"><title>Full screen mode</title> <para>&rekonq; supports full-screening the webpage straight from the configuration menu button or through a keyboard shortcut (<keycombo>&Ctrl;&Shift;<keycap>F</keycap></keycombo>, by default). In the full screen view, the main toolbar will auto-hide and the webpage will be displayed over your entire screen. </para> </chapter> -<chapter id="zoom-slider"><title>Zoom slider</title> +<!-- +<chapter id="zoom-slider"><title>Zoom slider</title> <para> <screenshot> <screeninfo></screeninfo> @@ -428,7 +429,7 @@ <para>&rekonq; has a slider to adjust the zoom right from the configuration menu with a handy button to restore the zoom back to default. Of course, you can still use keyboard (<keycombo>&Ctrl;<keycap>+/-</keycap></keycombo>) or mouse (<keycombo>&Ctrl;<keycap> mouse scroll up/down</keycap></keycombo>) shortcuts just the same. </para> </chapter> - +--> <chapter id="Config-rekonq"> <title>Detailed &rekonq; configuration</title> @@ -499,7 +500,7 @@ Here a List of configurable points and explanation for it: <para>Here you learn how to change the settings for tabs.</para> -<para>To come to the dialog click on the <guiicon>Tool</guiicon> icon and open +<para>To come to the dialog click on the <guiicon>Tool</guiicon> icon and open <menuchoice> <guisubmenu>Configure rekonq</guisubmenu> <guimenuitem>Tabs</guimenuitem> @@ -532,8 +533,8 @@ Here a list of configurable points and explanation for it: <listitem><para>Here you can choose the default contents for the new tabs.</para></listitem> </varlistentry> <varlistentry> - <term><guilabel>Open links in new tab instead of in new window</guilabel></term> - <listitem><para>This enables the default opening of links in new tabs.</para></listitem> + <term><guilabel>Don't use tabs: open links in new window</guilabel></term> + <listitem><para>This enables the default opening of links in new windows.</para></listitem> </varlistentry> <varlistentry> <term><guilabel>Always show tab bar</guilabel></term> @@ -548,10 +549,6 @@ Here a list of configurable points and explanation for it: <listitem> <para>This makes it to default that tabs are opened next to the currently active one.</para></listitem> </varlistentry> <varlistentry> - <term><guilabel>Show preview when hovering tab</guilabel></term> - <listitem> <para>This shows you an preview of the content of a tab if you hover it. This can be useful if you have many tabs opened. </para> </listitem> - </varlistentry> - <varlistentry> <term><guilabel>Activate previously used tab when closing the current one</guilabel></term> <listitem> <para>This makes &rekonq; storing your last opened tab and if you close your current one it will reopen the old one. This also can be useful if you use many tabs.</para> </listitem> </varlistentry> @@ -580,7 +577,8 @@ Here a list of configurable points and explanation for it: </para> <para> -Following will explain the configurable things and what they do + Following will explain the configurable things and what they do on <guilabel>Fonts</guilabel> tab. +</para> <variablelist> <varlistentry> <term><guilabel>Standard font</guilabel></term> @@ -614,22 +612,52 @@ Following will explain the configurable things and what they do <term><guilabel>Minimal font size:</guilabel></term> <listitem><para>You can configure the minimal size of fonts in &rekonq;. Every smaller font will grow to that size.</para></listitem> </varlistentry> +</variablelist> +<para>On <guilabel>Stylesheets</guilabel> tab:</para> + +<para> +<screenshot> +<screeninfo>Now you should see this</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="appearance_stylesheets.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<variablelist> <varlistentry> - <term><guilabel>User CSS path:</guilabel></term> + <term><guilabel>Path to custom CSS file:</guilabel></term> <listitem><para>Here you can set the path to your CSS file used to format webpages.</para></listitem> </varlistentry> - <varlistentry> - <term><guilabel>Auto-scroll on middle-click</guilabel></term> - <listitem><para>Enabling this option makes contents to scroll after the &MMB; click.</para></listitem> - </varlistentry> +</variablelist> +<para>On <guilabel>Misc</guilabel> tab:</para> + +<para> +<screenshot> +<screeninfo>Now you should see this</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="appearance_misc.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<variablelist> <varlistentry> <term><guilabel>Enable smooth scrolling</guilabel></term> <listitem><para>If you enable this option &rekonq; will use smooth scrolling. Uncheck this option if the scrolling becomes choppy.</para></listitem> </varlistentry> </variablelist> -</para> - </sect1> <sect1 id="Webkit"> @@ -723,40 +751,6 @@ As you can see the cookies can be configured in many ways. </sect1> -<sect1 id="AdBlock"> - -<title>Configure the Adblock settings</title> - -<para> -<screenshot> -<screeninfo>Now you should see this</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="Rekonq-adblockconfiguration.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Screenshot</phrase> - </textobject> - </mediaobject> -</screenshot> -</para> - -<para> -<screenshot> -<screeninfo>Now you should see this</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="Rekonq-adblockconfiguration-manual.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Screenshot</phrase> - </textobject> - </mediaobject> -</screenshot> -</para> - -</sect1> - <sect1 id="Shortcut"> <title>Configure the Shortcut settings</title> @@ -779,7 +773,7 @@ As you can see the cookies can be configured in many ways. <sect1 id="WebShortcut"> -<title>Configure the Web Shortcuts settings</title> +<title>Configure Search Engines settings</title> <para> <screenshot> @@ -799,8 +793,8 @@ As you can see the cookies can be configured in many ways. </chapter> -<chapter id="rekonq-faqs-tips-and-tricks"><title>rekonq FAQs, Tips and Tricks</title> -<sect1 id="how-do-i-set-rekonq-as-my-default-browser"><title>How do I set &rekonq; as my default browser?</title> +<chapter id="rekonq-faqs-tips-and-tricks"><title>rekonq FAQs, Tips and Tricks</title> +<sect1 id="how-do-i-set-rekonq-as-my-default-browser"><title>How do I set &rekonq; as my default browser?</title> <para>Head to <menuchoice><guimenu>System Settings</guimenu><guimenuitem>Default Applications</guimenuitem></menuchoice>. Here, click on <guilabel>Web Browser</guilabel> to set your default browser. Select to open http and https URLs in the following browser and enter <userinput>rekonq %u</userinput> as the browser. Click <guilabel>Apply</guilabel>. </para> <para> @@ -820,7 +814,7 @@ As you can see the cookies can be configured in many ways. </screenshot> </para> </sect1> -<sect1 id="how-do-i-load-flash-on-demand"><title>How do I load flash on demand?</title> +<sect1 id="how-do-i-load-flash-on-demand"><title>How do I load flash on demand?</title> <para>Click on the <guilabel>configuration</guilabel> menu button, and open the <guilabel>Configure rekonq</guilabel> dialog. Click on <guilabel>WebKit</guilabel> and under <guilabel>Plugin settings</guilabel>, select to <guilabel>Manually Load Plugins</guilabel>. Click <guilabel>OK</guilabel>. </para> <para> @@ -840,7 +834,7 @@ As you can see the cookies can be configured in many ways. </screenshot> </para> </sect1> -<sect1 id="how-do-i-make-rekonq-behave-like-chrome-chromium"><title>How do I make &rekonq; behave like chrome/chromium?</title> +<sect1 id="how-do-i-make-rekonq-behave-like-chrome-chromium"><title>How do I make &rekonq; behave like chrome/chromium?</title> <para>Using <ulink url="help:/kwin/index.html">KWin</ulink>'s window tabbing feature, we can make &rekonq; emulate the behavior of <guilabel>chromium</guilabel> by opening new windows instead of tabs within the same window. This will not however allow each window of &rekonq; to crash independently – all windows of &rekonq; crash as a single process. It merely emulates the look of <application>Chromium</application>, giving individual controls for each webpage you load. </para> <para>Click on the configuration menu button and open the <guilabel>Configure rekonq</guilabel> dialog. Click on <guilabel>Tabs</guilabel>. Unselect all options to disable all tab handling in &rekonq;. Now, &rekonq; will always open new windows instead of tabs. @@ -898,8 +892,8 @@ As you can see the cookies can be configured in many ways. </screenshot> </para> </sect1> -<sect1 id="how-do-i-enable-adblock"><title>How do I enable Adblock?</title> -<para>Adblocking should already be enabled for you using the <guilabel>Easylist</guilabel> adblock subscription. You can further configure it by clicking on the configuration menu button and opening the <guilabel>Configure rekonq</guilabel> dialog. Click on <guilabel>AdBlocK Filters</guilabel>. Here, you can add custom filters using wildcard strings (e.g. <command>http://www.site.com/ads/*</command>) or regular expressions within forward slashes (e.g. <userinput>//(ads|dclk)\./</userinput>). +<sect1 id="how-do-i-enable-adblock"><title>How do I enable Adblock?</title> +<para>Adblocking should already be enabled for you using the <guilabel>Easylist</guilabel> adblock subscription. You can further configure it by clicking on the configuration menu button and choosing <menuchoice><guisubmenu>Tools</guisubmenu> <guimenuitem>Ad Block</guimenuitem> </menuchoice> to open <guilabel>Ad Block Settings</guilabel> dialog. Click on <guilabel>AdBlocK Filters</guilabel>. Here, you can add custom filters using wildcard strings (e.g. <command>http://www.site.com/ads/*</command>) or regular expressions within forward slashes (e.g. <userinput>//(ads|dclk)\./</userinput>). </para> <para>Clicking <guilabel>Apply</guilabel> activates your adblock filters instantly. </para> @@ -936,16 +930,16 @@ As you can see the cookies can be configured in many ways. </screenshot> </para> </sect1> -<sect1 id="i-have-more-questions"><title>I have more questions!</title> +<sect1 id="i-have-more-questions"><title>I have more questions!</title> <para>If you have &rekonq; installed, you can load up the <guilabel>Help</guilabel> document (just press <keycap>F1</keycap>) for more information.</para> -<!--A user-generated manual is also available <ulink url="http://userbase.kde.org/Special:myLanguage/Rekonq/Manual">here</ulink>.--> +<!--A user-generated manual is also available <ulink url="http://userbase.kde.org/Special:myLanguage/Rekonq/Manual">here</ulink>.--> <para><ulink url="http://forum.kde.org">&kde; Forums</ulink> is always a good place to ask user-specific questions.</para> <para>The <ulink url="http://rekonq.kde.org/">&rekonq; website</ulink> has release announcements for the latest stable and unstable releases along with more helpful links. You can also contact the developers on the <ulink url="irc://freenode/#rekonq">#rekonq IRC channel</ulink> or the <ulink url="mailto:rekonq@kde.org">mailing list</ulink> with more questions. </para> </sect1> -<sect1 id="how-do-i-contribute"><title>How do I contribute?</title> +<sect1 id="how-do-i-contribute"><title>How do I contribute?</title> <para>See above for now. <inlinemediaobject> <imageobject> <imagedata fileref="Face-smile.png" format="PNG"/> @@ -982,8 +976,8 @@ Documentation copyright 2009-2010 &Rohan.Garg; &Rohan.Garg.mail; Documentation copyright 2010 &Jonathan.Kolberg; &Jonathan.Kolberg.mail; </para> <para> -List of the UserBase contributors can be found on - <ulink url="http://userbase.kde.org/index.php?title=Rekonq&action=history">Rekonq</ulink> and <ulink url="http://userbase.kde.org/index.php?title=Rekonq/FAQs&action=history">Rekonq/FAQs</ulink> page history.</para> +List of the UserBase contributors can be found on + <ulink url="http://userbase.kde.org/index.php?title=Rekonq&action=history">Rekonq</ulink> and <ulink url="http://userbase.kde.org/index.php?title=Rekonq/FAQs&action=history">Rekonq/FAQs</ulink> page history.</para> <!-- TRANS:CREDIT_FOR_TRANSLATORS --> &underFDL; </chapter> @@ -1023,7 +1017,7 @@ List of the UserBase contributors can be found on </para> <para> -We will be using git, as the most recent code is available on the git repository. The &kde; Projects webpage for &rekonq; can be found <ulink url="https://projects.kde.org/projects/extragear/network/rekonq">here</ulink>. Stable releases, can also be downloaded <ulink url="http://sourceforge.net/projects/rekonq/files/">here</ulink> in form of tarballs. +We will be using git, as the most recent code is available on the git repository. The &kde; Projects webpage for &rekonq; can be found <ulink url="https://projects.kde.org/projects/extragear/network/rekonq">here</ulink>. Stable releases, can also be downloaded <ulink url="http://sourceforge.net/projects/rekonq/files/">here</ulink> in form of tarballs. </para> <para> |