[graphics/okular] doc: Update docs to the new annotation toolbar
Yuri Chornoivan
null at kde.org
Thu Jun 4 21:20:20 BST 2020
Git commit 9647a104a758a7126e6afa558dc0243056bb293e by Yuri Chornoivan.
Committed on 04/06/2020 at 18:30.
Pushed by ngraham into branch 'master'.
Update docs to the new annotation toolbar
Differential review: https://phabricator.kde.org/D25229
M +- -- doc/annotations.png
M +388 -61 doc/index.docbook
M +- -- doc/mainwindow.png
A +- -- doc/tool-draw-arrow.png
A +- -- doc/tool-draw-ellipse.png
A +- -- doc/tool-draw-freehand.png
A +- -- doc/tool-draw-highlight.png
A +- -- doc/tool-draw-line.png
A +- -- doc/tool-draw-polyline.png
A +- -- doc/tool-draw-rectangle.png
A +- -- doc/tool-edit-comment.png
A +- -- doc/tool-edit-line-width.png
A +- -- doc/tool-edit-opacity.png
D +- -- doc/tool-ellipse-okular.png
A +- -- doc/tool-favorite.png
A +- -- doc/tool-fill-color.png
A +- -- doc/tool-font-face.png
A +- -- doc/tool-format-text-color.png
A +- -- doc/tool-format-text-strikethrough.png
A +- -- doc/tool-format-text-underline-squiggle.png
A +- -- doc/tool-format-text-underline.png
D +- -- doc/tool-highlighter-okular.png
D +- -- doc/tool-ink-okular.png
D +- -- doc/tool-line-okular.png
D +- -- doc/tool-note-inline-okular.png
D +- -- doc/tool-note-okular.png
A +- -- doc/tool-note.png
A +- -- doc/tool-pin.png
D +- -- doc/tool-polygon-okular.png
A +- -- doc/tool-settings-configure.png
D +- -- doc/tool-stamp-okular.png
A +- -- doc/tool-tag.png
A +- -- doc/tool-tool-text.png
D +- -- doc/tool-typewriter-okular.png
D +- -- doc/tool-underline-okular.png
A +- -- doc/tool-window-pin.png
https://invent.kde.org/graphics/okular/commit/9647a104a758a7126e6afa558dc0243056bb293e
diff --git a/doc/annotations.png b/doc/annotations.png
index 07a7f6a29..ae4c5d9e3 100644
Binary files a/doc/annotations.png and b/doc/annotations.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index b79948962..3f044804f 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -33,7 +33,7 @@ Context menu actions like Rename Bookmarks etc.)
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<legalnotice>&FDLNotice;</legalnotice>
- <date>2020-04-08</date>
+ <date>2020-06-05</date>
<releaseinfo>1.11 (Applications 20.08)</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
@@ -182,7 +182,7 @@ Context menu actions like Rename Bookmarks etc.)
</listitem>
<listitem>
<para>
- If the document has annotations, enable the <guilabel>Reviews</guilabel> view
+ If the document has annotations, enable the <guilabel>Annotations</guilabel> view
and click the annotations or select them with the <keysym>Up Arrow</keysym> and <keysym>Down Arrow</keysym> keys and press <keycap>Return</keycap> to go to the associated page.
</para>
</listitem>
@@ -496,7 +496,7 @@ Context menu actions like Rename Bookmarks etc.)
<para>Text annotations like <guilabel>Yellow Highlighter</guilabel> and <guilabel>Black Underlining</guilabel>
for files with text like ⪚ &PDF;.</para>
<para>Graphic annotations like <guilabel>Pop-up Note</guilabel>, <guilabel>Inline Note</guilabel>, <guilabel>Freehand Line</guilabel>, <guilabel>Highlighter</guilabel>, <guilabel>Straight Line</guilabel>, <guilabel>Polygon</guilabel>, <guilabel>Stamp</guilabel>, <guilabel>Underline</guilabel>, <guilabel>Ellipse</guilabel>, and <guilabel>Typewriter</guilabel> for all formats supported by &okular;.</para>
- <para>Using the context menu either in the <guilabel>Reviews</guilabel> view of the sidebar or in the main window you can open a <guilabel>Pop up Note</guilabel> for any kind of annotation and add or edit comments.</para>
+ <para>Using the context menu either in the <guilabel>Annotations</guilabel> view of the sidebar or in the main window you can open a <guilabel>Pop up Note</guilabel> for any kind of annotation and add or edit comments.</para>
<para>Annotations are not only limited to &PDF; files, they can be used for any format &okular; supports.</para>
<para>
&okular; has the "document archiving" feature. This is an &okular;-specific format for carrying the document plus various metadata related to it (currently only annotations). You can save a "document archive" from the open document by choosing <menuchoice><guimenu>File</guimenu><guisubmenu>Save As</guisubmenu></menuchoice> and selecting <guilabel>Okular document archive</guilabel> in the <guilabel>Filter</guilabel> selector. Documents saved this way will get <filename>.okular</filename> as their filename extension. To open an &okular; document archive, just open it with &okular; as it would be ⪚ a &PDF; document.
@@ -521,9 +521,9 @@ Context menu actions like Rename Bookmarks etc.)
<sect2 id="annotations-add">
<title>Adding annotations</title>
<para>
- To add some annotations to the document, you have to activate the annotating toolbar.
+ To add some annotations to the document, you have to use <guilabel>Quick Annotations</guilabel> button on the main &okular; toolbar or activate the annotating toolbar.
This is done by either selecting
- <menuchoice><guimenu>Tools</guimenu><guimenuitem>Review</guimenuitem></menuchoice> or
+ <menuchoice><guimenu>Tools</guimenu><guimenuitem>Annotations</guimenuitem></menuchoice> or
pressing <keycap>F6</keycap>. Once the annotating toolbar is shown, just press one of
its buttons or use keyboard shortcuts (keys from <keycap>1</keycap> to <keycap>9</keycap>) to start constructing that annotation.
</para>
@@ -551,25 +551,133 @@ Context menu actions like Rename Bookmarks etc.)
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-note-okular.png" format="PNG"/>
+ <imagedata fileref="tool-draw-highlight.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
</entry>
<entry>
<para>
- Pop-up Note
+ Highlighter
</para>
</entry>
<entry>
<para>
- To draw multiline note. The note will can be viewed by double clicking on an icon in the document.
+ To highlight text in the document with some given background color.
</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.
+ 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>
<para>
- It is possible to define the <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, and <guilabel>Icon</guilabel> for the note. Just right-click on the note icon created and select the <guimenuitem>Properties</guimenuitem> menu item.
+ It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the highlighter. Just right-click on the highlighted text and select the <guimenuitem>Properties</guimenuitem> menu item.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-format-text-underline.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>
+ <para>
+ It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the underline. Just right-click on the underlined text and select the <guimenuitem>Properties</guimenuitem> menu item.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-format-text-underline-squiggle.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Squiggle
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To underline some text by a squiggle line.
+ </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>
+ <para>
+ It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the underline. Just right-click on the underlined text and select the <guimenuitem>Properties</guimenuitem> menu item.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-format-text-strikethrough.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Strike Out
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To strike out 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>
+ <para>
+ It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the underline. Just right-click on the underlined text and select the <guimenuitem>Properties</guimenuitem> menu item.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-tool-text.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Typewriter
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Typewriter features opaque letters on transparent background, so that it is useful to fill noninteractive forms.
+ </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>
+ <para>
+ It is possible to define the <guilabel>Font</guilabel> and <guilabel>Text color</guilabel> for the text. Just right-click on the typewriter text created and select the <guimenuitem>Properties</guimenuitem> menu item.
</para>
</entry>
</row>
@@ -578,7 +686,7 @@ Context menu actions like Rename Bookmarks etc.)
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-note-inline-okular.png" format="PNG"/>
+ <imagedata fileref="tool-note.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
@@ -605,7 +713,34 @@ Context menu actions like Rename Bookmarks etc.)
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-ink-okular.png" format="PNG"/>
+ <imagedata fileref="tool-edit-comment.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>
+ <para>
+ It is possible to define the <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, and <guilabel>Icon</guilabel> for the note. Just right-click on the note icon created and select the <guimenuitem>Properties</guimenuitem> menu item.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-draw-freehand.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
@@ -632,25 +767,25 @@ Context menu actions like Rename Bookmarks etc.)
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-highlighter-okular.png" format="PNG"/>
+ <imagedata fileref="tool-draw-arrow.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
</entry>
<entry>
<para>
- Highlighter
+ Arrow (drop-down list)
</para>
</entry>
<entry>
<para>
- To highlight text in the document with some given background color.
+ To mark with an arrow.
</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.
+ 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>
<para>
- It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the highlighter. Just right-click on the highlighted text and select the <guimenuitem>Properties</guimenuitem> menu item.
+ It is possible to define the <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Width</guilabel>, <guilabel>Line start</guilabel>, <guilabel>Line end</guilabel>, <guilabel>Leader line length</guilabel>, and <guilabel>Leader line extension length</guilabel> for the line. Just right-click on the line created and select the <guimenuitem>Properties</guimenuitem> menu item.
</para>
</entry>
</row>
@@ -659,14 +794,14 @@ Context menu actions like Rename Bookmarks etc.)
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-line-okular.png" format="PNG"/>
+ <imagedata fileref="tool-draw-line.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
</entry>
<entry>
<para>
- Straight Line
+ Straight line (drop-down list)
</para>
</entry>
<entry>
@@ -686,14 +821,68 @@ Context menu actions like Rename Bookmarks etc.)
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-polygon-okular.png" format="PNG"/>
+ <imagedata fileref="tool-draw-rectangle.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Rectangle (drop-down list)
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To draw a rectangle 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 rectangle, then drag to place the bottom-right one.
+ </para>
+ <para>
+ It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Rectangle</guimenuitem> or <guimenuitem>Ellipse</guimenuitem>), <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Shape fill</guilabel> (and its color), and <guilabel>Width</guilabel> for the border. Just right-click on the border created and select the <guimenuitem>Properties</guimenuitem> menu item.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-draw-ellipse.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Ellipse (drop-down list)
+ </para>
+ </entry>
+ <entry>
+ <para>
+ To draw an ellipse or rectangle 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>
+ <para>
+ It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Rectangle</guimenuitem> or <guimenuitem>Ellipse</guimenuitem>), <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Shape fill</guilabel> (and its color), and <guilabel>Width</guilabel> for the border. Just right-click on the border created and select the <guimenuitem>Properties</guimenuitem> menu item.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-draw-polyline.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
</entry>
<entry>
<para>
- Polygon
+ Polygon (drop-down list)
</para>
</entry>
<entry>
@@ -713,7 +902,7 @@ Context menu actions like Rename Bookmarks etc.)
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-stamp-okular.png" format="PNG"/>
+ <imagedata fileref="tool-tag.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
@@ -728,7 +917,7 @@ Context menu actions like Rename Bookmarks etc.)
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.
+ Click on the tool button to choose the stamp from the drop-down list then click with the &LMB; to place the stamp.
</para>
<para>
A single click just places a square stamp (useful for icons).
@@ -744,30 +933,81 @@ Context menu actions like Rename Bookmarks etc.)
</warning>
</entry>
</row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>These are the default annotations provided by &okular;. Using the <link linkend="configannotations">Annotations page</link> of the configuration dialog
+ you can add your own annotations like custom stamps, text markup or a geometrical shape with inner color to highlight regions &etc;
+ </para>
+ <note>
+ <para>
+ It is possible to add &latex; code into the text of annotations. Please add <userinput>$$<replaceable>code</replaceable>$$</userinput> to the text of annotation, where <replaceable>code</replaceable> is any valid &latex; equation, and follow instructions on the screen to make it render by a &latex; distribution installed in your system.
+ </para>
+ </note>
+ <para>
+ It is possible to configure the current tool options using the annotating toolbar itself. The table below describes exactly what the default set of annotating toolbar configuring buttons does.
+ </para>
+ <informaltable>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>
+ Button
+ </entry>
+ <entry>
+ Option Name
+ </entry>
+ <entry>
+ Description
+ </entry>
+ </row>
+ </thead>
+ <tbody>
<row>
<entry>
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-underline-okular.png" format="PNG"/>
+ <imagedata fileref="tool-edit-line-width.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
</entry>
<entry>
<para>
- Underline
+ Line width
</para>
</entry>
<entry>
<para>
- To underline some text.
+ Click on the tool button to choose the width from the drop-down list.
</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
<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.
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-format-text-color.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ /
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-bordertool.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
</para>
+ </entry>
+ <entry>
<para>
- It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the underline. Just right-click on the underlined text and select the <guimenuitem>Properties</guimenuitem> menu item.
+ Annotation color
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Click on the tool button to choose color of text or border of your annotation. You can chose one of the predefined colors or click on the <guimenuitem>Custom Color...</guimenuitem> item to open the color selection dialog.
</para>
</entry>
</row>
@@ -776,82 +1016,169 @@ Context menu actions like Rename Bookmarks etc.)
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-ellipse-okular.png" format="PNG"/>
+ <imagedata fileref="tool-fill-color.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
</entry>
<entry>
<para>
- Ellipse
+ Annotation fill color
</para>
</entry>
<entry>
<para>
- To draw an ellipse or rectangle around some chosen area.
+ Click on the tool button to choose a fill color of your annotation. You can chose one of the predefined colors or click on the <guimenuitem>Custom Color...</guimenuitem> item to open the color selection dialog.
</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
<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.
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-edit-opacity.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
</para>
+ </entry>
+ <entry>
<para>
- It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Rectangle</guimenuitem> or <guimenuitem>Ellipse</guimenuitem>), <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Shape fill</guilabel> (and its color), and <guilabel>Width</guilabel> for the border. Just right-click on the border created and select the <guimenuitem>Properties</guimenuitem> menu item.
+ Annotation opacity
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Click on the tool button to choose annotation level of opacity from the drop-down list (<guimenuitem>100%</guimenuitem> is for the opaque annotations).
</para>
</entry>
</row>
- <row>
+ <row>
<entry>
<para>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="tool-typewriter-okular.png" format="PNG"/>
+ <imagedata fileref="tool-font-face.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
</para>
</entry>
<entry>
<para>
- Typewriter
+ Annotation font
</para>
</entry>
<entry>
<para>
- Typewriter features opaque letters on transparent background, so that it is useful to fill noninteractive forms.
+ Click on the tool button to open the font selection dialog.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-settings-configure.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
</para>
+ </entry>
+ <entry>
<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.
+ Advanced settings for the current annotation tool
</para>
+ </entry>
+ <entry>
<para>
- It is possible to define the <guilabel>Font</guilabel> and <guilabel>Text color</guilabel> for the text. Just right-click on the typewriter text created and select the <guimenuitem>Properties</guimenuitem> menu item.
+ Click on the tool button to open the general configuration dialog for your annotation.
</para>
</entry>
</row>
- </tbody>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+ There are three additional utility buttons on the default annotating toolbar.
+ </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>
+ Button
+ </entry>
+ <entry>
+ Description
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-favorite.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Add the current annotation to the <guilabel>Quick Annotations</guilabel> menu on the main toolbar.
+ </para>
+ <note>
+ <para>
+ You can use the default shortcuts from <keycombo action="simul">&Alt;<keycap>9</keycap></keycombo> to <keycombo action="simul">&Alt;<keycap>0</keycap></keycombo> to select the quick annotation actions any time you like even with the annotating toolbar hidden.
+ </para>
+ </note>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-window-pin.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ When checked keep the current annotation tool active after use.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="tool-dialog-close.png" format="PNG"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Hide the annotating toolbar.
+ </para>
+ </entry>
+ </row>
+ </tbody>
</tgroup>
</informaltable>
- <para>These are the default annotations provided by &okular;. Using the <link linkend="configannotations">Annotations page</link> of the configuration dialog
- you can add your own annotations like custom stamps, text markup with <guilabel>Squiggle</guilabel> or <guilabel>Strike out</guilabel>, a geometrical shape
- like a <guilabel>Rectangle</guilabel> with inner color to highlight regions &etc;
- </para>
- <note>
- <para>
- It is possible to add &latex; code into the text of annotations. Please add <userinput>$$<replaceable>code</replaceable>$$</userinput> to the text of annotation, where <replaceable>code</replaceable> is any valid &latex; equation, and follow instructions on the screen to make it render by a &latex; distribution installed in your system.
- </para>
- </note>
<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.
- If you ⪚ want to highlight all important parts of a text, activate that tool
- permanently by double clicking on the tool button.
+ With a single &LMB; click on an annotation tool button you can use a tool once.
+ If you ⪚ want to highlight all important parts of a text, activate that tool
+ permanently by double clicking on the tool button.
Press the <keycap>Esc</keycap> key or click the tool button again to leave the permanent mode.
</para>
- <note>
- <para>
- The annotating toolbar can be docked in any side of the viewing area: just drag it to
- move it to another place.
- </para>
- </note>
<note>
<para>
Activating the annotating toolbar will make you switch to the Browse Mode.
@@ -1856,11 +2183,11 @@ Context menu actions like Rename Bookmarks etc.)
<menuchoice>
<shortcut><keycap>F6</keycap></shortcut>
<guimenu>Tools</guimenu>
- <guimenuitem>Review</guimenuitem>
+ <guimenuitem>Annotations</guimenuitem>
</menuchoice>
</term>
<listitem>
- <para><action>Open the review toolbar</action>. The review toolbar allows you to add
+ <para><action>Open the annotating toolbar</action>. The annotating toolbar allows you to add
annotations on the document you are reading. For more information, please see the
section about <link linkend="annotations">Annotations</link>.</para>
</listitem>
@@ -2395,7 +2722,7 @@ Context menu actions like Rename Bookmarks etc.)
<varlistentry>
<term><guilabel>Rendering</guilabel></term>
<listitem>
- <para>Using this group of options you can improve text and image rendering in &okular;. The result depends on the device to display the document.
+ <para>Using this group of options you can improve text and image rendering in &okular;. The result depends on the device to display the document.
<guilabel>Enable Text Antialias</guilabel> and <guilabel>Enable Graphics Antialias</guilabel> items can be used to switch on and off <ulink url="http://en.wikipedia.org/wiki/Spatial_anti-aliasing">spatial anti-aliasing</ulink> of text and images in document, correspondingly.
<guilabel>Enable Text Hinting</guilabel> item is meant to be a switcher for <ulink url="http://en.wikipedia.org/wiki/Font_hinting">font hinting</ulink>.
Antialiasing and hinting change how the documents are displayed, you may want to tweak them to your preference.</para>
diff --git a/doc/mainwindow.png b/doc/mainwindow.png
index 16e1eba7f..f091bbdbf 100644
Binary files a/doc/mainwindow.png and b/doc/mainwindow.png differ
diff --git a/doc/tool-draw-arrow.png b/doc/tool-draw-arrow.png
new file mode 100644
index 000000000..cb79a5889
Binary files /dev/null and b/doc/tool-draw-arrow.png differ
diff --git a/doc/tool-draw-ellipse.png b/doc/tool-draw-ellipse.png
new file mode 100644
index 000000000..d4aa579ba
Binary files /dev/null and b/doc/tool-draw-ellipse.png differ
diff --git a/doc/tool-draw-freehand.png b/doc/tool-draw-freehand.png
new file mode 100644
index 000000000..00b8c1513
Binary files /dev/null and b/doc/tool-draw-freehand.png differ
diff --git a/doc/tool-draw-highlight.png b/doc/tool-draw-highlight.png
new file mode 100644
index 000000000..7ee1b3221
Binary files /dev/null and b/doc/tool-draw-highlight.png differ
diff --git a/doc/tool-draw-line.png b/doc/tool-draw-line.png
new file mode 100644
index 000000000..1b9b8e8da
Binary files /dev/null and b/doc/tool-draw-line.png differ
diff --git a/doc/tool-draw-polyline.png b/doc/tool-draw-polyline.png
new file mode 100644
index 000000000..1125eaca5
Binary files /dev/null and b/doc/tool-draw-polyline.png differ
diff --git a/doc/tool-draw-rectangle.png b/doc/tool-draw-rectangle.png
new file mode 100644
index 000000000..3d05f65b8
Binary files /dev/null and b/doc/tool-draw-rectangle.png differ
diff --git a/doc/tool-edit-comment.png b/doc/tool-edit-comment.png
new file mode 100644
index 000000000..d720a153c
Binary files /dev/null and b/doc/tool-edit-comment.png differ
diff --git a/doc/tool-edit-line-width.png b/doc/tool-edit-line-width.png
new file mode 100644
index 000000000..63e0ee59f
Binary files /dev/null and b/doc/tool-edit-line-width.png differ
diff --git a/doc/tool-edit-opacity.png b/doc/tool-edit-opacity.png
new file mode 100644
index 000000000..a91957a1e
Binary files /dev/null and b/doc/tool-edit-opacity.png differ
diff --git a/doc/tool-ellipse-okular.png b/doc/tool-ellipse-okular.png
deleted file mode 100644
index 82d1d18a8..000000000
Binary files a/doc/tool-ellipse-okular.png and /dev/null differ
diff --git a/doc/tool-favorite.png b/doc/tool-favorite.png
new file mode 100644
index 000000000..b4c2b61f1
Binary files /dev/null and b/doc/tool-favorite.png differ
diff --git a/doc/tool-fill-color.png b/doc/tool-fill-color.png
new file mode 100644
index 000000000..48e12fd87
Binary files /dev/null and b/doc/tool-fill-color.png differ
diff --git a/doc/tool-font-face.png b/doc/tool-font-face.png
new file mode 100644
index 000000000..620c37e6f
Binary files /dev/null and b/doc/tool-font-face.png differ
diff --git a/doc/tool-format-text-color.png b/doc/tool-format-text-color.png
new file mode 100644
index 000000000..e7c2059e0
Binary files /dev/null and b/doc/tool-format-text-color.png differ
diff --git a/doc/tool-format-text-strikethrough.png b/doc/tool-format-text-strikethrough.png
new file mode 100644
index 000000000..1a37b8465
Binary files /dev/null and b/doc/tool-format-text-strikethrough.png differ
diff --git a/doc/tool-format-text-underline-squiggle.png b/doc/tool-format-text-underline-squiggle.png
new file mode 100644
index 000000000..23061d0a4
Binary files /dev/null and b/doc/tool-format-text-underline-squiggle.png differ
diff --git a/doc/tool-format-text-underline.png b/doc/tool-format-text-underline.png
new file mode 100644
index 000000000..26f9dc406
Binary files /dev/null and b/doc/tool-format-text-underline.png differ
diff --git a/doc/tool-highlighter-okular.png b/doc/tool-highlighter-okular.png
deleted file mode 100644
index 4a46158fc..000000000
Binary files a/doc/tool-highlighter-okular.png and /dev/null differ
diff --git a/doc/tool-ink-okular.png b/doc/tool-ink-okular.png
deleted file mode 100644
index 16f2b886a..000000000
Binary files a/doc/tool-ink-okular.png and /dev/null differ
diff --git a/doc/tool-line-okular.png b/doc/tool-line-okular.png
deleted file mode 100644
index e4f2d8251..000000000
Binary files a/doc/tool-line-okular.png and /dev/null differ
diff --git a/doc/tool-note-inline-okular.png b/doc/tool-note-inline-okular.png
deleted file mode 100644
index 235d0a446..000000000
Binary files a/doc/tool-note-inline-okular.png and /dev/null differ
diff --git a/doc/tool-note-okular.png b/doc/tool-note-okular.png
deleted file mode 100644
index b0dd4635c..000000000
Binary files a/doc/tool-note-okular.png and /dev/null differ
diff --git a/doc/tool-note.png b/doc/tool-note.png
new file mode 100644
index 000000000..d7d5849b4
Binary files /dev/null and b/doc/tool-note.png differ
diff --git a/doc/tool-pin.png b/doc/tool-pin.png
new file mode 100644
index 000000000..8156e2161
Binary files /dev/null and b/doc/tool-pin.png differ
diff --git a/doc/tool-polygon-okular.png b/doc/tool-polygon-okular.png
deleted file mode 100644
index 9df96ca12..000000000
Binary files a/doc/tool-polygon-okular.png and /dev/null differ
diff --git a/doc/tool-settings-configure.png b/doc/tool-settings-configure.png
new file mode 100644
index 000000000..c19a5a591
Binary files /dev/null and b/doc/tool-settings-configure.png differ
diff --git a/doc/tool-stamp-okular.png b/doc/tool-stamp-okular.png
deleted file mode 100644
index cb0b2de59..000000000
Binary files a/doc/tool-stamp-okular.png and /dev/null differ
diff --git a/doc/tool-tag.png b/doc/tool-tag.png
new file mode 100644
index 000000000..61df27df1
Binary files /dev/null and b/doc/tool-tag.png differ
diff --git a/doc/tool-tool-text.png b/doc/tool-tool-text.png
new file mode 100644
index 000000000..bd15b20a0
Binary files /dev/null and b/doc/tool-tool-text.png differ
diff --git a/doc/tool-typewriter-okular.png b/doc/tool-typewriter-okular.png
deleted file mode 100644
index 4f4465a1c..000000000
Binary files a/doc/tool-typewriter-okular.png and /dev/null differ
diff --git a/doc/tool-underline-okular.png b/doc/tool-underline-okular.png
deleted file mode 100644
index a14282d1f..000000000
Binary files a/doc/tool-underline-okular.png and /dev/null differ
diff --git a/doc/tool-window-pin.png b/doc/tool-window-pin.png
new file mode 100644
index 000000000..a26376e9b
Binary files /dev/null and b/doc/tool-window-pin.png differ
More information about the kde-doc-english
mailing list