From ade9a7818e6351663dafb20d9137a0540adb1741 Mon Sep 17 00:00:00 2001 From: Panagiotis Papadopoulos Date: Sun, 14 Nov 2010 20:53:01 +0100 Subject: Merge rekonq documentation from SVN. thanks to yurchor for the work :-) CCMAIL:yurchor@ukr.net --- docs/index.docbook | 695 +++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 563 insertions(+), 132 deletions(-) (limited to 'docs/index.docbook') diff --git a/docs/index.docbook b/docs/index.docbook index d0335008..3fc3ebff 100644 --- a/docs/index.docbook +++ b/docs/index.docbook @@ -1,6 +1,5 @@ -rekonq"> @@ -33,106 +32,44 @@ ]> - The &rekonq; Handbook - &Andrea.Diamantini; &Andrea.Diamantini.mail; &Rohan.Garg; &Rohan.Garg.mail; &Jonathan.Kolberg; &Jonathan.Kolberg.mail; + + + Part of this documentation was converted from the &kde; UserBase Rekonq page. + + + + + + Part of this documentation was converted from the &kde; UserBase Rekonq/FAQs page. + + + - - - -2008 -&Andrea.Diamantini; - - -2009 -2010 -&Rohan.Garg; - - -2010 -&Jonathan.Kolberg; - - + &FDLNotice; - -2010-05-07 -0.5.0 - +2010-11-13 + 0.6.1 (&kde; SC 4.5) - -&rekonq; is a lightweight web browser for &kde; based on QtWebKit. - - - - + + + KDE browser rekonq webkit - - - - - -Overview - - -&rekonq; is a lightweight web browser for &kde; based on QtWebKit. Amongst other it provides the following features: - -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 - +Introduction +Based initially on qtwebkit (and currently on kdewebkit), &rekonq; is a lightweight browser designed to use the WebKit 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 &konqueror; which is currently the default &kde; web browser. - - - - - - -Introduction - - -&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. - - - - - -Using &rekonq; - - - - -Here's a screenshot of &rekonq; - - - - - - Screenshot - - - - +&rekonq; has already replaced &konqueror; as the default browser in Chakra, with more distributions expressing similar intent for their future releases. Like all &kde; applications, &rekonq; is highly configurable. This document describes how &rekonq; behaves with the normal, @@ -167,10 +104,333 @@ Its implementation is going to embrace &kde; technologies, in order to have a fu - +Interface + + + + + + + + + &rekonq; main toolbar + + + &rekonq; main toolbar + + + + +By default, the &rekonq; window uses only one toolbar. This main toolbar consists of four navigation buttons (back, forward, home, reload/stop), the URL bar and two menu/buttons, one for bookmarks and one for the settings. This minimalist approach to the main toolbar marks the most significant user-interface departure from the traditional multi-toolbar paradigm followed by most other browsers like &konqueror;. + +Further, the main toolbar offers only limited customization – orientation (locked at the top of the window, by default), icon size (medium, by default) and icon labels (not shown, by default). This helps keep the &rekonq; UI simple and puts the focus on the webpage on display. + + + + + + + + + + &rekonq; URL bar + + + &rekonq; URL bar + + + + +&rekonq; introduces a vastly improved URL bar that offers access to search engines from the drop down completion list itself. The completion list is also populated by matching items from your history and bookmarks. + + + + + + + + + + &rekonq; new tab page + + + &rekonq; new tab page + + + + +When started, &rekonq; displays the New Tab page, much of which is taken by a set of preview thumbnails of favorite webpages. These thumbnails offer a speedy way for the user to access their most frequently used webpages. There is also a pane at the top of this page allows the user to switch to previews of recently closed tabs and lists of bookmarked webpages, download and browsing histories. + + + + + + + + + + &rekonq; hidden UI elements + + + &rekonq; hidden UI elements + + + + +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). + + +Features +Under its minimalist appearance, &rekonq; packs a full set of powerful features. Some of them are described below: + +&kde; integration +&rekonq; is designed with the aim of being a &kde; browser. And it shows this. + +Appearance +It obeys your themes, fonts, window decoration, menu highlighting, and many personalization options you set for your desktop. + + +Applications + + + + + + + + + &rekonq; opens a PDF file in an &okular; kpart + + + &rekonq; opens a PDF file in an &okular; kpart + + + + +&rekonq; plays well with other applications in the &kde; family. &rekonq; will always use your chosen default applications to handle file types. PDF files, for example will open in an embedded &okular; kpart within &rekonq; itself. Media files will open in &dragon; (or any other designated default application for that filetype). + + + + + + + + + + &rekonq; shares bookmarks &etc; with &konqueror; + + + &rekonq; shares bookmarks &etc; with &konqueror; + + + + +Bookmarks, web shortcuts (more on these later), cookies and authentication information are shared with &konqueror;. You will see the same set of bookmarks from either application and you can log onto a website in &konqueror; and carry on seamlessly if you decide to switch to &rekonq;. Your passwords are stored securely in KWallet and can be used from either &konqueror; or &rekonq;. + +Your downloads can be optionally handled by KGet. Feeds from websites can be saved to &akregator; (or Google Reader). + + + + + + + + + + &rekonq; + &akregator; + + + &rekonq; + &akregator; + + + + + + + + + + + + + &rekonq; + &kget; + + + &rekonq; + &kget; + + + + + + +Services +KIO support + + + + + + + + + &rekonq; browsing an &FTP; share + + + &rekonq; browsing an &FTP; share + + + + +&rekonq; supports KIO services, including cookies, cache, proxies and network settings. KIO-slaves like file:/, ftp:/, man:/, help:/, info:/ &etc; will work in &rekonq;, too. + + +Dialogs +In addition to all this, &rekonq; uses &kde;'s own file dialog for opening/saving documents. This means, you have access to the Places sidebar from &dolphin; while you open or save documents. + +Thus, &rekonq; looks, feels and behaves like a part of your &kde; desktop. + + + + +Webkit engine +&rekonq; uses the open source WebKit rendering engine which incidentally began life as a branch of the khtml/kjs libraries from the &kde; project. WebKit is fast, powerful and used by many other popular browsers today including Google's Chrome, Apple's Safari and others. + + +Auto-load/click-to-load plugins + + + + + + + + + &rekonq; demonstrating the click-to-load-plugins feature on youtube.com + + + &rekonq; demonstrating the click-to-load-plugins feature on youtube.com + + + + +One of the benefits of using the WebKit engine, is that plugins can be disabled from automatically loading. This comes in handy to surf websites fast, without being bogged down by flash plugins. In the so-called Click-to-load mode, you will instead see a button that you can click on to activate the plugin. + + +Adblock support + + + + + + + + + &rekonq; blocking images on kde-apps.org + + + &rekonq; blocking images on kde-apps.org + + + + +&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. + + +Web shortcuts support +&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 gg:&kde; in the location bar will search Google for &kde;, while wp:&kde; will search Wikipedia for &kde;. There are dozens of these defined by default. You can edit these or even define custom shortcuts to search on your favorite websites. + + +Privacy and security features + + + + + + + + + &rekonq; in private browsing mode + + + &rekonq; in private browsing mode + + + + +&rekonq; allows users to browse the web without retaining information about the visited pages in your history. Note that this feature does not necessarily make you anonymous on the Internet – it only prevents fresh information from being recorded on your computer. You can also delete your history, cookies and other private data anytime straight from the configuration menu button. + + + + + + + + + + &rekonq; URL bar showing the SSL info icon + + + &rekonq; URL bar showing the SSL info icon + + + + +When viewing webpages over a secure connection, you can also view SSL information straight from the URL bar by clicking on the yellow lock icon. + + +Advanced tab handling + + + + + + + + + &rekonq; showing a preview of a tab on hover + + + &rekonq; showing a preview of a tab on hover + + + + +&rekonq; allows you to rearrange your tabs on the fly. Just drag a tab to the left or to the right and the other tabs will move out of your way. You can also hover over a tab to see a live preview of the webpage being displayed there. + +A context menu (right-click menu) gives access to more tab-related functions such as the ability to detach, clone, reload the tab. + + +Session restore feature +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. + + +Full screen mode +&rekonq; supports full-screening the webpage straight from the configuration menu button or through a keyboard shortcut (CtrlShiftF, by default). In the full screen view, the main toolbar will auto-hide and the webpage will be displayed over your entire screen. + + +Zoom slider + + + + + + + + + &rekonq; showing the zoom slider in the configuration menu + + + &rekonq; showing the zoom slider in the configuration menu + + + + +&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 (Ctrl+/-) or mouse (Ctrl mouse scroll up/down) shortcuts just the same. + + -Configure &rekonq; +Detailed &rekonq; configuration @@ -199,7 +459,6 @@ To open the general settings go to Screenshot - @@ -216,12 +475,12 @@ Here a List of configurable points and explanation for it: You can either set your home page directly through tipping the &URL; in. - Set to Current Page - Sets your home page to the one you are visiting at the moment. + Use the New Tab Page as home page + Enabling this option makes an empty new page the default home page of &rekonq;. - Default search engine: - Here you can choose the search engine you like to be searched with as default. + Set to Current Page + Sets your home page to the one you are visiting at the moment. Use KGet for downloading files @@ -231,8 +490,6 @@ Here a List of configurable points and explanation for it: List links with KGet If enabled, &rekonq; will display an additional context menu entry, which, when selected, lists all available links of the current website in &kget;. - - @@ -264,14 +521,20 @@ Here a List of configurable points and explanation for it: Screenshot - -Here a List of configurable points and explanation for it: +Here a list of configurable points and explanation for it: + + New tab opens + Here you can choose the default behavior of &rekonq; when you open the new tab. + + New Tab Page starts with + Here you can choose the default contents for the new tabs. + Open links in new tab instead of in new window This enables the default opening of links in new tabs. @@ -302,27 +565,25 @@ Here a List of configurable points and explanation for it: - + -Configure the Fonts settings +Configure the Appearance settings Now you should see this - + Screenshot - - Following will explain the configurable things and what they do @@ -331,16 +592,44 @@ Following will explain the configurable things and what they do Fixed font - Here you can set your font for &rekonq; labels. The same synopsis like Standard font. + Here you can set your font for &rekonq; labels. The same synopsis like Standard font. + + + Serif font + Here you can set your font for Serif labels. The same synopsis like Standard font. + + + Sans Serif font + Here you can set your font for Sans Serif labels. The same synopsis like Standard font. + + + Cursive font + Here you can set your font for Cursive labels. The same synopsis like Standard font. - Font size + Fantasy font + Here you can set your font for Fantasy labels. The same synopsis like Standard font. + + + Default font size: To configure your preferred size of font. Minimal font size: You can configure the minimal size of fonts in &rekonq;. Every smaller font will grow to that size. + + User CSS path: + Here you can set the path to your CSS file used to format webpages. + + + Auto-scroll on middle-click + Enabling this option makes contents to scroll after the &MMB; click. + + + Enable smooth scrolling + If you enable this option &rekonq; will use smooth scrolling. Uncheck this option if the scrolling becomes choppy. + @@ -362,7 +651,6 @@ Following will explain the configurable things and what they do Screenshot - @@ -387,18 +675,19 @@ Following will explain the configurable things and what they do Screenshot - -As you can see the Cookies can be configured in many ways. +As you can see the cookies can be configured in many ways. -&rekonq; can handle Cookies in three ways +&rekonq; can handle cookies in three ways by default -"Ask for Confirmation" +Ask for confirmation +Accept all cookies +Reject all cookies @@ -418,7 +707,6 @@ As you can see the Cookies can be configured in many ways. Screenshot - @@ -433,7 +721,6 @@ As you can see the Cookies can be configured in many ways. Screenshot - @@ -449,13 +736,12 @@ As you can see the Cookies can be configured in many ways. Now you should see this - + Screenshot - @@ -464,13 +750,12 @@ As you can see the Cookies can be configured in many ways. Now you should see this - + Screenshot - @@ -491,7 +776,6 @@ As you can see the Cookies can be configured in many ways. Screenshot - @@ -512,7 +796,6 @@ As you can see the Cookies can be configured in many ways. Screenshot - @@ -520,12 +803,166 @@ As you can see the Cookies can be configured in many ways. - +rekonq FAQs, Tips and Tricks +How do I set &rekonq; as my default browser? +Head to System SettingsDefault Applications. Here, click on Web Browser to set your default browser. Select to open http and https URLs in the following browser and enter rekonq %u as the browser. Click Apply. + + + + + + + + + + Setting &rekonq; as the default web browser + + + Setting &rekonq; as the default web browser + + + + + +How do I load flash on demand? +Click on the configuration menu button, and open the Configure rekonq dialog. Click on WebKit and under Plugin settings, select to Manually Load Plugins. Click OK. + + + + + + + + + + Setting &rekonq; to not automatically load plugins + + + Setting &rekonq; to not automatically load plugins + + + + + +How do I make &rekonq; behave like chrome/chromium? +Using KWin's window tabbing feature, we can make &rekonq; emulate the behavior of chromium 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 Chromium, giving individual controls for each webpage you load. + +Click on the configuration menu button and open the Configure rekonq dialog. Click on Tabs. Unselect all options to disable all tab handling in &rekonq;. Now, &rekonq; will always open new windows instead of tabs. + +Now, we'll set up KWin to automatically tab all &rekonq; windows together. Head to System SettingsWindow Behavior. Select Window Behavior on the left and go to the Advanced tab. Here, under Window Tabbing, check Automatically group similar windows. Click Apply. + +Now, &rekonq; will open windows by default which will automatically get tabbed together. + + + + + + + + + + &rekonq; configuration + + + &rekonq; configuration + + + + + + + + + + + + + System Settings configuration + + + System Settings configuration + + + + + + + + + + + + + The result + + + The result + + + + + +How do I enable Adblock? +Adblocking should already be enabled for you using the Easylist adblock subscription. You can further configure it by clicking on the configuration menu button and opening the Configure rekonq dialog. Click on AdBlocK Filters. Here, you can add custom filters using wildcard strings (e.g. http://www.site.com/ads/*) or regular expressions within forward slashes (e.g. //(ads|dclk)\./). + +Clicking Apply activates your adblock filters instantly. + + + + + + + + + + &rekonq; AdBlocK (automatic) configuration + + + &rekonq; AdBlocK (automatic) configuration + + + + + + + + + + + + + &rekonq; AdBlocK (manual) configuration + + + &rekonq; AdBlocK (manual) configuration + + + + + +I have more questions! +If you have &rekonq; installed, you can load up the Help document (just press F1) for more information. - + +&kde; Forums is always a good place to ask user-specific questions. +The &rekonq; website has release announcements for the latest stable and unstable releases along with more helpful links. You can also contact the developers on the #rekonq IRC channel or the mailing list with more questions. + + +How do I contribute? +See above for now. + + + + +Smiley + + + + + + Credits and License - &rekonq; @@ -536,9 +973,7 @@ Program copyright: &underGPL; Developers -&The.rekonq.Team; &The.rekonq.Team.mail; Find more about us in the 'About &rekonq;' section - - +&The.rekonq.Team; &The.rekonq.Team.mail; @@ -550,14 +985,12 @@ Documentation copyright 2009-2010 &Rohan.Garg; &Rohan.Garg.mail; Documentation copyright 2010 &Jonathan.Kolberg; &Jonathan.Kolberg.mail; - - - -&underFDL; -&underGPL; - + +List of the UserBase contributors can be found on + Rekonq and Rekonq/FAQs page history. + +&underFDL; - Installation @@ -649,7 +1082,5 @@ To compile the code tip in the following - &documentation.index; - - + \ No newline at end of file -- cgit v1.2.1 From 8866b373200ef9c73653f458badc9b65ae95c62e Mon Sep 17 00:00:00 2001 From: Panagiotis Papadopoulos Date: Sun, 14 Nov 2010 21:11:47 +0100 Subject: Some small fixes --- docs/index.docbook | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/index.docbook') diff --git a/docs/index.docbook b/docs/index.docbook index 3fc3ebff..3a363838 100644 --- a/docs/index.docbook +++ b/docs/index.docbook @@ -1004,7 +1004,7 @@ List of the UserBase contributors can be found on Requirements -In order to successfully use &rekonq;, you need at least &Qt; 4.6.x and &kde; 4.4.x. +In order to successfully use &rekonq;, you need at least &Qt; 4.7.x and &kde; 4.5.x. @@ -1027,7 +1027,7 @@ List of the UserBase contributors can be found on -We will be using git, as the most recent code is available on the git repository. The gitorious page for &rekonq; can be found here. Stable releases, can also be downloaded here 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 here. Stable releases, can also be downloaded here in form of tarballs. @@ -1036,12 +1036,12 @@ Now we need to checkout the latest code. To do so, in a terminal run: - git git://gitorious.org/rekonq/mainline.git + git git://git.kde.org/rekonq -To compile the code tip in the following +To compile the code type in the following -- cgit v1.2.1 From a1073109b384ae167033bc2f3d09ead8a7d598a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Burkhard=20L=C3=BCck?= Date: Sat, 20 Nov 2010 18:02:06 +0100 Subject: Fix markup: there is no menu string 'Toolbutton', it is an 'Tool' icon --- docs/index.docbook | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) (limited to 'docs/index.docbook') diff --git a/docs/index.docbook b/docs/index.docbook index 3a363838..dc6a0120 100644 --- a/docs/index.docbook +++ b/docs/index.docbook @@ -441,11 +441,8 @@ You want to configure the general behavior of &rekonq;? You found the right plac -To open the general settings go to - -Toolbutton -Configure rekonq - +To open the general settings click on the Tool icon +and select Configure rekonq. @@ -502,9 +499,8 @@ Here a List of configurable points and explanation for it: Here you learn how to change the settings for tabs. -To come to the dialog open +To come to the dialog click on the Tool icon and open -Toolbutton Configure rekonq Tabs -- cgit v1.2.1