diff options
| -rw-r--r-- | doc/index.docbook | 607 |
1 files changed, 183 insertions, 424 deletions
diff --git a/doc/index.docbook b/doc/index.docbook index 6eb4cd25..2141c177 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,497 +1,305 @@ <?xml version="1.0" ?> -<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ - <!-- Define an entity for your application if it is not part of KDE - CVS --> - <!ENTITY kmyapplication "<application>rekonq</application>"> - <!ENTITY kappname "&rekonq;"><!-- replace kmyapplication here - do *not* replace kappname--> - <!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc. Leave - this unchanged if your - application is not maintained in KDE CVS --> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ + <!ENTITY rekonq "Rekonq"> + <!ENTITY Andrea.Diamantini "<personname> + <firstname>Andrea</firstname> + <surname>Diamantini</surname> + </personname> + "> + <!ENTITY Andrea.Diamantini.mail "<email>adjam7@gmail.com</email>"> <!ENTITY % addindex "IGNORE"> - <!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English - original documentation, change - the language here --> - - <!-- Do not define any other entities; instead, use the entities - from entities/general.entities and $LANG/user.entities. --> + <!ENTITY % English "INCLUDE"> ]> -<!-- kdoctemplate v0.9 January 10 2003 - Changes to comments to clarify entity usage January 10 2003 - Minor update to "Credits and Licenses" section on August 24, 2000 - Removed "Revision history" section on 22 January 2001 - Changed to Installation/Help menu entities 18 October 2001 - Other minor cleanup and changes 18 October 2001 - FPI change and minor changes November 2002 --> - -<!-- -This template was designed by: David Rugge davidrugge@mindspring.com -with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr -and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de -of the KDE DocBook team. - -You may freely use this template for writing any sort of KDE documentation. -If you have any changes or improvements, please let us know. - -Remember: -- in XML, the case of the <tags> and attributes is relevant ; -- also, quote all attributes. - -Please don't forget to remove all these comments in your final documentation, -thanks ;-). ---> - -<!-- ................................................................ --> - -<!-- The language must NOT be changed here. --> -<!-- If you are writing original documentation in a language other --> -<!-- than English, change the language above ONLY, not here --> -<book lang="&language;"> -<!-- This header contains all of the meta-information for the document such -as Authors, publish date, the abstract, and Keywords --> +<book lang="&language;"> <bookinfo> <title>The &rekonq; Handbook</title> <authorgroup> -<author> -<!-- This is just put in as an example. For real documentation, please - define a general entity in entities/contributor.entities, e.g. -<!ENTITY George.N.Ugnacious "<personname><firstname>George</firstname><othername>N.</othername><surname>Ugnacious</surname></personname>"> -<!ENTITY George.N.Ugnacious.mail "<email>gnu@kde.org</email>"> -and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element. - --> -<personname> -<firstname>Andrea</firstname> -<surname>Diamantini</surname> -</personname> -<email>adjam7@gmail.com</email> -</author> +<author>&Andrea.Diamantini; &Andrea.Diamantini.mail;</author> </authorgroup> -<!-- TRANS:ROLES_OF_TRANSLATORS --> - <copyright> <year>2008</year> -<holder>Andrea Diamantini</holder> +<year>2009</year> +<holder>&Andrea.Diamantini;</holder> </copyright> -<!-- Translators: put here the copyright notice of the translation --> -<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook - and in the FDL itself on how to use it. --> -<legalnotice>&FDLNotice;</legalnotice> - -<!-- Date and version information of the application -Don't forget to include this last date and this last revision number, we -need them for translation coordination ! -Please respect the format of the date (YYYY-MM-DD) and of the version -(V.MM.LL), it could be used by automation scripts. -Do NOT change these in the translation. --> -<date>2008-12-01</date> -<releaseinfo>0.00.03</releaseinfo> +<legalnotice>&FDLNotice;</legalnotice> -<!-- Abstract about this handbook --> +<date>2008-11-16</date> +<releaseinfo>0.0.3</releaseinfo> <abstract> <para> -&rekonq; is an application specially designed to do nothing you would -ever want. +&rekonq; is a lightweight KDE browser based on WebKit. </para> </abstract> -<!-- This is a set of Keywords for indexing by search engines. -Please at least include KDE, the KDE package it is in, the name - of your application, and a few relevant keywords. --> - <keywordset> <keyword>KDE</keyword> -<keyword>kdenetwork</keyword> +<keyword>browser</keyword> <keyword>rekonq</keyword> <keyword>webkit</keyword> -<keyword>browser</keyword> </keywordset> </bookinfo> -<!-- The contents of the documentation begin here. Label -each chapter so with the id attribute. This is necessary for two reasons: it -allows you to easily reference the chapter from other chapters of your -document, and if there is no ID, the name of the generated HTML files will vary -from time to time making it hard to manage for maintainers and for the CVS -system. Any chapter labelled (OPTIONAL) may be left out at the author's -discretion. Other chapters should not be left out in order to maintain a -consistent documentation style across all KDE apps. --> +<!-- ================== CHAPTER ================== --> <chapter id="introduction"> -<title>Introduction</title> -<!-- The introduction chapter contains a brief introduction for the -application that explains what it does and where to report -problems. Basically a long version of the abstract. Don't include a -revision history. (see installation appendix comment) --> +<title>Introduction</title> <para> -&rekonq; is a program that lets you do absolutely nothing. Please report -any problems or feature requests to the &kde; mailing lists. +&rekonq; is a lightweight KDE browser based on WebKit. </para> -</chapter> -<chapter id="using-kapp"> -<title>Using &rekonq;</title> +<sect1 id="starting"> -<!-- This chapter should tell the user how to use your app. You should use as -many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document -your application. --> +<title>Launching &rekonq;</title> <para> +The Find Files tool is a useful method of searching for specific files on your +computer, or for searching for files that match a pattern. An example of +this could include searching for files of a particular type or with certain +letters in the filename. -<!-- Note that all graphics should be in .png format. Do not use gifs because of -patent issues. --> - -<screenshot> -<screeninfo>Here's a screenshot of &rekonq;</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="screenshot.png" format="PNG"/> - </imageobject> - <imageobject> - <imagedata fileref="screenshot.eps" format="EPS"/> - </imageobject> - <textobject> - <phrase>Screenshot</phrase> - </textobject> - </mediaobject> -</screenshot> -</para> - - -<sect1 id="kapp-features"> -<title>More &rekonq; features</title> - -<para>It slices! It dices! and it comes with a free toaster!</para> -<para> -The Squiggle Tool <guiicon><inlinemediaobject> - <imageobject> - <imagedata fileref="squiggle.png" format="PNG"/> - </imageobject> - <imageobject> - <imagedata fileref="squiggle.eps" format="EPS"/> - </imageobject> - <textobject> - <phrase>Squiggle</phrase> - </textobject> -</inlinemediaobject></guiicon> is used to draw squiggly lines all over -the &rekonq; main window. It's not a bug, it's a feature! +You can load this utility by clicking on <guimenuitem>Find Files</guimenuitem>. This will +launch &rekonq;. </para> </sect1> + </chapter> -<chapter id="commands"> -<title>Command Reference</title> +<!-- ================== CHAPTER ================== --> -<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the -application windows and their menubar and toolbar commands for easy reference. -Also include any keys that have a special function but have no equivalent in the -menus or toolbars. This may not be necessary for small apps or apps with no tool -or menu bars. --> +<chapter id="kfind"> +<title>Finding Files</title> -<sect1 id="kapp-mainwindow"> -<title>The main &rekonq; window</title> +<sect1 id="name-tab"> +<title>The Name/Location Tab</title> -<sect2> -<title>The File Menu</title> <para> +When starting &rekonq;, you will see a quite simple window. Type in the +name of the file you are searching in the text box labeled +<guilabel>Named:</guilabel>. Choose a folder where you want to search +by typing it in the field <guilabel>Look in:</guilabel> +or by clicking <guibutton>Browse...</guibutton> and press +<keycap>Enter</keycap> or click <guibutton>Find</guibutton>. If +<guilabel>Include subfolders</guilabel> is checked all +subfolders starting from your chosen folder will be searched +too. The results will be displayed in the box below. +</para> + +<para> +You can use the following wildcards: +</para> + <variablelist> <varlistentry> -<term><menuchoice> -<shortcut> -<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> -</shortcut> -<guimenu>File</guimenu> -<guimenuitem>New</guimenuitem> -</menuchoice></term> -<listitem><para><action>Creates a new document</action></para></listitem> -</varlistentry> -<varlistentry> -<term><menuchoice> -<shortcut> -<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> -</shortcut> -<guimenu>File</guimenu> -<guimenuitem>Save</guimenuitem> -</menuchoice></term> -<listitem><para><action>Saves the document</action></para></listitem> +<term>The Asterisk <quote><keycap>*</keycap></quote></term> +<listitem> +<para> +The asterisk stands for any number of missing characters (even zero), +that means ⪚ searching for <userinput>marc*</userinput> may find the +files <filename>marc</filename>, <filename>marc.png</filename> and +<filename> marc_must_not_read_this.kwd</filename>. +<userinput>mar*.kwd</userinput> may find +<filename>marketplace.kwd</filename> and +<filename>marc_must_not_read_this.kwd</filename>. +</para> +</listitem> </varlistentry> + <varlistentry> -<term><menuchoice> -<shortcut> -<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> -</shortcut> -<guimenu>File</guimenu> -<guimenuitem>Quit</guimenuitem> -</menuchoice></term> -<listitem><para><action>Quits</action> &rekonq;</para></listitem> -</varlistentry> -</variablelist> +<term>The Question Mark <quote><keycap>?</keycap></quote></term> +<listitem> +<para> +In contrast to the asterisk, the question mark stands for exactly one +character, so <userinput>mar?</userinput> will find +<filename>marc</filename>, but <userinput>marc?</userinput> will not find +anything, as our files are called <filename>marc</filename> and +<filename>marc.png</filename>. You can put as many question marks in the +term as you want, it will find exactly that number of characters. </para> +</listitem> +</varlistentry> -</sect2> - -<sect2> -<title>The <guimenu>Help</guimenu> Menu</title> - -<!-- Assuming you have a standard help menu (help, what's this, about --> -<!-- &rekonq;, about KDE) then the documentation is already written. --> -<!-- The following entity is valid anywhere that a variablelist is --> -<!-- valid. --> - -&help.menu.documentation; +</variablelist> -</sect2> +<para> +Of course you can combine those two wildcard symbols in a search term. +</para> </sect1> -</chapter> - -<chapter id="developers"> -<title>Developer's Guide to &rekonq;</title> -<!-- (OPTIONAL) A Programming/Scripting reference chapter should be -used for apps that use plugins or that provide their own scripting hooks -and/or development libraries. --> +<sect1 id="kfind-date-range"> +<title>The Contents Tab</title> +<variablelist> +<varlistentry> +<term><guilabel>File type</guilabel></term> +<listitem> <para> -Programming &rekonq; plugins is a joy to behold. Just read through the next -66 pages of API's to learn how! +Here you can specify the type of file you are searching for. </para> +</listitem> +</varlistentry> -<!-- Use refentries to describe APIs. Refentries are fairly complicated and you -should consult the docbook reference for further details. The example below was -taken from that reference and shortened a bit for readability. --> - -<refentry id="re-1007-unmanagechildren-1"> -<refmeta> -<refentrytitle>XtUnmanageChildren</refentrytitle> -<refmiscinfo>Xt - Geometry Management</refmiscinfo> -</refmeta> -<refnamediv> -<refname>XtUnmanageChildren -</refname> -<refpurpose>remove a list of children from a parent widget's managed -list. -<indexterm id="ix-1007-unmanagechildren-1"><primary>widgets</primary><secondary>removing</secondary></indexterm> -<indexterm id="ix-1007-unmanagechildren-2"><primary>XtUnmanageChildren</primary></indexterm> -</refpurpose> - -</refnamediv> -<refsynopsisdiv> -<refsynopsisdivinfo> -<date>4 March 1996</date> -</refsynopsisdivinfo> -<synopsis> -void XtUnmanageChildren(<replaceable class="parameter">children</replaceable>, <replaceable class="parameter">num_children</replaceable>) - WidgetList <replaceable class="parameter">children</replaceable>; - Cardinal <replaceable class="parameter">num_children</replaceable>; -</synopsis> - -<refsect2 id="r2-1007-unmanagechildren-1"> -<title>Inputs</title> -<variablelist> <varlistentry> -<term><replaceable class="parameter">children</replaceable> -</term> +<term><guilabel>Containing text</guilabel></term> <listitem> -<para>Specifies an array of child widgets. Each child must be of -class RectObj or any subclass thereof. +<para> +Type in the word or phrase the files you are searching for must +contain. Note: If you do this in a large folder or checked +<guilabel>Include subfolders</guilabel> in the +<guilabel>Name/Location</guilabel> tab, this may take a long time. </para> + +<note> +<para>This option will <emphasis>not</emphasis> work for all files listed +under <guilabel>File type</guilabel>. Only the following file types +are supported: + +<itemizedlist> +<listitem><para>Text files, ⪚ source code and <filename>README</filename> files</para></listitem> +<listitem><para>&kword; >= 1.2</para></listitem> +<listitem><para>&kpresenter; >= 1.2</para></listitem> +<listitem><para>&kspread; >= 1.2</para></listitem> +<listitem><para>OpenOffice.org Writer</para></listitem> +<listitem><para>OpenOffice.org Impress</para></listitem> +<listitem><para>OpenOffice.org Calc</para></listitem> +</itemizedlist> + +</para> +</note> + </listitem> </varlistentry> + <varlistentry> -<term><replaceable class="parameter">num_children</replaceable> -</term> +<term><guilabel>Case sensitive</guilabel></term> <listitem> -<para>Specifies the number of elements in <replaceable class="parameter">children</replaceable>. +<para> +If you enable this option, &rekonq; will +only find files with the exact case matching, ⪚ +<userinput>MARC</userinput> will only match +<quote>MARC</quote>, not <quote>Marc</quote>. </para> </listitem> </varlistentry> + +<varlistentry> +<term><guilabel>Regular expression</guilabel></term> +<listitem><para>If you have installed the &kregexpeditor; tool from +the kdeutils package, you will have this additional option. Enabling +it will allow you to search for a <firstterm>regexp</firstterm> or +regular expression. A regexp is a way to specify conditions for your +search, and they can be very complex, and equally they can be very +powerful. If you are unfamiliar with regular expressions, you can +choose <guilabel>Edit Regular Expression</guilabel> to open +&kregexpeditor;. This tool allows you to construct your set of +conditions graphically, and then generates the expression for +you.</para> + +<para>&kregexpeditor; is a very useful tool, and can be used from within +many &kde; applications other than &rekonq;. You can find more +information from within its own help file.</para> +</listitem> +</varlistentry> + +<!-- TODO: "Search metainfo sections" --> + </variablelist> -</refsect2></refsynopsisdiv> - -<refsect1 id="r1-1007-unmanagechildren-1"> -<title>Description -</title> -<para><function>XtUnmanageChildren()</function> unmaps the specified widgets -and removes them from their parent's geometry management. -The widgets will disappear from the screen, and (depending -on its parent) may no longer have screen space allocated for -them. -</para> -<para>Each of the widgets in the <replaceable class="parameter">children</replaceable> array must have -the same parent. -</para> -<para>See the “Algorithm” section below for full details of the -widget unmanagement procedure. -</para> -</refsect1> -<refsect1 id="r1-1007-unmanagechildren-2"> -<title>Usage</title> -<para>Unmanaging widgets is the usual method for temporarily -making them invisible. They can be re-managed with -<function>XtManageChildren()</function>. -</para> -<para>You can unmap a widget, but leave it under geometry -management by calling <function>XtUnmapWidget()</function>. You can -destroy a widget's window without destroying the widget by -calling <function>XtUnrealizeWidget()</function>. You can destroy a -widget completely with <function>XtDestroyWidget()</function>. -</para> -<para>If you are only going to unmanage a single widget, it is -more convenient to call <function>XtUnmanageChild()</function>. It is -often more convenient to call <function>XtUnmanageChild()</function> -several times than it is to declare and initialize an array -of widgets to pass to <function>XtUnmanageChildren()</function>. Calling -<function>XtUnmanageChildren()</function> is more efficient, however, -because it only calls the parent's <function>change_managed()</function> -method once. -</para> -</refsect1> +</sect1> -<refsect1 id="r1-1007-unmanagechildren-3"> -<title>Algorithm -</title> -<para><function>XtUnmanageChildren()</function> performs the following: +<sect1 id="kfind-advanced"> +<title>The Properties Tab</title> + +<para> +Here you can refine your search. These are the special refinements +you can choose: </para> + <variablelist> + <varlistentry> -<term>- -</term> +<term><guilabel>Find all files created or modified</guilabel></term> <listitem> -<para>Ignores the child if it already is unmanaged or is being -destroyed. +<para> +Here you can either enter two dates, between which the +files were created or modified, or specify a time period. </para> </listitem> </varlistentry> + <varlistentry> -<term>- -</term> +<term><guilabel>File size is</guilabel></term> <listitem> -<para>Otherwise, if the child is realized, it makes it nonvisible -by unmapping it. +<para>Here you can specify if the file has to be at least or as most as +big as the size you entered in the following box. </para> </listitem> </varlistentry> -</variablelist> -<para> -</para> -</refsect1> -<refsect1 id="r1-1007-unmanagechildren-4"> -<title>Structures</title> -<para>The <type>WidgetList</type> type is simply an array of widgets: +<varlistentry> +<term><guilabel>Files owned by user, Files owned by group</guilabel></term> +<listitem> +<para>Here you can specify user and group names. </para> -<screen id="sc-1007-unmanagechildren-1">typedef Widget *WidgetList; -</screen> -</refsect1> -</refentry> +</listitem> +</varlistentry> -</chapter> +</variablelist> + +</sect1> -<chapter id="faq"> -<title>Questions and Answers</title> - -<!-- (OPTIONAL but recommended) This chapter should include all of the silly -(and not-so-silly) newbie questions that fill up your mailbox. This chapter -should be reserved for BRIEF questions and answers! If one question uses more -than a page or so then it should probably be part of the -"Using this Application" chapter instead. You should use links to -cross-reference questions to the parts of your documentation that answer them. -This is also a great place to provide pointers to other FAQ's if your users -must do some complicated configuration on other programs in order for your -application work. --> - -&reporting.bugs; -&updating.documentation; - -<qandaset id="faqlist"> -<qandaentry> -<question> -<para>My Mouse doesn't work. How do I quit &rekonq;?</para> -</question> -<answer> -<para>You silly goose! Check out the <link linkend="commands">Commands -Section</link> for the answer.</para> -</answer> -</qandaentry> -<qandaentry> -<question> -<para>Why can't I twiddle my documents?</para> -</question> -<answer> -<para>You can only twiddle your documents if you have the foobar.lib -installed.</para> -</answer> -</qandaentry> -</qandaset> </chapter> -<chapter id="credits"> +<!-- ================== CHAPTER ================== --> -<!-- Include credits for the programmers, documentation writers, and -contributors here. The license for your software should then be included below -the credits with a reference to the appropriate license file included in the KDE -distribution. --> +<chapter id="credits"> <title>Credits and License</title> <para> -&rekonq; +&rekonq; </para> + <para> -Program copyright 2008 John Q. Hacker <email>jqh@kde.org</email> +Program copyright: </para> -<para> -Contributors: + <itemizedlist> -<listitem><para>Konqui the KDE Dragon <email>konqui@kde.org</email></para> -</listitem> -<listitem><para>Tux the Linux Penguin <email>tux@linux.org</email></para> +<title>Developers</title> +<listitem> +<para>&Andrea.Diamantini; &Andrea.Diamantini.mail;</para> </listitem> + </itemizedlist> -</para> <para> -Documentation Copyright © 2008 George N. Ugnacious <email>gnu@kde.org</email> -</para> +Documentation copyright 2008 &Andrea.Diamantini; &Andrea.Diamantini.mail; +</para> <!-- TRANS:CREDIT_FOR_TRANSLATORS --> &underFDL; <!-- FDL: do not remove --> - -<!-- Determine which license your application is licensed under, - and delete all the remaining licenses below: - - (NOTE: All documentation are licensed under the FDL, - regardless of what license the application uses) --> - -&underGPL; <!-- GPL License --> &underBSDLicense; <!-- BSD License --> -&underArtisticLicense; <!-- BSD Artistic License --> -&underX11License; <!-- X11 License --> </chapter> <appendix id="installation"> <title>Installation</title> -<sect1 id="getting-kapp"> +<sect1 id="getting-kfind"> <title>How to obtain &rekonq;</title> -<!-- This first entity contains boiler plate for applications that are -part of KDE CVS. You should remove it if you are releasing your -application --> - &install.intro.documentation; </sect1> @@ -499,70 +307,21 @@ application --> <sect1 id="requirements"> <title>Requirements</title> -<!-- -List any special requirements for your application here. This should include: -.Libraries or other software that is not included in kdesupport, -kdelibs, or kdebase. -.Hardware requirements like amount of RAM, disk space, graphics card -capabilities, screen resolution, special expansion cards, etc. -.Operating systems the app will run on. If your app is designed only for a -specific OS, (you wrote a graphical LILO configurator for example) put this -information here. ---> - <para> -In order to successfully use &rekonq;, you need &kde; 1.1. Foobar.lib is -required in order to support the advanced &rekonq; features. &rekonq; uses -about 5 megs of memory to run, but this may vary depending on your -platform and configuration. +In order to successfully use &rekonq;, you need at least Qt 4.4.x and &kde; 4.1.x. </para> -<para> -All required libraries as well as &rekonq; itself can be found -on <ulink url="ftp://ftp.kapp.org">The &rekonq; home page</ulink>. -</para> - -<!-- For a list of updates, you may refer to the application web site -or the ChangeLog file, or ... --> -<para> -You can find a list of changes at <ulink -url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>. -</para> </sect1> <sect1 id="compilation"> <title>Compilation and Installation</title> -<!-- This entity contains the boilerplate text for standard --> -<!-- compilation instructions. If your application requires any --> -<!-- special handling, remove it, and replace with your own text. --> - &install.compile.documentation; </sect1> -<sect1 id="configuration"> -<title>Configuration</title> - -<para>Don't forget to tell your system to start the <filename>dtd</filename> -dicer-toaster daemon first, or &rekonq; won't work !</para> - -</sect1> - </appendix> &documentation.index; -</book> -<!-- -Local Variables: -mode: xml -sgml-minimize-attributes:nil -sgml-general-insert-case:lower -sgml-indent-step:0 -sgml-indent-data:nil -End: - -vim:tabstop=2:shiftwidth=2:expandtab -kate: space-indent on; indent-width 2; tab-width 2; indent-mode none; ---> +</book> |