@ -182,7 +182,7 @@ Context menu actions like Rename Bookmarks etc.)
</listitem>
</listitem>
<listitem>
<listitem>
<para>
<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.
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>
</para>
</listitem>
</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>
<para>Text annotations like <guilabel>Yellow Highlighter</guilabel> and <guilabel>Black Underlining</guilabel>
for files with text like ⪚ &PDF;.</para>
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>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>Annotations are not only limited to &PDF; files, they can be used for any format &okular; supports.</para>
<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.
&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">
<sect2 id="annotations-add">
<title>Adding annotations</title>
<title>Adding annotations</title>
<para>
<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
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
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.
its buttons or use keyboard shortcuts (keys from <keycap>1</keycap> to <keycap>9</keycap>) to start constructing that annotation.
</para>
</para>
@ -551,25 +551,133 @@ Context menu actions like Rename Bookmarks etc.)
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>
<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>
<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.
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.
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.
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.
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>
</para>
</entry>
</entry>
</row>
</row>
@ -578,7 +686,7 @@ Context menu actions like Rename Bookmarks etc.)
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.
To highlight text in the document with some given background color.
To mark with an arrow.
</para>
</para>
<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>
<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>
</para>
</entry>
</entry>
</row>
</row>
@ -659,14 +794,14 @@ Context menu actions like Rename Bookmarks etc.)
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.
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.
@ -728,7 +917,7 @@ Context menu actions like Rename Bookmarks etc.)
To mark the text or image with some predefined shape.
To mark the text or image with some predefined shape.
</para>
</para>
<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>
<para>
<para>
A single click just places a square stamp (useful for icons).
A single click just places a square stamp (useful for icons).
@ -744,30 +933,81 @@ Context menu actions like Rename Bookmarks etc.)
</warning>
</warning>
</entry>
</entry>
</row>
</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.
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>
</para>
</entry>
</entry>
</row>
</row>
@ -776,67 +1016,160 @@ Context menu actions like Rename Bookmarks etc.)
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>
</para>
</entry>
</row>
<row>
<entry>
<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.
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).
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>
</para>
</entry>
<entry>
<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.
Click on the tool button to open the general configuration dialog for your annotation.
</para>
</para>
</entry>
</entry>
</row>
</row>
</tbody>
</tbody>
</tgroup>
</informaltable>
<para>
There are three additional utility buttons on the default annotating toolbar.
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>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>
<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 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>
@ -846,12 +1179,6 @@ Context menu actions like Rename Bookmarks etc.)
permanently by double clicking on the tool button.
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.
Press the <keycap>Esc</keycap> key or click the tool button again to leave the permanent mode.
</para>
</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>
<note>
<para>
<para>
Activating the annotating toolbar will make you switch to the Browse Mode.
Activating the annotating toolbar will make you switch to the Browse Mode.
@ -1856,11 +2183,11 @@ Context menu actions like Rename Bookmarks etc.)
<menuchoice>
<menuchoice>
<shortcut><keycap>F6</keycap></shortcut>
<shortcut><keycap>F6</keycap></shortcut>
<guimenu>Tools</guimenu>
<guimenu>Tools</guimenu>
<guimenuitem>Review</guimenuitem>
<guimenuitem>Annotations</guimenuitem>
</menuchoice>
</menuchoice>
</term>
</term>
<listitem>
<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
annotations on the document you are reading. For more information, please see the
section about <link linkend="annotations">Annotations</link>.</para>
section about <link linkend="annotations">Annotations</link>.</para>
Yuri Chornoivan
6 years ago
