You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
432 lines
12 KiB
432 lines
12 KiB
<?xml version="1.0" ?>
|
|
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
|
|
"dtd/kdex.dtd" [
|
|
<!ENTITY ksig "<application>KSig</application>">
|
|
<!ENTITY kappname "&ksig;">
|
|
<!ENTITY package "tdeaddons">
|
|
<!ENTITY % addindex "IGNORE">
|
|
<!ENTITY % English "INCLUDE">
|
|
]>
|
|
<book lang="&language;">
|
|
|
|
<!-- This header contains all of the meta-information for the document such
|
|
as Authors, publish date, the abstract, and Keywords -->
|
|
|
|
<bookinfo>
|
|
<title>The &ksig; Handbook</title>
|
|
|
|
<authorgroup>
|
|
<author>
|
|
<personname>
|
|
<firstname>Richard</firstname>
|
|
<othername>A.</othername>
|
|
<surname>Johnson</surname>
|
|
</personname>
|
|
<email>nixternal@ubuntu.com</email>
|
|
</author>
|
|
<!-- TRANS:ROLES_OF_TRANSLATORS -->
|
|
</authorgroup>
|
|
|
|
<copyright>
|
|
<year>2006</year>
|
|
<holder>Richard A. Johnson</holder>
|
|
</copyright>
|
|
<!-- Translators: put here the copyright notice of the translation -->
|
|
|
|
<legalnotice>&FDLNotice;</legalnotice>
|
|
|
|
<date>2007-01-06</date>
|
|
<releaseinfo>1.01.00</releaseinfo>
|
|
|
|
<abstract>
|
|
<para>
|
|
&ksig; is an application specially designed to manage multiple email signatures
|
|
graphically.
|
|
</para>
|
|
</abstract>
|
|
|
|
<keywordset>
|
|
<keyword>KSig</keyword>
|
|
<keyword>tdeaddons</keyword>
|
|
<keyword>signature</keyword>
|
|
<keyword>kmail</keyword>
|
|
<keyword>plugin</keyword>
|
|
</keywordset>
|
|
|
|
</bookinfo>
|
|
|
|
<!-- CHAPTER: INTRODUCTION -->
|
|
<chapter id="introduction">
|
|
<title>Introduction</title>
|
|
<para>
|
|
&ksig; is a graphical tool for keeping track of many different email signatures.
|
|
The signatures themselves can be edited through &ksig;'s graphical user
|
|
interface. A command-line interface is then available for generating random or
|
|
daily signatures from a list. The command-line interface makes a suitable plugin
|
|
for generating signatures in external mail clients such as &kmail;.
|
|
</para>
|
|
<para>
|
|
Random signatures will pull signatures from the &ksig; signature file randomly.
|
|
You can make every email more exiciting and uniqe than the previous by creating
|
|
multiple signatures with varying quotes, styles, and information.
|
|
</para>
|
|
<para>
|
|
Daily signatures will pull signatures from the &ksig; signature file only using
|
|
one signature for an entire day. Every day will provide a different signature,
|
|
and just like the random signatures provide uniqueness to your emails.
|
|
</para>
|
|
<para>
|
|
Please report any problems or feature requests to the &kde; mailing lists.
|
|
</para>
|
|
</chapter>
|
|
|
|
<chapter id="using-ksig">
|
|
<title>Using &ksig;</title>
|
|
<para>
|
|
Go to
|
|
<menuchoice><guimenu>KMenu</guimenu><guisubmenu>Utilities</guisubmenu>
|
|
<guisubmenu>PIM</guisubmenu><guimenuitem>&ksig; Signature Editor</guimenuitem></menuchoice></para>
|
|
|
|
<para>
|
|
<screenshot>
|
|
<screeninfo>Here's a screenshot of &ksig;</screeninfo>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>Screenshot</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</para>
|
|
|
|
<sect1 id="ksig-newsig">
|
|
<title>Creating a new signature</title>
|
|
<para>To create a new signature, go to <menuchoice> <shortcut> <keycombo
|
|
action="simul">&Ctrl;<keycap>N</keycap></keycombo> </shortcut>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>New</guimenuitem> </menuchoice>. This will create an
|
|
<guilabel><empty signature></guilabel> in the
|
|
<guilabel>Signatures</guilabel> section. <mousebutton>Left</mousebutton> click
|
|
the <empty signature> and in the bottom section type in your new
|
|
signature.
|
|
<example>
|
|
<title>Signature example</title>
|
|
<screen>
|
|
Mr. Konqi
|
|
konqi@kde.org
|
|
http://www.kde.org
|
|
</screen>
|
|
</example>
|
|
Once you have completed your signature, save it by going to <menuchoice>
|
|
<shortcut> <keycombo
|
|
action="simul">&Ctrl;<keycap>S</keycap></keycombo> </shortcut>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>Save</guimenuitem> </menuchoice>, or by pressing the
|
|
<guibutton>Save</guibutton> button (floppy disc icon).
|
|
</para>
|
|
|
|
<para>You can create as many signatures as you would like. Doing so provides you
|
|
with a list of signatures to use in email applications such as &kmail;, so no
|
|
matter how informal or professional you need to be, there will always be an
|
|
available signature.</para>
|
|
|
|
</sect1>
|
|
|
|
<sect1 id="ksig-delsig">
|
|
<title>Deleting a signature</title>
|
|
<para>To remove a signature first select the signature that you want to remove
|
|
and then click
|
|
<menuchoice><guimenu>File</guimenu><guimenuitem>Remove</guimenuitem></menuchoice
|
|
>, or by clicking the <guibutton>Remove</guibutton> button with the red x icon in the
|
|
toolbar.
|
|
</para>
|
|
</sect1>
|
|
|
|
<sect1 id="ksig-kmail-daily">
|
|
<title>Adding daily signatures to &kmail;</title>
|
|
<para>Adding a daily signature is pretty straight forward. Open &kmail; by
|
|
pressing <keycombo>&Alt;<keycap>F2</keycap></keycombo>. Enter
|
|
<command>kmail</command> in the text box and then press
|
|
<guibutton>Run</guibutton>. Once inside &kmail;, go to
|
|
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
|
|
KMail...</guimenuitem></menuchoice>. In the <guilabel>Identities</guilabel>
|
|
selection, highlight the identity to add the signature to and then press the
|
|
<guibutton>Modify...</guibutton> button on the right-hand side of the window. Select
|
|
the <guilabel>Signature</guilabel> tab. Check the <guilabel>Enable
|
|
signature</guilabel> box. From the <guilabel>Obtain signature text
|
|
from</guilabel> drop down, select <guimenuitem>Output of Command</guimenuitem>.
|
|
In the <guilabel>Specify command</guilabel> text box, enter <command>ksig
|
|
--daily</command> and then press the <guibutton>OK</guibutton> button.
|
|
</para>
|
|
</sect1>
|
|
|
|
<sect1 id="ksig-kmail-random">
|
|
<title>Adding random signatures to &kmail;</title>
|
|
<para>Adding a random signature, just like the daily signature, is pretty
|
|
straight forward. Open &kmail; by pressing
|
|
<keycombo>&Alt;<keycap>F2</keycap></keycombo>. Enter <command>kmail</command> in
|
|
the text box and then press <guibutton>Run</guibutton>. Once inside &kmail;, go
|
|
to <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
|
|
KMail...</guimenuitem></menuchoice>. In the <guilabel>Identities</guilabel>
|
|
selection, highlight the identity to add the signature to and then press the
|
|
<guibutton>Modify...</guibutton> button on the right-hand side of the window. Select
|
|
the <guilabel>Signature</guilabel> tab. Check the <guilabel>Enable
|
|
signature</guilabel> box. From the <guilabel>Obtain signature text
|
|
from</guilabel> drop down, select <guimenuitem>Output of Command</guimenuitem>.
|
|
In the <guilabel>Specify command</guilabel> text box, enter <command>ksig
|
|
--random</command> and then press the <guibutton>OK</guibutton> button.
|
|
</para>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter id="commands">
|
|
<title>Command Reference</title>
|
|
|
|
<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
|
|
application windows and their menubar and toolbar commands for easy reference.
|
|
Also include any keys that have a special function but have no equivalent in the
|
|
menus or toolbars. This may not be necessary for small apps or apps with no tool
|
|
or menu bars. -->
|
|
|
|
<sect1 id="filemenu">
|
|
<title>The <guilabel>File</guilabel> Menu</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><menuchoice> <shortcut> <keycombo
|
|
action="simul">&Ctrl;<keycap>N</keycap></keycombo> </shortcut>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>New</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Creates a new signature.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice> <shortcut> <keycombo
|
|
action="simul">&Ctrl;<keycap>S</keycap></keycombo> </shortcut>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>Save</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Saves the signature.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>Remove</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Removes a signature.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice> <shortcut> <keycombo
|
|
action="simul">&Ctrl;<keycap>Q</keycap></keycombo> </shortcut>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>Quit</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Quits &ksig;.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect1>
|
|
|
|
<sect1 id="editmenu">
|
|
<title>The <guilabel>Edit</guilabel> Menu</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><menuchoice> <shortcut> <keycombo
|
|
action="simul">&Ctrl;<keycap>X</keycap></keycombo> </shortcut>
|
|
<guimenu>Edit</guimenu>
|
|
<guimenuitem>Cut</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Cuts the current selection.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice> <shortcut> <keycombo
|
|
action="simul">&Ctrl;<keycap>C</keycap></keycombo> </shortcut>
|
|
<guimenu>Edit</guimenu>
|
|
<guimenuitem>Copy</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Copies the current selection.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice> <shortcut> <keycombo
|
|
action="simul">&Ctrl;<keycap>V</keycap></keycombo> </shortcut>
|
|
<guimenu>Edit</guimenu>
|
|
<guimenuitem>Paste</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Pastes the current &klipper; content.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<guimenu>Edit</guimenu>
|
|
<guimenuitem>Clear</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Clears the current selection.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
</sect1>
|
|
|
|
<sect1 id="settingsmenu">
|
|
<title>The <guilabel>Settings</guilabel> Menu</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<guimenu>Settings</guimenu>
|
|
<guimenuitem>Toolbars</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Toggles whether the <guimenuitem>Main Toolbar
|
|
(&ksig;)</guimenuitem> or the <guimenuitem>Search Toolbar (&ksig;)</guimenuitem>
|
|
is displayed.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<guimenu>Settings</guimenu>
|
|
<guimenuitem>Show/Hide Statusbar</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Toggles whether the status bar is displayed.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<guimenu>Settings</guimenu>
|
|
<guimenuitem>Edit Standard Header</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Edits the <guilabel>Standard signature
|
|
header.</guilabel></action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<guimenu>Settings</guimenu>
|
|
<guimenuitem>Edit Standard Footer</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Edits the <guilabel>Standard signature
|
|
footer.</guilabel></action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<guimenu>Settings</guimenu>
|
|
<guimenuitem>Configure Shortcuts...</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Displays the <guilabel>Configure Shortcuts</guilabel> dialog box.
|
|
This lets you choose shortcut keys for various menu items. To change a shortcut,
|
|
select an action from the list, and then choose which keystroke to use. Clicking
|
|
on the bottom right <guibutton>Custom</guibutton> button lets you choose which
|
|
specific key to use. Just press the new key or key combo.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><menuchoice>
|
|
<guimenu>Settings</guimenu>
|
|
<guimenuitem>Configure Toolbars...</guimenuitem> </menuchoice></term>
|
|
<listitem>
|
|
<para><action>Displays a &kde; standard dialog where you can configure the
|
|
toolbar icons.</action></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
</sect1>
|
|
|
|
<sect1 id="helpmenu">
|
|
<title>The <guilabel>Help</guilabel> Menu</title>
|
|
|
|
&help.menu.documentation;
|
|
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<chapter id="credits">
|
|
<title>Credits and License</title>
|
|
|
|
<para>
|
|
&ksig;
|
|
</para>
|
|
<para>
|
|
Program copyright 2002 &Scott.Wheeler; &Scott.Wheeler.mail;
|
|
</para>
|
|
|
|
<para>
|
|
Documentation Copyright © 2006 Richard A. Johnson
|
|
<email>nixternal@ubuntu.com</email>
|
|
</para>
|
|
|
|
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
|
|
|
|
&underFDL; <!-- FDL: do not remove -->
|
|
|
|
&underGPL; <!-- GPL License -->
|
|
|
|
</chapter>
|
|
|
|
<appendix id="installation">
|
|
<title>Installation</title>
|
|
|
|
<sect1 id="getting-kapp">
|
|
<title>How to obtain &ksig;</title>
|
|
|
|
&install.intro.documentation;
|
|
|
|
</sect1>
|
|
|
|
<sect1 id="requirements">
|
|
<title>Requirements</title>
|
|
|
|
<para>
|
|
In order to successfully use &ksig;, you need &kde; 3.5. To apply a signature to
|
|
your emails you will also need a client such as &kmail; or any other client that
|
|
can obtain the signature text from the output of a command.
|
|
</para>
|
|
|
|
</sect1>
|
|
|
|
<sect1 id="compilation">
|
|
<title>Compilation and Installation</title>
|
|
|
|
&install.compile.documentation;
|
|
|
|
</sect1>
|
|
|
|
|
|
</appendix>
|
|
|
|
&documentation.index;
|
|
</book>
|
|
|
|
<!--
|
|
Local Variables:
|
|
mode: xml
|
|
sgml-minimize-attributes:nil
|
|
sgml-general-insert-case:lower
|
|
sgml-indent-step:0
|
|
sgml-indent-data:nil
|
|
End:
|
|
|
|
vim:tabstop=2:shiftwidth=2:expandtab
|
|
kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
|
|
-->
|