[spectacle] doc: Convert tabs to spaces in docbook
Henrik Fehlauer
null at kde.org
Wed Mar 14 00:15:00 UTC 2018
Git commit 90c4a03981e3822786cfad34bc28be76dda3ece1 by Henrik Fehlauer.
Committed on 14/03/2018 at 00:14.
Pushed by rkflx into branch 'master'.
Convert tabs to spaces in docbook
Summary:
Tabs in the docbook often cause contributor's editors to introduce
accidental whitespace changes. It was agreed to change to spaces like in
most other files.
This also corrects a problem where there were tabs inside the content.
Thanks to @gregormi for the initial version of the patch.
Test Plan: `checkXML5 index.docbook`
Reviewers: #spectacle, #documentation, ngraham, gregormi
Reviewed By: #spectacle, ngraham
Subscribers: gregormi, ltoscano, yurchor, rkflx, lueck, ngraham
Differential Revision: https://phabricator.kde.org/D10529
M +318 -318 doc/index.docbook
https://commits.kde.org/spectacle/90c4a03981e3822786cfad34bc28be76dda3ece1
diff --git a/doc/index.docbook b/doc/index.docbook
index 0ada2ed..32bea95 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -8,64 +8,64 @@
]>
<book id="spectacle" lang="&language;">
- <bookinfo>
- <title>The &spectacle; Handbook</title>
+ <bookinfo>
+ <title>The &spectacle; Handbook</title>
- <authorgroup>
- <author>
- &Boudhayan.Gupta;
- &Boudhayan.Gupta.mail;
- </author>
+ <authorgroup>
+ <author>
+ &Boudhayan.Gupta;
+ &Boudhayan.Gupta.mail;
+ </author>
- <othercredit role="developer">
- &Boudhayan.Gupta;
- &Boudhayan.Gupta.mail;
- </othercredit>
+ <othercredit role="developer">
+ &Boudhayan.Gupta;
+ &Boudhayan.Gupta.mail;
+ </othercredit>
- <!-- TRANS:ROLES_OF_TRANSLATORS -->
- </authorgroup>
+ <!-- TRANS:ROLES_OF_TRANSLATORS -->
+ </authorgroup>
- <copyright><year>1997-2000</year><holder>&Richard.J.Moore;</holder></copyright>
- <copyright><year>2000</year><holder>&Matthias.Ettrich;</holder></copyright>
- <copyright><year>2015</year><holder>&Boudhayan.Gupta;</holder></copyright>
+ <copyright><year>1997-2000</year><holder>&Richard.J.Moore;</holder></copyright>
+ <copyright><year>2000</year><holder>&Matthias.Ettrich;</holder></copyright>
+ <copyright><year>2015</year><holder>&Boudhayan.Gupta;</holder></copyright>
- <legalnotice>&FDLNotice;</legalnotice>
+ <legalnotice>&FDLNotice;</legalnotice>
- <date>2017-11-06</date>
- <releaseinfo>Applications 17.12</releaseinfo>
+ <date>2017-11-06</date>
+ <releaseinfo>Applications 17.12</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>
- </abstract>
+ <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>
+ </abstract>
- <keywordset>
- <keyword>KDE</keyword>
- <keyword>spectacle</keyword>
- <keyword>kdegraphics</keyword>
- <keyword>screenshot</keyword>
- <keyword>screen capture</keyword>
- <keyword>screen grab</keyword>
- </keywordset>
- </bookinfo>
+ <keywordset>
+ <keyword>KDE</keyword>
+ <keyword>spectacle</keyword>
+ <keyword>kdegraphics</keyword>
+ <keyword>screenshot</keyword>
+ <keyword>screen capture</keyword>
+ <keyword>screen grab</keyword>
+ </keywordset>
+ </bookinfo>
- <chapter id="introduction">
- <title>Introduction</title>
+ <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 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>Please report any problems or feature requests to the <ulink url="http://bugs.kde.org/">&kde; Bug Tracking System</ulink>.</para>
- </chapter>
+ <para>Please report any problems or feature requests to the <ulink url="http://bugs.kde.org/">&kde; Bug Tracking System</ulink>.</para>
+ </chapter>
- <chapter id="starting">
- <title>Starting &spectacle;</title>
+ <chapter id="starting">
+ <title>Starting &spectacle;</title>
- <para>&spectacle; can be started in a variety of ways, as described below:</para>
+ <para>&spectacle; can be started in a variety of ways, as described below:</para>
- <itemizedlist>
- <listitem>
- <para>In the application launcher menu, &spectacle; can be found at <menuchoice><guisubmenu>Applications</guisubmenu><guisubmenu>Utilities</guisubmenu><guimenuitem>Screenshot Capture Utility &spectacle;</guimenuitem></menuchoice></para>
- </listitem>
- <listitem>
+ <itemizedlist>
+ <listitem>
+ <para>In the application launcher menu, &spectacle; can be found at <menuchoice><guisubmenu>Applications</guisubmenu><guisubmenu>Utilities</guisubmenu><guimenuitem>Screenshot Capture Utility &spectacle;</guimenuitem></menuchoice></para>
+ </listitem>
+ <listitem>
<para>Pressing the <keysym>Print</keysym> button on the keyboard will immediately launch &spectacle;. Additionally, three more keyboard shortcuts are available to take screenshots and save them in your default save folder without showing the &GUI;:</para>
<itemizedlist>
<listitem><para><keycombo action="simul"><keycap>Meta</keycap><keysym>Print</keysym></keycombo> will take a screenshot of the active window</para></listitem>
@@ -73,140 +73,140 @@
<listitem><para><keycombo action="simul"><keycap>Meta</keycap>&Shift;<keysym>Print</keysym></keycombo> will take a rectangular region screenshot</para></listitem>
</itemizedlist>
<para>You can configure the default save location and filename by starting &spectacle; normally and clicking on the <guibutton>Configure...</guibutton> button, then navigating to the Save section.</para>
- </listitem>
- <listitem>
- <para>The mini command line &krunner; (invoked with <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>) may also be used to start &spectacle;.</para>
- </listitem>
- <listitem>
- <para> &spectacle; can be started from the command-line. &spectacle; has an extensive set of command-line options, including a background mode which can be used to script the capture of screenshots without showing the &GUI; or requiring user interaction.</para>
-
- <para>To start &spectacle; from the command prompt, type in:</para>
- <screen width="40">
- <prompt>%</prompt> <command>spectacle &</command>
- </screen>
-
- <para>To view the full list of command-line options and their explanation, type in:</para>
- <screen width="40">
- <prompt>%</prompt> <command>spectacle --help</command>
- </screen>
- </listitem>
- </itemizedlist>
- </chapter>
-
- <chapter id="using">
- <title>Using &spectacle;</title>
-
- <para>Once &spectacle; starts, you will see a window like the following:
- <mediaobject>
- <imageobject>
- <imagedata fileref="MainWindow.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>&spectacle; Main Window</phrase>
- </textobject>
- </mediaobject>
- </para>
-
- <para>&spectacle; grabs an image of your entire desktop immediately after it is started, but before it displays itself on screen. This allows you to quickly create full-desktop screenshot images.</para>
-
- <para>The snapshot taken by &spectacle; is displayed in the preview window, which is located on the left-hand side of the &spectacle; application window.</para>
-
- <para>The image can be saved to a location of your choice by clicking on the <guibutton>Save As</guibutton> button or typing <keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo>. This opens the standard save dialog, where you can choose the filename, the folder location, and the format that your screenshot will be saved in. You may edit the filename to anything you wish, including the name of a previously saved screenshot.</para>
-
- <para>To save a screenshot to the default location, click on the arrow portion of the <guibutton>Save As...</guibutton> button and press the <guimenuitem>Save </guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>) button. The new save mode will be remembered for next time. The default save location and filename can be configured, as described later.</para>
-
- <para>To quickly save the image and quit &spectacle;, click on the checkbox beside <guilabel>Quit after Save or Copy</guilabel>, then click the arrow portion of the <guibutton>Save As...</guibutton> button and press the <guimenuitem>Save</guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>) item. This saves the image as a PNG file in your default Pictures folder, and exits the application immediately. As above, this new save mode will be remembered.</para>
-
- <sect1 id="taking-screenshot">
- <title>Taking A Screenshot</title>
-
- <para>When you open spectacle, it immediately takes a screenshot of the whole screen as a convenience and shows a preview of it in the main window. You can save this screenshot using the buttons on the bottom of the window, or take a new one using the controls to the right of the preview.</para>
-
- <para>To discard the current screenshot and take another screenshot, press the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button.</para>
-
- <para>You may configure certain options on the right hand side of the application window before taking a new screenshot. These options allow you to select the area of the screen that is to be captured, set a delay before capturing the image, and configure whether the mouse cursor and/or the window decorations should be captured along with the screenshot.</para>
-
- <sect2>
- <title>Capture Mode</title>
-
- <para>The capture mode settings allow you to set the area of the screen that should be captured, and whether there should be a delay between pressing the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button and taking the screenshot. You may also enable the <guilabel>On Click</guilabel> checkbox, which disables the delay function and only takes the screenshot after you click anywhere on the screen after clicking the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button.</para>
-
- <para>The <guilabel>Area</guilabel> combo-box allows you to set the area of the screen that should be captured. There are five options to select from, as described below.</para>
-
- <itemizedlist>
- <listitem>
- <para>The <guilabel>Full Screen (All Monitors)</guilabel> option takes a screenshot of your entire desktop, spread across all the outputs, including all the monitors, projectors etc.</para>
- </listitem>
- <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>
-
- <para>This mode does not immediately take a screenshot but allows you to draw a rectangle on your screen, which can be moved and resized as needed. Once the desired selection rectangle has been drawn, double-clicking anywhere on the screen, or pressing the &Enter; button on the keyboard will capture the screenshot.</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>
-
- <para>Enabling the <guilabel>On Click</guilabel> checkbox overrides the delay. When this checkbox is enabled, pressing the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button hides the &spectacle; window and changes the mouse cursor to a crosshair. The screenshot is captured when the mouse is left-clicked, or aborted if any other mouse buttons are clicked. Note that you cannot interact with the desktop using the mouse while the cursor is a crosshair, but you can use the keyboard.</para>
- </sect2>
-
- <sect2>
- <title>Options</title>
-
- <para>The Options settings allow you to select whether the mouse cursor should be included in the screenshots, and whether to capture window decorations along with the image of a single application window. In <guilabel>Window Under Cursor</guilabel> mode, it also allows you to select if &spectacle; shall only capture the image of the current popup menu under the cursor, or also include the parent window. Finally, <guilabel>Quit after Save or Copy</guilabel> will quit Spectacle after any save or copy operations.</para>
-
- <itemizedlist>
- <listitem>
- <para>Enabling the <guilabel>Include mouse pointer</guilabel> checkbox includes an image of the mouse pointer in the screenshot.</para>
- </listitem>
- <listitem>
- <para>The <guilabel>Include window titlebar and borders</guilabel> option is only enabled when either the <guilabel>Active Window</guilabel> mode or the <guilabel>Window Under Cursor</guilabel> mode is selected in the <guilabel>Area</guilabel> combo-box. Checking this option includes the window borders and decoration in the screenshot, while unchecking it gives an image of only the window contents.</para>
- </listitem>
- <listitem>
- <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>
- </listitem>
- </itemizedlist>
- </sect2>
- </sect1>
- </chapter>
-
- <chapter id="additional-functionality">
- <title>Additional Functionality</title>
-
- <sect1>
- <title>Buttons</title>
-
- <para>There are some buttons located at the bottom of the &spectacle; window. Their functions are described below:</para>
-
- <variablelist>
- <varlistentry>
- <term><guibutton>Help</guibutton></term>
- <listitem>
- <para>Gives you the common menu items described in the <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guibutton>Configure...</guibutton></term>
- <listitem>
- <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>Tools</guibutton></term>
- <listitem>
+ </listitem>
+ <listitem>
+ <para>The mini command line &krunner; (invoked with <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>) may also be used to start &spectacle;.</para>
+ </listitem>
+ <listitem>
+ <para> &spectacle; can be started from the command-line. &spectacle; has an extensive set of command-line options, including a background mode which can be used to script the capture of screenshots without showing the &GUI; or requiring user interaction.</para>
+
+ <para>To start &spectacle; from the command prompt, type in:</para>
+ <screen width="40">
+ <prompt>%</prompt> <command>spectacle &</command>
+ </screen>
+
+ <para>To view the full list of command-line options and their explanation, type in:</para>
+ <screen width="40">
+ <prompt>%</prompt> <command>spectacle --help</command>
+ </screen>
+ </listitem>
+ </itemizedlist>
+ </chapter>
+
+ <chapter id="using">
+ <title>Using &spectacle;</title>
+
+ <para>Once &spectacle; starts, you will see a window like the following:
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="MainWindow.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>&spectacle; Main Window</phrase>
+ </textobject>
+ </mediaobject>
+ </para>
+
+ <para>&spectacle; grabs an image of your entire desktop immediately after it is started, but before it displays itself on screen. This allows you to quickly create full-desktop screenshot images.</para>
+
+ <para>The snapshot taken by &spectacle; is displayed in the preview window, which is located on the left-hand side of the &spectacle; application window.</para>
+
+ <para>The image can be saved to a location of your choice by clicking on the <guibutton>Save As</guibutton> button or typing <keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo>. This opens the standard save dialog, where you can choose the filename, the folder location, and the format that your screenshot will be saved in. You may edit the filename to anything you wish, including the name of a previously saved screenshot.</para>
+
+ <para>To save a screenshot to the default location, click on the arrow portion of the <guibutton>Save As...</guibutton> button and press the <guimenuitem>Save </guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>) button. The new save mode will be remembered for next time. The default save location and filename can be configured, as described later.</para>
+
+ <para>To quickly save the image and quit &spectacle;, click on the checkbox beside <guilabel>Quit after Save or Copy</guilabel>, then click the arrow portion of the <guibutton>Save As...</guibutton> button and press the <guimenuitem>Save</guimenuitem> (<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>) item. This saves the image as a PNG file in your default Pictures folder, and exits the application immediately. As above, this new save mode will be remembered.</para>
+
+ <sect1 id="taking-screenshot">
+ <title>Taking A Screenshot</title>
+
+ <para>When you open spectacle, it immediately takes a screenshot of the whole screen as a convenience and shows a preview of it in the main window. You can save this screenshot using the buttons on the bottom of the window, or take a new one using the controls to the right of the preview.</para>
+
+ <para>To discard the current screenshot and take another screenshot, press the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button.</para>
+
+ <para>You may configure certain options on the right hand side of the application window before taking a new screenshot. These options allow you to select the area of the screen that is to be captured, set a delay before capturing the image, and configure whether the mouse cursor and/or the window decorations should be captured along with the screenshot.</para>
+
+ <sect2>
+ <title>Capture Mode</title>
+
+ <para>The capture mode settings allow you to set the area of the screen that should be captured, and whether there should be a delay between pressing the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button and taking the screenshot. You may also enable the <guilabel>On Click</guilabel> checkbox, which disables the delay function and only takes the screenshot after you click anywhere on the screen after clicking the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button.</para>
+
+ <para>The <guilabel>Area</guilabel> combo-box allows you to set the area of the screen that should be captured. There are five options to select from, as described below.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <guilabel>Full Screen (All Monitors)</guilabel> option takes a screenshot of your entire desktop, spread across all the outputs, including all the monitors, projectors etc.</para>
+ </listitem>
+ <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>
+
+ <para>This mode does not immediately take a screenshot but allows you to draw a rectangle on your screen, which can be moved and resized as needed. Once the desired selection rectangle has been drawn, double-clicking anywhere on the screen, or pressing the &Enter; button on the keyboard will capture the screenshot.</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>
+
+ <para>Enabling the <guilabel>On Click</guilabel> checkbox overrides the delay. When this checkbox is enabled, pressing the <guibutton>Take a New Screenshot</guibutton> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button hides the &spectacle; window and changes the mouse cursor to a crosshair. The screenshot is captured when the mouse is left-clicked, or aborted if any other mouse buttons are clicked. Note that you cannot interact with the desktop using the mouse while the cursor is a crosshair, but you can use the keyboard.</para>
+ </sect2>
+
+ <sect2>
+ <title>Options</title>
+
+ <para>The Options settings allow you to select whether the mouse cursor should be included in the screenshots, and whether to capture window decorations along with the image of a single application window. In <guilabel>Window Under Cursor</guilabel> mode, it also allows you to select if &spectacle; shall only capture the image of the current popup menu under the cursor, or also include the parent window. Finally, <guilabel>Quit after Save or Copy</guilabel> will quit Spectacle after any save or copy operations.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Enabling the <guilabel>Include mouse pointer</guilabel> checkbox includes an image of the mouse pointer in the screenshot.</para>
+ </listitem>
+ <listitem>
+ <para>The <guilabel>Include window titlebar and borders</guilabel> option is only enabled when either the <guilabel>Active Window</guilabel> mode or the <guilabel>Window Under Cursor</guilabel> mode is selected in the <guilabel>Area</guilabel> combo-box. Checking this option includes the window borders and decoration in the screenshot, while unchecking it gives an image of only the window contents.</para>
+ </listitem>
+ <listitem>
+ <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>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+ </sect1>
+ </chapter>
+
+ <chapter id="additional-functionality">
+ <title>Additional Functionality</title>
+
+ <sect1>
+ <title>Buttons</title>
+
+ <para>There are some buttons located at the bottom of the &spectacle; window. Their functions are described below:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><guibutton>Help</guibutton></term>
+ <listitem>
+ <para>Gives you the common menu items described in the <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guibutton>Configure...</guibutton></term>
+ <listitem>
+ <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>Tools</guibutton></term>
+ <listitem>
<para>Opens a drop-down menu which offers various tools:</para>
<itemizedlist>
<listitem>
@@ -216,148 +216,148 @@
<para>a range of external programs for Screen Recording</para>
</listitem>
</itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guibutton>Export</guibutton></term>
- <listitem>
- <para>Opens a drop-down menu that will allow you to directly open the screenshot with all programs that are associated with the PNG (Portable Network Graphics) &MIME; type. Depending on what programs are installed, you will be able to open and edit the snapshot in your graphics applications or viewers.</para>
-
- <para>Furthermore, if you have the <application>KIPI Plugins</application> installed, you will be able to email your screenshots and export them directly to some social networks and websites.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guibutton>Copy To Clipboard</guibutton></term>
- <listitem>
- <para>Copies the current screenshot to the clipboard. You can also use the <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> keyboard shortcut for this.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guibutton>Save As</guibutton></term>
- <listitem>
- <para>Saves the screenshot as a PNG image in your default Pictures folder and immediately exits the application.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect1>
-
- <sect1>
- <title>Configure</title>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guibutton>Export</guibutton></term>
+ <listitem>
+ <para>Opens a drop-down menu that will allow you to directly open the screenshot with all programs that are associated with the PNG (Portable Network Graphics) &MIME; type. Depending on what programs are installed, you will be able to open and edit the snapshot in your graphics applications or viewers.</para>
+
+ <para>Furthermore, if you have the <application>KIPI Plugins</application> installed, you will be able to email your screenshots and export them directly to some social networks and websites.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guibutton>Copy To Clipboard</guibutton></term>
+ <listitem>
+ <para>Copies the current screenshot to the clipboard. You can also use the <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> keyboard shortcut for this.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guibutton>Save As</guibutton></term>
+ <listitem>
+ <para>Saves the screenshot as a PNG image in your default Pictures folder and immediately exits the application.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect1>
+
+ <sect1>
+ <title>Configure</title>
<para>Use the <guibutton>Configure...</guibutton> button to open the configuration dialog.</para>
- <sect2>
- <title>General</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="ApplicationPreferences.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>General</phrase>
- </textobject>
- </mediaobject>
- <variablelist>
- <varlistentry>
- <term><guilabel>Copy save location to clipboard</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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Use light background</guilabel></term>
- <listitem>
- <para>Use a light background color to mask the cropped-out area in the rectangular region selector. This may make dark cursors easier to see.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Remember selected area</guilabel></term>
- <listitem>
- <para>By default, &spectacle; does not show an initial selection when you take a screenshot of a rectangular region. Enable this option to remember
- the last selected region of the screen, and set it as the initial selection when you use the rectangular region selector the next time.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- <sect2>
- <title>Save</title>
- <para>When you use the <guilabel>Save</guilabel> function, &spectacle; saves the image with a default filename, in your Pictures folder (which is inside your home folder). The default filename includes the date and time when the image was taken.</para>
-
- <para>The <guilabel>Save</guilabel> page allows you to set the default save location and filename. Clicking this option brings up a dialog box like the following:
- <mediaobject>
- <imageobject>
- <imagedata fileref="SaveOptions.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Save</phrase>
- </textobject>
- </mediaobject>
- </para>
- <variablelist>
- <varlistentry>
- <term><guilabel>Default Save Location</guilabel></term>
- <listitem>
+ <sect2>
+ <title>General</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ApplicationPreferences.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>General</phrase>
+ </textobject>
+ </mediaobject>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Copy save location to clipboard</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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Use light background</guilabel></term>
+ <listitem>
+ <para>Use a light background color to mask the cropped-out area in the rectangular region selector. This may make dark cursors easier to see.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Remember selected area</guilabel></term>
+ <listitem>
+ <para>By default, &spectacle; does not show an initial selection when you take a screenshot of a rectangular region. Enable this option to remember
+ the last selected region of the screen, and set it as the initial selection when you use the rectangular region selector the next time.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+ <sect2>
+ <title>Save</title>
+ <para>When you use the <guilabel>Save</guilabel> function, &spectacle; saves the image with a default filename, in your Pictures folder (which is inside your home folder). The default filename includes the date and time when the image was taken.</para>
+
+ <para>The <guilabel>Save</guilabel> page allows you to set the default save location and filename. Clicking this option brings up a dialog box like the following:
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="SaveOptions.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Save</phrase>
+ </textobject>
+ </mediaobject>
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Default 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>Default Save Filename</guilabel></term>
- <listitem>
- <para>Set a default filename for saved screenshots.</para>
- <para>You can use the following placeholders in the filename, which will be replaced with actual text when the file is saved:</para>
- <itemizedlist>
- <listitem><para><userinput>%Y</userinput>: Year (4 digit)</para></listitem>
- <listitem><para><userinput>%y</userinput>: Year (2 digit)</para></listitem>
- <listitem><para><userinput>%M</userinput>: Month</para></listitem>
- <listitem><para><userinput>%D</userinput>: Day</para></listitem>
- <listitem><para><userinput>%H</userinput>: Hour</para></listitem>
- <listitem><para><userinput>%m</userinput>: Minute</para></listitem>
- <listitem><para><userinput>%S</userinput>: Second</para></listitem>
- <listitem><para><userinput>%T</userinput>: Window title</para></listitem>
- </itemizedlist>
- <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>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- </sect1>
-
- <sect1>
- <title>Drag and Drop</title>
- <para>A captured image can be dragged to another application or document. If the application is able to handle images, a copy of the full image is inserted there.</para>
-
- <para>If you drag a screenshot into a file manager window, a dialog pops up where you can edit the filename and select the image format and the file will be inserted into the actual folder.</para>
-
- <para>If you drag the screenshot to a text box, the path to the temporary saved file is inserted. This is useful for example to upload a screenshot through web forms or to attach screenshots into bug reports on the <ulink url="https://bugs.kde.org/">&kde; bugtracker</ulink>.</para>
-
- <para>This works with all clients that do not pick up the image data, but only look for a &URL; in the dragged mimedata.</para>
- </sect1>
- </chapter>
-
- <chapter id="credits">
- <title>Credits and License</title>
-
- <para>Program copyright © 2015 &Boudhayan.Gupta; &Boudhayan.Gupta.mail;.</para>
-
- <para>Portions of the code are based directly on code from the &ksnapshot; project. Copyright © 1997-2011 The &ksnapshot; Developers. Detailed copyright assignment notices are available in the headers in the source code.</para>
-
- <para>Portions of the code are based directly on code from the &kwin; project. Copyright © 2008, 2013 The &kwin; Developers. Detailed copyright assignment notices are available in the headers in the source code.</para>
-
- <para>Documentation based on the original &ksnapshot; documentation:</para>
-
- <itemizedlist>
- <listitem>
- <para>Copyright © 1997-2000 &Richard.J.Moore; &Richard.J.Moore.mail;</para>
- </listitem>
- <listitem>
- <para>Copyright © 2000 &Matthias.Ettrich; &Matthias.Ettrich.mail;</para>
- </listitem>
- </itemizedlist>
-
- <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
-
- &underFDL;
- &underGPL;
- </chapter>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Default Save Filename</guilabel></term>
+ <listitem>
+ <para>Set a default filename for saved screenshots.</para>
+ <para>You can use the following placeholders in the filename, which will be replaced with actual text when the file is saved:</para>
+ <itemizedlist>
+ <listitem><para><userinput>%Y</userinput>: Year (4 digit)</para></listitem>
+ <listitem><para><userinput>%y</userinput>: Year (2 digit)</para></listitem>
+ <listitem><para><userinput>%M</userinput>: Month</para></listitem>
+ <listitem><para><userinput>%D</userinput>: Day</para></listitem>
+ <listitem><para><userinput>%H</userinput>: Hour</para></listitem>
+ <listitem><para><userinput>%m</userinput>: Minute</para></listitem>
+ <listitem><para><userinput>%S</userinput>: Second</para></listitem>
+ <listitem><para><userinput>%T</userinput>: Window title</para></listitem>
+ </itemizedlist>
+ <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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+ </sect1>
+
+ <sect1>
+ <title>Drag and Drop</title>
+ <para>A captured image can be dragged to another application or document. If the application is able to handle images, a copy of the full image is inserted there.</para>
+
+ <para>If you drag a screenshot into a file manager window, a dialog pops up where you can edit the filename and select the image format and the file will be inserted into the actual folder.</para>
+
+ <para>If you drag the screenshot to a text box, the path to the temporary saved file is inserted. This is useful for example to upload a screenshot through web forms or to attach screenshots into bug reports on the <ulink url="https://bugs.kde.org/">&kde; bugtracker</ulink>.</para>
+
+ <para>This works with all clients that do not pick up the image data, but only look for a &URL; in the dragged mimedata.</para>
+ </sect1>
+ </chapter>
+
+ <chapter id="credits">
+ <title>Credits and License</title>
+
+ <para>Program copyright © 2015 &Boudhayan.Gupta; &Boudhayan.Gupta.mail;.</para>
+
+ <para>Portions of the code are based directly on code from the &ksnapshot; project. Copyright © 1997-2011 The &ksnapshot; Developers. Detailed copyright assignment notices are available in the headers in the source code.</para>
+
+ <para>Portions of the code are based directly on code from the &kwin; project. Copyright © 2008, 2013 The &kwin; Developers. Detailed copyright assignment notices are available in the headers in the source code.</para>
+
+ <para>Documentation based on the original &ksnapshot; documentation:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Copyright © 1997-2000 &Richard.J.Moore; &Richard.J.Moore.mail;</para>
+ </listitem>
+ <listitem>
+ <para>Copyright © 2000 &Matthias.Ettrich; &Matthias.Ettrich.mail;</para>
+ </listitem>
+ </itemizedlist>
+
+ <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+
+ &underFDL;
+ &underGPL;
+ </chapter>
&documentation.index;
</book>
More information about the kde-doc-english
mailing list