From 7b48967a21c5ea37cbd79923523bad1e2cd6a25b Mon Sep 17 00:00:00 2001 From: Jonathan Raphael Joachim Kolberg Date: Sun, 2 May 2010 14:25:19 +0200 Subject: I rewrote the documentation and made a few screenshots. There are some parts left to write, but I will do that soon. --- docs/CMakeLists.txt | 3 +- docs/automatic_filters.png | Bin 0 -> 56501 bytes docs/cache.png | Bin 0 -> 61487 bytes docs/cookies.png | Bin 0 -> 77768 bytes docs/fonts.png | Bin 0 -> 57415 bytes docs/general.png | Bin 0 -> 69690 bytes docs/index.docbook | 337 ++++++++++++++++++++++++++++++++++++++++++--- docs/old_screenshot.png | Bin 0 -> 72657 bytes docs/own_filter.png | Bin 0 -> 11375 bytes docs/proxy.png | Bin 0 -> 73465 bytes docs/screenshot.png | Bin 72657 -> 248715 bytes docs/shortcuts.png | Bin 0 -> 87938 bytes docs/snapshot1.png | Bin 0 -> 598555 bytes docs/tabs.png | Bin 0 -> 62259 bytes docs/webkit.png | Bin 0 -> 75241 bytes docs/webshortcuts.png | Bin 0 -> 86908 bytes 16 files changed, 318 insertions(+), 22 deletions(-) create mode 100644 docs/automatic_filters.png create mode 100644 docs/cache.png create mode 100644 docs/cookies.png create mode 100644 docs/fonts.png create mode 100644 docs/general.png create mode 100644 docs/old_screenshot.png create mode 100644 docs/own_filter.png create mode 100644 docs/proxy.png create mode 100644 docs/shortcuts.png create mode 100644 docs/snapshot1.png create mode 100644 docs/tabs.png create mode 100644 docs/webkit.png create mode 100644 docs/webshortcuts.png diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 5ddaecc9..58af3730 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -1,5 +1,4 @@ -########### install files ############### -# +########### install files ################ cmake_minimum_required(VERSION 2.6) find_package(KDE4 REQUIRED) include (KDE4Defaults) diff --git a/docs/automatic_filters.png b/docs/automatic_filters.png new file mode 100644 index 00000000..ad69fd3a Binary files /dev/null and b/docs/automatic_filters.png differ diff --git a/docs/cache.png b/docs/cache.png new file mode 100644 index 00000000..27e683c6 Binary files /dev/null and b/docs/cache.png differ diff --git a/docs/cookies.png b/docs/cookies.png new file mode 100644 index 00000000..24c860e3 Binary files /dev/null and b/docs/cookies.png differ diff --git a/docs/fonts.png b/docs/fonts.png new file mode 100644 index 00000000..54a1a10e Binary files /dev/null and b/docs/fonts.png differ diff --git a/docs/general.png b/docs/general.png new file mode 100644 index 00000000..d3e02f22 Binary files /dev/null and b/docs/general.png differ diff --git a/docs/index.docbook b/docs/index.docbook index ca07e9cf..a1a18995 100644 --- a/docs/index.docbook +++ b/docs/index.docbook @@ -13,6 +13,11 @@ Garg "> + + Jonathan + Kolberg + + "> rekonq Team @@ -20,6 +25,7 @@ "> adjam7@gmail.com"> rohan16garg@gmail.com"> + bulldog98@kubuntu-de.org"> rekonq@kde.org"> @@ -34,19 +40,23 @@ &Andrea.Diamantini; &Andrea.Diamantini.mail; &Rohan.Garg; &Rohan.Garg.mail; +&Jonathan.Kolberg; &Jonathan.Kolberg.mail; + 2008 -2009 +2009-2010 +2010 &Andrea.Diamantini; &Rohan.Garg; +&Jonathan.Kolberg; &FDLNotice; -2009-10-22 -0.3.0 +2010-05-01 +0.5.0 @@ -70,16 +80,20 @@ Overview -&rekonq; is a lightweight web browser for &kde; based on WebKit. It can currently +&rekonq; is a lightweight web browser for &kde; based on QtWebKit. Amongst other it provides the following features: -Share bookmarks with &konqueror; -Share Cookies with &konqueror; +Shared bookmarks with &konqueror; +Shared cookies with &konqueror; Handle tabbed browsing Display tab previews Handle support for NS plugins (eg: flash) Share General &kde; Proxy settings Browse anonymously Inspect web pages +File and &FTP; protocol handling +KWallet support for storing passwords +Ad-Block support +&kget; Download integration @@ -91,8 +105,8 @@ Introduction -&rekonq; is a lightweight web browser for &kde; based on WebKit. Its code is based on Nokia QtDemoBrowser. -Its implementation is going to embrace &kde; technologies to have a full-featured &kde; web browser. +&rekonq; is a lightweight web browser for &kde; based on WebKit. Its code is based on the Nokia QtDemoBrowser. +Its implementation is going to embrace &kde; technologies, in order to have a full-featured &kde; web browser. @@ -115,6 +129,19 @@ Its implementation is going to embrace &kde; technologies to have a full-feature +Like all &kde; applications, &rekonq; is highly + configurable. This document describes how &rekonq; behaves with the normal, + default settings. + + A three button mouse can be useful when you are running + &rekonq; or any other &kde; application. If your mouse only has two buttons + then you should be able to set your system up so that you can simulate a a middle mouse button by pressing both buttons at the same time. + + If you are used to having to double-click to perform an action, + then take care, because in common with the rest of &kde;, &rekonq; defaults + to single-clicking. + + @@ -122,19 +149,286 @@ Its implementation is going to embrace &kde; technologies to have a full-feature &rekonq; can be started in the following ways -From the application launcher select + From the application launcher select + + Applications + Internet + rekonq + + + &Alt;F2 will open a + Run Command dialog box,type &rekonq; (lower case) and press &Enter; or + the Run to start &rekonq; + + + + + + + +Configure &rekonq; + + + +Do the general settings of &rekonq; + + +You want to configure the general behavior of &rekonq;? You found the right place to get it explained. + + + +To open the general settings go to -Applications -Internet -rekonq +Toolbutton +Configure rekonq - -&Alt;F2 will open a -Run Command dialog box,type rekonq (lower case) and press &Enter; or -the Run to start &rekonq; + + + + +Now you should see this + + + + + + Screenshot + + + + + + + +Here a List of configurable point and explanation for it: + + + When starting rekonq: You can configure what &rekonq; should do on startup. + Home page URL: You can either set your home page directly trought tipping the &URL; in. + Set to Current Page Sets your home page to the one you are visiting at the moment. + Default search engine: Here you can choose the search engine you like to be searched with as default. + Use KGet for downloading files This activates wether you want to download with &kget;. + List links with KGet ????? + + + + + + + + +Configure the Tabs settings + + + +Now you should see this + + + + + + Screenshot + + + + + + + + +Configure the Fonts settings + + + +Now you should see this + + + + + + Screenshot + + + + + + + + + + +Configure the Webkit settings + + + +Now you should see this + + + + + + Screenshot + + + + + + + + + + +Network configuration + + + +Handling of Cookies with &rekonq; + + + +This is a screenshot of the cookie settings dialog + + + + + + Screenshot + + + + + + + +As you can see the Cookies can be configured in many ways. + + + +&rekonq; can handel Cookies in three ways + +"Ask for Confirmation" + + + + + + +Rest + + + +Now you should see this + + + + + + Screenshot + + + + + + + + +Now you should see this + + + + + + Screenshot + + + + + + + + + + + +Configure the Adblock settings + + + +Now you should see this + + + + + + Screenshot + + + + + + + + +Now you should see this + + + + + + Screenshot + + + + + + + + + + +Configure the Shortcut settings + + + +Now you should see this + + + + + + Screenshot + + + + + + + + + + +Configure the Web Shortcuts settings + + + +Now you should see this + + + + + + Screenshot + + + + + + + + @@ -162,12 +456,14 @@ Program copyright: Documentation copyright 2008 &Andrea.Diamantini; &Andrea.Diamantini.mail; -Documentation copyright 2009 &Rohan.Garg; &Rohan.Garg.mail; +Documentation copyright 2009-2010 &Rohan.Garg; &Rohan.Garg.mail; + + +Documentation copyright 2010 &Jonathan.Kolberg; &Jonathan.Kolberg.mail; - &underFDL; &underBSDLicense; @@ -185,15 +481,16 @@ Documentation copyright 2009 &Rohan.Garg; &Rohan.Garg.mail; Requirements -In order to successfully use &rekonq;, you need at least &Qt; 4.5.x and &kde; 4.3.x. +In order to successfully use &rekonq;, you need at least &Qt; 4.6.x and &kde; 4.4.x. Compilation and Installation -If you wish to compile &rekonq;,go to +If you wish to compile &rekonq;, go to The how to compile &rekonq; page. + diff --git a/docs/old_screenshot.png b/docs/old_screenshot.png new file mode 100644 index 00000000..5603f409 Binary files /dev/null and b/docs/old_screenshot.png differ diff --git a/docs/own_filter.png b/docs/own_filter.png new file mode 100644 index 00000000..01242602 Binary files /dev/null and b/docs/own_filter.png differ diff --git a/docs/proxy.png b/docs/proxy.png new file mode 100644 index 00000000..f08dce80 Binary files /dev/null and b/docs/proxy.png differ diff --git a/docs/screenshot.png b/docs/screenshot.png index 5603f409..ac9d9d76 100644 Binary files a/docs/screenshot.png and b/docs/screenshot.png differ diff --git a/docs/shortcuts.png b/docs/shortcuts.png new file mode 100644 index 00000000..b47cb37b Binary files /dev/null and b/docs/shortcuts.png differ diff --git a/docs/snapshot1.png b/docs/snapshot1.png new file mode 100644 index 00000000..2300d36b Binary files /dev/null and b/docs/snapshot1.png differ diff --git a/docs/tabs.png b/docs/tabs.png new file mode 100644 index 00000000..21f81c7c Binary files /dev/null and b/docs/tabs.png differ diff --git a/docs/webkit.png b/docs/webkit.png new file mode 100644 index 00000000..9698be6d Binary files /dev/null and b/docs/webkit.png differ diff --git a/docs/webshortcuts.png b/docs/webshortcuts.png new file mode 100644 index 00000000..7f20e110 Binary files /dev/null and b/docs/webshortcuts.png differ -- cgit v1.2.1