Clear the URL line edit when navigating history. https://redmine.stoutner.com/issues/841
[PrivacyBrowserPC.git] / doc / index.docbook
1 <?xml version="1.0" ?>
2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
3   <!-- Define an entity for your application if it is not part of KDE
4        Git -->
5   <!ENTITY kmyapplication "<application>privacybrowserpc</application>">
6   <!ENTITY i18n-translatable-entity "<application>Translatable Entity</application>">
7   <!ENTITY % addindex "IGNORE">
8   <!ENTITY % English "INCLUDE">
9
10   <!-- Do not define any other entities; instead, use the entities
11        from entities/general.entities and en/user.entities. -->
12 ]>
13
14 <!--
15 Use this template for application docbooks
16 For kioslave, systemsettings (kcontrol) modules and simple/short application docbooks use article-template.docbook
17 Rename this template to index.docbook and place into the directory doc/ or doc/appname if you have several applications in one doc directory
18 -->
19
20 <!-- kdoctemplate v0.13.0 2017-07-31 ltoscano
21      add CC BY-SA 4.0 International and set as default
22
23      kdoctemplate v0.12.0 2016-04-23 lueck
24      add translatable entities
25      remove help.menu.documentation entity
26      and add some examples how to use the common menus Settings and Help
27
28      kdoctemplate v0.11.0 2015-04-03 lueck
29      updated instructions for date + releaseinfo
30      remove ENTITY package - not used anymore
31      add info about KDE Games special chapters
32      Appendix Installation is now optional
33
34      kdoctemplate v0.10.0 2014-04-02 ltoscano
35      updated to KF5/kdoctools
36      references to KDE reworded
37
38      kdoctemplate v0.9.2 2012-10-15 pino
39      update versions to 4.9
40      update years to 2012
41      switch from CVS to Git
42      add id attribute to <book>
43      
44      kdoctemplate v0.9.1 2010-10-27 lueck
45      changed releaseinfo format
46      removed screenshot format="EPS
47      added comment when to write a command reference
48      added tip using id's in varlistentries
49      removed refentry stuff
50      
51      kdoctemplate v0.9 January 10 2003
52      Changes to comments to clarify entity usage January 10 2003
53      Minor update to "Credits and Licenses" section on August 24, 2000
54      Removed "Revision history" section on 22 January 2001
55      Changed to Installation/Help menu entities 18 October 2001
56      Other minor cleanup and changes 18 October 2001
57      FPI change and minor changes November 2002 -->
58
59 <!--
60 This template was designed by: David Rugge davidrugge@mindspring.com
61 with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
62 and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
63 of the KDE DocBook team.
64
65 You may freely use this template for writing any sort of KDE documentation.
66 If you have any changes or improvements, please let us know.
67
68 Remember:
69 - in XML, the case of the <tags> and attributes is relevant ;
70 - also, quote all attributes.
71
72 Please don't forget to remove all these comments in your final documentation,
73 thanks ;-).
74 -->
75
76 <!-- ................................................................ -->
77
78 <!-- The language must NOT be changed here. -->
79 <!-- If you are writing original documentation in a language other -->
80 <!-- than English, change the language above ONLY, not here -->
81 <!-- Change the value of id to the name of your application -->
82 <book id="kmyapplication" lang="&language;">
83
84 <!-- This header contains all of the meta-information for the document such
85 as Authors, publish date, the abstract, and Keywords -->
86
87 <bookinfo>
88 <title>The &kmyapplication; Handbook</title>
89
90 <authorgroup>
91 <author>
92 <!-- This is just put in as an example.  For real documentation, please
93      define a general entity in entities/contributor.entities, e.g.
94 <!ENTITY George.N.Ugnacious "<personname><firstname>George</firstname><othername>N.</othername><surname>Ugnacious</surname></personname>">
95 <!ENTITY George.N.Ugnacious.mail "<email>gnu@kde.org</email>">
96 and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
97  -->
98 <personname>
99 <firstname>George</firstname>
100 <othername>N.</othername>
101 <surname>Ugnacious</surname>
102 </personname>
103 <email>gnu@kde.org</email>
104 </author>
105 <!-- TRANS:ROLES_OF_TRANSLATORS -->
106 </authorgroup>
107
108 <copyright>
109 <year>2015</year>
110 <holder>George N. Ugnacious</holder>
111 </copyright>
112 <legalnotice>&CCBYSA4Notice;</legalnotice>
113
114 <!-- Date of the documentation
115 Change date/releaseinfo only if
116    docbook is updated and verified to be valid for the current app version
117    or
118    docbook is proofread and verified to be valid for the current app version
119 Don't forget to include this last date.
120 Please respect the format of the date (YYYY-MM-DD),it is used by scripts.
121 -->
122 <date>2016-04-23</date>
123
124 <!--version information of Frameworks/Plasma/Applications this documentation is valid for.
125 Example:
126 Frameworks xx.yy for docbooks in frameworks
127 Plasma xx.yy for docbooks in plasma workspace
128 Applications xx.yy for docbooks released as Applications
129 xx.yy (Applications xx.yy) for docbooks with own version released as Applications
130 $applicationname xx.yy for applications with independent release schedule (extragear/playground)
131 -->
132 <releaseinfo>Frameworks xx.yy or Plasma xx.yy or Applications xx.yy or xx.yy (Applications xx.yy) or $applicationname xx.yy</releaseinfo>
133
134 <!-- Abstract about this handbook -->
135
136 <abstract>
137 <para>
138 &kmyapplication; is an application specially designed to do nothing you would
139 ever want.
140 </para>
141 </abstract>
142
143 <!-- This is a set of Keywords for indexing by search engines.
144 Please at least include KDE, the KDE section it is in, the name
145  of your application, and a few relevant keywords. -->
146
147 <keywordset>
148 <keyword>KDE</keyword>
149 <keyword>kdeutils</keyword>
150 <keyword>Kapp</keyword>
151 <keyword>nothing</keyword>
152 <keyword>nothing else</keyword>
153 </keywordset>
154
155 </bookinfo>
156
157 <!-- The contents of the documentation begin here.  Label
158 each chapter so with the id attribute. This is necessary for two reasons: it
159 allows you to easily reference the chapter from other chapters of your
160 document, and if there is no ID, the name of the generated HTML files will vary
161 from time to time making it hard to manage for maintainers and for the CVS
162 system. Any chapter labelled (OPTIONAL) may be left out at the author's
163 discretion. Other chapters should not be left out in order to maintain a
164 consistent documentation style across all KDE apps. -->
165
166
167 <!-- KDE Games have special chapters
168
169 Introduction
170
171 How to play
172
173 Game Rules, Strategies and Tips
174
175 Interface Overview
176
177 Frequently asked questions
178
179 Credits and License
180
181 Please use one of index.docbook files from kdegames
182
183 -->
184 <chapter id="introduction">
185 <title>Introduction</title>
186
187 <!-- The introduction chapter contains a brief introduction for the
188 application that explains what it does and where to report
189 problems. Basically a long version of the abstract.  Don't include a
190 revision history. (see installation appendix comment) -->
191
192 <para>
193 &kmyapplication; is a program that lets you do absolutely nothing. Please report
194 any problems or feature requests to the &kde; mailing lists.
195 </para>
196 </chapter>
197
198 <chapter id="using-kapp">
199 <title>Using &kmyapplication;</title>
200
201 <!-- This chapter should tell the user how to use your app. You should use as
202 many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
203 your application. -->
204
205 <para>
206
207 <!-- Note that all graphics should be in .png format. Use no gifs because of
208 patent issues. -->
209
210 <screenshot>
211 <screeninfo>Here's a screenshot of &kmyapplication;</screeninfo>
212         <mediaobject>
213           <imageobject>
214             <imagedata fileref="screenshot.png" format="PNG"/>
215           </imageobject>
216           <textobject>
217             <phrase>Screenshot</phrase>
218           </textobject>
219         </mediaobject>
220 </screenshot>
221 </para>
222
223
224 <sect1 id="kapp-features">
225 <title>More &kmyapplication; features</title>
226
227 <para>It slices! It dices! and it comes with a free toaster!</para>
228 <para>
229 The Squiggle Tool <guiicon><inlinemediaobject>
230           <imageobject>
231             <imagedata fileref="squiggle.png" format="PNG"/>
232           </imageobject>
233           <textobject>
234             <phrase>Squiggle</phrase>
235           </textobject>
236 </inlinemediaobject></guiicon> is used to draw squiggly lines all over
237 the &kmyapplication; main window. It's not a bug, it's a feature!
238 </para>
239
240 </sect1>
241 </chapter>
242
243 <chapter id="commands">
244 <title>Command Reference</title>
245
246 <!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
247 application windows and their menubar and toolbar commands for easy reference.
248 Also include any keys that have a special function but have no equivalent in the
249 menus or toolbars. 
250 This may not be necessary for small apps or apps with no tool or menu bars.
251
252 Don't bother users with well known kde menu items like Settings->Shortcuts etc. 
253
254 Use cases for a command reference:
255
256 Applications with many menu items (Kate/Konqueror) 
257 Applications with different modes and menus (KWrite/Konqueror)
258 -> Enables search for menu items
259
260 For Applications with default menu items and some special items where user 
261 needs additional information use something like:
262 "Apart from the common KDE menu items you find these action in the menu:
263
264 File -> Special Action: Explanation of special action
265
266 Tools -> Special Tool: Explanation of special tool
267
268 Use variablelist markup for this
269 -->
270
271 <sect1 id="kapp-mainwindow">
272 <title>The main &kmyapplication; window</title>
273
274 <sect2>
275 <title>The File Menu</title>
276 <para>
277 <variablelist>
278 <varlistentry  id="file-new">
279 <!-- Tip: With id's here, then you can use them like 
280 "select <xref linkend="file-new"/> to open the file dialog"
281 which will be expanded to:
282 "select File->New (Ctrl+N) to open the file dialog"
283 -->
284 <term><menuchoice>
285 <shortcut>
286 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
287 </shortcut>
288 <guimenu>File</guimenu>
289 <guimenuitem>New</guimenuitem>
290 </menuchoice></term>
291 <listitem><para><action>Creates a new document</action></para></listitem>
292 </varlistentry>
293
294 <varlistentry  id="file-save">
295 <term><menuchoice>
296 <shortcut>
297 <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
298 </shortcut>
299 <guimenu>File</guimenu>
300 <guimenuitem>Save</guimenuitem>
301 </menuchoice></term>
302 <listitem><para><action>Saves the document</action></para></listitem>
303 </varlistentry>
304
305 <varlistentry  id="file-quit">
306 <term><menuchoice>
307 <shortcut>
308 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
309 </shortcut>
310 <guimenu>File</guimenu>
311 <guimenuitem>Quit</guimenuitem>
312 </menuchoice></term>
313 <listitem><para><action>Quits</action> &kmyapplication;</para></listitem>
314 </varlistentry>
315 </variablelist>
316 </para>
317
318 </sect2>
319
320 <!-- Examples how to use the common menus Settings and Help -->
321
322 <sect2 id="settings-help-menu">
323 <title>The Settings and Help Menu</title>
324 <para>
325 &kmyapplication; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
326 menu items, for more information read the sections about the <ulink url="help:/fundamentals/ui.html#menus-settings"
327 >Settings Menu</ulink> and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>
328 of the &kde; Fundamentals.
329 </para>
330 </sect2>
331
332 <sect2 id="help-menu1">
333 <title>The Help Menu</title>
334 <para>
335 &kmyapplication; has the common &kde; <guimenu>Help</guimenu> menu item, for more information read the section
336 about the <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
337 </para>
338 </sect2>
339
340 <sect2 id="menu-commands">
341 <title>Menu Items</title>
342 <para>Apart from the common &kde; menus described in the <ulink url="help:/fundamentals/ui.html#menus">Menu</ulink>
343 chapter of the &kde; Fundamentals documentation &kmyapplication; has these application specific menu entries:
344 </para>
345 <!-- variablelist -->
346 </sect2>
347
348 <sect2 id="help-menu2">
349 <title>The Help Menu</title>
350 <para>&kmyapplication; has a default &kde; <guimenu>Help</guimenu> menu as described in the
351 <ulink url="help:/fundamentals/ui.html#menus-help">&kde; Fundamentals</ulink>
352 with two additional entries:</para>
353 <!-- variablelist -->
354 </sect2>
355
356 </sect1>
357 </chapter>
358
359 <chapter id="developers">
360 <title>Developer's Guide to &kmyapplication;</title>
361
362 <!-- (OPTIONAL) A Programming/Scripting reference chapter should be
363 used for apps that use plugins or that provide their own scripting hooks
364 and/or development libraries. -->
365
366 <para>
367 Programming &kmyapplication; plugins is a joy to behold.
368 </para>
369
370
371 </chapter>
372
373 <chapter id="faq">
374 <title>Questions and Answers</title>
375
376 <!-- (OPTIONAL but recommended) This chapter should include all of the silly
377 (and not-so-silly) newbie questions that fill up your mailbox. This chapter
378 should be reserved for BRIEF questions and answers! If one question uses more
379 than a page or so then it should probably be part of the
380 "Using this Application" chapter instead. You should use links to
381 cross-reference questions to the parts of your documentation that answer them.
382 This is also a great place to provide pointers to other FAQ's if your users
383 must do some complicated configuration on other programs in order for your
384 application work. -->
385
386 <qandaset id="faqlist">
387 <qandaentry>
388 <question>
389 <para>My Mouse doesn't work. How do I quit &kmyapplication;?</para>
390 </question>
391 <answer>
392 <para>You silly goose! Check out the <link linkend="commands">Commands
393 Section</link> for the answer.</para>
394 </answer>
395 </qandaentry>
396 <qandaentry>
397 <question>
398 <para>Why can I not twiddle my documents?</para>
399 </question>
400 <answer>
401 <para>You can only twiddle your documents if you have the foobar.lib
402 installed.</para>
403 </answer>
404 </qandaentry>
405 </qandaset>
406 </chapter>
407
408 <chapter id="credits">
409
410 <!-- Include credits for the programmers, documentation writers, and
411 contributors here. The license for your software should then be included below
412 the credits with a reference to the appropriate license file included in the KDE
413 distribution. -->
414
415 <title>Credits and License</title>
416
417 <para>
418 &kmyapplication;
419 </para>
420 <para>
421 Program copyright 2010-2014 John Q. Hacker <email>jqh@kde.org</email>
422 </para>
423 <para>
424 Contributors:
425 <itemizedlist>
426 <listitem><para>Konqui the &kde; Dragon <email>konqui@kde.org</email></para>
427 </listitem>
428 <listitem><para>Tux the &Linux; Penguin <email>tux@linux.org</email></para>
429 </listitem>
430 </itemizedlist>
431 </para>
432
433 <para>
434 Documentation Copyright &copy; 2012-2014 George N. Ugnacious <email>gnu@kde.org</email>
435 </para>
436
437 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
438
439 <!-- License for new documents after 2017-07-27 (or relicensed) -->
440
441 &underCCBYSA4;           <!-- CC BY-SA 4.0: do not remove -->
442
443 <!-- FDL: old license; only for reference (and old documents) -->
444 <!--
445 &underFDL;
446 -->
447
448 <!-- Determine which license your application is licensed under,
449      and delete all the remaining licenses below:
450
451      (NOTE:  All documentation are licensed under the CC BY-SA 4.0,
452      regardless of what license the application uses) -->
453
454 &underGPL;               <!-- GPL License -->
455 &underBSDLicense;        <!-- BSD License -->
456 &underArtisticLicense;   <!-- BSD Artistic License -->
457 &underX11License;        <!-- X11 License  -->
458
459 </chapter>
460
461 <!-- Appendix Installation is optional, usually not required
462
463 Entities &install.intro.documentation; + &install.compile.documentation; will be removed in later kdoctools
464
465 -->
466
467 <appendix id="installation">
468 <title>Installation</title>
469
470 <sect1 id="getting-kapp">
471 <title>How to obtain &kmyapplication;</title>
472
473 <!-- This first entity contains boiler plate for applications that are
474 part of KDE archive.  You should remove it if you are releasing your
475 application -->
476
477 &install.intro.documentation;
478
479 </sect1>
480
481 <sect1 id="requirements">
482 <title>Requirements</title>
483
484 <!--
485 List any special requirements for your application here. This should include:
486 .Libraries or other software that is not included in kdesupport or kf5
487 .Hardware requirements like amount of RAM, disk space, graphics card
488 capabilities, screen resolution, special expansion cards, etc.
489 .Operating systems the app will run on. If your app is designed only for a
490 specific OS, (you wrote a graphical LILO configurator for example) put this
491 information here.
492 -->
493
494 <para>
495 In order to successfully use &kmyapplication;, you need few libraries from
496 &kf5; 5.1 (bar, baz). Foobar.lib is
497 required in order to support the advanced &kmyapplication; features. &kmyapplication; uses
498 about 5 megs of memory to run, but this may vary depending on your
499 platform and configuration.
500 </para>
501
502 <para>
503 All required libraries as well as &kmyapplication; itself can be found
504 on <ulink url="ftp://ftp.kapp.org">The &kmyapplication; home page</ulink>.
505 </para>
506
507 <!-- For a list of updates, you may refer to the application web site
508 or the ChangeLog file, or ... -->
509 <para>
510 You can find a list of changes at <ulink
511 url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>.
512 </para>
513 </sect1>
514
515 <sect1 id="compilation">
516 <title>Compilation and Installation</title>
517
518 <!-- This entity contains the boilerplate text for standard -->
519 <!-- compilation instructions.  If your application requires any -->
520 <!-- special handling, remove it, and replace with your own text. -->
521
522 &install.compile.documentation;
523
524 </sect1>
525
526 <sect1 id="configuration">
527 <title>Configuration</title>
528
529 <para>Don't forget to tell your system to start the <filename>dtd</filename>
530 dicer-toaster daemon first, or &kmyapplication; won't work!</para>
531
532 </sect1>
533
534 </appendix>
535
536 &documentation.index;
537 </book>
538
539 <!--
540 Local Variables:
541 mode: xml
542 sgml-minimize-attributes:nil
543 sgml-general-insert-case:lower
544 sgml-indent-step:0
545 sgml-indent-data:nil
546 End:
547
548 vim:tabstop=2:shiftwidth=2:expandtab
549 kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
550 -->