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.
krusader/doc/en/useraction-xml.docbook

218 lines
8.8 KiB

<appendix id="useraction-xml">
<!-- **********************************************************************
installation.docbook
++++++++++++++++++++++++++
copyright : (C) 2000 - 2008
Rafi Yanai, Shie Erlich, Frank Schoolmeesters
& the Krusader Krew
e-mail : krusader@users.sourceforge.net
web site : http://www.krusader.org
description : a Krusader Documentation File
***************************************************************************
* Permission is granted to copy, distribute and/or modify this *
* document under the terms of the GNU Free Documentation License, *
* Version 1.1 or any later version published by the Free Software *
* Foundation; with no Invariant Sections, no Front-Cover Texts and *
* no Back-Cover Texts. A copy of the license is available on the *
* GNU site http://www.gnu.org/licenses/fdl.html or by writing to: *
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, *
* MA 02110-1301, USA. *
*********************************************************************** -->
<title>useraction.xml</title>
<para>This appendix gives several examples of
<filename>useraction.xml</filename> files. With this you can begin
to discover the power of the &useractions-lnk; and
start learning how to use them. Once you understand how to write
UserActions you will find that &krusader; is an even
more powerful, customizable tool.</para>
<para>Please consider uploading your UserActions at
&kde-files-url; as we are collecting them. If your
UserAction is selected by us it will be shipped with
&krusader; at the next release. We provide also an
&useractionsforum-url;.</para>
<itemizedlist>
<listitem><para>Runs <command>uptime</command>
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="uptime" >
&lt;title>Up-time&lt;/title>
&lt;tooltip>tells how long since the computer has been booted&lt;/tooltip>
&lt;icon>clock&lt;/icon>
&lt;category>information&lt;/category>
&lt;description same_as="tooltip" />
&lt;command executionmode="collect_output" >uptime&lt;/command>
&lt;defaultshortcut>Alt+Ctrl+U&lt;/defaultshortcut>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>Runs <command>ls -l</command>
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="ls -l" >
&lt;title>ls -l in curremt dir&lt;/title>
&lt;description same_as="tooltip" />
&lt;command executionmode="collect_output" >ls -l %aPath% %oPath%&lt;/command>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>Echo Placeholder
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="test_placeholder" >
&lt;title>Echo Placeholder&lt;/title>
&lt;tooltip>Echo's the placeholder values&lt;/tooltip>
&lt;category>Testing&lt;/category>
&lt;description same_as="tooltip" />
&lt;command executionmode="collect_output" onmultiplefiles="call_each" >echo -e &quot;aPath %aPath()% \naCurrent: %aCurrent()%&quot;&lt;/command>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>This useraction copies current path and filename to clipboard:
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="clipboard current" >
&lt;title>Copy to Clipboard&lt;/title>
&lt;tooltip>Copy to clipboard&lt;/tooltip>
&lt;icon>klipper&lt;/icon>
&lt;category>System&lt;/category>
&lt;description>Copy current path and filename to clipboard&lt;/description>
&lt;command>%_Clipboard(&quot;%aCurrent%&quot;)%&lt;/command>
&lt;defaultshortcut>Win+C&lt;/defaultshortcut>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>Selects <literal role="extension">.diff</literal> and <literal role="extension">*.h</literal> in the active panel:
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="test_select" >
&lt;title>Add selection *.diff and *.h&lt;/title>
&lt;category>Selection&lt;/category>
&lt;command>%aSelect(&quot;*.diff&quot;, &quot;add&quot;)% %aSelect(&quot;*.h&quot;, &quot;add&quot;)%&lt;/command>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>Active panel changes to <filename>mnt/floppy</filename> (bookmark):
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;action name="mnt/floppy bookmark" >
&lt;title>Jump to /mnt/floppy&lt;/title>
&lt;category>Bookmarks&lt;/category>
&lt;command>%aGoto(&quot;/mnt/floppy&quot;, &quot;yes&quot;)%&lt;/command>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>Select in the non-active panel, all filenames that are highlighted in the active panel:
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;action name="asdfasdf" >
&lt;title>Select in Other Panel&lt;/title>
&lt;category>Selection&lt;/category>
&lt;description>Select all filenames that are selected in the active panel, also in the non-active panel&lt;/description>
&lt;command>%oSelect(&quot;%aList(&quot;selected&quot;, &quot; &quot;, &quot;Yes&quot;)%&quot;)%&lt;/command>
&lt;/action>
&lt;/KrusaderUserActions</programlisting>
</para></listitem>
<listitem><para>Make a backup of the current file/folder to <filename>foo.bak</filename> into the current directory:
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="backup current" >
&lt;title>Backup in Current Directory&lt;/title>
&lt;tooltip>Backup in current directory&lt;/tooltip>
&lt;icon>filesaveas&lt;/icon>
&lt;category>System&lt;/category>
&lt;description same_as="tooltip" />
&lt;command>%_Copy(&quot;%aCurrent%&quot;, &quot;%_Ask(&quot;new name&quot;, &quot;%aCurrent%.bak&quot;)&quot;)%&lt;/command>
&lt;defaultshortcut>Shift+F5&lt;/defaultshortcut>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>Opens <link linkend="krusearcher">KruSearcher</link>:
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="search" >
&lt;title>Search Test&lt;/title>
&lt;command>%_NewSearch(&quot;Search 2&quot;)%&lt;/command>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>Sets the selected picture as wallpaper:
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="set wallpaper" >
&lt;title>Set as Wallpaper&lt;/title>
&lt;tooltip>Set as wallpaper&lt;/tooltip>
&lt;icon>image&lt;/icon>
&lt;category>Service Menu&lt;/category>
&lt;description>Set as wallpaper (scaled)&lt;/description>
&lt;command>dcop kdesktop KBackgroundIface setWallpaper &quot;%aCurrent%&quot; 6&lt;/command>
&lt;defaultshortcut>Win+W&lt;/defaultshortcut>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>This useraction edits a file with root permissions using <command>kdesu</command>:
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="edit as root" >
&lt;title>Edit as Root&lt;/title>
&lt;tooltip>Edit as root&lt;/tooltip>
&lt;icon>kwrite&lt;/icon>
&lt;category>System&lt;/category>
&lt;description>Edit a file with root permissions using kdesu&lt;/description>
&lt;command>kdesu kedit %aCurrent%&lt;/command>
&lt;defaultshortcut>Win+F4&lt;/defaultshortcut>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>This useraction Add item(s) to Amarok playlist:
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="amarok enqueue" >
&lt;title>Enqueue in Amarok&lt;/title>
&lt;tooltip>Append selected item(s) to Amarok playlist&lt;/tooltip>
&lt;icon>amarok&lt;/icon>
&lt;category>Multimedia&lt;/category>
&lt;description same_as="tooltip" />
&lt;command>amarok --append %aList(&quot;Selected&quot;)%&lt;/command>
&lt;defaultshortcut>Win+A&lt;/defaultshortcut>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
<listitem><para>Opens <link linkend="synchronizer">Synchronizer</link>:
<programlisting>
&lt;!DOCTYPE KrusaderUserActions>
&lt;KrusaderUserActions>
&lt;action name="synchronizer" >
&lt;title>Synchronizer&lt;/title>
&lt;command>%_Sync(&quot;Sync 2&quot;)%&lt;/command>
&lt;/action>
&lt;/KrusaderUserActions></programlisting>
</para></listitem>
</itemizedlist>
</appendix>