[khelpcenter] doc/fundamentals: update fundamentals docbook
Burkhard Lück
lueck at hube-lueck.de
Mon Dec 5 21:42:16 UTC 2016
Git commit 33f5eca9a3ba54bb41d511674114d229697937b5 by Burkhard Lück.
Committed on 05/12/2016 at 21:41.
Pushed by lueck into branch 'master'.
update fundamentals docbook
bump date + releaseinfo
cleanup/update find + replace
new screenshots
add Help->Donate + Tip of the day
explain how to use print to split a pdf
more info about Show Menubar
REVIEW:129579
M +- -- doc/fundamentals/find-find.png
M +- -- doc/fundamentals/find-found.png
M +- -- doc/fundamentals/find-replace-inline.png
M +- -- doc/fundamentals/find-replace.png
M +4 -4 doc/fundamentals/index.docbook
M +1 -1 doc/fundamentals/install.docbook
M +29 -23 doc/fundamentals/tasks.docbook
M +33 -3 doc/fundamentals/ui.docbook
https://commits.kde.org/khelpcenter/33f5eca9a3ba54bb41d511674114d229697937b5
diff --git a/doc/fundamentals/find-find.png b/doc/fundamentals/find-find.png
index 59032f4..a75ab6f 100644
Binary files a/doc/fundamentals/find-find.png and b/doc/fundamentals/find-find.png differ
diff --git a/doc/fundamentals/find-found.png b/doc/fundamentals/find-found.png
index fde3959..020fef7 100644
Binary files a/doc/fundamentals/find-found.png and b/doc/fundamentals/find-found.png differ
diff --git a/doc/fundamentals/find-replace-inline.png b/doc/fundamentals/find-replace-inline.png
index 1b16e08..702d7d3 100644
Binary files a/doc/fundamentals/find-replace-inline.png and b/doc/fundamentals/find-replace-inline.png differ
diff --git a/doc/fundamentals/find-replace.png b/doc/fundamentals/find-replace.png
index 85d657a..0ddb708 100644
Binary files a/doc/fundamentals/find-replace.png and b/doc/fundamentals/find-replace.png differ
diff --git a/doc/fundamentals/index.docbook b/doc/fundamentals/index.docbook
index 7782cad..dfdf064 100644
--- a/doc/fundamentals/index.docbook
+++ b/doc/fundamentals/index.docbook
@@ -35,11 +35,11 @@
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
-<date>2016-06-06</date>
-<releaseinfo>&plasma; 5.6</releaseinfo>
+<date>2016-11-28</date>
+<releaseinfo>Frameworks 5.28 / Applications 16.12</releaseinfo>
<abstract>
-<para>This guide provides an introduction to the &kde; workspace and applications and describes many
+<para>This guide provides an introduction to the &plasma; workspace and applications and describes many
common tasks that can be performed.</para>
</abstract>
@@ -69,7 +69,7 @@ common tasks that can be performed.</para>
<title>Introduction</title>
<para>Welcome to &kde;!</para>
-<para>This guide will introduce you to the many features of the &kde; workspace and applications and
+<para>This guide will introduce you to the many features of the &plasma; workspace and applications and
describe many common tasks you can perform.</para>
<para>For more information on &kde;, visit the
diff --git a/doc/fundamentals/install.docbook b/doc/fundamentals/install.docbook
index a47aac2..01f393d 100644
--- a/doc/fundamentals/install.docbook
+++ b/doc/fundamentals/install.docbook
@@ -103,7 +103,7 @@ like what you see, most offer an option to install it to your hard drive.</para>
<para>There is <ulink url="http://www.kde.org/download/distributions.php">a list
of distributions that offer the &kde; workspace and applications on live media</ulink> on the &kde; website.</para>
</sect2>
-
+<!--Neon?-->
<sect2 id="install-source">
<title>Building from Source Code</title>
diff --git a/doc/fundamentals/tasks.docbook b/doc/fundamentals/tasks.docbook
index 49ae3aa..03ee2ce 100644
--- a/doc/fundamentals/tasks.docbook
+++ b/doc/fundamentals/tasks.docbook
@@ -801,11 +801,12 @@ many &kde; applications. For more information on this menu, see
<screenshot id="screenshot-find-find">
<screeninfo>The Find Window</screeninfo>
+<!--FIXME find dialog is only used in sheets + kalarm, see https://lxr.kde.org/search?_filestring=&_string=kfinddialog.h-->
<mediaobject>
<imageobject><imagedata fileref="find-find.png" format="PNG"/></imageobject>
<textobject><phrase>The Find window.</phrase></textobject>
-<caption><para>Searching for <userinput>software</userinput> in
-<ulink url="http://kde.org/applications/internet/kmail/">&kmail;'s composer window</ulink>.
+<caption><para>Searching for <userinput>income</userinput> in
+<ulink url="http://kde.org/applications/office/sheets/">&calligrasheets;</ulink>.
</para></caption>
</mediaobject>
</screenshot>
@@ -869,24 +870,12 @@ selected, not the entire document. It is disabled when no text is selected.
</variablelist>
-<para>The Find function only selects the first match that it finds. You can
-continue searching by selecting <menuchoice><guimenu>Edit</guimenu><guimenuitem>Find Next</guimenuitem></menuchoice>
-or by pressing <keycap>F3</keycap>.</para>
-
-<screenshot id="screenshot-find-found">
-<screeninfo>Example of a Search</screeninfo>
-<mediaobject>
-<imageobject><imagedata fileref="find-found.png" format="PNG"/></imageobject>
-<textobject><phrase>Example of a search.</phrase></textobject>
-<caption><para>&kmail; displays a match for <userinput>software</userinput>.
-</para></caption>
-</mediaobject>
-</screenshot>
-
<!--FIXME
-Copy documentation from Kate/KWrite here.
+Copy documentation from Kate/KWrite here or keep in sync with kate/menus.docbook + katepart/part.docbook
-->
-<para>Applications which use the &kde; text editor component show a search bar instead of the Find window. See <ulink url="help:/katepart/kate-part-find-replace.html#finding-text">&katepart; documentation</ulink> for additional information on the search bar.</para>
+<para>Many applications show a search bar instead of the Find window.
+See <ulink url="help:/katepart/kate-part-find-replace.html#finding-text">&katepart;
+documentation</ulink> for additional information on the search bar.</para>
<screenshot id="screenshot-find-find-inline">
<screeninfo>The search bar in &kate;.</screeninfo>
@@ -898,6 +887,20 @@ Copy documentation from Kate/KWrite here.
</mediaobject>
</screenshot>
+<para>The Find function only selects the first match that it finds. You can
+continue searching by selecting <menuchoice><guimenu>Edit</guimenu><guimenuitem>Find Next</guimenuitem></menuchoice>
+or by pressing <keycap>F3</keycap>.</para>
+
+<screenshot id="screenshot-find-found">
+<screeninfo>Example of a Search</screeninfo>
+<mediaobject>
+<imageobject><imagedata fileref="find-found.png" format="PNG"/></imageobject>
+<textobject><phrase>Example of a search.</phrase></textobject>
+<caption><para>&kate; displays a match for <userinput>KDE</userinput>.
+</para></caption>
+</mediaobject>
+</screenshot>
+
</sect2>
<sect2 id="find-replace">
@@ -909,12 +912,13 @@ other text. You can find it in many application at
or by pressing <keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>.</para>
<screenshot id="screenshot-find-replace">
+<!--FIXME replace dialog is only used in sheets + kalarm, see https://lxr.kde.org/search?_filestring=&_string=kreplacedialog.h-->
<screeninfo>The Replace Window</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="find-replace.png" format="PNG"/></imageobject>
<textobject><phrase>The Replace window.</phrase></textobject>
-<caption><para>Replacing <userinput>food</userinput> with
-<userinput>drink</userinput> in &kmail;</para></caption>
+<caption><para>Replacing <userinput>income</userinput> with
+<userinput>expense</userinput> in &calligrasheets;</para></caption>
</mediaobject>
</screenshot>
@@ -964,11 +968,13 @@ to replace the found text.</para></listitem>
</variablelist>
<!--FIXME
-Copy documentation from Kate/KWrite here.
+Copy documentation from Kate/KWrite here or keep in sync with kate/menus.docbook + katepart/part.docbook
-->
-<para>Applications which use the &kde; text editor component show a search and replace bar instead of the Replace window. See <ulink url="help:/kwrite/edit.html#replace">&kwrite; documentation</ulink> for additional information on the search and replace bar.</para>
+<para>Many Applications show a search and replace bar instead of the Replace window.
+See <ulink url="help:/kwrite/edit.html#replace">&kwrite; documentation</ulink> for
+additional information on the search and replace bar.</para>
-<screenshot id="screenshot-find-replace-inline">
+<screenshot id="screenshot-find-replace-inline"><!--FIXME update !!!-->
<screeninfo>The search and replace bar.</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="find-replace-inline.png" format="PNG"/></imageobject>
diff --git a/doc/fundamentals/ui.docbook b/doc/fundamentals/ui.docbook
index bdc9621..561f670 100644
--- a/doc/fundamentals/ui.docbook
+++ b/doc/fundamentals/ui.docbook
@@ -863,7 +863,8 @@ Reloads all open files.
<guimenu>File</guimenu><guimenuitem>Print...</guimenuitem>
</menuchoice></term>
<listitem><para>
-Prints the file.
+Prints the file. Use <guilabel>Print to File (PDF)</guilabel> to generate a &PDF; file
+or select a range of pages to print only these pages to a new &PDF; file
</para></listitem>
</varlistentry>
@@ -1085,7 +1086,7 @@ information, see <xref linkend="spellcheck-config"/>.
</variablelist>
</sect2>
-
+<!--FIXME add bookmarks menu ?-->
<sect2 id="menus-settings">
<title>The Settings Menu</title>
<para>The <guimenu>Settings</guimenu> allows you to customize the application.</para>
@@ -1101,7 +1102,13 @@ information, see <xref linkend="spellcheck-config"/>.
<guimenu>Settings</guimenu>
<guimenuitem>Show Menubar</guimenuitem>
</menuchoice></term>
-<listitem><para><action>Hides and shows the menubar.</action></para></listitem>
+<listitem><para>
+<action>Toggle the Menubar display</action> on and off. Once
+hidden it can be made visible using the shortcut
+<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> again.
+If the menubar is hidden, the context menu opened with a right mouse button
+click anywhere in the view area has an extra entry <guimenuitem>Show Menubar</guimenuitem>.
+</para></listitem>
</varlistentry>
<varlistentry>
@@ -1218,6 +1225,19 @@ window (if one exists for the particular item) explaining the item's
function.</para></listitem>
</varlistentry>
+<varlistentry>
+<term><menuchoice>
+<guimenu>Help</guimenu>
+<guimenuitem>Tip of the Day</guimenuitem>
+</menuchoice></term>
+<listitem>
+<para>This command <action>opens the <guilabel>Tip of the Day</guilabel> dialog</action>.
+You can page through all the tips by using the buttons on the dialog
+and select to show the tips at startup.</para>
+<para>Note: Not all applications provide these tips.</para>
+
+</listitem>
+</varlistentry>
<varlistentry>
<term><menuchoice>
@@ -1230,6 +1250,16 @@ report a bug or request a <quote>wishlist</quote> feature.</para></listitem>
<!--FIXME two different dialogs, either via web (default if aboutData->bugAddress() == "" or == "submit at bugs.kde.org" )
or via email (see krecipes doc rev 1306076)
-->
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Help</guimenu>
+<guimenuitem>Donate</guimenuitem>
+</menuchoice></term>
+<listitem><para>Opens the <ulink url="https://www.kde.org/community/donations">Donations page</ulink>
+where you can support &kde; and its projects.</para></listitem>
+</varlistentry>
+
<varlistentry>
<term><menuchoice>
<guimenu>Help</guimenu>
More information about the kde-doc-english
mailing list