Changeset View
Changeset View
Standalone View
Standalone View
doc/index.docbook
1 | <?xml version="1.0" ?> | 1 | <?xml version="1.0" ?> | ||
---|---|---|---|---|---|
2 | <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ | 2 | <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ | ||
3 | <!ENTITY spectacle "<application>Spectacle</application>"> | 3 | <!ENTITY spectacle "<application>Spectacle</application>"> | ||
4 | <!ENTITY % addindex "IGNORE"> | 4 | <!ENTITY % addindex "IGNORE"> | ||
5 | <!ENTITY % English "INCLUDE" > <!-- change language only here --> | 5 | <!ENTITY % English "INCLUDE" > <!-- change language only here --> | ||
6 | <!ENTITY Boudhayan.Gupta "<personname><firstname>Boudhayan</firstname><surname>Gupta</surname></personname>"> | 6 | <!ENTITY Boudhayan.Gupta "<personname><firstname>Boudhayan</firstname><surname>Gupta</surname></personname>"> | ||
7 | <!ENTITY Boudhayan.Gupta.mail "<email>bgupta@kde.org</email>"> | 7 | <!ENTITY Boudhayan.Gupta.mail "<email>bgupta@kde.org</email>"> | ||
lueck: please remove these entities from the header
since 2016-09-17 these entities are already… | |||||
8 | ]> | 8 | ]> | ||
9 | 9 | | |||
10 | <book id="spectacle" lang="&language;"> | 10 | <book id="spectacle" lang="&language;"> | ||
11 | <bookinfo> | 11 | <bookinfo> | ||
12 | <title>The &spectacle; Handbook</title> | 12 | <title>The &spectacle; Handbook</title> | ||
13 | 13 | | |||
14 | <authorgroup> | 14 | <authorgroup> | ||
15 | <author> | 15 | <author> | ||
Show All 10 Lines | |||||
26 | </authorgroup> | 26 | </authorgroup> | ||
27 | 27 | | |||
28 | <copyright><year>1997-2000</year><holder>&Richard.J.Moore;</holder></copyright> | 28 | <copyright><year>1997-2000</year><holder>&Richard.J.Moore;</holder></copyright> | ||
29 | <copyright><year>2000</year><holder>&Matthias.Ettrich;</holder></copyright> | 29 | <copyright><year>2000</year><holder>&Matthias.Ettrich;</holder></copyright> | ||
30 | <copyright><year>2015</year><holder>&Boudhayan.Gupta;</holder></copyright> | 30 | <copyright><year>2015</year><holder>&Boudhayan.Gupta;</holder></copyright> | ||
31 | 31 | | |||
32 | <legalnotice>&FDLNotice;</legalnotice> | 32 | <legalnotice>&FDLNotice;</legalnotice> | ||
33 | 33 | | |||
34 | <date>2017-11-06</date> | 34 | <date>2017-11-06</date> | ||
35 | <releaseinfo>Applications 17.12</releaseinfo> | 35 | <releaseinfo>Applications 17.12</releaseinfo> | ||
lueck: please bump date + releaseinfo, this docbook is for Spectacle 18.04 | |||||
36 | 36 | | |||
37 | <abstract> | 37 | <abstract> | ||
38 | <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> | 38 | <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> | ||
39 | </abstract> | 39 | </abstract> | ||
40 | 40 | | |||
41 | <keywordset> | 41 | <keywordset> | ||
42 | <keyword>KDE</keyword> | 42 | <keyword>KDE</keyword> | ||
43 | <keyword>spectacle</keyword> | 43 | <keyword>spectacle</keyword> | ||
▲ Show 20 Lines • Show All 161 Lines • ▼ Show 20 Line(s) | 201 | <varlistentry> | |||
205 | </listitem> | 205 | </listitem> | ||
206 | </varlistentry> | 206 | </varlistentry> | ||
207 | <varlistentry> | 207 | <varlistentry> | ||
208 | <term><guibutton>Tools</guibutton></term> | 208 | <term><guibutton>Tools</guibutton></term> | ||
209 | <listitem> | 209 | <listitem> | ||
210 | <para>Opens a drop-down menu which offers various tools:</para> | 210 | <para>Opens a drop-down menu which offers various tools:</para> | ||
211 | <itemizedlist> | 211 | <itemizedlist> | ||
212 | <listitem> | 212 | <listitem> | ||
213 | <para>the print dialog</para> | 213 | <para>Open the <guimenuitem>Print</guimenuitem> dialog</para> | ||
214 | </listitem> | 214 | </listitem> | ||
215 | <listitem> | 215 | <listitem> | ||
216 | <para>a range of external programs for Screen Recording</para> | 216 | <para><guimenuitem>Open Screenshots Folder</guimenuitem> which will highlight the last saved screenshot in the default file manager</para> | ||
217 | </listitem> | ||||
218 | <listitem> | ||||
219 | <para>A range of external programs for Screen Recording</para> | ||||
217 | </listitem> | 220 | </listitem> | ||
218 | </itemizedlist> | 221 | </itemizedlist> | ||
219 | </listitem> | 222 | </listitem> | ||
220 | </varlistentry> | 223 | </varlistentry> | ||
221 | <varlistentry> | 224 | <varlistentry> | ||
222 | <term><guibutton>Export</guibutton></term> | 225 | <term><guibutton>Export</guibutton></term> | ||
223 | <listitem> | 226 | <listitem> | ||
224 | <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> | 227 | <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> | ||
225 | 228 | | |||
226 | <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> | 229 | <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> | ||
227 | </listitem> | 230 | </listitem> | ||
228 | </varlistentry> | 231 | </varlistentry> | ||
229 | <varlistentry> | 232 | <varlistentry> | ||
230 | <term><guibutton>Copy To Clipboard</guibutton></term> | 233 | <term><guibutton>Copy To Clipboard</guibutton></term> | ||
231 | <listitem> | 234 | <listitem> | ||
232 | <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> | 235 | <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> | ||
233 | </listitem> | 236 | </listitem> | ||
234 | </varlistentry> | 237 | </varlistentry> | ||
235 | <varlistentry> | 238 | <varlistentry> | ||
236 | <term><guibutton>Save As</guibutton></term> | 239 | <term><guibutton>Save As</guibutton></term> | ||
237 | <listitem> | 240 | <listitem> | ||
238 | <para>Saves the screenshot as a PNG image in your default Pictures folder and immediately exits the application.</para> | 241 | <para>Saves the screenshot as a PNG image to a location of your choosing. Clicking on the arrow on the side will expose the other save mode, | ||
242 | <guimenuitem>Save</guimenuitem>, which will save the screenshot as a PNG image to the standard location (which defaults to your Pictures folder). | ||||
243 | By default, the last-used save mode is remembered for next time.</para> | ||||
239 | </listitem> | 244 | </listitem> | ||
240 | </varlistentry> | 245 | </varlistentry> | ||
241 | </variablelist> | 246 | </variablelist> | ||
242 | </sect1> | 247 | </sect1> | ||
243 | 248 | | |||
244 | <sect1> | 249 | <sect1> | ||
245 | <title>Configure</title> | 250 | <title>Configure</title> | ||
246 | <para>Use the <guibutton>Configure...</guibutton> button to open the configuration dialog.</para> | 251 | <para>Use the <guibutton>Configure...</guibutton> button to open the configuration dialog.</para> | ||
▲ Show 20 Lines • Show All 66 Lines • ▼ Show 20 Line(s) | 314 | <listitem> | |||
313 | <listitem><para><userinput>%Y</userinput>: Year (4 digit)</para></listitem> | 318 | <listitem><para><userinput>%Y</userinput>: Year (4 digit)</para></listitem> | ||
314 | <listitem><para><userinput>%y</userinput>: Year (2 digit)</para></listitem> | 319 | <listitem><para><userinput>%y</userinput>: Year (2 digit)</para></listitem> | ||
315 | <listitem><para><userinput>%M</userinput>: Month</para></listitem> | 320 | <listitem><para><userinput>%M</userinput>: Month</para></listitem> | ||
316 | <listitem><para><userinput>%D</userinput>: Day</para></listitem> | 321 | <listitem><para><userinput>%D</userinput>: Day</para></listitem> | ||
317 | <listitem><para><userinput>%H</userinput>: Hour</para></listitem> | 322 | <listitem><para><userinput>%H</userinput>: Hour</para></listitem> | ||
318 | <listitem><para><userinput>%m</userinput>: Minute</para></listitem> | 323 | <listitem><para><userinput>%m</userinput>: Minute</para></listitem> | ||
319 | <listitem><para><userinput>%S</userinput>: Second</para></listitem> | 324 | <listitem><para><userinput>%S</userinput>: Second</para></listitem> | ||
320 | </itemizedlist> | 325 | </itemizedlist> | ||
321 | <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> | 326 | <para>If a file with this name already exists, a serial number will be appended to the filename. For example, if the | ||
327 | filename is <filename>Screenshot</filename>, and <filename>Screenshot.png</filename> already exists, | ||||
328 | the image will be saved as <filename>Screenshot-1.png</filename>.</para> | ||||
322 | <para>Typing an extension into the filename will automatically set the image format correctly and remove the extension from the filename field.</para> | 329 | <para>Typing an extension into the filename will automatically set the image format correctly and remove the extension from the filename field.</para> | ||
323 | </listitem> | 330 | </listitem> | ||
324 | </varlistentry> | 331 | </varlistentry> | ||
325 | </variablelist> | 332 | </variablelist> | ||
326 | </sect2> | 333 | </sect2> | ||
327 | </sect1> | 334 | </sect1> | ||
328 | 335 | | |||
329 | <sect1> | 336 | <sect1> | ||
Show All 39 Lines |
please remove these entities from the header
since 2016-09-17 these entities are already defined in kdoctools:
https://cgit.kde.org/kdoctools.git/commit/src/customization/entities/contributor.entities?id=e7389ef900e8e606aaba3074de3bfe52172c8705