From e8b08487a54938fc711c88cba9376e03cea3f319 Mon Sep 17 00:00:00 2001 From: Andrea Diamantini Date: Wed, 31 Dec 2008 00:05:55 +0100 Subject: minor changes added doc subdir --- doc/CMakeLists.txt | 4 + doc/index.docbook | 569 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 573 insertions(+) create mode 100644 doc/CMakeLists.txt create mode 100644 doc/index.docbook (limited to 'doc') diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 00000000..3a54287f --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,4 @@ +########### install files ############### +# + +kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR rekonq) diff --git a/doc/index.docbook b/doc/index.docbook new file mode 100644 index 00000000..e9b64bd5 --- /dev/null +++ b/doc/index.docbook @@ -0,0 +1,569 @@ + + + rekonq"> + + + + + + +]> + + + + + + + + + + + + + + +The &kmyapplication; Handbook + + + + + +George +N. +Ugnacious + +gnu@kde.org + + + + + + +2008 +George N. Ugnacious + + + +&FDLNotice; + + + +2008-01-10 +1.01.00 + + + + + +&kmyapplication; is an application specially designed to do nothing you would +ever want. + + + + + + +KDE +kdeutils +Kapp +nothing +nothing else + + + + + + + +Introduction + + + + +&kmyapplication; is a program that lets you do absolutely nothing. Please report +any problems or feature requests to the &kde; mailing lists. + + + + +Using &kmyapplication; + + + + + + + + +Here's a screenshot of &kmyapplication; + + + + + + + + + Screenshot + + + + + + + +More &kmyapplication; features + +It slices! It dices! and it comes with a free toaster! + +The Squiggle Tool + + + + + + + + Squiggle + + is used to draw squiggly lines all over +the &kmyapplication; main window. It's not a bug, it's a feature! + + + + + + +Command Reference + + + + +The main &kmyapplication; window + + +The File Menu + + + + + +&Ctrl;N + +File +New + +Creates a new document + + + + +&Ctrl;S + +File +Save + +Saves the document + + + + +&Ctrl;Q + +File +Quit + +Quits &kmyapplication; + + + + + + + +The <guimenu>Help</guimenu> Menu + + + + + + +&help.menu.documentation; + + + + + + + +Developer's Guide to &kmyapplication; + + + + +Programming &kmyapplication; plugins is a joy to behold. Just read through the next +66 pages of API's to learn how! + + + + + + +XtUnmanageChildren +Xt - Geometry Management + + +XtUnmanageChildren + +remove a list of children from a parent widget's managed +list. +widgetsremoving +XtUnmanageChildren + + + + + +4 March 1996 + + +void XtUnmanageChildren(children, num_children) + WidgetList children; + Cardinal num_children; + + + +Inputs + + +children + + +Specifies an array of child widgets. Each child must be of +class RectObj or any subclass thereof. + + + + +num_children + + +Specifies the number of elements in children. + + + + + + + +Description + +XtUnmanageChildren() 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. + +Each of the widgets in the children array must have +the same parent. + +See the “Algorithm” section below for full details of the +widget unmanagement procedure. + + + + +Usage +Unmanaging widgets is the usual method for temporarily +making them invisible. They can be re-managed with +XtManageChildren(). + +You can unmap a widget, but leave it under geometry +management by calling XtUnmapWidget(). You can +destroy a widget's window without destroying the widget by +calling XtUnrealizeWidget(). You can destroy a +widget completely with XtDestroyWidget(). + +If you are only going to unmanage a single widget, it is +more convenient to call XtUnmanageChild(). It is +often more convenient to call XtUnmanageChild() +several times than it is to declare and initialize an array +of widgets to pass to XtUnmanageChildren(). Calling +XtUnmanageChildren() is more efficient, however, +because it only calls the parent's change_managed() +method once. + + + + +Algorithm + +XtUnmanageChildren() performs the following: + + + +- + + +Ignores the child if it already is unmanaged or is being +destroyed. + + + + +- + + +Otherwise, if the child is realized, it makes it nonvisible +by unmapping it. + + + + + + + + + +Structures +The WidgetList type is simply an array of widgets: + +typedef Widget *WidgetList; + + + + + + + +Questions and Answers + + + +&reporting.bugs; +&updating.documentation; + + + + +My Mouse doesn't work. How do I quit &kmyapplication;? + + +You silly goose! Check out the Commands +Section for the answer. + + + + +Why can't I twiddle my documents? + + +You can only twiddle your documents if you have the foobar.lib +installed. + + + + + + + + + +Credits and License + + +&kmyapplication; + + +Program copyright 2008 John Q. Hacker jqh@kde.org + + +Contributors: + +Konqui the KDE Dragon konqui@kde.org + +Tux the Linux Penguin tux@linux.org + + + + + +Documentation Copyright © 2008 George N. Ugnacious gnu@kde.org + + + + +&underFDL; + + + +&underGPL; +&underBSDLicense; +&underArtisticLicense; +&underX11License; + + + + +Installation + + +How to obtain &kmyapplication; + + + +&install.intro.documentation; + + + + +Requirements + + + + +In order to successfully use &kmyapplication;, you need &kde; 1.1. Foobar.lib is +required in order to support the advanced &kmyapplication; features. &kmyapplication; uses +about 5 megs of memory to run, but this may vary depending on your +platform and configuration. + + + +All required libraries as well as &kmyapplication; itself can be found +on The &kmyapplication; home page. + + + + +You can find a list of changes at http://apps.kde.org/kapp. + + + + +Compilation and Installation + + + + + +&install.compile.documentation; + + + + +Configuration + +Don't forget to tell your system to start the dtd +dicer-toaster daemon first, or &kmyapplication; won't work ! + + + + + +&documentation.index; + + + -- cgit v1.2.1 From dd0c4480eec6e12665aef9991c92cb80cc9e6a12 Mon Sep 17 00:00:00 2001 From: Andrea Diamantini Date: Thu, 29 Jan 2009 11:59:07 +0100 Subject: 1st lines of docs --- doc/index.docbook | 63 +++++++++++++++++++++++++++---------------------------- 1 file changed, 31 insertions(+), 32 deletions(-) (limited to 'doc') diff --git a/doc/index.docbook b/doc/index.docbook index e9b64bd5..6eb4cd25 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -3,7 +3,7 @@ rekonq"> - -The &kmyapplication; Handbook +The &rekonq; Handbook @@ -63,11 +63,10 @@ as Authors, publish date, the abstract, and Keywords --> and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element. --> -George -N. -Ugnacious +Andrea +Diamantini -gnu@kde.org +adjam7@gmail.com @@ -75,7 +74,7 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element. 2008 -George N. Ugnacious +Andrea Diamantini -2008-01-10 -1.01.00 +2008-12-01 +0.00.03 -&kmyapplication; is an application specially designed to do nothing you would +&rekonq; is an application specially designed to do nothing you would ever want. @@ -107,10 +106,10 @@ Please at least include KDE, the KDE package it is in, the name KDE -kdeutils -Kapp -nothing -nothing else +kdenetwork +rekonq +webkit +browser @@ -133,13 +132,13 @@ problems. Basically a long version of the abstract. Don't include a revision history. (see installation appendix comment) --> -&kmyapplication; is a program that lets you do absolutely nothing. Please report +&rekonq; is a program that lets you do absolutely nothing. Please report any problems or feature requests to the &kde; mailing lists. -Using &kmyapplication; +Using &rekonq; patent issues. --> -Here's a screenshot of &kmyapplication; +Here's a screenshot of &rekonq; @@ -168,7 +167,7 @@ patent issues. --> -More &kmyapplication; features +More &rekonq; features It slices! It dices! and it comes with a free toaster! @@ -183,7 +182,7 @@ The Squiggle Tool Squiggle is used to draw squiggly lines all over -the &kmyapplication; main window. It's not a bug, it's a feature! +the &rekonq; main window. It's not a bug, it's a feature! @@ -199,7 +198,7 @@ menus or toolbars. This may not be necessary for small apps or apps with no tool or menu bars. --> -The main &kmyapplication; window +The main &rekonq; window The File Menu @@ -233,7 +232,7 @@ or menu bars. --> File Quit -Quits &kmyapplication; +Quits &rekonq; @@ -244,7 +243,7 @@ or menu bars. --> The <guimenu>Help</guimenu> Menu - + @@ -256,14 +255,14 @@ or menu bars. --> -Developer's Guide to &kmyapplication; +Developer's Guide to &rekonq; -Programming &kmyapplication; plugins is a joy to behold. Just read through the next +Programming &rekonq; plugins is a joy to behold. Just read through the next 66 pages of API's to learn how! @@ -418,7 +417,7 @@ application work. --> -My Mouse doesn't work. How do I quit &kmyapplication;? +My Mouse doesn't work. How do I quit &rekonq;? You silly goose! Check out the Commands @@ -447,7 +446,7 @@ distribution. --> Credits and License -&kmyapplication; +&rekonq; Program copyright 2008 John Q. Hacker jqh@kde.org @@ -487,7 +486,7 @@ Documentation Copyright © 2008 George N. Ugnacious gnu@kde.orgInstallation -How to obtain &kmyapplication; +How to obtain &rekonq; -In order to successfully use &kmyapplication;, you need &kde; 1.1. Foobar.lib is -required in order to support the advanced &kmyapplication; features. &kmyapplication; uses +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. -All required libraries as well as &kmyapplication; itself can be found -on The &kmyapplication; home page. +All required libraries as well as &rekonq; itself can be found +on The &rekonq; home page. - rekonq"> - - + + + Andrea + Diamantini + + "> + adjam7@gmail.com"> - - - + ]> - - - - - - - - - - - + The &rekonq; Handbook - - - -Andrea -Diamantini - -adjam7@gmail.com - +&Andrea.Diamantini; &Andrea.Diamantini.mail; - - 2008 -Andrea Diamantini +2009 +&Andrea.Diamantini; - - -&FDLNotice; - - -2008-12-01 -0.00.03 +&FDLNotice; - +2008-11-16 +0.0.3 -&rekonq; is an application specially designed to do nothing you would -ever want. +&rekonq; is a lightweight KDE browser based on WebKit. - - KDE -kdenetwork +browser rekonq webkit -browser - + -Introduction - +Introduction -&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. - - -Using &rekonq; + - +Launching &rekonq; +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. - - - -Here's a screenshot of &rekonq; - - - - - - - - - Screenshot - - - - - - - -More &rekonq; features - -It slices! It dices! and it comes with a free toaster! - -The Squiggle Tool - - - - - - - - Squiggle - - 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 Find Files. This will +launch &rekonq;. + - -Command Reference + - + +Finding Files - -The main &rekonq; window + +The Name/Location Tab - -The File Menu +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 +Named:. Choose a folder where you want to search +by typing it in the field Look in: +or by clicking Browse... and press +Enter or click Find. If +Include subfolders is checked all +subfolders starting from your chosen folder will be searched +too. The results will be displayed in the box below. + + + +You can use the following wildcards: + + - - -&Ctrl;N - -File -New - -Creates a new document - - - - -&Ctrl;S - -File -Save - -Saves the document +The Asterisk * + + +The asterisk stands for any number of missing characters (even zero), +that means ⪚ searching for marc* may find the +files marc, marc.png and + marc_must_not_read_this.kwd. +mar*.kwd may find +marketplace.kwd and +marc_must_not_read_this.kwd. + + + - - -&Ctrl;Q - -File -Quit - -Quits &rekonq; - - +The Question Mark ? + + +In contrast to the asterisk, the question mark stands for exactly one +character, so mar? will find +marc, but marc? will not find +anything, as our files are called marc and +marc.png. You can put as many question marks in the +term as you want, it will find exactly that number of characters. + + - - - -The <guimenu>Help</guimenu> Menu - - - - - - -&help.menu.documentation; + - + +Of course you can combine those two wildcard symbols in a search term. + - - - -Developer's Guide to &rekonq; - + +The Contents Tab + + +File type + -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. + + - - - - -XtUnmanageChildren -Xt - Geometry Management - - -XtUnmanageChildren - -remove a list of children from a parent widget's managed -list. -widgetsremoving -XtUnmanageChildren - - - - - -4 March 1996 - - -void XtUnmanageChildren(children, num_children) - WidgetList children; - Cardinal num_children; - - - -Inputs - -children - +Containing text -Specifies an array of child widgets. Each child must be of -class RectObj or any subclass thereof. + +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 +Include subfolders in the +Name/Location tab, this may take a long time. + + +This option will not work for all files listed +under File type. Only the following file types +are supported: + + +Text files, ⪚ source code and README files +&kword; >= 1.2 +&kpresenter; >= 1.2 +&kspread; >= 1.2 +OpenOffice.org Writer +OpenOffice.org Impress +OpenOffice.org Calc + + + + + + -num_children - +Case sensitive -Specifies the number of elements in children. + +If you enable this option, &rekonq; will +only find files with the exact case matching, ⪚ +MARC will only match +MARC, not Marc. + + +Regular expression +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 regexp 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 Edit Regular Expression to open +&kregexpeditor;. This tool allows you to construct your set of +conditions graphically, and then generates the expression for +you. + +&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. + + + + + - - - -Description - -XtUnmanageChildren() 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. - -Each of the widgets in the children array must have -the same parent. - -See the “Algorithm” section below for full details of the -widget unmanagement procedure. - - - -Usage -Unmanaging widgets is the usual method for temporarily -making them invisible. They can be re-managed with -XtManageChildren(). - -You can unmap a widget, but leave it under geometry -management by calling XtUnmapWidget(). You can -destroy a widget's window without destroying the widget by -calling XtUnrealizeWidget(). You can destroy a -widget completely with XtDestroyWidget(). - -If you are only going to unmanage a single widget, it is -more convenient to call XtUnmanageChild(). It is -often more convenient to call XtUnmanageChild() -several times than it is to declare and initialize an array -of widgets to pass to XtUnmanageChildren(). Calling -XtUnmanageChildren() is more efficient, however, -because it only calls the parent's change_managed() -method once. - - + - -Algorithm - -XtUnmanageChildren() performs the following: + +The Properties Tab + + +Here you can refine your search. These are the special refinements +you can choose: + + -- - +Find all files created or modified -Ignores the child if it already is unmanaged or is being -destroyed. + +Here you can either enter two dates, between which the +files were created or modified, or specify a time period. + -- - +File size is -Otherwise, if the child is realized, it makes it nonvisible -by unmapping it. +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. - - - - - -Structures -The WidgetList type is simply an array of widgets: + +Files owned by user, Files owned by group + +Here you can specify user and group names. -typedef Widget *WidgetList; - - - + + - + + + - -Questions and Answers - - - -&reporting.bugs; -&updating.documentation; - - - - -My Mouse doesn't work. How do I quit &rekonq;? - - -You silly goose! Check out the Commands -Section for the answer. - - - - -Why can't I twiddle my documents? - - -You can only twiddle your documents if you have the foobar.lib -installed. - - - - + - + Credits and License -&rekonq; +&rekonq; + -Program copyright 2008 John Q. Hacker jqh@kde.org +Program copyright: - -Contributors: + -Konqui the KDE Dragon konqui@kde.org - -Tux the Linux Penguin tux@linux.org +Developers + +&Andrea.Diamantini; &Andrea.Diamantini.mail; + - -Documentation Copyright © 2008 George N. Ugnacious gnu@kde.org - +Documentation copyright 2008 &Andrea.Diamantini; &Andrea.Diamantini.mail; + &underFDL; - - - -&underGPL; &underBSDLicense; -&underArtisticLicense; -&underX11License; Installation - + How to obtain &rekonq; - - &install.intro.documentation; @@ -499,70 +307,21 @@ application --> Requirements - - -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. - -All required libraries as well as &rekonq; itself can be found -on The &rekonq; home page. - - - - -You can find a list of changes at http://apps.kde.org/kapp. - Compilation and Installation - - - - &install.compile.documentation; - -Configuration - -Don't forget to tell your system to start the dtd -dicer-toaster daemon first, or &rekonq; won't work ! - - - &documentation.index; - - + -- cgit v1.2.1 From bce15c7583913a7fc95b0206c5a093ac1bc3c55a Mon Sep 17 00:00:00 2001 From: Andrea Diamantini Date: Wed, 11 Mar 2009 23:59:18 +0100 Subject: Solved Bookmark Position problem. Updated TODO. --- doc/index.docbook | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/index.docbook b/doc/index.docbook index 2141c177..32fcb41e 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -30,7 +30,7 @@ &FDLNotice; 2008-11-16 -0.0.3 +0.0.4 -- cgit v1.2.1