[kde-doc-english] [kdepim] doc/knotes: Update KNotes docbook to 16.08
Burkhard Lück
lueck at hube-lueck.de
Sun Jul 31 19:23:18 UTC 2016
Git commit cbd0e64aa7eec7da18319af904ef8b5c23938369 by Burkhard Lück.
Committed on 31/07/2016 at 19:22.
Pushed by lueck into branch 'master'.
Update KNotes docbook to 16.08
proofread + update
new screenshot
bump date + releaseinfo
remove unused entities kappname + package
REVIEW:128544
M +68 -40 doc/knotes/index.docbook
A +- -- doc/knotes/select-note-folder.png
A +- -- doc/knotes/setup-knotes.png
http://commits.kde.org/kdepim/cbd0e64aa7eec7da18319af904ef8b5c23938369
diff --git a/doc/knotes/index.docbook b/doc/knotes/index.docbook
index a9e9130..7ee4834 100644
--- a/doc/knotes/index.docbook
+++ b/doc/knotes/index.docbook
@@ -1,7 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
- <!ENTITY kappname "&knotes;">
- <!ENTITY package "kdepim">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
@@ -46,8 +44,8 @@
<legalnotice>&FDLNotice;</legalnotice>
-<date>2013-05-26</date>
-<releaseinfo>4.11 pre (&kde; 4.11)</releaseinfo>
+<date>2016-07-28</date>
+<releaseinfo>5.3.40 (Applications 16.08)</releaseinfo>
<abstract><para>&knotes; is a sticky notes application for the
desktop.</para></abstract>
@@ -55,7 +53,6 @@ desktop.</para></abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>Knotes</keyword>
-<keyword>kdeutils</keyword>
<keyword>notes</keyword>
<keyword>popup</keyword>
<keyword>pop-up</keyword>
@@ -81,7 +78,8 @@ customized for each note. You may also customize the
defaults. </para>
<para>After starting &knotes; for the first time you will have a resource installed
-that saves all notes in a file under <filename>$<envar>HOME</envar>/.kde/share/apps/knotes/notes.ics</filename>.
+that saves all notes in a maildir folder under <filename>notes</filename>
+in <filename class="directory">$(qtpaths --paths GenericDataLocation)</filename>.
</para>
</chapter>
@@ -93,12 +91,25 @@ that saves all notes in a file under <filename>$<envar>HOME</envar>/.kde/share/a
<varlistentry>
<term>Creating a new note:</term>
<listitem>
-<para>To create a new note &RMB; click on the &knotes; panel
+<para>To create a new note &RMB; click on the &knotes; tray
icon and select <guimenuitem>New Note</guimenuitem>.</para>
<para>You can create a new note containing the contents of the
clipboard by selecting <guimenuitem>New Note From
-Clipboard</guimenuitem>.</para>
+Clipboard</guimenuitem> or use <guimenuitem>New Note From Textfile</guimenuitem>.</para>
+<para>Now a dialog will appear which allows you to select a folder to save your note:</para>
+
+<screenshot>
+<screeninfo>Select Notes Folder</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="select-notes-folder.png" format="PNG" />
+</imageobject>
+<textobject><phrase>Select Notes Folder</phrase></textobject>
+</mediaobject>
+</screenshot>
+
+<para>Select a default folder here to skip this dialog creating new notes.</para>
</listitem>
</varlistentry>
@@ -122,6 +133,7 @@ following menu options:</para>
<listitem><para><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
</shortcut><guimenuitem>Paste</guimenuitem></menuchoice></para></listitem>
<listitem><para><guimenuitem>Delete</guimenuitem></para></listitem>
+<listitem><para><guimenuitem>Clear</guimenuitem></para></listitem>
<listitem><para><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo>
</shortcut><guimenuitem>Select All</guimenuitem></menuchoice></para></listitem>
<listitem><para><guimenuitem>Check Spelling</guimenuitem></para></listitem>
@@ -134,6 +146,8 @@ following menu options:</para>
<listitem><para><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>
</shortcut><guimenuitem>Replace</guimenuitem></menuchoice></para></listitem>
<listitem><para><guimenuitem>Speak Text</guimenuitem></para></listitem>
+<listitem><para><guimenuitem>Insert Date</guimenuitem></para></listitem>
+<listitem><para><guimenuitem>insert Checkmark</guimenuitem></para></listitem>
</itemizedlist>
<para>Text may be selected by holding down the &LMB; and moving the
mouse, or by holding down the &Shift; key and using the
@@ -144,9 +158,8 @@ mouse, or by holding down the &Shift; key and using the
<varlistentry>
<term>Inserting the date:</term>
<listitem>
-<para>To insert the current date in the note &RMB; click on the title
-bar of the note and select <guimenuitem>Insert
-Date</guimenuitem>.</para>
+<para>To insert the current date in the note use the context menu of the editing space
+and select <guimenuitem>Insert Date</guimenuitem>.</para>
<para>The current date and time will be inserted at the cursor
position in the text of the note.</para>
</listitem>
@@ -206,8 +219,8 @@ displayed on the screen. The note itself will not be deleted.</para>
<varlistentry>
<term>Setting an alarm:</term>
<listitem>
-<para>Select <guimenuitem>Set Alarm</guimenuitem> in the context menu of the
-note titlebar. Check <guilabel>Alarm at</guilabel> in the next dialog and adjust
+<para>Select <guimenuitem>Set Alarm</guimenuitem> in the context menu of the
+note titlebar. Check <guilabel>Alarm at</guilabel> in the next dialog and adjust
the date and time for the reminder. At alarm time a popup window will
be displayed and list all notes with the actual alarm date.</para>
</listitem>
@@ -216,8 +229,8 @@ be displayed and list all notes with the actual alarm date.</para>
<varlistentry>
<term>Sending a note:</term>
<listitem>
-<para>To send a note to an other computer select <guimenuitem>Send...</guimenuitem>
-in the context menu of the note titlebar. Add a hostname or ip or choose a recipient
+<para>To send a note to an other computer select <guimenuitem>Send...</guimenuitem>
+in the context menu of the note titlebar. Add a hostname or ip or choose a recipient
from the list of previously sent notes. If the recipients has enabled incoming notes,
the note will appear on his screen, indicating the sender id in the titlebar.</para>
</listitem>
@@ -226,7 +239,7 @@ the note will appear on his screen, indicating the sender id in the titlebar.</p
<varlistentry>
<term>Locking a note:</term>
<listitem>
-<para>To prevent accidental changes in a note select <guimenuitem>Lock</guimenuitem>
+<para>To prevent accidental changes in a note select <guimenuitem>Lock</guimenuitem>
in the context menu of the note titlebar.</para>
</listitem>
</varlistentry>
@@ -234,8 +247,8 @@ in the context menu of the note titlebar.</para>
<varlistentry>
<term>Saving a note:</term>
<listitem>
-<para>To save a note select <guimenuitem>Save As...</guimenuitem>
-in the context menu of the note titlebar. The note can be saved as a plain text file
+<para>To save a note select <guimenuitem>Save As...</guimenuitem>
+in the context menu of the note titlebar. The note can be saved as a plain text file
or in &HTML; format, if <guilabel>Rich text</guilabel> is enabled.</para>
</listitem>
</varlistentry>
@@ -266,12 +279,12 @@ for in all notes.</para>
<para>To send a note to a specific desktop, &RMB; click on the title
bar of the note and select <guisubmenu>To Desktop</guisubmenu>.
Choose the desktop desired, or alternatively, <guimenuitem>All
-Desktops</guimenuitem></para>
+Desktops</guimenuitem></para>
<para>To make the note remain on top of other windows &RMB; click on
-the titlebar of the note and select <guimenuitem>Keep Above
-Others</guimenuitem>.</para>
-<para>To return the note to more normal window behavior, select
-<guimenuitem>Keep Below Others</guimenuitem>.</para>
+the titlebar of the note and select <guimenuitem>Keep Above
+Others</guimenuitem>.</para>
+<para>To return the note to more normal window behavior, select
+<guimenuitem>Keep Below Others</guimenuitem>.</para>
</listitem>
</varlistentry>
@@ -285,15 +298,6 @@ Others</guimenuitem>.</para>
</variablelist>
-<!--FIXME Not using Akonadi resources and will probably never ported to akonadi framework
-After starting &knotes; for the first time you will have a resource installed
-that saves all notes in a file under <filename>$<envar>HOME</envar>/.kde/share/apps/knotes/notes.ics</filename>;
-<envar>$KDEHOME</envar> is usually a hidden folder in your Home folder called <filename class="directory">.kde</filename>
-or <filename class="directory">.kde4</filename>
-"$KDEHOME" is not always defined eg not in kubuntu 11.04
-<filename class="directory">`kde4-config - -localprefix`/share/apps/kvtml</filename>
-(without whitespace between '- -') is afaik always defined
--->
</chapter>
<chapter id="configuration">
@@ -340,13 +344,13 @@ taskbar for each note. If you prefer they do so, enable this
option.</para>
</listitem>
</varlistentry>
-<!--FIXME does not work in 4.11 here
+
<varlistentry>
<term><guilabel>Remember desktop</guilabel></term>
-<listitem><para>.</para>
+<listitem><para>If you use several virtual desktops and this option
+is selected, notes will appear only on the specific desktop.</para>
</listitem>
</varlistentry>
--->
</variablelist>
<variablelist>
@@ -421,14 +425,38 @@ hostname or ip and date of sending.</para></listitem>
</varlistentry>
</variablelist>
+<variablelist>
+<title>The Print Section</title>
+<varlistentry>
+<term><guilabel>Theme</guilabel></term>
+<listitem><para>The theme used to print the note.</para></listitem>
+</varlistentry>
+</variablelist>
<variablelist>
-<title>The Style Section</title>
+<title>The Collections Section</title>
<varlistentry>
-<term><guilabel>Style</guilabel></term>
-<listitem><para>Only <guilabel>Plain</guilabel> text format is selectable so far.</para></listitem>
+<term><guilabel>Folders</guilabel></term>
+<listitem><para>On this tab you can select which folders are shown activating the checkbox
+in front of folders, change the default saving folder and add subfolders for notes.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><guilabel>Accounts</guilabel></term>
+<listitem><para>On this tab you can edit the local maildir folders to be used for notes.</para></listitem>
+</varlistentry>
+</variablelist>
+
+<variablelist>
+<title>The Misc Section</title>
+<varlistentry>
+<term>Misc settings</term>
+<listitem><para>Enable to display the number of notes in the tray icon</para>
+<para>To customize the default title you can use <userinput>%d</userinput>
+for current date in short format, <userinput>%I</userinput> for
+current date in long format and <userinput>%t</userinput> for current time.</para></listitem>
</varlistentry>
</variablelist>
+
</sect1>
<sect1 id="customizing-display">
@@ -443,8 +471,8 @@ settings.</para>
<para>To customize a single note display &RMB; click on the note title
bar and select <guimenuitem>Preferences...</guimenuitem>.</para>
-<para>A dialog with the <guilabel>Display</guilabel> and
-<guilabel>Editor</guilabel> pages will open,
+<para>A dialog with the <guilabel>Display Settings</guilabel> and
+<guilabel>Editor Settings</guilabel> pages will open,
allowing you to configure the note.</para>
</sect1>
diff --git a/doc/knotes/select-note-folder.png b/doc/knotes/select-note-folder.png
new file mode 100644
index 0000000..2d6f158
Binary files /dev/null and b/doc/knotes/select-note-folder.png differ
diff --git a/doc/knotes/setup-knotes.png b/doc/knotes/setup-knotes.png
new file mode 100644
index 0000000..735f210
Binary files /dev/null and b/doc/knotes/setup-knotes.png differ
More information about the kde-doc-english
mailing list