[graphics/spectacle] doc: Update manual
Yuri Chornoivan
null at kde.org
Sun Apr 11 11:44:52 BST 2021
Git commit 01b471c3e925398aeb95ef299ecf6ff34a97828d by Yuri Chornoivan.
Committed on 11/04/2021 at 10:44.
Pushed by yurchor into branch 'master'.
Update manual
A +- -- doc/Annotate.png
M +- -- doc/ApplicationPreferences.png
M +- -- doc/MainWindow.png
M +- -- doc/SaveOptions.png
M +39 -26 doc/index.docbook
M +6 -20 doc/man-spectacle.1.docbook
https://invent.kde.org/graphics/spectacle/commit/01b471c3e925398aeb95ef299ecf6ff34a97828d
diff --git a/doc/Annotate.png b/doc/Annotate.png
new file mode 100644
index 0000000..414af2a
Binary files /dev/null and b/doc/Annotate.png differ
diff --git a/doc/ApplicationPreferences.png b/doc/ApplicationPreferences.png
index fd199e8..6e5e5b2 100644
Binary files a/doc/ApplicationPreferences.png and b/doc/ApplicationPreferences.png differ
diff --git a/doc/MainWindow.png b/doc/MainWindow.png
index a0aca72..afefb27 100644
Binary files a/doc/MainWindow.png and b/doc/MainWindow.png differ
diff --git a/doc/SaveOptions.png b/doc/SaveOptions.png
index 1066572..d6e2b03 100644
Binary files a/doc/SaveOptions.png and b/doc/SaveOptions.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index b4b394c..726e58c 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -29,11 +29,11 @@
<legalnotice>&FDLNotice;</legalnotice>
- <date>2019-12-28</date>
- <releaseinfo>Applications 20.04</releaseinfo>
+ <date>2021-04-11</date>
+ <releaseinfo>Applications 21.08</releaseinfo>
<abstract>
- <para>&spectacle; is a simple application for capturing desktop screenshots. It can capture images of the entire desktop, a single monitor, the currently active window, the window currently under the mouse, or a rectangular region of the screen. The images can then be printed, sent to other applications for manipulation, or quickly be saved as-is.</para>
+ <para>&spectacle; is an application for capturing and editing desktop screenshots. It can capture images of the entire desktop, a single monitor, the currently active window, the window currently under the mouse, or a rectangular region of the screen. The images can then be annotated, printed, sent to other applications for manipulation, or quickly be saved as-is.</para>
</abstract>
<keywordset>
@@ -49,7 +49,7 @@
<chapter id="introduction">
<title>Introduction</title>
- <para>&spectacle; is a simple application for capturing desktop screenshots. It can capture images of the entire desktop, a single monitor, the currently active window, the window currently under the mouse, or a rectangular region of the screen. The images can then be printed, sent to other applications for manipulation, or quickly be saved as-is.</para>
+ <para>&spectacle; is an application for capturing and editing desktop screenshots. It can capture images of the entire desktop, a single monitor, the currently active window, the window currently under the mouse, or a rectangular region of the screen. The images can then be annotated, printed, sent to other applications for manipulation, or quickly be saved as-is.</para>
<para>Please report any problems or feature requests to the <ulink url="https://bugs.kde.org/">&kde; Bug Tracking System</ulink>.</para>
</chapter>
@@ -140,14 +140,6 @@
<listitem>
<para>The <guilabel>Current Screen</guilabel> option takes a screenshot of the output that currently contains the mouse pointer.</para>
</listitem>
- <listitem>
- <para>The <guilabel>Active Window</guilabel> option takes a screenshot of the window that currently has focus. It is advisable to use a delay with this mode, to give you time to select and activate a window before the screenshot is taken.</para>
- </listitem>
- <listitem>
- <para>The <guilabel>Window Under Cursor</guilabel> option takes a screenshot of the window that is under the mouse cursor. If the cursor is on top of a popup menu, &spectacle; tries to take a screenshot of the menu as well as its parent window.</para>
-
- <para>While this works most of the time, in certain cases it may fail to obtain information about the parent window. In this case, &spectacle; falls back to old way of capturing the image automatically, and captures an image of only the popup menu. You can also force the old way of capturing the image by checking the <guilabel>Capture the current pop-up only</guilabel> checkbox under <guilabel>Options</guilabel></para>
- </listitem>
<listitem>
<para>The <guilabel>Rectangular Region</guilabel> option allows you to select a rectangular region of your desktop with your mouse. This region may be spread across different outputs.</para>
@@ -156,6 +148,14 @@
<para>You can use the arrow keys to move and adjust the rectangle. Pressing the arrow keys will move the rectangle. Holding the &Shift; key while pressing the arrow keys will move the rectangle slowly, for fine-tuning your selection. Holding the &Alt; key while pressing the arrow keys will adjust the size of the rectangle.</para>
</listitem>
+ <listitem>
+ <para>The <guilabel>Active Window</guilabel> option takes a screenshot of the window that currently has focus. It is advisable to use a delay with this mode, to give you time to select and activate a window before the screenshot is taken.</para>
+ </listitem>
+ <listitem>
+ <para>The <guilabel>Window Under Cursor</guilabel> option takes a screenshot of the window that is under the mouse cursor. If the cursor is on top of a popup menu, &spectacle; tries to take a screenshot of the menu as well as its parent window.</para>
+
+ <para>While this works most of the time, in certain cases it may fail to obtain information about the parent window. In this case, &spectacle; falls back to old way of capturing the image automatically, and captures an image of only the popup menu. You can also force the old way of capturing the image by checking the <guilabel>Capture the current pop-up only</guilabel> checkbox under <guilabel>Options</guilabel></para>
+ </listitem>
</itemizedlist>
<para>The <guilabel>Delay</guilabel> spin-box allows you to set the delay between pressing the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button and taking the screenshot. This delay can be set in increments of 1 seconds using the spinbox buttons or the keyboard.</para>
@@ -183,7 +183,7 @@
<para>The <guilabel>Capture the current pop-up only</guilabel> option is only enabled when the <guilabel>Window Under Cursor</guilabel> mode is selected in the <guilabel>Area</guilabel> combo-box. Checking this option captures only the popup menu under the cursor, without its parent window.</para>
</listitem>
<listitem>
- <para>The <guilabel>Quit after Save or Copy</guilabel> option will quit &spectacle; after any saving or copying operations. Note that a copied screenshot will only be retained if you are running a clipboard manager that accepts images. KDE Klipper can be configured in this manner by right-clicking on its icon, selecting <guilabel>Configure Clipboard...</guilabel>, and unchecking <guilabel>Ignore images</guilabel>.</para>
+ <para>The <guilabel>Quit after manual Save or Copy</guilabel> option will quit &spectacle; after any saving or copying operations. Note that a copied screenshot will only be retained if you are running a clipboard manager that accepts images. KDE Klipper can be configured in this manner by right-clicking on its icon, selecting <guilabel>Configure Clipboard...</guilabel>, and unchecking <guilabel>Ignore images</guilabel>.</para>
</listitem>
</itemizedlist>
</sect2>
@@ -211,6 +211,26 @@
<para>Gives you access to &spectacle;'s Configure window where you can change the capture settings and default save location and filename.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><guibutton>Annotate</guibutton></term>
+ <listitem>
+ <para>Opens an annotation editor window that offers various annotating tools:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="Annotate.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Annotation editor</phrase>
+ </textobject>
+ </mediaobject>
+ <para>
+ Give a try to the annotating tools. You might find everything that is needed to explain your screenshots there: arrows, pen, markers, text boxes, numbers, even smileys. It is possible to change the tool parameters and add effects (shadow, grayscale, and border).
+ </para>
+ <para>
+ When you think that annotating is finished press the <guibutton>Annotation done</guibutton> button.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><guibutton>Tools</guibutton></term>
<listitem>
@@ -266,15 +286,15 @@
</mediaobject>
<variablelist>
<varlistentry>
- <term><guilabel>Press screenshot key to</guilabel></term>
+ <term><guilabel>After taking a screenshot</guilabel></term>
<listitem>
- <para>When a shortcut to make screenshot is pressed and &spectacle; is already running it is possible to configure the behavior of the screenshoting system. You can choose between taking a new screenshot, opening of a new &spectacle; window, and returning focus to the existing &spectacle; window.</para>
+ <para>Allows copying image to clipboard or autosave the image to the default location. The default location can be configured using the <link linkend="save-page">Save</link> configuration page. It is possible to <guilabel>Copy file location to clipboard after saving</guilabel>. You can then paste it anywhere that accepts text input. Note that you must be running a clipboard manager in order to keep the path in the clipboard after &spectacle; quits.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><guilabel>After taking a screenshot</guilabel></term>
+ <term><guilabel>Press screenshot key to</guilabel></term>
<listitem>
- <para>Allows copying image to clipboard or autosave the image to the default location. The default location can be configured using the <link linkend="save-page">Save</link> configuration page.</para>
+ <para>When a shortcut to make screenshot is pressed and &spectacle; is already running it is possible to configure the behavior of the screenshoting system. You can choose between taking a new screenshot, opening of a new &spectacle; window, and returning focus to the existing &spectacle; window.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -323,14 +343,7 @@
<varlistentry>
<term><guilabel>Save Location</guilabel></term>
<listitem>
- <para>In the <guilabel>Location</guilabel> text box set the folder where you'd like to save your screenshots when you press <guibutton>Save</guibutton>.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Copy file location to clipboard after saving</guilabel></term>
- <listitem>
- <para>When a screenshot is saved, copy the location at which the file was saved to the clipboard. You can then paste it anywhere that accepts
- text input. Note that you must be running a clipboard manager in order to keep the path in the clipboard after &spectacle; quits.</para>
+ <para>In the location text box set the folder where you'd like to save your screenshots when you press <guibutton>Save</guibutton>.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -358,7 +371,7 @@
</itemizedlist>
<para>You can click on placeholders in the reference list below to insert them into the <guilabel>Filename</guilabel> line.</para>
<para>If a file with this name already exists, a serial number will be appended to the filename. For example, if the filename is <filename>Screenshot</filename>, and <filename>Screenshot.png</filename> already exists, the image will be saved as <filename>Screenshot-1.png</filename>.</para>
- <para>Typing an extension into the filename will automatically set the image format correctly and remove the extension from the filename field.</para>
+ <para>Use the drop-down box next to the text field to select the default image format for screenshots. See <ulink url="https://en.wikipedia.org/wiki/Image_file_formats">Wikipedia page</ulink> for the details on the image formats that are used in &spectacle;.</para>
</listitem>
</varlistentry>
</variablelist>
diff --git a/doc/man-spectacle.1.docbook b/doc/man-spectacle.1.docbook
index a97b06f..ca9f282 100644
--- a/doc/man-spectacle.1.docbook
+++ b/doc/man-spectacle.1.docbook
@@ -9,8 +9,8 @@
<author><firstname>Yuri</firstname><surname>Chornoivan</surname>
<contrib>Spectacle man page.</contrib>
<email>yurchor at ukr.net</email></author>
-<date>2020-09-15</date>
-<releaseinfo>Spectacle 20.12</releaseinfo>
+<date>2021-04-11</date>
+<releaseinfo>Spectacle 21.08</releaseinfo>
<productname>KDE Applications</productname>
</refentryinfo>
@@ -146,30 +146,16 @@
</varlistentry>
<varlistentry>
-<term><option>--include-pointer</option></term>
+<term><option>-i, --pointer</option></term>
<listitem>
-<para>Include pointer in the screenshot.</para>
+<para>In background mode, include pointer in the screenshot.</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><option>--include-decorations</option></term>
+<term><option>-e, --no-decoration</option></term>
<listitem>
-<para>Include window decorations in the screenshot.</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--no-include-pointer</option></term>
-<listitem>
-<para>Do not include pointer in the screenshot.</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--no-include-decorations</option></term>
-<listitem>
-<para>Do not include window decorations in the screenshot.</para>
+<para>In background mode, do not include window decorations in the screenshot.</para>
</listitem>
</varlistentry>
</variablelist>
More information about the kde-doc-english
mailing list