[Goodies-commits] r7242 - in xfce4-clipman-plugin/trunk/docs/manual/C: . images

Mike Massonnet mmassonnet at xfce.org
Sun Apr 19 22:33:20 CEST 2009

Author: mmassonnet
Date: 2009-04-19 20:33:20 +0000 (Sun, 19 Apr 2009)
New Revision: 7242

Build xfce4-clipman-plugin.html instead of index and install images to ./xfce4/doc/C/images

Modified: xfce4-clipman-plugin/trunk/docs/manual/C/Makefile.am
--- xfce4-clipman-plugin/trunk/docs/manual/C/Makefile.am	2009-04-19 19:42:23 UTC (rev 7241)
+++ xfce4-clipman-plugin/trunk/docs/manual/C/Makefile.am	2009-04-19 20:33:20 UTC (rev 7242)
@@ -14,12 +14,6 @@
 STYLESHEET = ../xfce-nochunk.xsl
 DOCUMENT = xfce4-clipman-plugin.xml
-# We set GPATH here; this gives us semantics for GNU make
-# which are more like other make's VPATH, when it comes to
-# whether a source that is a target of one rule is then
-# searched for in VPATH/GPATH.
-GPATH = $(srcdir)
 DOC_STAMPS = html-build.stamp
@@ -31,21 +25,15 @@
 html-build.stamp: $(srcdir)/$(DOCUMENT) $(srcdir)/$(STYLESHEET)
 	@echo "*** Building HTML ***"
 	@-chmod -R u+w $(srcdir)
-	rm -rf $(srcdir)/html
-	mkdir $(srcdir)/html
-	$(XSLTPROC) --nonet -o $(srcdir)/html/ $(srcdir)/$(STYLESHEET) \
-		$(srcdir)/$(DOCUMENT)
+	$(XSLTPROC) --nonet -o $(srcdir) $(srcdir)/$(STYLESHEET) $(srcdir)/$(DOCUMENT)
 	touch html-build.stamp
-maintainer-clean-local: clean
-	(cd $(srcdir) && rm -rf html)
-	installfiles=`echo $(srcdir)/html/*`;				\
-	if test "$$installfiles" = '$(srcdir)/html/*'; then		\
+	installfiles=`echo $(srcdir)/*.html`;				\
+	if test "$$installfiles" = '$(srcdir)/*.html'; then		\
 		echo "--- Nothing to install";				\
 	else								\
 		$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR);		\
@@ -67,8 +55,7 @@
 dist-hook: dist-check-xsltproc dist-hook-local
-	mkdir $(distdir)/html
-	-cp $(srcdir)/html/* $(distdir)/html
+	-cp $(srcdir)/*.html $(distdir)
 .PHONY: dist-hook-local

Modified: xfce4-clipman-plugin/trunk/docs/manual/C/images/Makefile.am
--- xfce4-clipman-plugin/trunk/docs/manual/C/images/Makefile.am	2009-04-19 19:42:23 UTC (rev 7241)
+++ xfce4-clipman-plugin/trunk/docs/manual/C/images/Makefile.am	2009-04-19 20:33:20 UTC (rev 7242)
@@ -1,6 +1,6 @@
 NULL = 
-imagesdir = $(datadir)/doc/xfce4-clipman-plugin/html/C/images
+imagesdir = $(datadir)/xfce4/doc/C/images
 images_DATA =								\
 	clipman-action-dialog.png					\
 	clipman-menu.png						\

Added: xfce4-clipman-plugin/trunk/docs/manual/C/xfce4-clipman-plugin.html
--- xfce4-clipman-plugin/trunk/docs/manual/C/xfce4-clipman-plugin.html	                        (rev 0)
+++ xfce4-clipman-plugin/trunk/docs/manual/C/xfce4-clipman-plugin.html	2009-04-19 20:33:20 UTC (rev 7242)
@@ -0,0 +1,107 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Clipman Manual</title><link rel="stylesheet" href="../xfce.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="#xfce4-clipman-plugin" title="Clipman Manual"><link rel="next" href="#intro" title="Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="xfce4-clipman-plugin"></a>Clipman Manual</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Mike</span> <span class="surname">Massonnet</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:mmassonnet at xfce.org">mmassonnet at xfce.org</a>></code></p></div></div></div></div></div><div><span xmlns="http://www.w3.org/TR/xhtml1/transitional" 
+      This manual describes version 1.0.0 of Clipman.
+    <br></br></span></div><div><p class="copyright">Copyright © 2009 Mike Massonnet</p></div><div><div class="legalnotice"><a name="legalnotice"></a><p>
+        Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free
+        Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no
+        Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. The complete license text is
+        available from the <a class="ulink" href="http://www.fsf.org/" target="_top">Free Software Foundation</a>.
+      </p></div></div><div><p class="pubdate">April 2009</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#intro">Introduction</a></span></dt><dd><dl><dt><span class="sect2"><a href="#anatomy-clipboard">Anatomy of a Clipboard</a></span></dt></dl></dd><dt><span class="sect1"><a href="#usage">Usage</a></span></dt><dt><span class="sect1"><a href="#settings">Settings</a></span></dt><dd><dl><dt><span class="sect2"><a href="#history">History</a></span></dt><dt><span class="sect2"><a href="#actions">Actions</a></span></dt><dt><span class="sect2"><a href="#xfconf">Xfconf</a></span></dt></dl></dd><dt><span class="sect1"><a href="#action">Action</a></span></dt><dd><dl><dt><span class="sect2"><a href="#regexes">Regular Expression</a></span></dt><dt><span class="sect2"><a href="#command">Command</a></span></dt></dl></dd><dt><span class="sect1"><a href="#support">Support</a></span></dt><dt><span class="sect1"><a href="#about">A
 bout Clipman</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="intro"></a>Introduction</h2></div></div></div><p>
+      Clipman is a clipboard manager for Xfce. It keeps the clipboard contents around while it is usually lost
+      when you close an application. It is able to handle text and images, and has a feature to execute actions on
+      specific text selections by matching them against regular expressions.
+    </p><p>
+      There are two ways to run Clipman. You can select Clipman in the applications menu under the category
+      Utility or type <span class="command"><strong>xfce4-clipman-plugin</strong></span> on the command line, or you can add it into your panel. To
+      add a new item in the panel right click the panel and select “Add new item…”.
+    </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="anatomy-clipboard"></a>Anatomy of a Clipboard</h3></div></div></div><p>
+        In X11 (all Unix platforms) there are by default two clipboards to exchange any data between the windows. A
+        default clipboard which is modified by manual copies (for instance when you select a file and press the copy
+        button), and there is a primary clipboard which is modified by selections (for instance when you select text in
+        a field).
+      </p><p>
+        Clipman handles only the default clipboard, but optionnaly it can also notice the selections.  When it is
+        handling the selections, the default clipboard will always be synced with it and contain the same data.
+      </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="usage"></a>Usage</h2></div></div></div><p>
+      Clipman is used to keep in history a list of clipboard contents and to restore them. The history is
+      displayed in a menu by clicking on the main icon. Within the menu it is possible to select an item to restore it,
+      to clear the history and to activate or deactivate the clipboard manager.
+    </p><div class="screenshot"><div class="mediaobject"><img src="images/clipman-menu.png" alt="Menu displaying the history"></div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="settings"></a>Settings</h2></div></div></div><p>
+      The settings dialog is available under the “Properties” item in the right click context menu on the main icon. It
+      allows to tweak the history and to edit actions.
+    </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="history"></a>History</h3></div></div></div><p>
+        The following table describes the available options for the history:
+      </p><div class="table"><a name="id3048488"></a><p class="title"><b>Table 1. History options in the Settings dialog</b></p><div class="table-contents"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" bgcolor="#F8F9FD" cellspacing="0" cellpadding="4" summary="History options in the Settings dialog" border="1"><colgroup><col xmlns=""><col xmlns=""></colgroup><thead xmlns=""><tr><th align="left">Options</th><th align="left">Description</th></tr></thead><tbody xmlns=""><tr><td align="left">Save on quit</td><td align="left">Keeps the history at every new session</td></tr><tr><td align="left">Add selections</td><td align="left">Adds the selections to the history</td></tr><tr><td align="left">Store an image</td><td align="left">Allows to store one image in the history</td></tr><tr><td align="left">Size of the history</td><td align="left">Sets the number of items to keep in history</td></tr></tbody></table></div></div><br class="table-break"><div class="screenshot"><div 
 class="mediaobject"><img src="images/clipman-settings-general.png" alt="Settings dialog with the General tab"></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="actions"></a>Actions</h3></div></div></div><p>
+        An action is a pair of an action name and a regular expression. Each action can have one or more commands. The
+        support of actions is optional and can be enabled or disabled through the “Enable actions” option.
+      </p><p>
+        To add an action click the Add icon, to edit an action select the action and click the Edit icon or double click
+        the action, and to remove an action select an action and click the Delete icon. By adding or editing an action a
+        new dialog is opened.
+      </p><p>
+        To learn more about actions go to <a class="xref" href="#action" title="Action">the section called “Action”</a>.
+      </p><div class="screenshot"><div class="mediaobject"><img src="images/clipman-settings-actions.png" alt="Settings dialog with the Actions tab"></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfconf"></a>Xfconf</h3></div></div></div><p>
+        Clipman uses Xfconf to store its settings in the <code class="constant">xfce4-panel</code> channel. That allows you
+        to change the settings with the tool <span class="command"><strong>xfconf-query</strong></span>. The following table lists all the
+        properties with their possible values:
+      </p><div class="table"><a name="id3048836"></a><p class="title"><b>Table 2. Xfconf Properties</b></p><div class="table-contents"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" bgcolor="#F8F9FD" cellspacing="0" cellpadding="4" summary="Xfconf Properties" border="1"><colgroup><col xmlns=""><col xmlns=""><col xmlns=""><col xmlns=""></colgroup><thead xmlns=""><tr><th align="left">Property</th><th align="left">Type</th><th align="left">Default</th><th align="left">Values</th></tr></thead><tbody xmlns=""><tr><td align="left">/plugins/clipman/settings/add-primary-clipboard</td><td align="left">bool</td><td align="left">false</td><td align="left">true to add selections</td></tr><tr><td align="left">/plugins/clipman/settings/enable-actions</td><td align="left">bool</td><td align="left">false</td><td align="left">true to enable actions</td></tr><tr><td align="left">/plugins/clipman/settings/max-images-in-history</td><td align="left">uint</td><td align="left">0</td><td a
 lign="left">0-5 number of images in history</td></tr><tr><td align="left">/plugins/clipman/settings/max-texts-in-history</td><td align="left">uint</td><td align="left">10</td><td align="left">5-100 number of texts in history</td></tr><tr><td align="left">/plugins/clipman/settings/save-on-quit</td><td align="left">bool</td><td align="left">true</td><td align="left">true to restore the history at every new session</td></tr></tbody></table></div></div><br class="table-break"><p>
+        To change a setting type the command-line:
+      </p><code class="literal">xfconf-query -c xfce4-panel -p <property> -s <value></code></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="action"></a>Action</h2></div></div></div><p>
+      An action has a human readable name that describes the pattern it is going to match. The matches are made against
+      text from the selections and the pattern is a regular expression. An action must have at least one command which
+      also has a human readable name. The matched text can be reused in the command.
+    </p><div class="screenshot"><div class="mediaobject"><img src="images/clipman-action-dialog.png" alt="Action edit dialog"></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="regexes"></a>Regular Expression</h3></div></div></div><p>
+        Basic special characters: "<span class="bold"><strong><code class="code">.?+*(|)[]\</code></strong></span>".
+      </p><div class="itemizedlist"><ul type="disc"><li>
+          ”<span class="bold"><strong><code class="code">.</code></strong></span>”: represents a single character.
+        </li><li>
+          ”<span class="bold"><strong><code class="code">?+*</code></strong></span>”: respectively means zero or one character, one or more
+          characters, and zero or more characters.
+        </li><li>
+          ”<span class="bold"><strong><code class="code">(|)</code></strong></span>”: used for grouping and substitution, the vertical bar is
+          used as an OR operation.
+        </li><li>
+          ”<span class="bold"><strong><code class="code">[^]</code></strong></span>”: used to match a character from a set of characters and
+          special characters, the circumflex is used at the start as a negation.
+        </li><li>
+          ”<span class="bold"><strong><code class="code">\</code></strong></span>”: escapes a special character.
+        </li></ul></div><p>
+        Basic alphanumeric character class: "<span class="bold"><strong><code class="code">A-Za-z0-9</code></strong></span>". Character classes
+        are used within square brackets to represent a set of characters.
+      </p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="regexes-examples"></a>Examples</h4></div></div></div><div class="itemizedlist"><ul type="disc"><li>
+            "<span class="bold"><strong><code class="code">bug ?#?[0-9]+</code></strong></span>": text "<span class="emphasis"><em>bug </em></span>", zero or one
+            space, zero or one sharp character, and one or more numbers.
+          </li><li>
+            "<span class="bold"><strong><code class="code">(http|ftp).+\.(jpg|png|gif)</code></strong></span>": text
+            "<span class="emphasis"><em>http</em></span>" or "<span class="emphasis"><em>ftp</em></span>", one or more character, a point, and the text
+            "<span class="emphasis"><em>jpg</em></span>", "<span class="emphasis"><em>png</em></span>" or "<span class="emphasis"><em>gif</em></span>".
+          </li><li>
+            "<span class="bold"><strong><code class="code">http://.{120}[^ ]+</code></strong></span>": text "<span class="emphasis"><em>http://</em></span>", 120
+            characters, and one or more characters except a space.
+          </li></ul></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="regexes-external-ressource"></a>External Ressource</h4></div></div></div><p>
+          Have a look at the <a class="ulink" href="http://en.wikipedia.org/wiki/Regular_expression" target="_top">Wikipedia
+          article</a> about regular expressions.
+        </p></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="command"></a>Command</h3></div></div></div><p>
+        A command can reuse one or more substitutions from the regular expression. The substitutions are represented by
+        ”<span class="bold"><strong><code class="code">\<number></code></strong></span>” where <number> corresponds to the
+        sub-pattern within parentheses or 0 for the complete text.
+      </p><p>
+        For example, from the simple pattern ”<span class="bold"><strong><code class="code">bug #(123)</code></strong></span>” it is possible
+        to use ”<span class="emphasis"><em><code class="code">\0</code></em></span>” for the text “bug #123” and ”<span class="emphasis"><em><code class="code">\1</code></em></span>” for the text “123”.  For the command ”<code class="code">exo-open
+        http://host/\1</code>”, the real executed command would be ”<code class="code">exo-open http://host/123</code>”.
+      </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="support"></a>Support</h2></div></div></div><p>
+      To report a bug or a feature request use the bug tracking system at <a class="ulink" href="http://bugzilla.xfce.org/" target="_top">http://bugzilla.xfce.org/</a>. If you have questions about the use of this software,
+      please ask on the <a class="ulink" href="http://foo-projects.org/mailman/listinfo/xfce" target="_top">Xfce mailing list</a>
+      or point your IRC client to <span class="bold"><strong>irc.freenode.net</strong></span>, join the channel <span class="bold"><strong>#xfce</strong></span> and ask for help.
+    </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="about"></a>About Clipman</h2></div></div></div><p>
+      Clipman was written by Mike Massonnet (<code class="email"><<a class="email" href="mailto:mmassonnet at xfce.org">mmassonnet at xfce.org</a>></code>). Visit the <a class="ulink" href="http://goodies.xfce.org/projects/panel-plugins/xfce4-clipman-plugin" target="_top">Clipman Web site</a>.
+    </p><p>
+      This documentation was written by Mike Massonnet (<code class="email"><<a class="email" href="mailto:mmassonnet at xfce.org">mmassonnet at xfce.org</a>></code>). Please send all your comments and
+      suggestions regarding this manual to <code class="email"><<a class="email" href="mailto:mmassonnet at xfce.org">mmassonnet at xfce.org</a>></code>.
+    </p><p>
+      This software is distributed under the terms of the <em class="citetitle">GNU General Public License</em> as published
+      by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+    </p><p>
+      You should have received a copy of the <em class="citetitle">GNU General Public License</em> along with this program;
+      if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA.
+    </p></div></div></body></html>

Modified: xfce4-clipman-plugin/trunk/docs/manual/C/xfce4-clipman-plugin.xml.in
--- xfce4-clipman-plugin/trunk/docs/manual/C/xfce4-clipman-plugin.xml.in	2009-04-19 19:42:23 UTC (rev 7241)
+++ xfce4-clipman-plugin/trunk/docs/manual/C/xfce4-clipman-plugin.xml.in	2009-04-19 20:33:20 UTC (rev 7242)
@@ -14,7 +14,7 @@
 translators: suit lang to your locale, don't change id
-<article id="index" lang="en">
+<article id="xfce4-clipman-plugin" lang="en">
   <!-- Header -->

More information about the Goodies-commits mailing list