kruler/doc/index.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY % English "INCLUDE" > <!-- change language only here -->
0004   <!ENTITY % addindex "IGNORE">
0005 ]>
0006
0007 <book id="kruler" lang="&language;">
0008
0009 <bookinfo>
0010 <title>The &kruler; Handbook</title>
0011
0012 <authorgroup>
0013 <author>
0014 <firstname>Lauri</firstname>
0015 <surname>Watts</surname>
0016 <affiliation>
0017 <address><email>&Lauri.Watts.mail;</email></address>
0018 </affiliation>
0019 </author>
0020
0021 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0022 </authorgroup>
0023
0024 <legalnotice>&FDLNotice;</legalnotice>
0025
0026 <copyright>
0027 <year>2001</year>
0028 <holder>&Lauri.Watts;</holder>
0029 </copyright>
0030
0031 <date>2017-06-14</date>
0032 <releaseinfo>5.0 (Applications 17.08)</releaseinfo>
0033
0034 <!-- Abstract about this handbook -->
0035
0036 <abstract>
0037 <para>
0038 &kruler; can be used to measure objects on the screen.
0039 </para>
0040 </abstract>
0041
0042 <keywordset>
0043 <keyword>KDE</keyword>
0044 <keyword>KRuler</keyword>
0045 <keyword>kdegraphics</keyword>
0046 </keywordset>
0047
0048 </bookinfo>
0049
0050 <chapter id="introduction">
0051 <title>Introduction</title>
0052
0053 <para>&kruler; is a very simple application, with only one aim in life.  To
0054 measure pixel distances on your screen. It is useful for working on layout
0055 of dialogs, web pages &etc;</para>
0056
0057 <para>To start &kruler;, choose <menuchoice><guimenu>Applications</guimenu><guisubmenu>Utilities</guisubmenu>
0058 <guisubmenu>More Applications</guisubmenu>
0059 <guimenuitem>Screen Ruler</guimenuitem></menuchoice> from your application menu.</para>
0060
0061 <screenshot>
0062 <screeninfo>&kruler;</screeninfo>
0063 <mediaobject>
0064 <imageobject>
0065 <imagedata fileref="kruler.png" format="PNG" />
0066 </imageobject>
0067 <textobject>
0068 <phrase>&kruler;</phrase>
0069 </textobject>
0070 </mediaobject>
0071 </screenshot>
0072
0073 <para>Clicking with the &LMB; on the &kruler; will turn the cursor to a cross
0074 with four arrows and enables you to drag &kruler; around the screen.</para>
0075
0076 <para>When you move the mouse over &kruler;, your cursor will turn into a
0077 red arrow.  As you move the cursor, &kruler; will
0078 display how far from the origin the cursor currently is.
0079 </para>
0080
0081 <para>You can resize the ruler by moving the mouse over the handle on the
0082 left or right edges of &kruler; (the top or bottom edges when it is oriented
0083 vertically), holding down the &LMB; and dragging the handle.</para>
0084
0085 <para>You can change the orientation in two different ways:</para>
0086
0087 <simplelist>
0088 <member>Clicking the &MMB; switches the ruler from vertical to horizontal orientation</member>
0089 <member>Using the context menu, described in the next chapter</member>
0090 </simplelist>
0091
0092 </chapter>
0093
0094 <chapter id="menu-reference">
0095 <title>Menu Reference</title>
0096
0097 <para>Clicking with the &RMB; on the ruler will pop up a context menu, with the
0098 following entries:</para>
0099
0100 <variablelist>
0101 <varlistentry>
0102 <term>
0103 <menuchoice>
0104 <guimenuitem>Rotate</guimenuitem>
0105 </menuchoice>
0106 </term>
0107 <listitem>
0108 <para>Switches &kruler; from vertical to horizontal orientation.</para>
0109 </listitem>
0110 </varlistentry>
0111
0112 <varlistentry>
0113 <term>
0114 <menuchoice>
0115 <guimenuitem>Scale</guimenuitem>
0116 </menuchoice>
0117 </term>
0118 <listitem>
0119 <para>This option lets you set the ruler scale to <guilabel>Right to Left</guilabel>
0120 (<keycap>D</keycap>), <guilabel>Center Origin</guilabel> (<keycap>C</keycap>),
0121 <guilabel>Offset</guilabel> (<keycap>O</keycap>) and <guilabel>Percentage</guilabel>.</para>
0122 <para>Changing the offset via the mousewheel is also possible when holding the &LMB;.</para>
0123 </listitem>
0124 </varlistentry>
0125
0126 <varlistentry>
0127 <term>
0128 <menuchoice>
0129 <guimenuitem>Opacity</guimenuitem>
0130 </menuchoice>
0131 </term>
0132 <listitem>
0133 <para>This menu item displays a slider to change the opacity of &kruler;.</para>
0134 </listitem>
0135 </varlistentry>
0136
0137 <varlistentry>
0138 <term>
0139 <menuchoice>
0140 <guimenuitem>Configure Shortcuts...</guimenuitem>
0141 </menuchoice>
0142 </term>
0143 <listitem>
0144 <para>The <guilabel>Configure Shortcut</guilabel> dialog allows you to assign shortcuts
0145 to &kruler; actions, and configure the shortcuts already assigned.</para>
0146 <para>For more information, read the section about the
0147 <ulink url="help:/fundamentals/config.html#shortcuts">Shortcuts</ulink> of the &kde; Fundamentals.
0148 </para>
0149 </listitem>
0150 </varlistentry>
0151
0152 <varlistentry id= "settings-dialog">
0153 <term>
0154 <menuchoice>
0155 <guimenuitem>Configure &kruler;...</guimenuitem>
0156 </menuchoice>
0157 </term>
0158 <listitem>
0159 <para>
0160 <screenshot>
0161 <screeninfo>&kruler;'s settings dialog</screeninfo>
0162 <mediaobject>
0163 <imageobject>
0164 <imagedata fileref="kruler-settings.png" format="PNG" />
0165 </imageobject>
0166 <textobject>
0167 <phrase>&kruler;'s settings dialog</phrase>
0168 </textobject>
0169 </mediaobject>
0170 </screenshot>
0171 </para>
0172 <para>In this dialog you can change the background color and font and enable
0173 the tray icon.</para>
0174 </listitem>
0175 </varlistentry>
0176
0177 <varlistentry>
0178 <term>
0179 <menuchoice>
0180 <shortcut>
0181 <keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>
0182 </shortcut>
0183 <guimenuitem>Close</guimenuitem>
0184 </menuchoice>
0185 </term>
0186 <listitem>
0187 <para><action>Hides</action> &kruler;. It can be shown again using the icon in the system tray.
0188 The context menu displays this item only when <guilabel>Show tray icon</guilabel> is checked in the
0189 <link linkend="settings-dialog">settings dialog</link>.</para>
0190 </listitem>
0191 </varlistentry>
0192
0193 <varlistentry>
0194 <term>
0195 <menuchoice>
0196 <shortcut>
0197 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
0198 </shortcut>
0199 <guimenuitem>Quit</guimenuitem>
0200 </menuchoice>
0201 </term>
0202 <listitem>
0203 <para><action>Quits</action> &kruler;</para>
0204 </listitem>
0205 </varlistentry>
0206 </variablelist>
0207 <para>
0208 &kruler; has the common &kde; <guimenu>Help</guimenu> menu item, for more information read the section
0209 about the <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
0210 </para>
0211
0212 </chapter>
0213
0214 <chapter id="keyboard-handling">
0215 <title>Keyboard Handling</title>
0216
0217 <para>You can move the ruler using the arrow key buttons.</para>
0218
0219 <para>You can move the mouse cursor, and thus the indicator, by holding down
0220 &Alt; and using the arrow buttons.</para>
0221
0222 <para>Hold down &Shift; while doing one of those to move faster.</para>
0223 </chapter>
0224
0225 <chapter id="credits-and-license">
0226 <title>Credits and License</title>
0227
0228 <para>&kruler;</para>
0229
0230 <para>Copyright 2000, 2001 Till Krech <email>till@snafu.de</email></para>
0231 <para>Copyright 2009 Mathias Soeken <email>msoeken@tzi.de</email></para>
0232
0233 <para>Thanks to Gunnstein Lye <email>gl@ez.no</email> for the initial port to
0234 &kde; 2</para>
0235
0236 <para>Documentation Copyright &Lauri.Watts;
0237 &Lauri.Watts.mail;</para>
0238
0239 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0240
0241 &underFDL;
0242 &underGPL;
0243
0244 </chapter>
0245
0246 &documentation.index;
0247 </book>
0248 <!--
0249 Local Variables:
0250 mode: sgml
0251 sgml-minimize-attributes: nil
0252 sgml-general-insert-case: lower
0253 End:
0254 -->
0255