[kde-doc-english] [okular/KDE/4.11] doc: Add some documentation about usage of Okular annotating tools
Burkhard Lück
lueck at hube-lueck.de
Sat Sep 28 13:06:46 UTC 2013
Git commit c1a61dd912dc61ae07b45f0c9e200dc6f68d9a9f by Burkhard Lück, on behalf of Yuri Chornoivan.
Committed on 21/09/2013 at 16:07.
Pushed by lueck into branch 'KDE/4.11'.
Add some documentation about usage of Okular annotating tools
REVIEW: 112569
(cherry picked from commit 452f7705a7ef0e64572da2a2c44e79b6a449f550)
backport to 4.11.3
M +243 -6 doc/index.docbook
A +- -- doc/tool-ellipse-okular.png
A +- -- doc/tool-highlighter-okular.png
A +- -- doc/tool-ink-okular.png
A +- -- doc/tool-line-okular.png
A +- -- doc/tool-note-inline-okular.png
A +- -- doc/tool-note-okular.png
A +- -- doc/tool-polygon-okular.png
A +- -- doc/tool-stamp-okular.png
A +- -- doc/tool-underline-okular.png
http://commits.kde.org/okular/c1a61dd912dc61ae07b45f0c9e200dc6f68d9a9f
diff --git a/doc/index.docbook b/doc/index.docbook
index 432aee2..1e58a18 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -488,7 +488,249 @@ Context menu actions like Rename Bookmarks etc.)
its buttons or use keyboard shortcuts (keys from <keycap>1</keycap> to <keycap>9</keycap>) to start constructing that annotation.
</para>
<para>
- The contents of the annotating toolbar can be configured using the <link linkend="configannotations">Annotations page of &okular; configuration dialog</link>. This page can be opened with &RMB; clicking on the annotating toolbar then choosing <guimenuitem>Configure Annotations...</guimenuitem> from the context menu.
+ The annotating toolbar helps you to make annotations with drawings, shapes, and text messages. You can use the annotating toolbar to mark up a document (⪚ add lines, ellipses, polygons, stamps, highlights, underlines &etc;). The table below describes exactly what the default set of annotating toolbar buttons does.
+ </para>
+ <informaltable>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>
+ Button
+ </entry>
+ <entry>
+ Tool Name
+ </entry>
+ <entry>
+ Description
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-note-okular.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Pop-up Note
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To draw multiline note. The note will can be viewed by double clicking on an icon in the document.
+ </para>
+ <para>
+ Click on the tool button, then click on the place in the document where the pop-up note should be added. Enter the text of pop-up note then click on the <guilabel>Close this note</guilabel> button in the top right corner of the pop-up window.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-note-inline-okular.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Inline Note
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To draw inline note. The note will be shown inline as is.
+ </para>
+ <para>
+ Click on the tool button, then click with the &LMB; and hold to place the top-left corner of the note, then drag to place the bottom-right one. Enter the text of the note then click on the <guibutton>OK</guibutton> to save the note, <guibutton>Cancel</guibutton> to cancel note entering or <guibutton>Clear</guibutton> to clear the note.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-ink-okular.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Freehand Line
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To draw free-form lines.
+ </para>
+ <para>
+ Click on the tool button, then click with the &LMB; and hold to place the start of the line, then drag to draw the line.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-highlighter-okular.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Highlighter
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To highlight text in the document with some given background color.
+ </para>
+ <para>
+ Click on the tool button, then click with the &LMB; and hold to place the beginning of the highlighted text snippet, then drag to highlight it.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-line-okular.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Straight Line
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To mark with a line.
+ </para>
+ <para>
+ Click on the tool button, then click with the &LMB; to place the starting point of the line, then drag to place of the ending point of the line should be and click once more.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-polygon-okular.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Polygon
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To draw a closed plane figure from three or more segments. The corresponding note can be viewed by double clicking inside the polygon.
+ </para>
+ <para>
+ Click on the tool button, then click with the &LMB; to place the first vertex of the polygon, then drag to place of the second vertex. Proceed until you draw the whole polygon up to the first vertex. Click twice if you want to add some note to the polygon. Enter the text of the note then click on the <guibutton>OK</guibutton> to save the note, <guibutton>Cancel</guibutton> to cancel note entering or <guibutton>Clear</guibutton> to clear the note.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-stamp-okular.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Stamp
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To mark the text or image with some predefined shape.
+ </para>
+ <para>
+ Click on the tool button then click with the &LMB; to place the stamp.
+ </para>
+ <para>
+ A single click just places a square stamp (useful for icons).
+ To add a rectangular stamp you can click with the &LMB; and hold to place the top-left point, then drag to place the bottom-right one.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-underline-okular.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Underline
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To underline some text.
+ </para>
+ <para>
+ Click on the tool button, then click with the &LMB; and hold to place the beginning of the underlined text snippet, then drag to underline it.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-ellipse-okular.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Ellipse
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To draw an ellipse around some chosen area.
+ </para>
+ <para>
+ Click on the tool button, then click with the &LMB; and hold to place the top-left corner of the circumscribed rectangular for the ellipse, then drag to place the bottom-right one.
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+ The contents of the annotating toolbar can be configured using the <link linkend="configannotations">Annotations page of &okular; configuration dialog</link>. This page can be opened with &RMB; clicking on the annotating toolbar then choosing <guimenuitem>Configure Annotations...</guimenuitem> from the context menu.
</para>
<para>
With a single &LMB; click on an annotation tool button you can use a tool once.
@@ -516,11 +758,6 @@ Context menu actions like Rename Bookmarks etc.)
<link linkend="configannotations"><guilabel>Annotations</guilabel> page</link> in &okular;s
configuration dialog. The <guilabel>Annotations</guilabel> page can also be used to configure the content of the annotating toolbar.
</para>
- <note>
- <para>Using stamps a single click just places a square stamp (useful for icons).
- To add a rectangular stamp you can click with the &LMB; and hold to place the top-left point,
- then drag to place the bottom-right one.</para>
- </note>
</sect2>
<sect2 id="annotations-remove">
<title>Removing annotations</title>
diff --git a/doc/tool-ellipse-okular.png b/doc/tool-ellipse-okular.png
new file mode 100644
index 0000000..82d1d18
Binary files /dev/null and b/doc/tool-ellipse-okular.png differ
diff --git a/doc/tool-highlighter-okular.png b/doc/tool-highlighter-okular.png
new file mode 100644
index 0000000..4a46158
Binary files /dev/null and b/doc/tool-highlighter-okular.png differ
diff --git a/doc/tool-ink-okular.png b/doc/tool-ink-okular.png
new file mode 100644
index 0000000..16f2b88
Binary files /dev/null and b/doc/tool-ink-okular.png differ
diff --git a/doc/tool-line-okular.png b/doc/tool-line-okular.png
new file mode 100644
index 0000000..e4f2d82
Binary files /dev/null and b/doc/tool-line-okular.png differ
diff --git a/doc/tool-note-inline-okular.png b/doc/tool-note-inline-okular.png
new file mode 100644
index 0000000..235d0a4
Binary files /dev/null and b/doc/tool-note-inline-okular.png differ
diff --git a/doc/tool-note-okular.png b/doc/tool-note-okular.png
new file mode 100644
index 0000000..b0dd463
Binary files /dev/null and b/doc/tool-note-okular.png differ
diff --git a/doc/tool-polygon-okular.png b/doc/tool-polygon-okular.png
new file mode 100644
index 0000000..9df96ca
Binary files /dev/null and b/doc/tool-polygon-okular.png differ
diff --git a/doc/tool-stamp-okular.png b/doc/tool-stamp-okular.png
new file mode 100644
index 0000000..1bbd268
Binary files /dev/null and b/doc/tool-stamp-okular.png differ
diff --git a/doc/tool-underline-okular.png b/doc/tool-underline-okular.png
new file mode 100644
index 0000000..a14282d
Binary files /dev/null and b/doc/tool-underline-okular.png differ
More information about the kde-doc-english
mailing list