Plugins-Commits July 2010

plugins-commits@lists.geany.org

2 participants
25 discussions

SF.net SVN: geany-plugins:[1479] www/staging/
by dmaphy＠users.sourceforge.net 17 Jul '10

17 Jul '10

Revision: 1479 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1479&view=rev Author: dmaphy Date: 2010-07-17 21:36:39 +0000 (Sat, 17 Jul 2010) Log Message: ----------- delete incorrect set property Property Changed: ---------------- www/staging/ Property changes on: www/staging ___________________________________________________________________ Deleted: svn:external - geanylua trunk/geany-plugins/geanylua/docs This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1478] www/staging
by dmaphy＠users.sourceforge.net 17 Jul '10

17 Jul '10

Revision: 1478 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1478&view=rev Author: dmaphy Date: 2010-07-17 21:19:18 +0000 (Sat, 17 Jul 2010) Log Message: ----------- make the geanylua directory svn:external Removed Paths: ------------- www/staging/geanylua/ Property Changed: ---------------- www/staging/ Property changes on: www/staging ___________________________________________________________________ Added: svn:external + geanylua trunk/geany-plugins/geanylua/docs This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1477] www/staging
by dmaphy＠users.sourceforge.net 17 Jul '10

17 Jul '10

Revision: 1477 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1477&view=rev Author: dmaphy Date: 2010-07-17 20:48:39 +0000 (Sat, 17 Jul 2010) Log Message: ----------- add the geanylua documentation directory. Note: this has to be kept in sync with the geanylua documentation Added Paths: ----------- www/staging/geanylua/ www/staging/geanylua/Makefile.am www/staging/geanylua/geanylua-index.html www/staging/geanylua/geanylua-input.html www/staging/geanylua/geanylua-intro.html www/staging/geanylua/geanylua-keyfile.html www/staging/geanylua/geanylua-keys.html www/staging/geanylua/geanylua-ref.html www/staging/geanylua/luarefv51.html Added: www/staging/geanylua/Makefile.am =================================================================== --- www/staging/geanylua/Makefile.am (rev 0) +++ www/staging/geanylua/Makefile.am 2010-07-17 20:48:39 UTC (rev 1477) @@ -0,0 +1,23 @@ +# don't include if geanylua's disabled, otherwise a whole bunch of empty +# directories will be created +if ENABLE_GEANYLUA +include $(top_srcdir)/build/vars.docs.mk +endif + +plugin = geanylua + +DOCFILES = \ + geanylua-index.html \ + geanylua-input.html \ + geanylua-intro.html \ + geanylua-keyfile.html \ + geanylua-keys.html \ + geanylua-ref.html \ + luarefv51.html + +if ENABLE_GEANYLUA +htmldoc_DATA = $(DOCFILES) +endif + +# make sure that these files are distributed as well +EXTRA_DIST = $(DOCFILES) Added: www/staging/geanylua/geanylua-index.html =================================================================== --- www/staging/geanylua/geanylua-index.html (rev 0) +++ www/staging/geanylua/geanylua-index.html 2010-07-17 20:48:39 UTC (rev 1477) @@ -0,0 +1,19 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<html> +<head> +<title>Lua plugin for Geany - Index</title> +</head> +<body> +<center> +<h3> +<br><br> +<a href="./geanylua-intro.html">Introduction to GeanyLua.</a><br><br> +<a href="./geanylua-ref.html">Reference to functions and variables.</a><br><br> +<a href="./geanylua-keyfile.html">Accessing keyfile configuration data.</a><br><br> +<a href="./geanylua-input.html">Creating custom dialog boxes.</a><br><br> +<a href="./geanylua-keys.html">Assigning keybindings to scripts.</a><br><br> +<a href="./luarefv51.html">Lua language quick reference.</a><br><br> +</h3> +</center> +</body> +</html> Added: www/staging/geanylua/geanylua-input.html =================================================================== --- www/staging/geanylua/geanylua-input.html (rev 0) +++ www/staging/geanylua/geanylua-input.html 2010-07-17 20:48:39 UTC (rev 1477) @@ -0,0 +1,179 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<html> +<head> +<title>The Dialog Module for Lua</title> +</head> +<body style="margin: 32px 25% 24px 5%"> +<hr><h2>The Dialog module</h2><hr> +<p> +The <tt>dialog</tt> module provides a relatively simple way to create some fairly +complex dialog boxes for user interaction.  The general idea is very loosely based on HTML forms. +<p> + + +<p>The functions are described below. The  <tt>dlg</tt>  argument expects a +dialog object, most other arguments are strings, unless otherwise noted.</p> + +Note that you can also use these functions in object-oriented style:<br> +  For instance   <tt>dialog.label(dlg, "hello")</tt>  <br> +  can also be written as   <tt>dlg:label("hello")</tt><br></p> + + +<br> + +<hr><tt><b><big>function dialog.new ( title, buttons )</big></b></tt><br><p> +Creates a new dialog object. The <tt>title</tt> string assigns the window's title bar +text for the dialog.   The  <tt>buttons</tt>  argument is a table of +strings, where each string will create a button with that text and add it to the +bottom row of the dialog. If a button's text contains an underscore, the letter after +it will be seen as an underlined accelerator for the button.</p> + +<br> +<hr><tt><b><big>function dialog.run ( dlg )</big></b></tt><br> +<p>Displays the dialog to the user and waits for submission.</p><p> +This function returns two values:  the one-based <tt>index</tt> of the the clicked button, +and a <tt>results</tt> table containing key-value pairs collected from the dialog's elements.</p><p> +If the user cancels the dialog e.g. by pressing the <tt>[Esc]</tt> key, the <tt>index</tt> will be zero, and the <tt>results</tt> table will be <tt>nil</tt>. +</p> + +<br> +<hr><tt><b><big>function dialog.label ( dlg, text )</big></b></tt><br> +<p>Adds some informative text to the dialog.</p> + + +<br> +<hr><tt><b><big>function dialog.hr ( dlg )</big></b></tt><br> +<p>Draws a horizontal separator across the dialog.</p> + +<br> +<hr><tt><b><big>function dialog.heading ( dlg, text )</big></b></tt><br> +<p>Adds a horizontal separator with some informative text below it.</p> +<p>This function is the same as calling the <tt>hr()</tt> and <tt>label()</tt> functions individually.</p> + + +<br> +<hr><tt><b><big>function dialog.text ( dlg, key, default, prompt )</big></b></tt><br> +<p>Creates a single-line text entry widget.</p> +<p> +The value of the <tt>key</tt> field in the <tt>results</tt> table will be set to the contents of the entry box.<br> +If the <tt>default</tt> string is non-nil, that text will initially be displayed in the entry box.<br> +The <tt>prompt</tt> string displays a label in front of the entry box to describe the requested input. +</p> + + +<br> +<hr><tt><b><big>function dialog.password ( dlg, key, default, prompt )</big></b></tt><br> +<p>Identical to the <tt>text()</tt> function, except that the contents of the entry box are "masked", the characters are displayed as asterisks. </p> + + +<br> +<hr><tt><b><big>function dialog.textarea ( dlg, key, default, caption )</big></b></tt><br> +<p>Creates a multi-line text entry widget.</p> +<p> +The value of the <tt>key</tt> field in the results table will be set to the contents of the text area.<br> +If the <tt>default</tt> string is non-nil, that text will initially be displayed in the text area.<br> +The <tt>caption</tt> string displays a label above the text area to describe the requested input. +</p> + +<br> +<hr><tt><b><big>function dialog.checkbox ( dlg, key, default, caption )</big></b></tt><br> +<p>Creates an on/off toggle button.</p> +<p> +If the boolean <tt>default</tt> argument is <tt>true</tt>, the button will initially be shown in a "checked" state.<br> +The <tt>caption</tt> argument is the human-readable text to be displayed next to the button. +</p><p> +Note that although the default argument is boolean, the <tt>key</tt> value returned in the + <tt>results</tt> table will be a string, either  <tt>"1"</tt>  + for checked or  <tt>"0"</tt>  for unchecked. +</p> + + + +<br> +<hr><tt><b><big>function dialog.select ( dlg, key, default, caption )</big></b></tt><br> +<p>Creates an empty drop-down list box.</p> +<p> +The contents of the <tt>key</tt> field in the <tt>results</tt> table will be set to the value of the selected item.<br> +If the <tt>default</tt> string is non-nil, the item with that value will initially be selected in the list.<br> +The <tt>caption</tt> string displays a label in front of the list box to describe the requested input. +</p> + +<br> +<hr><tt><b><big>function dialog.option ( dlg, key, value, label )</big></b></tt><br> +<p>Adds an item to the drop-down list identified by <tt>key</tt>.</p> +<p> +The returned value of <tt>key</tt> will be set to this <tt>value</tt> in the <tt>results</tt> table if this item is selected.<br> +The <tt>label</tt> argument is the human-readable text to be displayed in the list. +</p> + + +<br> +<hr><tt><b><big>function dialog.group ( dlg, key, default, caption )</big></b></tt><br> +<p>Creates an empty group for radio buttons.</p><p> +The contents of the <tt>key</tt> field in the <tt>results</tt> table will be set to +the value of the selected radio button.<br> +If the <tt>default</tt> string is non-nil, the button with that value will initially be selected in the group.<br> +The <tt>caption</tt> string displays a label above of the group to describe the requested input. +</p> + +<br> +<hr><tt><b><big>function dialog.radio ( dlg, key, value, label )</big></b></tt><br> +<p>Adds a button to the radio group identified by <tt>key</tt>.</p> +<p> +The returned value of <tt>key</tt> will be set to this <tt>value</tt> in the <tt>results</tt> table if this button is selected.<br> +The <tt>label</tt> argument is the human-readable text to be displayed next to this button. +</p> + +<br> +<hr><tt><b><big>function dialog.file ( dlg, key, default, caption )</big></b></tt><br> +<p> +Creates a single-line text entry widget, along with a "browse" button that +invokes a separate file-selection dialog. <br> +If the user selects a filename in the file dialog, the text in the +entry widget will be set to the selected filename. +</p> +<p> +The value of the <tt>key</tt> field in the <tt>results</tt> table will be set to +the contents of the entry box.<br> +</p> + + +<br> +<hr><tt><b><big>function dialog.color ( dlg, key, default, caption )</big></b></tt><br> +<p> +Creates a single-line text entry widget, along with a "choose" button that +invokes a separate color-selection dialog. <br> +If the user selects a color from the dialog, the text in the +entry widget will be set to the selected color name in  <tt>#RRGGBB</tt>  format. +</p> +<p> +The value of the <tt>key</tt> field in the <tt>results</tt> table will be set to +the contents of the entry box.<br> +</p> + + +<br> +<hr><tt><b><big>function dialog.font ( dlg, key, default, caption )</big></b></tt><br> +<p> +Creates a single-line text entry widget, along with a "select" button that +invokes a separate font-selection dialog. <br> +If the user selects a font from the dialog, the text in the +entry widget will be set to the font name. +</p> +<p> +The value of the <tt>key</tt> field in the <tt>results</tt> table will be set to +the contents of the entry box.<br> +</p> +<br> + + + +<hr> +<br><br> +<div align="right"><small>© 2007-2008 <i>Jeff Pohlmeyer </i>   </small></div> +<br><br> +<br><br><br><br> + + +</body> +</html> Added: www/staging/geanylua/geanylua-intro.html =================================================================== --- www/staging/geanylua/geanylua-intro.html (rev 0) +++ www/staging/geanylua/geanylua-intro.html 2010-07-17 20:48:39 UTC (rev 1477) @@ -0,0 +1,131 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<html> +<head> +<title>Lua plugin for Geany - Introduction</title> +</head> +<body style="margin: 32px 25% 24px 5%"> +<hr><h2>Lua scripting plugin for the Geany IDE</h2><hr> +<p> +This is a plugin for the <a href="http://www.geany.org/">Geany</a> IDE + to provide <a href="http://www.lua.org/">Lua</a> scripting. +</p><p> +To begin, you should install the plugin and the example scripts. Please +read the <tt> INSTALL </tt> file for more information. +</p><p> +The next time you start Geany, the plugin will look for a directory named <tt><b>geanylua</b></tt> +in the user's plugin directory. <br> +On Linux, this would be:   <tt>~/.geany/plugins/geanylua</tt><br> +( Unless you specify another config folder by the geany <tt>--config</tt> command line.)<br> +Any scripts found in this <tt>/plugins/geanylua/</tt> directory will appear in +the <i style="font-family:sans-serif">Tools->Lua Scripts</i> menu in Geany. +</p><p> +You can create additional scripts yourself, but all script files must have +names that end with the <tt><b>.lua</b></tt> file extension.   +The menu labels are generated from the filenames like this: +<ol> + <li> The  <tt><b>.lua</b></tt>  filename extension is removed. + <li> If the filename <i>begins</i> with two decimal digits, followed by a dot, + those three characters are stripped off. Since the list of filenames is + scanned in alphanumeric order, this convention allows for arbitrary + sorting.   For example if you wanted "<tt>Zebra</tt>" to appear before "<tt>Apple</tt>" + you could name your files   + "<tt>01.Zebra.lua</tt>"   and   "<tt>02.Apple.lua</tt>" . + <li> If the resulting label <i>ends</i> with a trailing underscore, that underscore + is removed, and replaced with an ellipsis (three dots). This notation is generally + used to indicate to the user that the menu item invokes an additional dialog. + <li> If the label contains any addtional underscores, the first (leftmost) underscore is removed, + and the letter immediately following it will be marked as the underlined + "accelerator" key for the menu item. + <li> Finally, the first letter of the label is capitalized, and all hyphens are converted to spaces. + +</ol> +<p> +No effort is made by the plugin to resolve conflicting accelerators. +While these collisions are generally harmless, you should take some +effort to make sure you don't create inaccessible (duplicate) mnemonic keys. +</p><p> +Note that if you modify an existing script, the change will take effect immediately, but if you delete an existing script, or add a new script, you must +reload the plugin in order for the change to completely take effect. +  ( The plugin can be reloaded either by restarting Geany, or +by toggling it OFF/ON via Geany's Plugin Manager, +or by calling the <tt>rescan()</tt> function from inside a script. ) +</p><p> +If there are any sub-directories that contain scripts, these will be recursed +to create sub-menus, with two exceptions - folders named  <tt><b>events</b></tt>  or  <tt><b>support</b></tt>  +will be ignored, these names are considered reserved. The <tt><b>events</b></tt> folder is +described below, and the <tt><b>support</b></tt> folder can be used to store arbitrary +user data files, modules, etc. +</p><p> +<a name="events"><br></a>The special directory  <tt>./plugins/geanylua/events/</tt>  +can contain some scripts that +will be invoked whenever the respective event is triggered by Geany. +</p><p> +Currently, there are nine valid filenames for the event scripts: +<dl compact> + <dt><tt>init.lua   </tt></dt><dd> -- Runs when the plugin is loaded.</dd> + <dt><tt>cleanup.lua   </tt></dt><dd> -- Runs when the plugin is unloaded.</dd> + + <dt><tt>saved.lua   </tt></dt><dd> -- Runs when an open document is saved.</dd> + <dt><tt>created.lua   </tt></dt><dd> -- Runs when a new document is created.</dd> + <dt><tt>opened.lua   </tt></dt><dd> -- Runs when an existing file is opened.</dd> + <dt><tt>activated.lua</tt></dt><dd> -- Runs when switching documents (notebook tabs).</dd> + + <dt><tt>proj-opened.lua   </tt></dt><dd> -- Runs when a project is opened.</dd> + <dt><tt>proj-saved.lua   </tt></dt><dd> -- Runs when a project is saved.</dd> + <dt><tt>proj-closed.lua   </tt></dt><dd> -- Runs when a project is closed.</dd> +</dl> +<p> +Note that if any of these nine files exists, it will be executed each time +its corresponding event occurs, which will result in some increase in disk activity. +In particular, you might notice a delay in startup time with the  <tt>opened.lua</tt>  +script when you open a bunch of files at once from the commmand line, etc. +</p><p> +<br><br> +Consult the <a href="geanylua-ref.html">reference</a> page for documentation of the Geany-specific Lua functions. +</p><p> + +A complete discussion of the Lua language is way beyond the scope of this +plugin package, but there is plenty of information available on the net, +For starters, you can check out: +</p><p>  +<dl> + +<dt> +The manual: +</dt> +<dd> +<a href="http://www.lua.org/manual/5.1/"> +http://www.lua.org/manual/5.1/ +</a><br><br> +</dd> + +<dt>The wiki:</dt> +<dd> +<a href="http://lua-users.org/wiki/TutorialDirectory"> +http://lua-users.org/wiki/TutorialDirectory +</a><br><br> +</dd> + +<dt> +The book: +</dt> +<dd> +<a href="http://www.lua.org/pil/"> +http://www.lua.org/pil/ +</a><br><br> +</dd> + +</dl> + +<p> +Also, be warned that the plugin does not place any restrictions on what +you can or can't do from inside a script. For example, if you decide to +call <tt> os.exit() </tt> from a script, you will end your current Geany session +immediately, and any unsaved changes will be lost! </p><p> +You should also take some caution not to write a script that hangs indefinitely, +if this happens, the only way out is to kill the editor. +</p> + + +</body> +</html> Added: www/staging/geanylua/geanylua-keyfile.html =================================================================== --- www/staging/geanylua/geanylua-keyfile.html (rev 0) +++ www/staging/geanylua/geanylua-keyfile.html 2010-07-17 20:48:39 UTC (rev 1477) @@ -0,0 +1,62 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<html> +<head> +<title>Lua plugin for Geany - The Keyfile Module</title> +</head> +<body style="margin: 32px 25% 24px 5%"> +<hr><h2>The Keyfile module</h2><hr> +<p> +The <tt>keyfile</tt> module provides a minimal Lua wrapper around the GLib library's  <tt><a href="http://www.gtk.org/api/2.6/glib/glib-Key-value-file-parser.html">GKeyFile</a></tt>  object, +for reading and writing of key-value file data, somewhat similar to MS-Windows <tt>*.INI</tt> files. +</p> +<p> +This file format is used by Geany for various configuration and project files. +Note that this module does not provide any functions for reading or writing disk files, +it simply receives or returns its file data as a single continuous string. If you need to +read or write a disk file, you can use Lua's built-in <tt>io</tt> module. +</p><p> +The functions are listed below... <br> +Optional parameters are noted in [ square ] brackets. +</p><p> +For get/set style functions, calling the function <i>with</i> the optional parameter +<i><u>assigns</u></i> a new value, calling the function <i>without</i> the optional +parameter <i><u>returns</u></i> the current value.<br> +</p><p> +Note that you can also use these functions in object-oriented style:<br> +For instance,   <tt>keyfile.value(kf,"foo","bar")</tt>  <br>can also be written +as   <tt>kf:value("foo","bar")</tt><br></p><br> + + +<hr><tt><b><big>function keyfile.new ()</big></b></tt><br> +<p>Creates a new, empty <tt>keyfile</tt> object.</p><br> + +<hr><tt><b><big>function keyfile.data ( kf [, text] )</big></b></tt>   -- <small>get/set</small><br> +<p>Returns or assigns the full text of the keyfile.</p><br> + +<hr><tt><b><big>function keyfile.groups ( kf )</big></b></tt><br> +<p>Returns an iterator to list the groups within the keyfile.</p><br> + +<hr><tt><b><big>function keyfile.keys ( kf, group )</big></b></tt><br> +<p>Returns an iterator to list the keys within the specified group.</p><br> + +<hr><tt><b><big>function keyfile.value ( kf, group, key [, value] )</big></b></tt>   -- <small>get/set</small><br> +<p>Returns or assigns the value of the specified key.</p><br> + +<hr><tt><b><big>function keyfile.comment ( kf, group, key [, comment] )</big></b></tt>   -- <small>get/set</small><br> +<p>Returns or assigns the comment for the specified key.<br> +If <tt>key</tt> is nil, it gets/sets the group comment.<br> +If <tt>group</tt> is nil, it gets/sets the comment for the file.<br> +</p><br> + +<hr><tt><b><big>function keyfile.has ( kf, group [, key] )</big></b></tt><br> +<p>Returns <tt>true</tt> if the specified group (and optionally the key) already exists.</p><br> + +<hr><tt><b><big>function keyfile.remove ( kf, group [, key] )</big></b></tt><br> +<p>Deletes the key, if specified, else it deletes the entire group.</p><br> +<hr> +<br><br> +<div align="right"><small>© 2007-2008 <i>Jeff Pohlmeyer </i>   </small></div> +<br><br> +<br><br><br><br> +</body> +</html> Added: www/staging/geanylua/geanylua-keys.html =================================================================== --- www/staging/geanylua/geanylua-keys.html (rev 0) +++ www/staging/geanylua/geanylua-keys.html 2010-07-17 20:48:39 UTC (rev 1477) @@ -0,0 +1,57 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<html> +<head> +<title>Lua plugin for Geany - Keybindings</title> +</head> +<body style="margin: 32px 25% 24px 5%"> +<hr><h2>How to assign custom key bindings to scripts</h2><hr> +Beginning with Geany version 0.14, it is now possible to integrate plugin +key bindings with Geany's built-in preferences system.   This allows for +much easier configuration, and also helps to resolve conflicts between +the editor's bindings and the bindings associated with plugins.</p> +<p> +To use the new method, you simply create a plain text file named +"<tt><b>hotkeys.cfg</b></tt>" and place it your <b>/plugins/geanylua/</b> +folder.   In this file you will list any scripts that you want to configure +keybindings for.   The scripts should be listed one per line and may be +specified either by using an absolute path, or with a path relative +to your <b>/plugins/geanylua/</b> folder.</p><p> +After reloading the plugin (or restarting Geany) the scripts will +appear in Geany's   <b>Edit->Preferences->Keybindings</b>   dialog. +  The names appearing in the dialog are derived from the filenames in a +manner similar to the way menu items are created from filenames. +<br><br> +</p> +<hr> +<h3>(The old way)</h3> +<p> +<b>Important:</b> The technique described below has been deprecated in favor +of Geany's built-in keybinding API. It is still working for now, however +you are strongly urged to convert your scripts over to the new method.   +The reference below is provided mainly for historical reasons... + +</p> +<p> +Before we begin, it is assumed that you are comfortable with your current +keybindings in the editor itself. If you are the sort who +likes to tweak your editor keybindings on a daily basis, adding script keybindings +into the mix will likely be an exercise in frustration!  This is because there is +absolutely no coordinated way to detect conflicts between the Geany keybindings + and script keybindings, or even between the individual scripts.  So you + are the only one responsible to insure that such conflicts don't occur, or at + least that they don't cause you any major problems. +</p><p> +The syntax for enabling a keybinding is quite simple, but it <i>must</i> be the very first line in the script file. +The line should begin with a double dash (the standard single-line Lua comment marker) followed by a space and the string  <tt><b>@ACCEL@</b></tt>  followed by another space and then the accelerator specification in standard +<a href="http://www.gtk.org/api/2.6/gtk/gtk-Keyboard-Accelerators.html#gtk-accelerat…">GTK syntax</a>. +</p><p> +For example, to launch a script by pressing the keys <b> <u>[Ctrl]</u>  <u>[Shift]</u>  <u>[J]</u> </b> you could write this as the first line of your script:<br> +<h3><tt>-- @ACCEL@ <Control><Shift>j</tt></h3> +<p>Note that such tags are scanned once only when the plugin is loaded, so any changes require reloading the plugin before the change will take effect. +   The plugin can be reloaded either by restarting Geany, or +by toggling it OFF/ON via Geany's Plugin Manager, +or by calling the <tt>rescan()</tt> function from inside a script. +</p> +<br><hr> +</body> +</html> Added: www/staging/geanylua/geanylua-ref.html =================================================================== --- www/staging/geanylua/geanylua-ref.html (rev 0) +++ www/staging/geanylua/geanylua-ref.html 2010-07-17 20:48:39 UTC (rev 1477) @@ -0,0 +1,1224 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<html> +<head> +<title>Lua plugin for Geany - Reference</title> +<style type="text/css"> + +</style> +</head> +<body > +<hr><h2>Lua scripting plugin for the Geany IDE</h2><hr><br> +The Geany module provides these functions and variables...<br><br><br> +<div style="background-color:#fcf4f4; margin-left:12px; margin-right:12px"> +<hr> +<table summary="quick links" width="90%" align="center" > +<tr align="center" > +<td><a href="#Editor_functions">Editor functions</a></td> +<td><a href="#System_functions">System functions</a></td> +<td><a href="#Dialog_functions">Dialog functions</a></td> +</tr></table> +<hr> +</div> +<br><br> + +<b><a name="Editor_functions"></a>Editor functions:</b> + +<table style="font-family:monospace" summary="function index" width="90%"> +<tr class="odd"> + <td>  function <a href="#activate"><b>activate</b></a> ( tab_id )<br></td> + <td class="desc">-- Focus the specified editor tab.</td> +</tr> +<tr class="even"> + <td>  function <a href="#appinfo"><b>appinfo</b></a> ()<br></td> + <td class="desc">-- Return information about the current Geany instance.</td> +</tr> +<tr class="odd"> + <td>  function <a href="#batch"><b>batch</b></a> ( start )<br></td> + <td class="desc">-- Set a marker for a reversible group of operations.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#byte"><b>byte</b></a> ( [position] )<br></td> + <td class="desc">-- Get the numeric value of the character at position.</td> +</tr> +<tr class="odd"> + <td>  function <a href="#caret"><b>caret</b></a> ( [position] )<br></td> + <td class="desc">-- Get or set the caret position.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#close"><b>close</b></a> ( [filename]|[index] )<br></td> + <td class="desc">-- Close a document.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#copy"><b>copy</b></a> ( [content]|[start,stop] )<br></td> + <td class="desc">-- Copy text to the clipboard.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#count"><b>count</b></a> ()<br></td> + <td class="desc">-- Get the number of open tabs.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#cut"><b>cut</b></a> ()<br></td> + <td class="desc">-- Cut selection to the clipboard.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#documents"><b>documents</b></a> ( [doc_id] )<br></td> + <td class="desc">-- Access the list of all open documents.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#filename"><b>filename</b></a> ()<br></td> + <td class="desc">-- Get the name of the current document.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#fileinfo"><b>fileinfo</b></a> ()<br></td> + <td class="desc">-- Return some information about the current document.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#find"><b>find</b></a> ( phrase, start, stop, options )<br></td> + <td class="desc">-- Search for text within the document.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#height"><b>height</b></a> ()<br></td> + <td class="desc">-- Get the number of lines in the current document</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#keycmd"><b>keycmd</b></a> ( command )<br></td> + <td class="desc">-- Activate a built-in Geany menu command.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#keygrab"><b>keygrab</b></a> ( [prompt] )<br></td> + <td class="desc">-- Intercept a keystroke from Geany.</td> +</tr> + + +<tr class="odd"> + <td>  function <a href="#length"><b>length</b></a> ()<br></td> + <td class="desc">-- Get number of characters in the current document.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#lines"><b>lines</b></a> ( [index] )<br></td> + <td class="desc">-- Get the text on one specific line, or all of them.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#match"><b>match</b></a> ( [position] )<br></td> + <td class="desc">-- Find a matching bracket, parenthesis, etc.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#navigate"><b>navigate</b></a> ( mode,count [,extend [,rect]])<br></td> + <td class="desc">-- Move the caret incrementally.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#newfile"><b>newfile</b></a> ( [filename] )<br></td> + <td class="desc">-- Create a new document.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#open"><b>open</b></a> ( [filename]|[index] )<br></td> + <td class="desc">-- Open or reload a file from disk.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#paste"><b>paste</b></a> ()<br></td> + <td class="desc">-- Paste text from the clipboard.</td> +</tr> + + +<tr class="even"> + <td>  function <a href="#rowcol"><b>rowcol</b></a> ( [pos]|[row,col] )<br></td> + <td class="desc">-- Translate between linear and rectangular locations.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#save"><b>save</b></a> ( [filename]|[index] )<br></td> + <td class="desc">-- Save an open document to a disk file.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#scintilla"><b>scintilla</b></a> ( msg_id, wparam, lparam )<br></td> + <td class="desc">-- Send a message directly to the Scintilla widget.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#select"><b>select</b></a> ( [[start,] stop] )<br></td> + <td class="desc">-- Get or set the selection endpoints and caret.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#selection"><b>selection</b></a> ( [content] )<br></td> + <td class="desc">-- Get or set the contents of the document's selection.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#signal"><b>signal</b></a> ( widget, signal )<br></td> + <td class="desc">-- Send a GTK signal to a Geany interface widget.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#text"><b>text</b></a> ( [content] )<br></td> + <td class="desc">-- Get or set the contents of the entire document.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#word"><b>word</b></a> ( [position] )<br></td> + <td class="desc">-- Get the word at the specified location.</td> +</tr> + +<tr class="even"> + <td>  function <a href="#xsel"><b>xsel</b></a> ( [text] )<br></td> + <td class="desc">-- Get or set the contents of the primary X selection.</td> +</tr> + +<tr class="odd"> + <td>  function <a href="#yield"><b>yield</b></a> ()<br></td> + <td class="desc">-- Refreshes the user interface.</td> +</tr> + + +<tr class="even"> + <td> </td> + <td></td> +</tr> + +<tr class="odd"> +<td>  var <a href="#caller"><b>caller</b></a> : <i>number</i><br> +</td><td class="desc">-- The index of the document that triggered an event.</td> +</tr> + +<tr class="even"> +<td>  var <a href="#rectsel"><b>rectsel</b></a> : <i>boolean</i><br> +</td><td class="desc">-- Whether or not the selection is in rectangular mode.</td> +</tr> +<tr class="odd"> +<td>  var <a href="#project"><b>project</b></a> : <i>keyfile</i><br> +</td><td class="desc">-- An object representing a project configuration event.</td> +</tr> +<tr class="even"> +<td>  var <a href="#script"><b>script</b></a> : <i>string</i><br> +</td><td class="desc">-- The filename of the currently executing Lua script.</td> +</tr> +<tr class="odd"> +<td>  var <a href="#wordchars"><b>wordchars</b></a> : <i>string</i><br></td> +<td class="desc">-- The characters that are considered part of a word.</td> +</tr> + +</table> + + +<br> +<br><br> + +<b><a name="System_functions"></a>System functions:</b> +<table style="font-family:monospace" summary="function index" width="90%"> +<tr class="odd"> +<td>  function <a href="#basename"><b>basename</b></a>( pathstr )<br></td> +<td class="desc">-- Extract the filename portion of a path string.</td> +</tr> +<tr class="even"> +<td>  function <a href="#dirlist"><b>dirlist</b></a>( path )<br></td> +<td class="desc">-- List the contents of a folder.</td> +</tr> +<tr class="odd"> +<td>  function <a href="#dirname"><b>dirname</b></a>( pathstr )<br></td> +<td class="desc">-- Get the directory portion of a file's path.</td> +</tr> +<tr class="even"> +<td>  function <a href="#fullpath"><b>fullpath</b></a>( filename )<br></td> +<td class="desc">-- Get the full path to a file.</td> +</tr> +<tr class="odd"> + <td>  function <a href="#launch"><b>launch</b></a> ( program [, arg1 [, arg2, ...]] )<br></td> + <td class="desc">-- Execute an external application.</td> +</tr> +<tr class="even"> + <td>  function <a href="#optimize"><b>optimize</b></a> ()<br></td> + <td class="desc">-- Run a script without the debug hook.</td> +</tr> +<tr class="odd"> + <td>  function <a href="#rescan"><b>rescan</b></a> ()<br></td> + <td class="desc">-- Regenerate the scripts menu.</td> +</tr> +<tr class="even"> + <td>  function <a href="#stat"><b>stat</b></a> ( filename [, lstat] )<br></td> + <td class="desc">-- Retrieve some information about a disk file.</td> +</tr> +<tr class="odd"> + <td>  function <a href="#timeout"><b>timeout</b></a> ( seconds )<br></td> + <td class="desc">-- Control maximum time allowed for script execution.</td> +</tr> +<tr class="even"> + <td>  function <a href="#wkdir"><b>wkdir</b></a> ( [folder] )<br></td> + <td class="desc">-- Get or set the current working directory.</td> +</tr> +<tr class="even"> + <td> </td> + <td></td> +</tr> +<tr class="odd"> +<td>  var <a href="#dirsep"><b>dirsep</b></a> : <i>string</i><br> +</td><td class="desc">-- The default filesystem path separator, "<tt>/</tt>" or "<tt>\</tt>".</td> +</tr> +</table> + +<br> +<br><br> + +<b><a name="Dialog_functions"></a>Dialog functions:</b> +<table style="font-family:monospace" summary="function index" width="90%"> +<tr class="odd"> +<td>  function <a href="#choose"><b>choose</b></a> ( prompt, items )</td> +<td class="desc" width="33%">-- Select an item from the list.</td> +</tr> +<tr class="even"> +<td>  function <a href="#confirm"><b>confirm</b></a> ( title, question, default )</td> +<td class="desc">-- Ask a yes-or-no question.</td> +</tr> +<tr class="odd"> +<td>  function <a href="#input"><b>input</b></a> ( [prompt] [,default] )</td> +<td class="desc">-- Prompt to enter some text.</td> +</tr> +<tr class="even"> +<td>  function <a href="#message"><b>message</b></a> ( [title,] message )</td> +<td class="desc">-- Display some information.</td> +</tr> +<tr class="odd"> +<td>  function <a href="#pickfile"><b>pickfile</b></a> ( [mode [,path [,filter]]] )</td> +<td class="desc">-- Select a file from disk.</td> +</tr> +<tr class="even"> + <td> </td> + <td></td> +</tr> +<tr class="odd"> +<td>  var <a href="#banner"><b>banner</b></a> : <i>string</i><br></td> +<td class="desc">-- The window title for all dialogs.</td> +</tr> +</table><br> +If you need a more advanced dialog creation API, check out the +<tt><big><a href="geanylua-input.html">dialog</a></big></tt> module. +<br><br><br> +<hr> + + +<hr><a name="activate"></a><h3><tt>geany.activate ( tab_id )</tt></h3><p> +Activates the document specified by <tt><b>tab_id</b></tt>. +</p> +<p> +If <tt><b>tab_id</b></tt> is a number, it activates the document at that index. +   A <i>positive</i> number refers to the internal document array, and a <i>negative</i> +number refers to the (absolute) GtkNotebook index.<br> +Note that the indices begin at <tt>(1)</tt> and <tt>(-1)</tt> respectively. +</p> +<p> +If <tt><b>tab_id</b></tt> is a string, the function will try to activate the +notebook tab whose filename matches that string.<br> +( The full pathname is required! ) +</p><p> +Returns <tt><b>true</b></tt> on success, or <tt><b>false</b></tt> if the tab could not be found. +</p><br><br> + +<a name="appinfo"></a><hr><h3><tt>geany.appinfo ()</tt></h3><p> +Returns a Lua table containing information about the currently running Geany instance.<br><br> +The <tt>appinfo</tt> table contains the following fields: +<br>  +<table border="0" summary="appinfo table fields"> +<tr><td width="5%"></td><td><tt>debug</tt></td><td> -- <tt>true</tt> if Geany is running in debug mode.</td></tr> +<tr><td width="5%"></td><td><tt>configdir   </tt></td><td> -- User's local configuration folder.</td></tr> +<tr><td width="5%"></td><td><tt>datadir</tt></td><td> -- System-wide configuration folder.</td></tr> +<tr><td width="5%"></td><td><tt>docdir</tt></td><td> -- Location of the Geany help files.</td></tr> +<tr><td width="5%"></td><td><tt>scriptdir</tt></td><td> -- Top level folder for GeanyLua scripts.</td></tr> +<tr><td width="5%"></td><td><tt>tools</tt></td><td> -- Table of user-configured tools. (see below)</td></tr> +<tr><td width="5%"></td><td><tt>template</tt></td><td> -- Table of user's template information. (see below)</td></tr> +<tr><td width="5%"></td><td><tt>project</tt></td><td> -- Table of current project information. (see below)</td></tr> +</table> +<p> +————</p><p> +The <tt>tools</tt> sub-table contains the following fields: +<br>  +<table border="0" summary="tools table fields"> +<tr><td width="15%"></td><td><tt>browser</tt> </td></tr> +<tr><td width="15%"></td><td><tt>term</tt> </td><td></tr> +<tr><td width="15%"></td><td><tt>print</tt> </td></tr> +<tr><td width="15%"></td><td><tt>grep</tt> </td></tr> +<tr><td width="15%"></td><td><tt>action</tt> </td></tr> +</table> +<p> +————</p><p> +The <tt>template</tt> sub-table contains the following fields: +<br>  +<table border="0" summary="template fields"> +<tr><td width="15%"></td><td><tt>developer</tt> </td></tr> +<tr><td width="15%"></td><td><tt>company</tt> </td></tr> +<tr><td width="15%"></td><td><tt>mail</tt> </td><td></tr> +<tr><td width="15%"></td><td><tt>initial</tt> </td></tr> +<tr><td width="15%"></td><td><tt>version</tt> </td></tr> +</table> +<p> +————</p><p> +The <tt>project</tt> sub-table *might* contain the following fields: +<br>  +<table border="0" summary="template fields"> +<tr><td width="15%"></td><td><tt>name</tt> </td><td> -- Name of project.</td></tr> +<tr><td width="15%"></td><td><tt>desc</tt> </td><td> -- Project description.</td></tr> +<tr><td width="15%"></td><td><tt>file</tt> </td><td> -- Project filename.</td></tr> +<tr><td width="15%"></td><td><tt>base</tt> </td><td> -- Base path of project files.</td></tr> +<tr><td width="15%"></td><td><tt>mask</tt> </td><td> -- Semicolon-delimited list of filetypes.</td></tr> +</table> +<p> +<b>* Important:</b> The entire <tt>project</tt> sub-table will be <tt>nil</tt> if there is no open project!<br> +<br><br> + +<a name="basename"></a><hr><h3><tt>geany.basename ( pathstr )</tt></h3><p> +Returns the rightmost filename portion of <tt>pathstr</tt>, with the directory portion removed. +</p><br><br> + +<hr><a name="batch"></a><h3><tt>geany.batch ( start )</tt></h3><p> +This function marks the beginning or ending of a group of operations<br> +that you want the user to be able to undo in a single step.</p> +<p> +If the <tt><b>start</b></tt> argument is <tt><b>true</b></tt>, +it marks the <i>beginning</i> of a group of operations.</p> +<p> +If the <tt><b>start</b></tt> argument is <tt><b>false</b></tt>, +it marks the <i>ending</i> of a group of operations. +</p><br><br> + +<hr><a name="byte"></a><h3><tt>geany.byte ( [position] )</tt></h3><p> +When called with no arguments, returns the numeric value of the character at +the current caret position.</p><p> +When called with a numeric <tt><b>position</b></tt> argument, returns the +value of the character at that position. +</p><br><br> + + +<hr><a name="caret"></a><h3><tt>geany.caret ( [position] )</tt></h3><p> +When called with no arguments, returns the current caret position.</p> +<p> +When called with a single numeric argument, moves the caret to that position.<br> +Out-of-range values are adjusted to the nearest possible position (i.e. the start or end of the document.) +</p><br><br> + +<a name="close"></a><hr><h3><tt>geany.close ( [filename]|[index] )</tt></h3> +<p> +When called with no arguments, closes the currently active document. +</p> +<p> +When called with a numeric argument, closes the file of that document index. +</p> +<p> +When called with a string argument, it will close that named document. +</p> +<p> +If the document has unsaved changes, the user will be prompted to save before closing,<br> +and will also be given the option to cancel the operation.   To avoid this, you might <br> +want to consider using the <tt>geany.save()</tt> function beforehand. +</p> +<p> +Returns <tt><b>true</b></tt> if the document was successfully closed, or <tt><b>false</b></tt> otherwise.</p> +<br><br> + +<hr><a name="copy"></a><h3><tt>geany.copy ( [content]|[start,stop] )</tt></h3><p> +When called with no arguments, copies the current selection to the clipboard. +</p><p> +When called with a single string argument, copies the contents of that string to the clipboard. +</p> +<p> +When called with two arguments, copies the portion of the current document's text +that lies between the <tt><b>start</b></tt> and <tt><b>stop</b></tt> positions. +(Both positions must be positive numbers.) +</p> +<p> +Returns the number of characters copied, or <tt><b>nil</b></tt> if there is no open document. +</p> +<br><br> + +<hr><a name="count"></a><h3><tt>geany.count ()</tt></h3><p> +Returns the number of open documents. +</p><br><br> + + +<hr><a name="cut"></a><h3><tt>geany.cut ()</tt></h3><p> +Cuts the current selection to the clipboard. +</p> +<p> +Returns the number of characters cut, or <tt><b>nil</b></tt> if there is no open document. +</p><br><br> + + +<a name="dirlist"></a><hr><h3><tt>geany.dirlist ( path )</tt></h3><p> +Returns an iterator function that will be called once for each entry (file or subdirectory) in the specified folder. +The iterator produces only the name of each entry, and in no particular order.</p><p> +This function will generate an error dialog if the specified folder does not exist or cannot be accessed. +</p><br><br> + +<a name="dirname"></a><hr><h3><tt>geany.dirname ( pathstr )</tt></h3><p> +Returns the directory portion of <tt>pathstr</tt>, with the rightmost filename portion removed. +</p><br><br> + +<hr><a name="documents"></a><h3><tt>geany.documents ( [doc_id] )</tt></h3><p> +When called with a numeric argument, returns the full path and filename of <br> +the document at the index specified by <tt><b>doc_id</b></tt>. +</p> +<p> +When called with a string argument, returns the numeric index of the document with the<br> +path/filename that matches the <tt><b>doc_id</b></tt> string.<br> +</p> +<p> +Either of the two forms above may also return <tt><b>nil</b></tt> if the argument cannot be matched.</p> +<p> +Note: The <i>index</i> here refers to the editor's internal document array, +and might not be <br> +the same as the notebook tab index, since the tabs can be re-ordered by the user. +</p> +<p> +<br><br> +When called with no arguments, the function returns an iterator to list the full path and filename +of each document currently open in the editor.</p><p> +For example:</p> +<pre> + +for filename in geany.documents() +do + print(filename) +end +</pre> + +<br><br> + + +<a name="filename"></a><hr><h3><tt>geany.filename ()</tt></h3><p> +Returns the full path and filename of the current Geany document.</p><p> +If there is no open document, or if the current document is untitled, returns <tt><b>nil</b></tt>. +</p><br><br> + + +<a name="fileinfo"></a><hr><h3><tt>geany.fileinfo ()</tt></h3><p> +Returns a Lua table containing various information about the current document.<br> +If there is no open document, returns <tt><b>nil</b></tt>. +</p><p> +The returned table contains the following fields: +<table border="0" summary="fileinfo fields"> +<tr><td width="5%"></td><td><tt>name</tt> </td><td> -- The filename, without the path.</td></tr> +<tr><td width="5%"></td><td><tt>path</tt> </td><td> -- The full path of the file's directory, including the trailing slash.</td></tr> +<tr><td width="5%"></td><td><tt>ext</tt> </td><td> -- The file extension, including the dot, e.g. "<b>.DLL</b>" or "<b>.txt</b>"</td></tr> +<tr><td width="5%"></td><td><tt>type</tt> </td><td> -- A one-word description of the filetype, e.g. "<b>C</b>" or "<b>Python</b>".</td></tr> +<tr><td width="5%"></td><td><tt>desc</tt> </td><td> -- A longer description of the filetype, e.g. "<b>Lua source file</b>" or "<b>Cascading StyleSheet</b>".</td></tr> +<tr><td width="5%"></td><td><tt>opener</tt> </td><td> -- The string used to begin a comment, e.g. "<b class="desc"></b>".</td></tr> +<tr><td width="5%"></td><td><tt>action</tt> </td><td> -- The action command as executed by the context menu</td></tr> + +<tr><td width="5%"></td><td><tt>ftid</tt> </td><td> -- The unique numeric filetype identifier, as used by Geany.</td></tr> +<tr><td width="5%"></td><td><tt>encoding</tt> </td><td> -- The file's in-memory encoding. (may differ from the on-disk encoding.)</td></tr> +<tr><td width="5%"></td><td><tt>bom</tt> </td><td> -- <tt><b>true</b></tt> if the file contains a <b>B</b>yte-<b>O</b>rder <b>M</b>arker.</td></tr> +<tr><td width="5%"></td><td><tt>changed</tt> </td><td> -- <tt><b>true</b></tt> if the file has unsaved changes.</td></tr> +<tr><td width="5%"></td><td><tt>readonly</tt> </td><td> -- <tt><b>true</b></tt> if the in-memory document is tagged as read-only.</td></tr> +</table> +<br><br> + + + +<a name="find"></a><hr><h3><tt>geany.find ( phrase, start, stop, options )</tt></h3><p> +Searches within the current document for the string <tt>phrase</tt>, beginning at <br> +the numeric <tt>start</tt> position and ending at the <tt>stop</tt> position.<br> +( To search backwards, specify a <tt>start</tt> value greater than <tt>stop</tt> . )<br><br> +</p><p> + + +The <tt>options</tt> argument is a table, each element may be one of the following strings:<br> + +<table border="0" summary="search options"> +<tr><td width="3%"> </td><td width="20%"><tt> +"matchcase"</tt></td><td> -- A match only occurs with text that matches the case of the search string. +</td></tr> +<tr><td> </td><td><tt> +"wholeword" </tt> </td><td> -- A match only occurs if the characters before and after are not word characters. +</td></tr> +<tr><td> </td><td><tt> +"wordstart" </tt> </td><td> -- A match only occurs if the character before is not a word character. +</td></tr> +<tr><td> </td><td><tt> +"regexp" </tt> </td><td> -- The search string should be interpreted as a regular expression. +</td></tr> +<tr><td> </td><td><tt> +"posix" </tt> </td><td> -- Use bare parentheses +<tt><b>(</b></tt> +<tt><b>)</b></tt> +for tagged sections rather than the escaped <tt><b>$</b></tt> and <tt><b>$</b></tt>. +</td></tr> +<tr><td colspan="3"> +( The empty set <tt><b>{}</b></tt> may also be specified, to search using the default options. ) +</td></tr> +</table> +<p> +If a match is found, the function returns the starting and ending positions of the match,<br> +otherwise it returns <tt><b>nil</b>.</tt> +</p><p> +For example, to select the first case-sensitive whole-word match of the string +  '<b>foobar</b>'  you could use something like this:</p> +<pre> + a,b = geany.find( "foobar", 0, geany.length(), {"wholeword","matchcase"} ) + if (a) then + geany.select(a,b) + else + geany.message("Search phrase not found.") + end +</pre><br><br> + + + +<a name="fullpath"></a><hr><h3><tt>geany.fullpath ( filename )</tt></h3><p> +Returns the fully canonicalized form of the path to an <i>existing</i> named file, or <tt>nil</tt> if the path could not be found. +</p><br><br> + + + + +<a name="height"></a><hr><h3><tt>geany.height ()</tt></h3><p> +Returns the total number of lines in the current document. +</p><br><br> + +<a name="keycmd"></a><hr><h3><tt>geany.keycmd ( command )</tt></h3><p> +Activates (runs) one of Geany's built-in menu commands.</p><p> +The <tt>command</tt> argument should be one the string constants defined in the +"<tt>glspi_keycmd.h</tt>" header from the plugin sources.   +For example, to display Geany's preferences dialog, you could use:</p><p> +<tt>   geany.keycmd("MENU_PREFERENCES")</tt> +</p> +<p> +This function raises an error if the command argument is invalid. +</p><br><br> + + + + + +<a name="keygrab"></a><hr><h3><tt>geany.keygrab ( [prompt] )</tt></h3><p> + +Intercepts the next keyboard key pressed, preventing the editor from receiving +that keyboard event.</p> +<p> +The function returns the value of the pressed key as a string, +alphanumeric keys will return their keyboard value, such as + <tt>"a"</tt>  or  <tt>"1"</tt>  while other keys may +return a string describing the key, such +as <tt>"Return"</tt> or <tt>"Escape"</tt>.   +( Consult the file  <tt>gdk/gdkkeysyms.h</tt>  in the GTK sources for some idea of the key names. ) +</p><p> +It should be possible to use this function on keyboards other than US, +although this hasn't been tested, and scripts written for one keyboard +might not be portable to another system. </p> +<p>Key combinations with the modifier keys  <b>[Ctrl]</b>  or  <b>[Alt]</b>  +are not supported.   Detection of the  <b>[Shift]</b>  key state is somewhat supported, +although currently it may not be completely reliable. +  Repeatedly calling this function in rapid succession (as in a loop) may also result in some "dropped" keys, +so for best results its use should be confined to detecting a single "lowercase" key press.</p><p> + +If the optional <tt>prompt</tt> string argument is present, its text will be shown +as a "calltip" near the upper left-hand area of the current document. +(but only if there is a document open.)</p> +<p> +This function was primarily intended for assigning "chained" sets of hot key +options, in conjunction with user-defined <a href="geanylua-keys.html">keybindings</a>. + + +</p> +<p> + +</p><br><br> + + + + + +<a name="launch"></a><hr><h3><tt>geany.launch ( program [, arg1 [, arg2, ...]] )</tt></h3><p> +Executes the external application specified by  <tt>program</tt>,  +passing any additional arguments to its command line. +</p> +<p> +Returns <tt>true</tt> if the process was succesfully created, else it returns <tt>false</tt> plus an error message.</p> +<p> +For example:<br><tt> +  local ok,msg = geany.launch("firefox", "http://www.yahoo.com/")<br> +  if not ok then geany.message(msg) end</tt> +</p> +<p> +This function returns immediately, regardless of the status of the newly-created process. +If you need to wait for a process to complete before returning, +use Lua's built-in  <tt>os.execute()</tt>  function instead. +</p> +<p>Note that using this function on MS-Windows might require installing the +"<b><tt>gspawn-win32-helper.exe</tt></b>" program somewhere in your <tt>PATH</tt>.   +( It is included in the GTK/GLib package. )</p> +<br><br> + + +<a name="length"></a><hr><h3><tt>geany.length ()</tt></h3><p> +Returns the text length of the current document. +</p><br><br> + + +<a name="lines"></a><hr><h3><tt>geany.lines ( [index] )</tt></h3><p> +When called with one argument, returns a string containing the text at +the specified line number of the current document.<br> +It may also return <tt><b>nil</b></tt> if there is no open document, +or if the specified <tt><b>index</b></tt> is outside the range of lines. +</p><p> +When called without any arguments, it returns an iterator that steps +through each line of the current document. <br> +So you can use it like this:<pre> +for line in geany.lines() +do + print(line) +end +</pre> +<br><br> + + +<a name="match"></a><hr><h3><tt>geany.match ( [position] )</tt></h3><p> +Attempts to find a corresponding matching brace from the given <tt><b>position</b></tt> of one brace.<br> +( If the <tt><b>position</b></tt> argument is omitted, the current caret position is assumed. ) +</p> +<p>The brace characters handled are: <tt><b>  () [] {} <></b></tt></p> +<p> The search is forwards from an opening brace and backwards from a closing brace.<br> +If the character at <tt><b>position</b></tt> is not a brace character, or a matching brace cannot be found,<br> +the return value is -1. Otherwise, the return value is the position of the matching brace. +</p><br><br> + + + +<a name="navigate"></a><hr><h3><tt>geany.navigate ( mode, count [,extend [,rect]] )</tt></h3><p> +Moves the caret incrementally.</p> +<p> +The  <tt><b>mode</b></tt>  argument must be one of the following strings: +<ul> +<li><tt>"char"</tt>   -- Move by characters.</li> +<li><tt>"part"</tt>   -- Move by segments in <big>MixedCase</big> or <big>under_score</big> style identifiers.</li> +<li><tt>"word"</tt>   -- Move by words.</li> +<li><tt>"edge"</tt>   -- Move to beginning or end of current line.</li> +<li><tt>"line"</tt>   -- Move up or down by lines.</li> +<li><tt>"para"</tt>   -- Move up or down by paragraphs.</li> +<li><tt>"page"</tt>   -- Move up or down by pages.</li> +<li><tt>"body"</tt>   -- Move to the beginning or end of the entire document.</li> +</ul> +<p> +If the numeric <tt><b>count</b></tt> argument is <i>positive</i>, the caret is moved <i>forward</i> or <i>down</i> by that many steps.<br> +If it is <i>negative</i>, the caret is moved <i>backward</i> or <i>up</i> by that many steps.<br> +( If it is <i>zero</i> there is not much point in using this function. )<br> +There is also no point in using a magnitude greater than <i>one</i> for the <tt>"edge"</tt> or <tt>"body"</tt> modes. +</p> +<p> +If the optional boolean <tt><b>extend</b></tt> argument is <tt><b>true</b></tt>, +the selection is expanded or contracted to the new caret position, +similar to holding down the  <big>[Shift]</big>  key when navigating with the keyboard. +</p><p> +If the optional boolean <tt><b>rect</b></tt> argument is also <tt><b>true</b></tt>, +the selection is treated as <i>rectangular</i> rather than <i>linear</i>.<br> +( Rectangular selection is only supported for <tt>char</tt>, <tt>edge</tt>, +<tt>line</tt>, or <tt>page</tt> modes. ) +</p> +<br><br> + + +<a name="newfile"></a><hr><h3><tt>geany.newfile ( [filename] )</tt></h3><p> +When called with one argument, creates a new document with the specified +<tt>filename</tt>. </p><p>When called with no arguments, creates a new, untitled document. +</p><br><br> + + + +<a name="open"></a><hr><h3><tt>geany.open ( [filename]|[index] )</tt></h3><p> +When called with no arguments, reloads the currently active document from disk. +</p><p> +When called with a numeric argument, reloads the file of that document index. +</p><p> +When called with a string argument, it will reload that filename if it is already open, +or otherwise it will open it in a new tab. <br> +It will not create a non-existent file, for that you need to use <tt>geany.newfile()</tt> +</p> +<p> +Returns the <i>one-based</i> document index on success, +or <i>zero</i> if the document could not be opened or reloaded.</p> +<br><br> + +<a name="optimize"></a><hr><h3><tt>geany.optimize ()</tt></h3><p> +Disables the Lua interpreter's "debug hook", the thing that +allows the plugin to track line number information and elapsed time.</p><p> +The advantage of calling <tt>optimize()</tt> is that a lengthy, CPU-intensive +script can sometimes run much faster. +</p><p> +The disadvantage is that you lose the line number information that helps in +debugging your script, and the built-in protection against things like endless loops. +For this reason you should only use this function if you really need it, and +only when you are reasonably sure that your script doesn't contain any errors. +</p><p>For best results this function should be called at the very +beginning of the script. + +</p> +<br><br> + +<a name="paste"></a><hr><h3><tt>geany.paste ()</tt></h3><p> +Pastes the text from the clipboard into the active document at the current caret position,<br> +replacing any current selection. +</p><p> +Returns <tt><b>nil</b></tt> if there is no open document, +or if the document is marked read-only.</p><p> +Otherwise it returns the effective change in the document's size. <br> +( Which may actually be negative, if the clipboard content size is less than the prior selection. ) +</p> +<br><br> + + +<a name="rescan"></a><hr><h3><tt>geany.rescan ()</tt></h3><p> +Scans the scripts folder, rebuilds the <b><i>Tools-><u>L</u>ua Scripts</i></b> menu, +and re-initializes the GTK accelerator group (keybindings) associated with the plugin. +</p><br><br> + + +<a name="rowcol"></a><hr><h3><tt>geany.rowcol ( [position]|[line,column] )</tt></h3><p> +This function translates between line/column coordinates and linear position (offset from beginning of document).<br> +</p> +<p>The syntax takes three forms:</p> +<ul> +<li> +With <i>no</i> arguments, it returns the rectangular coordinates of the current caret position:<br> +<tt>  line, column = geany.rowcol()</tt><br> +( Note that in Lua a single function call like the one above returns both values! )<br><br> +</li> +<li> +With <i>one</i> argument, it it returns the rectangular coordinates of the specified <tt><b>position</b></tt> +argument:<br> +<tt>  line, column = geany.rowcol(position)</tt><br><br> +</li> + +<li> +With <i>two</i> arguments, it translates from the given <tt><b>line</b></tt> and <tt><b>column</b></tt> +to the linear position:<br> +<tt>  position = geany.rowcol(line,column)</tt> +</li> +</ul> +<p> +Out-of-range arguments are adjusted to the nearest valid possibility. +</p><br><br> + +<a name="save"></a><hr><h3><tt>geany.save ( [filename]|[index] )</tt></h3><p> +When called with no arguments, saves the currently active document to disk. +</p><p> +When called with a numeric argument, saves the file of that document index. +</p><p> +When called with a string argument, it will save that named document ( That is, of course, if it is open. ) +</p> +<p> +Returns <tt><b>true</b></tt> on success, or <tt><b>false</b></tt> if the document could not be saved.</p> +<br><br> + + +<a name="scintilla"></a><hr><h3><tt>geany.scintilla ( msg_id [, wparam [, lparam]] )</tt></h3><p> +<i>Power users only!</i> +</p> +<p> +Sends a <tt><b>SCI_*</b></tt> message directly to the Scintilla widget of the active document.</p> +<p> +The <tt><b>msg_id</b></tt> can be a numeric value, or a case-insensitive string with or +without the <tt>"SCI_"</tt> prefix, +such as <tt>"SCI_POSITIONFROMPOINT"</tt>, <tt>"POSITIONFROMPOINT"</tt>, or <tt>"PositionFromPoint"</tt>. +</p><p> +The wparam, lparam, and return types depend on the particular message, based on the +interface described in the  "<tt><small>Scintilla.iface</small></tt>"  file from the Scintilla sources. +</p><p> +For API calls which expect a pre-allocated char buffer as the lparam, the allocation is +automatically managed +by the GeanyLua module, your lparam is ignored, and the return value is a Lua string.  +In cases where the length is specified +in the wparam, the null terminator is not counted - if you ask for 3 chars, you get 3 chars. +</p><p> +Currently only string, numeric, and boolean types are supported, any API call that +expects or returns complex types will result in an error.  This function tries hard to +protect from garbage being passed to +Scintilla, but ultimately <i>you</i> are expected to know what you're doing! +</p><br><br> + +<a name="select"></a><hr><h3><tt>geany.select ( [[start,] stop]] )</tt></h3><p> +When called with no arguments, returns the beginning <b><i>and</i></b> ending points of +the current selection, in the form:<br> +<tt> +  start, stop = geany.select() +</tt><br> +( Note that in Lua a single function call like the one above returns both values! )</p> +<p> +To find out if the selection is rectangular, test the +boolean variable <tt><b>geany.rectsel</b></tt> immediately after this call. +</p> +<p><br> +If this function is called with two arguments, it creates a new selection in +the current document. +<br> The selection is <i>anchored</i> at the <tt><b>start</b></tt> +position, and <i>extended</i> to the <tt><b>stop</b></tt> position.</p><p> +The boolean variable <tt><b>geany.rectsel</b></tt> can be set prior to this +call to control +whether this selection is created in normal or rectangular mode. +</p> +<p><br> +If called with one argument, the caret is moved to that position, but no selection is created,<br> +and any existing selection is lost. +</p> +<p> +<br> +Note that in all cases, the value of <tt><b>stop</b></tt> is considered to be +the end of the selection where the caret is located.</p><p> +So, if <tt><b>stop</b></tt> is less than <tt><b>start</b></tt>, the caret is postioned +at the <i>beginning</i> of the selection, <br>similar to a selection created by +dragging the mouse <i>backwards</i> in the document.</p> +<p> +<b>Hint:</b> To select the entire document, you can use:   +<tt>geany.select( 0, geany.length() )</tt> +</p><br><br> + + +<a name="selection"></a><hr><h3><tt>geany.selection ( [content] )</tt></h3><p> +When called with no arguments, returns the selected text in the current Geany +document as a string. <br> +Returns the empty string if no text is selected, or <tt><b>nil</b></tt> +if there is no open document. +</p><p>When called with one argument, the selected text of the current document +will be replaced with the specified <tt>content</tt> +string.<br> +If no text is currently selected, the text will be inserted at the current +(caret) position. +</p><br><br> + +<a name="signal"></a><hr><h3><tt>geany.signal ( widget, signal )</tt></h3><p> +Emits a GTK signal to a given widget in the Geany user interface.</p><p> +The <tt>widget</tt> argument is a string identifying the widget by its Glade  <tt><b>"id"</b></tt>  attribute.<br> +The <tt>signal</tt> argument is a string identifying the signal to be emitted. +</p><p> +This function was primarily intended for activating Geany's builtin menu commands.<br> +For instance, to display the file open dialog you could do:<br> +<tt>   geany.signal("menu_open1", "activate")</tt> +</p><p> +The function does not return a value, but may trigger an error message if the +widget name is not found or the signal name is not valid for the specified widget. +   +Note that it is generally easier and more reliable to use the <tt>keycmd()</tt> function whenever possible. +</p><br><br> + +<a name="stat"></a><hr><h3><tt>geany.stat( filename [, lstat] )</tt></h3><p> +Returns a table providing some (limited) information about the specified file.<br> +If the information could not be obtained, the function returns <tt>nil</tt> plus an string describing the reason for failure. +</p> +<p> +If the file is a symbolic link, and the optional  <tt>lstat</tt>  argument is <tt>true</tt>, the +information is returned about the link itself, otherwise the table provides +information about the file that the link points to. +</p><p> +The returned table contains the following fields: +<table border="0" summary="stat table fields"> +<tr><td width="5%"></td><td><tt>size </tt></td><td> -- The size of the file, in bytes.</td></tr> +<tr><td width="5%"></td><td><tt>time </tt></td><td> -- Modification time, in seconds from the epoch.</td></tr> +<tr><td width="5%"></td><td><tt>type </tt></td><td> -- A single-character string that denotes the type of file (see below)</td></tr> +<tr><td width="5%"></td><td><tt>read </tt></td><td> -- <tt>true</tt> if the effective user can read from the file.</td></tr> +<tr><td width="5%"></td><td><tt>write</tt></td><td> -- <tt>true</tt> if the effective user can modify the file.</td></tr> +<tr><td width="5%"></td><td><tt>exec </tt></td><td> -- <tt>true</tt> if the effective user can execute the file.</td></tr> +</table> +<p><br> +The <tt>type</tt> field contains one of the following values: +<table border="0" summary="stat table type field values"> +<tr><td width="5%"></td><td><tt>"b" </tt></td><td> -- a block-oriented device.</td></tr> +<tr><td width="5%"></td><td><tt>"c" </tt></td><td> -- a character-special device.</td></tr> +<tr><td width="5%"></td><td><tt>"d" </tt></td><td> -- a directory.</td></tr> +<tr><td width="5%"></td><td><tt>"f" </tt></td><td> -- a FIFO or named pipe.</td></tr> +<tr><td width="5%"></td><td><tt>"l" </tt></td><td> -- a symbolic link.</td></tr> +<tr><td width="5%"></td><td><tt>"r" </tt></td><td> -- a regular file.</td></tr> +<tr><td width="5%"></td><td><tt>"s" </tt></td><td> -- a socket.</td></tr> +</table> +<p> +Note that this function does not support symbolic links or ACL permissions on MS-Windows. +</p><br><br> + + + +<a name="text"></a><hr><h3><tt>geany.text ( [content] )</tt></h3><p> +When called with no arguments, returns the entire text of the currently +active Geany document as a string.<br>( Returns <tt><b>nil</b></tt> +if there is no open document.) +</p><p> +When called with one argument, the entire text of the current +document is replaced with the specified <tt>content</tt> string. +</p><br><br> + + +<a name="timeout"></a><hr><h3><tt>geany.timeout ( seconds )</tt></h3><p> + +Attempts to control the maximum time allowed, in whole seconds, for the current script to +finish execution.</p><p> +By default, scripts are allowed 15 seconds to complete, but if your script needs +more time, you can increase it here. +</p><p> +Note that the interpreter is only able to trigger this "timeout exceeded" error when it is actually processing instructions. +This provides protection against things like accidentally creating an endless loop, +but it might still be possible to create a script that hangs indefinitely. ( For instance if +you call <tt>io.read()</tt> without access to a terminal. )</p><p> +The internal timer is paused whenever one of the dialog box functions is called, +to allow the user time to respond. +</p><p> +Setting the timeout to zero will disable it completely, that is, the script will never time out. +</p><p><br><br> + +<a name="wkdir"></a><hr><h3><tt>geany.wkdir ( [folder] )</tt></h3><p> +When called with no arguments, returns the current working directory.</p> +<p> +When called with one argument, tries to change into that <tt>folder</tt>, +and returns <tt>true</tt> on sucess, or <tt>false</tt> plus an error message +on failure. +</p><br><br> + +<a name="word"></a><hr><h3><tt>geany.word ( [position] )</tt></h3><p> +When called with no arguments, returns the word at the current caret position. +</p><p> +When called with one argument, returns the word at the specified +<tt><b>position</b></tt>. +</p><p> +This function can return an empty string if the position is not touching +a character that is considered to be part of a word. You can modify this +set of characters in the <tt><b>geany.wordchars</b></tt> variable. +</p><br><br> + + +<a name="xsel"></a><hr><h3><tt>geany.xsel ( [text] )</tt></h3><p> +When called with no arguments, returns the text-based contents of the primary X selection. +</p><p> +When called with one argument, assigns that <tt>text</tt> as the contents of the primary X selection. + +</p><p> +This function is only valid for X-Window environments, on MS-Windows, it does nothing. +</p><br><br> + +<a name="yield"></a><hr><h3><tt>geany.yield ()</tt></h3><p> +Temporarily returns control to the IDE, to allow user interface elements to +be refreshed/repainted during lengthy script operations. +</p><p>Since most scripts will probably have a run time of less than a couple of seconds, +you will likely never need this function. But if you do, it should be used with caution, +since it allows Geany's state to be changed during script execution. This could have +unpleasant consequences, for instance if the user closes a document that the script is referencing. +</p> +<br><br> +<br><br> +<hr><hr> + + +<h3>      Dialog functions</h3> +<hr> + +<a name="choose"></a><hr><h3><tt>geany.choose ( prompt, items )</tt></h3><p> +Displays a dialog box to allow the user to choose from a list of items. </p><p> +The <tt>prompt</tt> argument string will display a message above the list box +to explain the request.</p><p> +The <tt>items</tt> argument is a Lua table, each element of the table must be +a string. +</p><p> +The function returns the selected item as a string:</p> +<ul> +<li>If the <b>OK</b> button is clicked, +<li>If the [Return] key is pressed while the item list is active. +<li>If the user double-clicks an item in the list. +</ul> +<p> +If the <b>Cancel</b> button is clicked, or if the dialog is is dismissed by +some other means, e.g. by pressing the [Escape] key, the function returns +<tt><b>nil</b></tt>. +</p><br><br> + + +<a name="confirm"></a><hr><h3><tt>geany.confirm ( title, question, default )</tt></h3><p> + Displays a simple yes-or-no style dialog box to ask the specified + <tt>question</tt>.<br> + The <tt>title</tt> argument is displayed as a bold-faced title for the dialog. + </p><p> + Returns <tt><b>true</b></tt> if the 'Yes' button is clicked, + or <tt><b>false</b></tt> if the 'No' button is + clicked.</p><p> + If the dialog is dismissed by some other means, e.g. by pressing the + [Escape] key, <br>the function will return the boolean value specified by the + <tt>default</tt> argument. </p> + <p>All three arguments are required, but you can pass <tt><b>nil</b></tt> + as the first argument to suppress the title. +</p><br><br> + + +<a name="input"></a><hr><h3><tt>geany.input ( [prompt] [,default] )</tt></h3><p> +Displays an input dialog to prompt the user for some text. </p><p> +The <tt>prompt</tt> argument string will display a message above the entry box +to explain what input is requested.</p><p> +The <tt>default</tt> argument string, if present, will add some pre-selected +text into the entry area.</p><p> +If the <b>OK</b> button is clicked, or if the [Return] key is pressed while the +entry field is active, the function will return the contents of the entry field + as a string.</p><p> +If the <b>Cancel</b> button is clicked, or if the dialog is is dismissed by +some other means, e.g. by pressing the + [Escape] key, the function returns <tt><b>nil</b></tt>. +</p><br><br> + + +<a name="message"></a><hr><h3><tt>geany.message ( [title,] message )</tt></h3><p> +When called with one argument, displays a simple dialog box containing +the specified <tt>message</tt> string. </p> +<p>When called with two arguments, the <tt>title</tt> argument is displayed as +a bold-faced title, +and the <tt>message</tt> argument will be the message text. +</p><br><br> +<hr> + +<a name="pickfile"></a><hr><h3><tt>geany.pickfile ( [mode [,path [,filter]]] )</tt></h3> +<p> +Displays a dialog that allows the user to select a filename.</p><p> +All three arguments are optional, but you can pass <tt>nil</tt> as a placeholder to +use the default value for any of the arguments.</p><p> +The <tt>mode</tt> argument specifies the type of dialog, and must be one +of two strings, either <tt>"open"</tt> or <tt>"save"</tt>.<br> +( passing <tt>nil</tt> is the same as <tt>"open"</tt> )<br> +In <tt>"save"</tt> mode the function will issue an overwrite confirmation prompt if the targeted file already exists. +</p><p> +The <tt>path</tt> string argument sets the initial directory for the dialog, or <tt>nil</tt> +to use the current directory.<br> +If the last (rightmost) element of the path is an existing directory, the path will be used as-is, +otherwise the last element is assumed to be a filename (whether it actually exists on disk or not) +and will be parsed off and used as the suggested filename for the dialog. +</p><p> +The <tt>filter</tt> argument controls which files are displayed, +or it can be <tt>nil</tt> to display all files.<br> +It is a string consisting of pairs of substrings, where each substring +is separated by the pipe "<tt>|</tt>" symbol.<br> +The first element in each pair of substrings is the human-readable description of the filetype,<br> +and the second element of the +pair is a set of semicolon-delimited shell wildcards to filter on.<br> +For instance, a filter for web files might look like:<br> +<tt><b>   "HTML files|*.html;*.htm|PHP files|*.php;*.php4|Style sheets|*.css"</b></tt> +<br> +( Those familiar with +<a href="http://en.wikipedia.org/wiki/Borland_Delphi">Borland Delphi</a> + might recognize this syntax from the + <a href="http://www.delphibasics.co.uk/RTL.asp?Name=TOpenDialog">TOpenDialog.Filter</a> property. ) +</p> +<p><br> +Note that this function does not actually open or save anything, it merely returns the +full path and filename of the selected file, or <tt>nil</tt> if the user cancels the dialog.</p> +<br><br> +<hr> +<hr> +<h3>Module level variables</h3> +<hr> +<a name="wordchars"></a><hr><h3><tt>geany.wordchars</tt></h3><p> +This variable determines which characters are considered to be part of a word. +</p><p> +It is used by the <tt><b>geany.word()</b></tt> function and may also be reset by that +function if its current value cannot be interpreted as a string.</p><p> +The default value is:<br><tt> +    <big> <big> +"_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"</big> </big></tt> +<p> +If you need to modify this string, you may want to save a copy of the original +so you can restore it later. +</p><br><br> + +<a name="rectsel"></a><hr><h3><tt>geany.rectsel</tt></h3><p> +This variable controls and/or returns the "selection mode" of the current document. +</p><p> +It is used by the <tt><b>geany.select()</b></tt> function and is adjusted +when the selection is queried, and examined when the selection is set. <br> +It may also be reset if its current value cannot be interpreted as a boolean.</p> +<p> +A value of <tt><b>true</b></tt> represents a rectangular selection +and <tt><b>false</b></tt> represents the normal linear selection mode. +</p><br><br> + +<a name="banner"></a><hr><h3><tt>geany.banner</tt></h3><p> +This variable controls the window title for dialogs displayed by the current script. +</p><p> +It may be reset by the dialog functions if its value cannot be interpreted as a string. +</p><br><br> + + +<a name="caller"></a><hr><h3><tt>geany.caller</tt></h3><p> +This variable stores the internal index of the document that triggered one of the <a href="./geanylua-intro.html#events">event scripts</a>.</p> +<p> +For example, to print the filename of a file that has just been saved, you could put<br> +this line in your <b>~/.geany/plugins/lua/events/saved.lua</b> script file:</p><p> +<tt>  print(geany.documents(geany.caller))</tt> +</p><p> + + + + +This variable is only relevant for the opened, created, activated, and saved event scripts, +for all other scripts it is set to zero.<br> + +</p><br><br> + +<a name="dirsep"></a><hr><h3><tt>geany.dirsep</tt></h3><p> +This variable returns the default filesystem path separator.<br> +( A forward slash <tt><b>/</b></tt> for Unix or + a backslash <tt><b>\</b></tt> for MS-Windows. ) +</p><br><br> + + +<a name="project"></a><hr><h3><tt>geany.project</tt></h3><p> +This variable provides a reference to the <a href="geanylua-keyfile.html">GKeyFile</a> object +for the project that triggered a + proj-*  <a href="./geanylua-intro.html#events">event script</a>.</p> +<p> +The information stored in the object can be manipulated using the <tt>keyfile</tt> module.<br> +For example, to print the description of the project that has just been opened, you could put<br> +this line in your <b>~/.geany/plugins/lua/events/proj-opened.lua</b> script file:</p><p> +<tt>  print(keyfile.value(geany.project, "project", "description"))</tt> +</p><p> +This variable is only relevant for the project-based event scripts, for all other scripts it is set to <tt>nil</tt>.<br> + +</p><br><br> + + +<a name="script"></a><hr><h3><tt>geany.script</tt></h3><p> +This variable stores the full path and filename of the active script.</p> +<br><br> +<hr> +<br><br> +<div align="right"><small>© 2007-2008 <i>Jeff Pohlmeyer </i>   </small></div> +<br><br> +<br><br><br><br> +<br><br><br><br> +<br><br><br><br> +<br><br><br><br> + +</body> +</html> Added: www/staging/geanylua/luarefv51.html =================================================================== --- www/staging/geanylua/luarefv51.html (rev 0) +++ www/staging/geanylua/luarefv51.html 2010-07-17 20:48:39 UTC (rev 1477) @@ -0,0 +1,3865 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> + +<html> +<head> + <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org"> + <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> + + <title>Lua 5.1 short reference</title> +<style type="text/css"> + +</style> +</head> + +<body bgcolor="white" style="line-break:strict"> + <p class='LuaPHeader1'><span lang='EN-US'>Contents</span></p> + + <div style='width:100%;font-size:12.0pt;font-weight:bold;text-align:center;line-height: 200%;'> + <p><a class="IndexRef" href="#The_Lua_language">· The Lua language ·</a> <a class="IndexRef" href="#The_base_library">· The base library ·</a> <a class="IndexRef" href="#Modules_and_the_package_library">· Modules and + the package library ·</a> <a class="IndexRef" href="#The_coroutine_library">· The coroutine library ·</a> <a class="IndexRef" href="#The_table_library">· The table library ·</a> <a class="IndexRef" href= + "#The_mathematical_library">· The mathematical library ·</a> <a class="IndexRef" href="#The_string_library">· The string library ·</a> <a class="IndexRef" href="#The_I_O_library">· The I/O library ·</a> + <a class="IndexRef" href="#The_operating_system_library">· The operating system library ·</a> <a class="IndexRef" href="#The_debug_library">· The debug library ·</a> <a class="IndexRef" href= + "#The_stand_alone_interpreter">· The stand-alone interpreter ·</a> <a class="IndexRef" href="#The_compiler">· The compiler ·</a></p> + </div> + + <p class="LuaPHeader1"><a name="The_Lua_language" id="The_Lua_language"><span lang="EN-US">The Lua language (v5.1)</span></a></p> + + <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'>  </span></span> <span lang="EN-US">Reserved identifiers and + comments</span></p> + + <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" width="650" summary="?"> + <tr> + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">and</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">break</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">do</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">else</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">elseif</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">end</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">false</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">for</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">function</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">if</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">in</span></span></p> + </td> + </tr> + + <tr> + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">local</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">nil</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">not</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">or</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">repeat</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">return</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">then</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">true</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">until</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">while</span></span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><b><span lang="EN-US"> </span></b></p> + </td> + </tr> + + <tr> + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-- ...</span></span></p> + </td> + + <td width="236" colspan="4" valign="top"> + <p class="MsoNormal"><span lang="EN-US">comment to end of line</span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">--[=[</span></span> <span lang="EN-US">  <span class="LuaCbold">]=]</span></span></p> + </td> + + <td width="295" colspan="5" valign="top"> + <p class="MsoNormal"><span lang="EN-US">multi line comment (zero or multiple '=' are valid)</span></p> + </td> + </tr> + + <tr> + <td width="295" colspan="5" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_X</span></span> <span lang="EN-US">is "reserved" (by convention) for constants (with X being any sequence of uppercase letters)</span></p> + </td> + + <td width="59" valign="top"> + <p class="MsoNormal"><span lang="EN-US">#!</span></p> + </td> + + <td width="295" colspan="5" valign="top"> + <p class="MsoNormal"><span lang="EN-US">usual Unix shebang; Lua ignores whole first line if this starts the line.</span></p> + </td> + </tr> + </table> + + <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'>  </span></span> <span lang="EN-US">Types (the string values are the + possible results of base library function type())</span></p> + + <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?"> + <tr> + <td width="81" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"nil"</span></span></p> + </td> + + <td width="81" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"boolean"</span></span></p> + </td> + + <td width="81" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"number"</span></span></p> + </td> + + <td width="81" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"string"</span></span></p> + </td> + + <td width="81" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"table"</span></span></p> + </td> + + <td width="81" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"function"</span></span></p> + </td> + + <td width="81" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"thread"</span></span></p> + </td> + + <td width="81" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"userdata"</span></span></p> + </td> + </tr> + </table> + + <p class="MsoNormal"><span lang="EN-GB">Note: for type boolean,</span> <span class="LuaCbold"><span lang="EN-US">nil</span></span> <span lang="EN-GB">and</span> <span class="LuaCbold"><span lang="EN-US">false</span></span> <span lang="EN-GB">count as + false; everything else is true (including 0 and "").</span></p> + + <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'>  </span></span> <span lang="EN-US">Strings and escape + sequences</span></p> + + <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?"> + <tr> + <td width="95" colspan="2" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">'...'</span></span> <span lang="EN-US">and</span> <span class="LuaCbold"><span lang="EN-US">"..."</span></span></p> + </td> + + <td width="201" colspan="3" valign="top"> + <p class="MsoNormal"><span lang="EN-US">string delimiters; interpret escapes.</span></p> + </td> + + <td width="71" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">[=[...]=]</span></span></p> + </td> + + <td width="284" colspan="4" valign="top"> + <p class="MsoNormal"><span lang="EN-US">multi line strings; escape sequences are ignored.</span></p> + </td> + </tr> + + <tr> + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\a  bell</span></p> + </td> + + <td width="93" colspan="2" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\b  backspace</span></p> + </td> + + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\f  form feed</span></p> + </td> + + <td width="93" colspan="3" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\n  newline</span></p> + </td> + + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\r  return</span></p> + </td> + + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\t  horiz. tab</span></p> + </td> + + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\v  vert. tab</span></p> + </td> + </tr> + + <tr> + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\\  backslash</span></p> + </td> + + <td width="93" colspan="2" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\"  d. quote</span></p> + </td> + + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\'  quote</span></p> + </td> + + <td width="93" colspan="3" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\[  sq. bracket</span></p> + </td> + + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\]  sq. bracket</span></p> + </td> + + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US">\ddd decimal</span></p> + </td> + + <td width="93" valign="top"> + <p class="MsoNormal"><span lang="EN-US"> </span></p> + </td> + </tr> + </table> + + <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'>  </span></span> <span lang="EN-US">Operators, decreasing + precedence</span></p> + + <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?"> + <tr> + <td width="650" colspan="6" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">^</span></span> <span lang="EN-US">  (right associative, math library required)</span></p> + </td> + </tr> + + <tr> + <td width="217" colspan="2" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">not</span></span></p> + </td> + + <td width="217" colspan="2" valign="top"> + <p class="MsoNormal"><span lang="EN-US">#  (length of strings and tables)</span></p> + </td> + + <td width="217" colspan="2" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span> <span lang="EN-US">  (unary)</span></p> + </td> + </tr> + + <tr> + <td width="217" colspan="2" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">*</span></span></p> + </td> + + <td width="217" colspan="2" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">/</span></span></p> + </td> + + <td width="217" colspan="2" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%</span></span></p> + </td> + </tr> + + <tr> + <td width="325" colspan="3" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">+</span></span></p> + </td> + + <td width="325" colspan="3" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span></p> + </td> + </tr> + + <tr> + <td width="650" colspan="6" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">..</span></span> <span lang="EN-US">  (string concatenation, right associative)</span></p> + </td> + </tr> + + <tr> + <td width="108" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US"><</span></span></p> + </td> + + <td width="108" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">></span></span></p> + </td> + + <td width="108" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US"><=</span></span></p> + </td> + + <td width="108" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">>=</span></span></p> + </td> + + <td width="108" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">~=</span></span></p> + </td> + + <td width="108" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">==</span></span></p> + </td> + </tr> + + <tr> + <td width="650" colspan="6" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">and</span></span> <span lang="EN-US">  (stops on <span class="LuaCbold">false</span> or <span class="LuaCbold">nil</span> , returns last evaluated value)</span></p> + </td> + </tr> + + <tr> + <td width="650" colspan="6" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">or</span></span> <span lang="EN-US"> (stops on <span class="LuaCbold">true</span> (not <span class="LuaCbold">false</span> or <span class="LuaCbold">nil</span> ), returns last + evaluated value)</span></p> + </td> + </tr> + </table> + + <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'>  </span></span> <span lang="EN-US">Assignment and + coercion</span></p> + + <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?"> + <tr> + <td width="142" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = 5  b= "hi"</span></span></p> + + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">local a = a</span></span></p> + </td> + + <td width="508" valign="top"> + <p class="MsoNormal"><span lang="EN-US">simple assignment; variables are not typed and can hold different types. Local variables are lexically scoped; their scope begins after the full declaration (so that local <span class="LuaCbold">a</span> = + 5).</span></p> + </td> + </tr> + + <tr> + <td width="142" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b, c = 1, 2, 3</span></span></p> + </td> + + <td width="508" valign="top"> + <p class="MsoNormal"><span lang="EN-US">multiple assignments are supported</span></p> + </td> + </tr> + + <tr> + <td width="142" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b = b, a</span></span></p> + </td> + + <td width="508" valign="top"> + <p class="MsoNormal"><span lang="EN-US">swap values: right hand side is evaluated before assignment takes place</span></p> + </td> + </tr> + + <tr> + <td width="142" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b = 4, 5, "6"</span></span></p> + </td> + + <td width="508" valign="top"> + <p class="MsoNormal"><span lang="EN-US">excess values on right hand side ("6") are evaluated but discarded</span></p> + </td> + </tr> + + <tr> + <td width="142" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b = "there"</span></span></p> + </td> + + <td width="508" valign="top"> + <p class="MsoNormal"><span lang="EN-US">for missing values</span> <span lang="EN-US">on right hand side <span class="LuaCbold">nil</span> is assumed</span></p> + </td> + </tr> + + <tr> + <td width="142" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = nil</span></span></p> + </td> + + <td width="508" valign="top"> + <p class="MsoNormal"><span lang="EN-US">destroys <span class="LuaCbold">a</span> ; its contents are eligible for garbage collection if unreferenced.</span></p> + </td> + </tr> + + <tr> + <td width="142" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = z</span></span></p> + </td> + + <td width="508" valign="top"> + <p class="MsoNormal"><span lang="EN-US">if <span class="LuaCbold">z</span> is not defined it is <span class="LuaCbold">nil</span> , so <span class="LuaCbold">nil</span> is assigned to <span class="LuaCbold">a</span> (destroying it)</span></p> + </td> + </tr> + + <tr> + <td width="142" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = "3" + "2"</span></span></p> + </td> + + <td width="508" valign="top"> + <p class="MsoNormal"><span lang="EN-US">numbers expected, strings are converted to numbers (a = 5)</span></p> + </td> + </tr> + + <tr> + <td width="142" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = 3 .. 2</span></span></p> + </td> + + <td width="508" valign="top"> + <p class="MsoNormal"><span lang="EN-US">strings expected, numbers are converted to strings (a = "32")</span></p> + </td> + </tr> + </table> + + <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'>  </span></span> <span lang="EN-US">Control structures</span></p> + + <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?"> + <tr> + <td width="331" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">do</span></span> <span class="LuaCitalic"><span lang="EN-US">block</span></span> <span class="LuaCbold"><span lang="EN-US">end</span></span></p> + </td> + + <td width="319" valign="top"> + <p class="MsoNormal"><span lang="EN-US">block; introduces local scope.</span></p> + </td> + </tr> + + <tr> + <td width="331" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">if</span></span> <span class="LuaCitalic"><span lang="EN-US">exp</span></span> <span class="LuaCbold"><span lang="EN-US">then</span></span> <span class="LuaCitalic"><span lang= + "EN-US">block</span></span> <span lang="EN-US">{ <span class="LuaCbold">elseif</span> <span class="LuaCitalic">exp</span> <span class="LuaCbold">then</span> <span class="LuaCitalic">block</span> } [ <span class="LuaCbold">else</span> <span class= + "LuaCitalic">block</span> ] <span class="LuaCbold">end</span></span></p> + </td> + + <td width="319" valign="top"> + <p class="MsoNormal"><span lang="EN-US">conditional execution</span></p> + </td> + </tr> + + <tr> + <td width="331" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">while</span></span> <span class="LuaCitalic"><span lang="EN-US">exp</span></span> <span class="LuaCbold"><span lang="EN-US">do</span></span> <span class="LuaCitalic"><span lang= + "EN-US">block</span></span> <span class="LuaCbold"><span lang="EN-US">end</span></span></p> + </td> + + <td width="319" valign="top"> + <p class="MsoNormal"><span lang="EN-US">loop as long as <span class="LuaCitalic">exp</span> is true</span></p> + </td> + </tr> + + <tr> + <td width="331" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">repeat</span></span> <span class="LuaCitalic"><span lang="EN-US">block</span></span> <span class="LuaCbold"><span lang="EN-US">until</span></span> <span class="LuaCitalic"><span lang= + "EN-US">exp</span></span></p> + </td> + + <td width="319" valign="top"> + <p class="MsoNormal"><span lang="EN-US">exits when <span class="LuaCitalic">exp</span> becomes true; <span class="LuaCitalic">exp</span> is in loop scope.</span></p> + </td> + </tr> + + <tr> + <td width="331" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">for</span></span> <span class="LuaCitalic"><span lang="EN-US">var</span></span> <span lang="EN-US">= <span class="LuaCitalic">start</span> <span class="LuaCbold">,</span> <span class= + "LuaCitalic">end</span> [ <span class="LuaCbold">,</span> <span class="LuaCitalic">step</span> ] <span class="LuaCbold">do</span> <span class="LuaCitalic">block</span> <span class="LuaCbold">end</span></span></p> + </td> + + <td width="319" valign="top"> + <p class="MsoNormal"><span lang="EN-US">numerical for loop; <span class="LuaCitalic">var</span> is local to loop.</span></p> + </td> + </tr> + + <tr> + <td width="331" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">for</span></span> <span class="LuaCitalic"><span lang="EN-US">vars</span></span> <span class="LuaCbold"><span lang="EN-US">in</span></span> <span class="LuaCitalic"><span lang= + "EN-US">iterator</span></span> <span class="LuaCbold"><span lang="EN-US">do</span></span> <span class="LuaCitalic"><span lang="EN-US">block</span></span> <span class="LuaCbold"><span lang="EN-US">end</span></span></p> + </td> + + <td width="319" valign="top"> + <p class="MsoNormal"><span lang="EN-US">iterator based for loop; <span class="LuaCitalic">vars</span> are local to loop.</span></p> + </td> + </tr> + + <tr> + <td width="331" valign="top"> + <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">break</span></span></p> + </td> + + <td width="319" valign="top"> + <p class="MsoNormal"><span lang="EN-US">exits loop; must be last statement in block.</span></p> + </td> + </tr> + </table> + + <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'>  </span></span> <span lang="EN-US">Table constructors</span></p> + + <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?"> + <tr> @@ Diff output truncated at 100000 characters. @@ This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1476] www/staging
by dmaphy＠users.sourceforge.net 17 Jul '10

17 Jul '10

Revision: 1476 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1476&view=rev Author: dmaphy Date: 2010-07-17 20:45:19 +0000 (Sat, 17 Jul 2010) Log Message: ----------- remove logfiles and generated content from the www directory Removed Paths: ------------- www/staging/content/addons.html www/staging/content/codenav.html www/staging/content/geanydoc.html www/staging/content/geanyextrasel.html www/staging/content/geanygdb.html www/staging/content/geanygendoc.html www/staging/content/geanyinsertnum.html www/staging/content/geanylipsum.html www/staging/content/geanyprj.html www/staging/content/geanyvc.html www/staging/content/pretty-printer.html www/staging/content/shiftcolumn.html www/staging/content/spellcheck.html www/staging/content/treebrowser.html www/staging/gencontent_logs/ Deleted: www/staging/content/addons.html =================================================================== --- www/staging/content/addons.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/addons.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,174 +0,0 @@ -<div class="section" id="about"> - <h3> - About - </h3> - <p> - This plugin adds various small addons to Geany which aren't worth an own plugin but might still - useful for people. - </p> - <div class="section" id="doclist"> - <h4> - DocList - </h4> - <p> - This addon places a new item in the toolbar and when clicked offers a menu listing all open - files plus the 'Close All' and 'Close Other Documents' menu items. This can be useful to - quickly access open files and switch to them. - </p> - </div> - <div class="section" id="openuri"> - <h4> - OpenURI - </h4> - <p> - Adds 'Open URI' and 'Copy URI' menu items to the editor menu when the word under the cursor - looks like a URI. 'Open URI' uses the browser command configured in Geany to open it. - </p> - </div> - <div class="section" id="tasks"> - <h4> - Tasks - </h4> - <p> - The tasks plugin goes through a file being edited and picks out lines with configurable - keywords (e.g. "TODO" or "FIXME") in them. It collects the text after - those words and puts them in a new "Tasks" tab in the message window. Clicking on a - task in that tab takes you to the line in the file where the task was defined. - </p> - </div> - <div class="section" id="systray"> - <h4> - Systray - </h4> - <p> - Adds a status icon to the notification area (systray) and provides a simple popup menu with - some basic actions. It can also be used to quickly show and hide the Geany main window. - </p> - </div> - <div class="section" id="bookmark-list"> - <h4> - Bookmark List - </h4> - <p> - Add a list of defined bookmarks (line markers) to the sidebar. This list contains all - bookmarks defined in the current file for faster overview and access. - </p> - </div> - <div class="section" id="mark-word"> - <h4> - Mark Word - </h4> - <p> - When double-clicking a word, all occurences of this word are searched and then highlighted - (similar to Geany's 'Mark All' Find option). - </p> - </div> - <div class="section" id="strip-trailing-blank-lines"> - <h4> - Strip trailing blank lines - </h4> - <p> - This addon removes excessive trailing blank lines from the document when it is saved. If you - have 'Ensure new line at file end' option checked in Preferences, one trailing newline will - be left. - </p> - </div> - <div class="section" id="xmltagging"> - <h4> - XMLtagging - </h4> - <p> - XMLtagging allows to easy tag a selected text, by checking for a selection, offering a little - dialog for inserting a tag and replacing a selection. - </p> - </div> -</div> -<div class="section" id="downloads"> - <h3> - Downloads - </h3> - <p> - The Addons plugin is part of the combined Geany Plugins release. For more information and - downloads, please visit <a class="reference external" href= - "http://plugins.geany.org/geany-plugins/">http://plugins.geany.org/geany-plugins/</a> - </p> - <div class="section" id="development-code"> - <h4> - Development Code - </h4> - <p> - Get the code from: - </p> - <blockquote> - svn checkout <a class="reference external" href= - "http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…">http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…</a> - </blockquote> - </div> -</div> -<div class="section" id="requirements"> - <h3> - Requirements - </h3> - <p> - For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries and header - files. You will also need its dependency libraries and header files, such as Pango, Glib and - ATK. All these files are available at <a class="reference external" href= - "http://www.gtk.org">http://www.gtk.org</a>. - </p> - <p> - And obviously, you will need have Geany installed. If you have Geany installed from the - sources, you should be ready to go. If you used a prepared package e.g. from your distribution - you probably need to install an additional package, this might be called geany-dev or - geany-devel. Please note that in order to compile and use this plugin, you need Geany 0.16 or - later. - </p> - <p> - Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these - tools are recommended. - </p> -</div> -<div class="section" id="installation"> - <h3> - Installation - </h3> - <p> - Compiling and installing the code is done by the following three commands: $ ./configure $ make - $ make install - </p> - <p> - For more configuration details run $ ./configure --help - </p> - <p> - If there are any errors during compilation, check your build environment and try to find the - error, otherwise contact one of the authors. - </p> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - After installed successfully, simply load the plugin in Geany's plugin manager. In the - configuration dialog you can enable or disable the various components of this plugin. - </p> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - Addons is distributed under the terms of the GNU General Public License as published by the - Free Software Foundation; either version 2 of the License, or (at your option) any later - version. A copy of this license can be found in the file COPYING included with the source code - of this program. - </p> -</div> -<div class="section" id="ideas-questions-patches-and-bug-reports"> - <h3> - Ideas, questions, patches and bug reports - </h3> - <p> - Report them at <a class="reference external" href= - "http://sourceforge.net/tracker/?group_id=222729">http://sourceforge.net/tracker/?group_id=222729</a>. - </p> -</div> Deleted: www/staging/content/codenav.html =================================================================== --- www/staging/content/codenav.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/codenav.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,76 +0,0 @@ -<div class="section" id="about"> - <h3> - About - </h3> - <p> - This plugin adds some facilities for navigating in the code. Actually, it will make it possible - to : - switch between header and implementation - go to a file by typing its name - </p> -</div> -<div class="section" id="requirements"> - <h3> - Requirements - </h3> - <p> - For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries and header - files. You will also need its dependency libraries and header files, such as Pango, Glib and - ATK. All these files are available at <a class="reference external" href= - "http://www.gtk.org">http://www.gtk.org</a>. - </p> -</div> -<div class="section" id="installation"> - <h3> - Installation - </h3> - <p> - Compiling and installing the code is done by the following three commands: $ ./configure $ make - $ make install - </p> - <p> - For more configuration details run $ ./configure --help - </p> - <p> - If there are any errors during compilation, check your build environment and try to find the - error, otherwise contact one of the authors. - </p> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - After installed successfully, load the plugin in Geany's plugin manager and new menu items in - the Edit menu will appear. You can change the keyboard shortcuts in Geany's preferences dialog. - </p> -</div> -<div class="section" id="known-issues"> - <h3> - Known issues - </h3> - <blockquote> - <ul class="simple"> - <li>still in development... - </li> - </ul> - </blockquote> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - "Code navigation plugin" is distributed under the terms of the GNU General Public - License as published by the Free Software Foundation; either version 2 of the License, or (at - your option) any later version. A copy of this license can be found in the file COPYING - included with the source code of this program. - </p> -</div> -<div class="section" id="ideas-questions-patches-and-bug-reports"> - <h3> - Ideas, questions, patches and bug reports - </h3> - <p> - Lionel Fuentes <<a class="reference external" href= - "mailto:funto66%40gmail.com">funto66<span>@</span>gmail<span>.</span>com</a>> - </p> -</div> Deleted: www/staging/content/geanydoc.html =================================================================== --- www/staging/content/geanydoc.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/geanydoc.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,294 +0,0 @@ -<div class="contents topic" id="contents"> - <p class="topic-title first"> - Contents - </p> - <ul class="simple"> - <li> - <a class="reference internal" href="#about" id="id1" name="id1">About</a> - </li> - <li> - <a class="reference internal" href="#usage" id="id2" name="id2">Usage</a> - </li> - <li> - <a class="reference internal" href="#settings" id="id3" name="id3">Settings</a> - </li> - <li> - <a class="reference internal" href="#license" id="id4" name="id4">License</a> - </li> - <li> - <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id5" name= - "id5">Ideas, questions, patches and bug reports</a> - </li> - <li> - <a class="reference internal" href="#coding" id="id6" name="id6">Coding</a> - </li> - <li> - <a class="reference internal" href="#style" id="id7" name="id7">Style</a> - </li> - <li> - <a class="reference internal" href="#download" id="id8" name="id8">Download</a> - <ul> - <li> - <a class="reference internal" href="#gentoo" id="id9" name="id9">Gentoo</a> - </li> - <li> - <a class="reference internal" href="#arch-linux" id="id10" name="id10">Arch linux</a> - </li> - <li> - <a class="reference internal" href="#windows" id="id11" name="id11">Windows</a> - </li> - </ul> - </li> - <li> - <a class="reference internal" href="#author" id="id12" name="id12">Author</a> - </li> - </ul> -</div> -<div class="section" id="about"> - <h3> - About - </h3> - <p> - Geanydoc is plugin for Geany IDE that allow execute specified commands on the current word at - the cursor position. This word is passed as an argument to these commands. It allow either - place output of these commands in geany buffer *DOC* or just execute external program. Geanydoc - is intended to be used for searching documentation API in different sources. - </p> - <p> - In order to use it you need Geany >= 0.16 or svn version. - </p> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - geanydoc define 2 keyboard shortcut "Document current word" and "Document - interactive" First you need to assign key to them in - "Edit->Preferences->Keybinding->Doc". - </p> - <p> - "Document current word" search documentation on the current word near cursor - position. "Document interactive" search documentation on word you enter in - interactive dialog. - </p> -</div> -<div class="section" id="settings"> - <h3> - Settings - </h3> - <p> - geanydoc allow to execute different commands for different filetypes. Use combobox to select - type you need. - </p> - <p> - "Put output in buffer" if you check this checkbox geanydoc will execute command wait - for it's exit and place it's output in geany buffer. If you have this button unchecked geanydoc - will simply spawn command and forgot about it. - </p> - <p> - NOTE: if you have multiple command all commands but last are treated as "Put output in - buffer" true. This checkbox is used only for last command. - </p> - <p> - If you specify several commands, second command will be called only if first one didn't return - something in output. - </p> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - geanydoc is distributed under the terms of the GNU General Public License as published by the - Free Software Foundation; either version 3 of the License, or (at your option) any later - version. A copy of this license can be found in the file COPYING included with the source code - of this program. - </p> -</div> -<div class="section" id="ideas-questions-patches-and-bug-reports"> - <h3> - Ideas, questions, patches and bug reports - </h3> - <p> - If you add something, or fix a bug, please send a patch (in 'diff -u' format) to the geany - mailing list or to one of the authors listed bellow. - </p> -</div> -<div class="section" id="coding"> - <h3> - Coding - </h3> - <p> - Use static functions where possible. Try to use GLib types and functions - e.g. g_free instead - of free and try to use only GLib 2.6 and GTK 2.6 functions. - </p> -</div> -<div class="section" id="style"> - <h3> - Style - </h3> - <p> - The file indent-all.sh contains information about the current code style. Run this script - before commit. - </p> -</div> -<div class="section" id="download"> - <h3> - Download - </h3> - <p> - The current version is: - </p> - <table border="1" class="docutils"> - <colgroup> - <col width="15%" /> - <col width="18%" /> - <col width="67%" /> - </colgroup> - <thead valign="bottom"> - <tr> - <th class="head"> - Geany Version - </th> - <th class="head"> - GeanyDoc Version - </th> - <th class="head"> - Download - </th> - </tr> - </thead> - <tbody valign="top"> - <tr> - <td> - 0.16 - </td> - <td> - 0.5 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4.tar.gz</a> - </td> - </tr> - </tbody> - </table> - <p> - Up to date source code can be downloaded here: - </p> - <pre class="literal-block"> -svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyd… -</pre> - <p> - If you have old version of Geany installed you need old version of plugin as well. These - versions of plugin are no longer supported and if you find bug in one of them, it won't be - fixed unless you do it yourself. - </p> - <table border="1" class="docutils"> - <colgroup> - <col width="15%" /> - <col width="18%" /> - <col width="67%" /> - </colgroup> - <thead valign="bottom"> - <tr> - <th class="head"> - Geany Version - </th> - <th class="head"> - GeanyDoc Version - </th> - <th class="head"> - Download - </th> - </tr> - </thead> - <tbody valign="top"> - <tr> - <td> - 0.16 - </td> - <td> - 0.4 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4.tar.gz</a> - </td> - </tr> - <tr> - <td> - 0.15 - </td> - <td> - 0.3 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.3.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.3.tar.gz</a> - </td> - </tr> - <tr> - <td> - 0.14 - </td> - <td> - 0.2 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.2.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.2.tar.gz</a> - </td> - </tr> - <tr> - <td> - 0.13 - </td> - <td> - 0.1 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.1.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.1.tar.gz</a> - </td> - </tr> - </tbody> - </table> - <div class="section" id="gentoo"> - <h4> - Gentoo - </h4> - <p> - Gentoo ebuild is available here: <a class="reference external" href= - "http://bugs.gentoo.org/show_bug.cgi?id=218493">http://bugs.gentoo.org/show_bug.cgi?id=218493</a> - </p> - </div> - <div class="section" id="arch-linux"> - <h4> - Arch linux - </h4> - <p> - A package for Arch Linux is available here: <a class="reference external" href= - "http://aur.archlinux.org/packages.php?ID=16475">http://aur.archlinux.org/packages.php?ID=16475</a> - </p> - </div> - <div class="section" id="windows"> - <h4> - Windows - </h4> - <p> - A windows installer is available here: <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4_setup.exe">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4_setup.exe</a> - </p> - </div> -</div> -<div class="section" id="author"> - <h3> - Author - </h3> - <p> - Yura Siamashka <a class="reference external" href= - "http://users.cosmostv.by/yurand/cv.html">http://users.cosmostv.by/yurand/cv.html</a> - </p> -</div> Deleted: www/staging/content/geanyextrasel.html =================================================================== --- www/staging/content/geanyextrasel.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/geanyextrasel.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,134 +0,0 @@ -<div class="section" id="about"> - <h3> - About - </h3> - <p> - The Extra Selection adds the following functions: - </p> - <p> - Goto matching brace and select (Select to matching brace). - </p> - <p> - Goto line and select (Select to line). - </p> - <p> - Ctrl-Shift-Alt-Left/Right/Home/End keys - same as Ctrl-Shift, but for rectangular selection. - </p> - <p> - Column mode - while active, all (Ctrl)-Shift-movement keys do rectangle selection instead of - stream. - </p> - <p> - "Movement keys" refers to the arrows, Home, End, Page Up and Page Down. - </p> - <p> - For more information, see the Usage section below. - </p> -</div> -<div class="section" id="requirements"> - <h3> - Requirements - </h3> - <p> - Geany 0.18 or later and the respective headers and development libraries. - </p> -</div> -<div class="section" id="installation"> - <h3> - Installation - </h3> - <p> - Compiling and installing the code is done by the following three commands: - </p> - <p> - $ ./waf configure $ ./waf build $ ./waf install - </p> - <p> - For more configuration details run $ ./waf --help - </p> - <p> - If there are any errors during compilation, check your build environment. - </p> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - Under Tools -> Extra Selection, there are 3 new items: "Column mode", "Select - to line" and "Select to matching brace". Normally these should be bound to keys, - for example Alt-c, Alt-Shift-l and Control-Shift-b. Now: - </p> - <ol class="arabic"> - <li> - <p class="first"> - Position the cursor on an opening brace and invoke "Select to matching brace". - The cursor will move to the closing brace, and the braced area will be selected. - </p> - </li> - <li> - <p class="first"> - Position the cursor on line 10, invoke "Select to line" and enter 15. The cursor - will move to line 15, and the area between the previous and the new current cursor position - will be selected. - </p> - </li> - <li> - <p class="first"> - Select a small rectangular area and press Control-Alt-Shift-Right. The cursor will move to - the next word, extending the rectangurar selection. The complete new keys list is: - </p> - <p> - Control-Alt-Shift Extends the selection to ----------------- ------------------------ Left - Previous word Right Next word Up Previous paragraph Down Next paragraph Home Start of file - End End of file - </p> - </li> - </ol> - <p> - Unfortunately, holding Alt for rectangular selection has some problems, which apply both to the - standard Geany keys and these added by the plugin. Under Windows, Alt and the keypad keys - generate unicodes, even if used with Shift or Control. With X11, some - Alt-(Ctrl)-(Shift)-movement keys may be used by the window manager for switching to the - previous/next desktop, moving windows etc. So then: - </p> - <ol class="arabic simple" start="4"> - <li>Turn "Column mode" on. While active, the (Control)-Shift-movement keys will - select a rectangle instead of stream without the need to hold Alt (in fact, the - (Control)-Alt-Shift-movement keys will be temporarily blocked). This way, you will avoid the - Alt key problems mentioned above, and it's move convinient to select while holding Shift only. - </li> - </ol> -</div> -<div class="section" id="known-issues"> - <h3> - Known issues - </h3> - <p> - The column mode is global, not per-document. However, (de)activating it will change the - selection (if any) to stream/rectangle for the current document only. - </p> - <p> - The column mode applies to the movement keys only - not to mouse selection, find functions etc. - </p> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - Extra Selection is distributed under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 2 of the License, or (at your option) any later - version. A copy of this license can be found in the file COPYING included with the source code - of this program. - </p> -</div> -<div class="section" id="ideas-questions-patches-and-bug-reports"> - <h3> - Ideas, questions, patches and bug reports - </h3> - <p> - Dimitar Zhekov <<a class="reference external" href= - "mailto:dimitar.zhekov%40gmail.com">dimitar<span>.</span>zhekov<span>@</span>gmail<span>.</span>com</a>> - </p> -</div> Deleted: www/staging/content/geanygdb.html =================================================================== --- www/staging/content/geanygdb.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/geanygdb.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,241 +0,0 @@ -<div class="contents topic" id="contents"> - <p class="topic-title first"> - Contents - </p> - <ul class="simple"> - <li> - <a class="reference internal" href="#about" id="id2" name="id2">About</a> - </li> - <li> - <a class="reference internal" href="#current-version" id="id3" name="id3">Current Version</a> - </li> - <li> - <a class="reference internal" href="#requirements" id="id4" name="id4">Requirements</a> - </li> - <li> - <a class="reference internal" href="#installation" id="id5" name="id5">Installation</a> - </li> - <li> - <a class="reference internal" href="#documentation" id="id6" name="id6">Documentation</a> - </li> - <li> - <a class="reference internal" href="#download" id="id7" name="id7">Download</a> - <ul> - <li> - <a class="reference internal" href="#id1" id="id8" name="id8">Current Version</a> - </li> - <li> - <a class="reference internal" href="#older-versions" id="id9" name="id9">Older - Versions</a> - </li> - </ul> - </li> - <li> - <a class="reference internal" href="#contact" id="id10" name="id10">Contact</a> - </li> - </ul> -</div> -<div class="section" id="about"> - <h3> - About - </h3> - <p> - GeanyGDB is a plugin for Geany which provides integrated debugging support within Geany via the - GNU Debugger (GDB). - </p> - <p> - Geany is a small and lightweight integrated development environment using the GTK2 toolkit. - </p> - <p> - The GNU Debugger is a source-level debugger for C, C++, Fortran, Modula 2 and Java programs. - </p> - <p> - It was developed and tested on openSUSE-10.3 with GDB-6.7.50. Other recent versions of GDB will - probably work, but operating systems other than Linux-PC will not work, at least not without - some considerable hacking. - </p> -</div> -<div class="section" id="current-version"> - <h3> - Current Version - </h3> - <p> - GeanyGDB now is part of the Geany-Plugins project. The current version of Geany-Plugins is - 0.18. The last stable release of GeanyGDB is 0.0.2. You are recommended to use the more current - versions of GeanyGDB shipped with Geany-Plugins. - </p> -</div> -<div class="section" id="requirements"> - <h3> - Requirements - </h3> - <p> - If you like to compile Geany-Plugins yourself, you will need the GTK (>= 2.8.0) libraries - and header files. You will also need its dependency libraries and header files, such as Pango, - Glib and ATK. All these files are available at <a class="reference external" href= - "http://www.gtk.org">http://www.gtk.org</a> or as package via your distributor. - </p> - <p> - And obviously, you will need have Geany installed. If you have Geany installed from the - sources, you should be ready to go. If you are using a prepared package e.g. from your - distribution you probably need to install an additional package, which might be called - geany-dev or geany-devel. Please note that in order to compile and use GeanyGDB, you will need - Geany 0.16 or later. - </p> - <p> - Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these - tools are recommended. - </p> - <p> - And last but not least: GDB. - </p> -</div> -<div class="section" id="installation"> - <h3> - Installation - </h3> - <p> - Please consider to compile and/or install the Geany-Plugins project, as GeanyGDB now is part of - Geany-Plugins. - </p> -</div> -<div class="section" id="documentation"> - <h3> - Documentation - </h3> - <p> - There is no real documentation, but if you hover your mouse over the buttons in the GeanyGDBs - sidebar panel in Geany the tooltips should give you some idea of what to do next. There are - also a few "rough draft" notes below: - </p> - <p> - Most of the console output from GDB is sent to the "Compiler" message window in - Geany, and you can send standard commands to GDB using the "Console" entry on the - debug sidebar. This should be used with caution, since GDB's machine interface and console - interface don't always play well together. - </p> - <p> - Also note that the plugin sets its own internal breakpoint #1 to grab the program's PID on - startup, so any user-specified breakpoint numbers begin at #2, and if you manually delete the - #1 breakpoint it will likely cause you some problems. - </p> - <p> - Whenever the target program hits a breakpoint or encounters a segfault etc. it will try to open - the appropriate source file and jump to the correct line. - </p> - <p> - To examine the state of the program's variables, you can click on the "Stack" button - in the debug sidebar. Note that the interaction between the plugin and GDB can sometimes be - quite slow, so please be patient when waiting for the dialogs to open. - </p> - <p> - The "Add breakpoint", "Add watchpoint", and "Run to" dialogs will - try to suggest some values based on your current position in whatever file you have open in - Geany, but if you don't like the choice, just click the "Clear" button and type in - whatever you please. - </p> - <p> - GeanyGDB tries to enable only the buttons that are relevant to the current state, but - ocassionally it might end up getting things wrong. If this happens, you should be able to click - the "Unload" button and everything will be reset. - </p> - <p> - If you try to unload the plugin using the plugin manager while it has a program loaded, the - plugin manager might appear to hang for a few seconds, while GDB tries to shut down. Again, - just be patient, but note that it is much better use the "Unload" button in the debug - sidebar before trying to disable the plugin. - </p> -</div> -<div class="section" id="download"> - <h3> - Download - </h3> - <div class="section" id="id1"> - <h4> - Current Version - </h4> - <p> - Current versions of Geany-Plugins can be found at <a class="reference external" href= - "http://plugins.geany.org/geany-plugins/">http://plugins.geany.org/geany-plugins/</a>. - </p> - <p> - You can also check out more current sources of Geany-Plugins from SVN, but note that SVN - checkouts may not run stable. - </p> - <blockquote> - svn checkout <a class="reference external" href= - "https://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany…">https://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany…</a> - </blockquote> - </div> - <div class="section" id="older-versions"> - <h4> - Older Versions - </h4> - <table border="1" class="docutils"> - <colgroup> - <col width="24%" /> - <col width="17%" /> - <col width="59%" /> - </colgroup> - <thead valign="bottom"> - <tr> - <th class="head"> - Geany Version - </th> - <th class="head"> - GeanyGDB Version - </th> - <th class="head"> - Download - </th> - </tr> - </thead> - <tbody valign="top"> - <tr> - <td> - known to work with 0.14 - </td> - <td> - 0.0.1 - </td> - <td> - <a class="reference external" href= - "http://plugins.geany.org/geanygdb/geanydebug-0.0.1.tar.gz">http://plugins.geany.org/geanygdb/geanydebug-0.0.1.tar.gz</a> - </td> - </tr> - <tr> - <td> - 0.16 - </td> - <td> - 0.0.2 - </td> - <td> - <a class="reference external" href= - "http://plugins.geany.org/geanygdb/geanygdb-0.0.2.tar.gz">http://plugins.geany.org/geanygdb/geanygdb-0.0.2.tar.gz</a> - </td> - </tr> - </tbody> - </table> - </div> -</div> -<div class="section" id="contact"> - <h3> - Contact - </h3> - <p> - Geanys official homepage is <a class="reference external" href= - "http://geany.org/">http://geany.org/</a> - </p> - <p> - mailing list is <a class="reference external" href= - "mailto:geany%40uvena.de">geany<span>@</span>uvena<span>.</span>de</a> - </p> - <p> - eMail to <a class="reference external" href= - "mailto:dmaphy%40googlemail.com">dmaphy<span>@</span>googlemail<span>.</span>com</a> - </p> - <p> - meet us in IRC on channels #geany or #geany-de using chat.freenode.net - </p> -</div> Deleted: www/staging/content/geanygendoc.html =================================================================== --- www/staging/content/geanygendoc.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/geanygendoc.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,11 +0,0 @@ -<h2>geanygendoc</h2> -<p>The geanygendoc plugin unfortunately does not have a README file yet, -where the contents for this page could be obtained from. If you are the -maintainer of the geanygendoc plugin you are appreciated to write a -README file for your plugin as a small documentation about what your plugin -does, how to use it and so on. You can get some inspiration on how to write -that by having a look at the other plugin pages.<br /> If you like to -contribute, feel free to write a README file for the geanygendoc plugin -and send it to someone who as write access to the Subversion repositorys of -Geany Plugins. Most likely a <a href="http://www.geany.org/Main/Authors"> -Geany developer</a> is such a person.</p> Deleted: www/staging/content/geanyinsertnum.html =================================================================== --- www/staging/content/geanyinsertnum.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/geanyinsertnum.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,72 +0,0 @@ -<div class="section" id="about"> - <h3> - About - </h3> - <p> - This plugin replaces a (possibly zero-width) rectangular selection with integer numbers, using - start/step/base etc. specified by the user. For practical reasons, the number of lines is - limited to 500000. - </p> -</div> -<div class="section" id="requirements"> - <h3> - Requirements - </h3> - <p> - Geany 0.18 or later and the respective headers and development libraries. - </p> -</div> -<div class="section" id="installation"> - <h3> - Installation - </h3> - <p> - Compiling and installing the code is done by the following three commands: - </p> - <p> - $ ./waf configure $ ./waf build $ ./waf install - </p> - <p> - For more configuration details run $ ./waf --help - </p> - <p> - If there are any errors during compilation, check your build environment. - </p> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - Select a rectangle and choose Tools -> Insert Numbers. - </p> -</div> -<div class="section" id="known-issues"> - <h3> - Known issues - </h3> - <p> - If you reload the current file while the plugin is running (after pressing OK), the insertion - may fail. Use Edit -> Undo to fix the file if needed. - </p> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - Insert Numbers is distributed under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or (at your option) any later - version. A copy of this license can be found in the file COPYING included with the source code - of this program. - </p> -</div> -<div class="section" id="ideas-questions-patches-and-bug-reports"> - <h3> - Ideas, questions, patches and bug reports - </h3> - <p> - Dimitar Toshkov Zhekov <<a class="reference external" href= - "mailto:jimmy%40is-vn.bg">jimmy<span>@</span>is-vn<span>.</span>bg</a>> - </p> -</div> Deleted: www/staging/content/geanylipsum.html =================================================================== --- www/staging/content/geanylipsum.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/geanylipsum.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,127 +0,0 @@ -<div class="section" id="geanylipsum"> - <h3> - GeanyLipsum - </h3> - <div class="contents topic" id="contents"> - <p class="topic-title first"> - Contents - </p> - <ul class="simple"> - <li> - <a class="reference internal" href="#geanylipsum" id="id1" name="id1">GeanyLipsum</a> - </li> - <li> - <a class="reference internal" href="#about" id="id2" name="id2">About</a> - </li> - <li> - <a class="reference internal" href="#installation" id="id3" name="id3">Installation</a> - </li> - <li> - <a class="reference internal" href="#usage" id="id4" name="id4">Usage</a> - </li> - <li> - <a class="reference internal" href="#development" id="id5" name="id5">Development</a> - </li> - <li> - <a class="reference internal" href="#known-issues" id="id6" name="id6">Known issues</a> - </li> - <li> - <a class="reference internal" href="#license" id="id7" name="id7">License</a> - </li> - <li> - <a class="reference internal" href="#bugs-questions-bugs-homepage" id="id8" name= - "id8">Bugs, questions, bugs, homepage</a> - </li> - </ul> - </div> -</div> -<div class="section" id="about"> - <h3> - About - </h3> - <p> - GeanyLipsum is a plugin for Geany that implements a Lorem Ipsum generator to insert placeholder - text into your document. - </p> -</div> -<div class="section" id="installation"> - <h3> - Installation - </h3> - <p> - This version of the plugin is installed with the combined geany-plugins release. Please check - README of this package - </p> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - After installed successfully, load the plugin in Geany's plugin manager and a new menu item in - the Tools menu will appear. - </p> - <p> - To insert Lorem Ipsum to your document, either use the appearing menu item or use the keystroke - which you can configure inside Geany's preferences dialog. Inside the dialog you can set up a - length of the text. Values between 1 and 5000 chars are available here. If you choose a length - that is not fitting with the length of the Lipsum snippet shipped with this plugin it will be - repeated and cut so you will always get the wished number of chars inserted. - </p> -</div> -<div class="section" id="development"> - <h3> - Development - </h3> - <p> - You can checkout the current source code from the Subversion repository at Sourceforge.net. Get - the code from: - </p> - <p> - svn checkout <a class="reference external" href= - "http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyl…">http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyl…</a> - </p> - <p> - If you want to create a patch, please respect the license of GeanyLipsum as well as - intellectual property of third. Patches that should be included to the default distribution - must be licensed under the same conditions as GeanySendMail by the copyright owner. - </p> -</div> -<div class="section" id="known-issues"> - <h3> - Known issues - </h3> - <p> - At the moment, there is no known issue. - </p> - <p> - For more recent information all reported issues will be tracked at <a class= - "reference external" href= - "http://sourceforge.net/tracker/?group_id=222729">http://sourceforge.net/tracker/?group_id=222729</a> - </p> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - GeanyLipsum and all its parts is distributed under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 of the License, or (at your - option) any later version. A copy of this license can be found in the file COPYING included - with the source code of this program. If not, you will be able to get a copy by contacting the - Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - </p> -</div> -<div class="section" id="bugs-questions-bugs-homepage"> - <h3> - Bugs, questions, bugs, homepage - </h3> - <p> - If you found any bugs or want to provide a patch, please contact Frank Lanitz - (frank(at)geany(dot)org). Please also do so, if you got any questions and visiting <a class= - "reference external" href= - "http://frank.uvena.de/en/Geany/geanylipsum">http://frank.uvena.de/en/Geany/geanylipsum</a> - didn't help you to figure out the answer. Visiting the website is also a good start if you want - to check for any update on this plugin. - </p> -</div> Deleted: www/staging/content/geanyprj.html =================================================================== --- www/staging/content/geanyprj.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/geanyprj.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,385 +0,0 @@ -<div class="contents topic" id="contents"> - <p class="topic-title first"> - Contents - </p> - <ul class="simple"> - <li> - <a class="reference internal" href="#about" id="id1" name="id1">About</a> - <ul> - <li> - <a class="reference internal" href="#why-it-was-created" id="id2" name="id2">Why it was - created?</a> - </li> - <li> - <a class="reference internal" href= - "#why-different-project-manager-why-don-t-improve-existing-code-in-geany" id="id3" name= - "id3">Why different project manager, why don't improve existing code in Geany?</a> - </li> - </ul> - </li> - <li> - <a class="reference internal" href="#usage" id="id4" name="id4">Usage</a> - <ul> - <li> - <a class="reference internal" href="#project-properties" id="id5" name="id5">Project - properties</a> - </li> - <li> - <a class="reference internal" href="#example-of-usage" id="id6" name="id6">Example of - usage</a> - </li> - </ul> - </li> - <li> - <a class="reference internal" href="#license" id="id7" name="id7">License</a> - </li> - <li> - <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id8" name= - "id8">Ideas, questions, patches and bug reports</a> - </li> - <li> - <a class="reference internal" href="#coding" id="id9" name="id9">Coding</a> - </li> - <li> - <a class="reference internal" href="#style" id="id10" name="id10">Style</a> - </li> - <li> - <a class="reference internal" href="#download" id="id11" name="id11">Download</a> - <ul> - <li> - <a class="reference internal" href="#gentoo" id="id12" name="id12">Gentoo</a> - </li> - <li> - <a class="reference internal" href="#arch-linux" id="id13" name="id13">Arch linux</a> - </li> - <li> - <a class="reference internal" href="#windows" id="id14" name="id14">Windows</a> - </li> - </ul> - </li> - </ul> -</div> -<div class="section" id="about"> - <h3> - About - </h3> - <p> - geanyprj is alternative project manager for Geany fast light IDE. In order to use it you need - Geany 0.16. - </p> - <div class="section" id="why-it-was-created"> - <h4> - Why it was created? - </h4> - <p> - Open source is great, there are a lot of nice sources that you can use for your projects in - Internet. But there are also a lot of crappy sources and when you want steal something you - need to check if it is good or not. Ability to jump to definition/declaration and back is - great help for such task. But no other text editor or IDE I know allow this without a lot of - setuping. You have to create/import project add files. When you finish with one project you - need to close it and repeat procedure for all other. Great time wasting. If you are checking - about 10 potential places you want steal code from, you won't create any project and don't - get "jump to definition/declaration" just because it is too much bother. - </p> - <p> - geanyprj aims to provide "jump to definition/declaration" functions with as little - setup as possible. - </p> - </div> - <div class="section" id="why-different-project-manager-why-don-t-improve-existing-code-in-geany"> - <h4> - Why different project manager, why don't improve existing code in Geany? - </h4> - <p> - That's because current project manager in Genny more about sessions. It is not something real - project manager should do (IMHO). It allow/require user manually open/close project and allow - to store project files in different locations from project sources. - </p> - <p> - geanyprj takes different approach: - </p> - <p> - 1) Never save session information (this way project files can be stored in version control - without constant noise from changes of opened files or cursor position) - </p> - <p> - 2) Never open/close project manually. If .geanyprj file is found somewhere up in path it will - be opened automatically. - </p> - </div> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - geanyprj add "Tools->Project" menu and sidebar "Project" tab. - </p> - <div class="section" id="project-properties"> - <h4> - Project properties - </h4> - <p> - Name - This is just project name you will see it in status window on open/close project. - </p> - <p> - Location - This is directory where .geanyprj file will be saved. - </p> - <p> - Base Path - If defined Geany will use this directory as current directory for make and run - commands - </p> - <p> - Generate file list on load - This option tell Geany to recreate project file list on project - load using selected type. If it is unchecked you should manually select files you want to be - parsed by tagmanager. - </p> - <p> - Type - This is type of files that needed to be parsed by tagmanager. - </p> - <blockquote> - <ul class="simple"> - <li>All - All files that is known to Geany - </li> - <li>C/C++ - This match any C or C++ files (.c, .cpp, .cxx, .h etc.) - </li> - <li>C - This match only C files (.c, .h) - </li> - <li>Python - This match python files (.py) - </li> - <li>None - This doesn't match any files - </li> - </ul> - </blockquote> - </div> - <div class="section" id="example-of-usage"> - <h4> - Example of usage - </h4> - <p> - Lets see plugin work at Geany source code example: - </p> - <ol class="arabic simple"> - <li>Download geany-0.15.tar.gz (<a class="reference external" href= - "http://prdownloads.sourceforge.net/geany/geany-0.15.tar.gz?download">http://prdownloads.sourceforge.net/geany/geany-0.15.tar.gz?download</a>) - </li> - <li>Unpack it somewhere, for example in ~/src/geany-0.15 - </li> - <li>Open ~/src/geany-0.15/configure.in - </li> - <li>Click "Tools->Project->New Project", and click "Create" button - </li> - </ol> - <blockquote> - This will create and save .geanyprj file in ~/src/geany-0.15. From now, every time you open - file from ~/src/geany-0.15 dirrectory or it's subdirrectory .geanyprj will be opened. So next - time you don't have to create or open project manually. - </blockquote> - <ol class="arabic simple" start="5"> - <li>Open any geany source code code file - </li> - </ol> - <blockquote> - "go to tag declaration/definition" should work for any geany function. (Not limited - to opened files). - </blockquote> - <ol class="arabic simple" start="6"> - <li>Now you open file that doesn't belong to Geany. For example ~/src/myprj/a.c Geany project - will be closed. If ~/src/myprj/.geanyprj exists it will be opened as current project. - </li> - <li>Switching back to any Geany file will open Geany project again. - </li> - </ol> - </div> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - geanyprj is distributed under the terms of the GNU General Public License as published by the - Free Software Foundation; either version 3 of the License, or (at your option) any later - version. A copy of this license can be found in the file COPYING included with the source code - of this program. - </p> -</div> -<div class="section" id="ideas-questions-patches-and-bug-reports"> - <h3> - Ideas, questions, patches and bug reports - </h3> - <p> - If you add something, or fix a bug, please send a patch (in 'diff -u' format) to the geany - mailing list or to one of the authors listed bellow. - </p> -</div> -<div class="section" id="coding"> - <h3> - Coding - </h3> - <p> - Use static functions where possible. Try to use GLib types and functions - e.g. g_free instead - of free and try to use only GLib 2.6 and GTK 2.6 functions. - </p> -</div> -<div class="section" id="style"> - <h3> - Style - </h3> - <p> - The file indent-all.sh contains information about the current code style. Run this script - before commit. - </p> -</div> -<div class="section" id="download"> - <h3> - Download - </h3> - <p> - The current version is: - </p> - <table border="1" class="docutils"> - <colgroup> - <col width="15%" /> - <col width="18%" /> - <col width="67%" /> - </colgroup> - <thead valign="bottom"> - <tr> - <th class="head"> - Geany Version - </th> - <th class="head"> - GeanyPrj Version - </th> - <th class="head"> - Download - </th> - </tr> - </thead> - <tbody valign="top"> - <tr> - <td> - 0.16 - </td> - <td> - 0.6 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5.tar.gz</a> - </td> - </tr> - </tbody> - </table> - <p> - Up to date source code can be downloaded here: - </p> - <pre class="literal-block"> -svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyp… -</pre> - <p> - If you have old version of Geany installed you need old version of plugin as well. These - versions of plugin are no longer supported and if you find bug in one of them, it won't be - fixed unless you do it yourself. - </p> - <table border="1" class="docutils"> - <colgroup> - <col width="15%" /> - <col width="18%" /> - <col width="67%" /> - </colgroup> - <thead valign="bottom"> - <tr> - <th class="head"> - Geany Version - </th> - <th class="head"> - GeanyPrj Version - </th> - <th class="head"> - Download - </th> - </tr> - </thead> - <tbody valign="top"> - <tr> - <td> - 0.16 - </td> - <td> - 0.5 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5.tar.gz</a> - </td> - </tr> - <tr> - <td> - 0.15 - </td> - <td> - 0.4 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.4.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.4.tar.gz</a> - </td> - </tr> - <tr> - <td> - 0.14 - </td> - <td> - 0.3 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.3.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.3.tar.gz</a> - </td> - </tr> - <tr> - <td> - 0.13 - </td> - <td> - 0.2 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.2.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.2.tar.gz</a> - </td> - </tr> - </tbody> - </table> - <div class="section" id="gentoo"> - <h4> - Gentoo - </h4> - <p> - Gentoo ebuild is available here: <a class="reference external" href= - "http://bugs.gentoo.org/show_bug.cgi?id=218506">http://bugs.gentoo.org/show_bug.cgi?id=218506</a> - </p> - </div> - <div class="section" id="arch-linux"> - <h4> - Arch linux - </h4> - <p> - A package for Arch Linux is available here: <a class="reference external" href= - "http://aur.archlinux.org/packages.php?ID=16477">http://aur.archlinux.org/packages.php?ID=16477</a> - </p> - </div> - <div class="section" id="windows"> - <h4> - Windows - </h4> - <p> - A windows installer is available here: <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5_setup.exe">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5_setup.exe</a> - </p> - <p> - 2007-2008 by Yura Siamashka yurand2(at)gmail(dot)com - </p> - </div> -</div> Deleted: www/staging/content/geanyvc.html =================================================================== --- www/staging/content/geanyvc.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/geanyvc.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,379 +0,0 @@ -<div class="contents topic" id="contents"> - <p class="topic-title first"> - Contents - </p> - <ul class="simple"> - <li> - <a class="reference internal" href="#about" id="id1" name="id1">About</a> - </li> - <li> - <a class="reference internal" href="#features" id="id2" name="id2">Features</a> - </li> - <li> - <a class="reference internal" href="#requirements" id="id3" name="id3">Requirements</a> - </li> - <li> - <a class="reference internal" href="#usage" id="id4" name="id4">Usage</a> - </li> - <li> - <a class="reference internal" href="#license" id="id5" name="id5">License</a> - </li> - <li> - <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id6" name= - "id6">Ideas, questions, patches and bug reports</a> - </li> - <li> - <a class="reference internal" href="#coding" id="id7" name="id7">Coding</a> - </li> - <li> - <a class="reference internal" href="#style" id="id8" name="id8">Style</a> - </li> - <li> - <a class="reference internal" href="#download" id="id9" name="id9">Download</a> - <ul> - <li> - <a class="reference internal" href="#gentoo" id="id10" name="id10">Gentoo</a> - </li> - <li> - <a class="reference internal" href="#arch-linux" id="id11" name="id11">Arch linux</a> - </li> - <li> - <a class="reference internal" href="#source-mage" id="id12" name="id12">Source Mage</a> - </li> - <li> - <a class="reference internal" href="#windows" id="id13" name="id13">Windows</a> - </li> - </ul> - </li> - </ul> -</div> -<div class="section" id="about"> - <h3> - About - </h3> - <p> - geanyvc is plugin that provides a uniform way of accessing the different version-control - systems inside Geany IDE. Only small subset of vc is implemented, but, hey, you don't need - anything besides diff, log, status, revert and commit most time. - </p> - <p> - In order to use it you need Geany 0.16. - </p> -</div> -<div class="section" id="features"> - <h3> - Features - </h3> - <p> - geanyvc currently support the following version control systems: - </p> - <p> - Bazaar, GIT, Mercurial, Subversion, SVK: - </p> - <pre class="literal-block"> -* diff file -* diff directory -* diff base directory -* blame -* log file -* log directory -* log base directory -* status -* revert file -* revert directory -* revert base directory -* show unmodified original file -* add file -* remove file -* update -* commit -</pre> - <p> - CVS: - </p> - <pre class="literal-block"> -* diff file -* diff directory -* diff base directory -* log file -* log directory -* log base directory -* status -* revert file -* revert directory -* revert base directory -* update -</pre> -</div> -<div class="section" id="requirements"> - <h3> - Requirements - </h3> - <p> - For compiling the plugin yourself, you will need the GTK (>= 2.6.0) libraries and header - files. You will also need its dependency libraries and header files, such as Pango, Glib and - ATK. All these files are available at <a class="reference external" href= - "http://www.gtk.org">http://www.gtk.org</a>. If you like to use spellchecking for your commit - messages you will also need gtkspell (>=2.0), but this is only optional. - </p> - <p> - And obviously, you will need have Geany installed. If you have Geany installed from the - sources, you should be ready to go. If you used a prepared package e.g. from your distribution - you probably need to install an additional package, this might be called geany-dev or - geany-devel. Please note that in order to compile and use this plugin, you need Geany 0.15 or - later. - </p> - <p> - Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these - tools are recommended. - </p> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - After compiling and/or installing geanyvc, start Geany and go to menu Tools->Plugin Manager - and set checkbox at VC plugin. - </p> - <p> - You can configure the following options: - </p> - <ul class="simple"> - <li>Set Change flag for document tabs created with pluging. - </li> - </ul> - <p> - If this option is activated, every new by the VC-plugin created document tab will be marked as - changed. Even thus this option is useful in some cases, it could cause a big number of - sometimes annoying "Do you want to save"-dialogs. - </p> - <ul class="simple"> - <li>Confirm adding new files to a VCS - </li> - </ul> - <p> - Shows a confirmation dialog on adding a new (created) file to VCS. If not set you will not see - dialog "Do you want to add <file>?" - </p> - <ul class="simple"> - <li>Maximize commit dialog - </li> - </ul> - <p> - If this option is activated, commit dialog will fit the full size of your monitor. If it is not - set commit dialog size will be 700x500. - </p> - <ul class="simple"> - <li>Use external diff viewer - </li> - </ul> - <p> - If this option is activated and you have <strong>meld</strong>, <strong>kompare</strong>, - <strong>kdiff3</strong>, <strong>diffuse</strong> or <strong>tkdiff</strong> available from - command line, one of these program will be used to show differences for "Diff From Current - File" command. - </p> - <ul class="simple"> - <li>Enable CVS/GIT/SVN/SVK/Bazaar/Mercurial - </li> - </ul> - <p> - geanyvc detect if opened file is in version control by checking directories and executing - commands from version control systems toolchain. These options disable checking for particular - version control system. Disabling not required ones can speed up things. So it is recommended - to activate svk only if you want to use it, since it is quiet slow. - </p> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - geanyvc is distributed under the terms of the GNU General Public License as published by the - Free Software Foundation; either version 2 of the License, or (at your option) any later - version. A copy of this license can be found in the file COPYING included with the source code - of this program. - </p> -</div> -<div class="section" id="ideas-questions-patches-and-bug-reports"> - <h3> - Ideas, questions, patches and bug reports - </h3> - <p> - If you add something, or fix a bug, please send a patch (in 'diff -u' format) to the geany - mailing list or to one of the authors listed bellow. - </p> -</div> -<div class="section" id="coding"> - <h3> - Coding - </h3> - <p> - Use static functions where possible. Try to use GLib types and functions - e.g. g_free instead - of free and try to use only GLib 2.6 and GTK 2.6 functions. At least for the moment, we want to - keep the minimum requirement for GTK at 2.6. - </p> -</div> -<div class="section" id="style"> - <h3> - Style - </h3> - <p> - The file indent-all.sh contains information about the current code style. Run this script - before commit. - </p> -</div> -<div class="section" id="download"> - <h3> - Download - </h3> - <p> - The current version is: - </p> - <table border="1" class="docutils"> - <colgroup> - <col width="15%" /> - <col width="17%" /> - <col width="67%" /> - </colgroup> - <thead valign="bottom"> - <tr> - <th class="head"> - Geany Version - </th> - <th class="head"> - Geanyvc Version - </th> - <th class="head"> - Download - </th> - </tr> - </thead> - <tbody valign="top"> - <tr> - <td> - 0.16 - </td> - <td> - 0.5 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.5.tar.gz">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.5.tar.gz</a> - </td> - </tr> - </tbody> - </table> - <p> - Up to date source code can be downloaded here: - </p> - <pre class="literal-block"> -svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyvc -</pre> - <p> - If you have old version of Geany installed you need old version of plugin as well. These - versions of plugin are no longer supported and if you find bug in one of them, it won't be - fixed unless you do it yourself. - </p> - <table border="1" class="docutils"> - <colgroup> - <col width="15%" /> - <col width="17%" /> - <col width="67%" /> - </colgroup> - <thead valign="bottom"> - <tr> - <th class="head"> - Geany Version - </th> - <th class="head"> - Geanyvc Version - </th> - <th class="head"> - Download - </th> - </tr> - </thead> - <tbody valign="top"> - <tr> - <td> - 0.15 - </td> - <td> - 0.4 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4.tar.gz">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4.tar.gz</a> - </td> - </tr> - <tr> - <td> - 0.14 - </td> - <td> - 0.3 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.3.tar.gz">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.3.tar.gz</a> - </td> - </tr> - <tr> - <td> - 0.13 - </td> - <td> - 0.2 - </td> - <td> - <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.2.tar.gz">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.2.tar.gz</a> - </td> - </tr> - </tbody> - </table> - <div class="section" id="gentoo"> - <h4> - Gentoo - </h4> - <p> - Gentoo ebuild is available here: <a class="reference external" href= - "http://bugs.gentoo.org/show_bug.cgi?id=218522">http://bugs.gentoo.org/show_bug.cgi?id=218522</a> - </p> - </div> - <div class="section" id="arch-linux"> - <h4> - Arch linux - </h4> - <p> - A package for Arch Linux is available here: <a class="reference external" href= - "http://aur.archlinux.org/packages.php?ID=16484">http://aur.archlinux.org/packages.php?ID=16484</a> - </p> - </div> - <div class="section" id="source-mage"> - <h4> - Source Mage - </h4> - <p> - To install geanyvc, just run the following command: - </p> - <pre class="literal-block"> -cast geanyvc -</pre> - </div> - <div class="section" id="windows"> - <h4> - Windows - </h4> - <p> - A windows installer is available here: <a class="reference external" href= - "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4_setup.exe">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4_setup.exe</a> - </p> - <p> - -- 2007-2008 by Yura Siamashka and Frank Lanitz yurand2(at)gmail(dot)com - frank(at)frank(dot)uvena(dot)de - </p> - </div> -</div> Deleted: www/staging/content/pretty-printer.html =================================================================== --- www/staging/content/pretty-printer.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/pretty-printer.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,11 +0,0 @@ -<h2>pretty-printer</h2> -<p>The pretty-printer plugin unfortunately does not have a README file yet, -where the contents for this page could be obtained from. If you are the -maintainer of the pretty-printer plugin you are appreciated to write a -README file for your plugin as a small documentation about what your plugin -does, how to use it and so on. You can get some inspiration on how to write -that by having a look at the other plugin pages.<br /> If you like to -contribute, feel free to write a README file for the pretty-printer plugin -and send it to someone who as write access to the Subversion repositorys of -Geany Plugins. Most likely a <a href="http://www.geany.org/Main/Authors"> -Geany developer</a> is such a person.</p> Deleted: www/staging/content/shiftcolumn.html =================================================================== --- www/staging/content/shiftcolumn.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/shiftcolumn.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,105 +0,0 @@ -<div class="contents topic" id="contents"> - <p class="topic-title first"> - Contents - </p> - <ul class="simple"> - <li> - <a class="reference internal" href="#about" id="id1" name="id1">About</a> - </li> - <li> - <a class="reference internal" href="#requirements" id="id2" name="id2">Requirements</a> - </li> - <li> - <a class="reference internal" href="#installation" id="id3" name="id3">Installation</a> - </li> - <li> - <a class="reference internal" href="#usage" id="id4" name="id4">Usage</a> - </li> - <li> - <a class="reference internal" href="#known-issues" id="id5" name="id5">Known issues</a> - </li> - <li> - <a class="reference internal" href="#license" id="id6" name="id6">License</a> - </li> - <li> - <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id7" name= - "id7">Ideas, questions, patches and bug reports</a> - </li> - </ul> -</div> -<div class="section" id="about"> - <h3> - About - </h3> - <p> - This plugin allows you to move blocks of text horizontally - </p> -</div> -<div class="section" id="requirements"> - <h3> - Requirements - </h3> - <p> - For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries and header - files. You will also need its dependency libraries and header files, such as Pango, Glib and - ATK. All these files are available at <a class="reference external" href= - "http://www.gtk.org">http://www.gtk.org</a>. - </p> -</div> -<div class="section" id="installation"> - <h3> - Installation - </h3> - <p> - Compiling and installing the code is done by the following three commands: $ ./configure $ make - $ make install - </p> - <p> - For more configuration details run $ ./configure --help - </p> - <p> - If there are any errors during compilation, check your build environment and try to find the - error, otherwise contact one of the authors. - </p> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - After installed successfully, load the plugin in Geany's plugin manager and a new menu item in - the Tools menu will appear. Alternatively, you can assign a keyboard shortcut in Geany's - preferences dialog. By default the mappings are to <Ctrl>9 and <Ctrl>0 - </p> -</div> -<div class="section" id="known-issues"> - <h3> - Known issues - </h3> - <blockquote> - <ul class="simple"> - <li>none, my code rocks.. (well I can hope) - </li> - </ul> - </blockquote> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - Shift Column is distributed under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or (at your option) any later - version. A copy of this license can be found in the file COPYING included with the source code - of this program. - </p> -</div> -<div class="section" id="ideas-questions-patches-and-bug-reports"> - <h3> - Ideas, questions, patches and bug reports - </h3> - <p> - Andrew Janke <<a class="reference external" href= - "mailto:a.janke%40gmail.com">a<span>.</span>janke<span>@</span>gmail<span>.</span>com</a>> - </p> -</div> Deleted: www/staging/content/spellcheck.html =================================================================== --- www/staging/content/spellcheck.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/spellcheck.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,195 +0,0 @@ -<div class="contents topic" id="contents"> - <p class="topic-title first"> - Contents - </p> - <ul class="simple"> - <li> - <a class="reference internal" href="#about" id="id1" name="id1">About</a> - </li> - <li> - <a class="reference internal" href="#downloads" id="id2" name="id2">Downloads</a> - <ul> - <li> - <a class="reference internal" href="#development-code" id="id3" name="id3">Development - Code</a> - </li> - </ul> - </li> - <li> - <a class="reference internal" href="#requirements" id="id4" name="id4">Requirements</a> - </li> - <li> - <a class="reference internal" href="#installation" id="id5" name="id5">Installation</a> - </li> - <li> - <a class="reference internal" href="#usage" id="id6" name="id6">Usage</a> - </li> - <li> - <a class="reference internal" href="#known-issues" id="id7" name="id7">Known issues</a> - </li> - <li> - <a class="reference internal" href="#license" id="id8" name="id8">License</a> - </li> - <li> - <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id9" name= - "id9">Ideas, questions, patches and bug reports</a> - </li> - </ul> -</div> -<div class="section" id="about"> - <h3> - About - </h3> - <p> - This plugin checks the content of the current document in Geany with the spell check library - Enchant. You can also select a certain text passage, then the plugin will only check the - selected text. All lines with misspelled words are highlighted with a red squiggly underline - and the wrong words are printed in the messages window at the bottom of Geany together with - available suggestions. For the plugin to work at all, you need to have the Enchant library - installed together with at least one backend (Aspell, Myspell, Hunspell, ...). The plugin's - configure dialog lists all available languages/dictionaries which can be used for the spell - check. - </p> -</div> -<div class="section" id="downloads"> - <h3> - Downloads - </h3> - <p> - Spell Check is part of the combined Geany Plugins release. For more information and downloads, - please visit <a class="reference external" href= - "http://plugins.geany.org/geany-plugins/">http://plugins.geany.org/geany-plugins/</a> - </p> - <div class="section" id="development-code"> - <h4> - Development Code - </h4> - <p> - Get the code from: - </p> - <blockquote> - svn checkout <a class="reference external" href= - "http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…">http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…</a> - </blockquote> - </div> -</div> -<div class="section" id="requirements"> - <h3> - Requirements - </h3> - <p> - For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries and header - files. You will also need its dependency libraries and header files, such as Pango, Glib and - ATK. All these files are available at <a class="reference external" href= - "http://www.gtk.org">http://www.gtk.org</a>. Furthermore, you need to have installed enchant - with its development files (libenchant-dev or enchant-devel). - </p> - <p> - And obviously, you will need have Geany installed. If you have Geany installed from the - sources, you should be ready to go. If you used a prepared package e.g. from your distribution - you probably need to install an additional package, this might be called geany-dev or - geany-devel. Please note that in order to compile and use this plugin, you need Geany 0.16 or - later. - </p> - <p> - Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these - tools are recommended. - </p> -</div> -<div class="section" id="installation"> - <h3> - Installation - </h3> - <p> - Compiling and installing the code is done by the following three commands: $ ./configure $ make - $ make install - </p> - <p> - For more configuration details run $ ./configure --help - </p> - <p> - If there are any errors during compilation, check your build environment and try to find the - error, otherwise contact one of the authors. - </p> -</div> -<div class="section" id="usage"> - <h3> - Usage - </h3> - <p> - After installed successfully, load the plugin in Geany's plugin manager and a new menu item in - the Tools menu will appear. Alternatively, you can assign a keyboard shortcut in Geany's - preferences dialog to perform a spell check. - </p> -</div> -<div class="section" id="known-issues"> - <h3> - Known issues - </h3> - <blockquote> - <ul> - <li> - <p class="first"> - Spell checking with some languages like Hindi might be incorrect, i.e. some words are - incorrectly marked as correctly spelled or marked incorrectly as misspelled. - </p> - </li> - <li> - <p class="first"> - Crashes of Geany when loading the Spell Check plugin after it was unloaded. This can - happen when you are using a dictionary from the Zemberek provider of Enchant (mostly - Turkish dictionaries). It can also happen when you tried to use a non-existing dictionary - and the Zemberek provider is installed on your system. To avoid these crashes you have - the following options: - </p> - <blockquote> - <ul class="simple"> - <li>Do not load the plugin after it was unloaded, restart Geany first - </li> - <li>Do not use any of the dictionaries provided by the Zemberek provider - </li> - <li>Update your Enchant version at least to 1.4.3 (once it is released) - </li> - <li>Uninstall the Zemberek provider - </li> - </ul> - </blockquote> - </li> - </ul> - <blockquote> - <dl class="docutils"> - <dt> - Background: - </dt> - <dd> - These crashes are all related to the Zemberek provider in Enchant. In version 1.4.2 and - prior of Enchant, this provider/backend always claimed to support any given invalid - dictionary name and so it was active and caused these crashes on load after unload of the - plugin. This provider is DBus-based and uses the GObject type registration system which - is not really capable of being unloaded and loaded again. - </dd> - </dl> - </blockquote> - </blockquote> -</div> -<div class="section" id="license"> - <h3> - License - </h3> - <p> - Spell Check is distributed under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or (at your option) any later - version. A copy of this license can be found in the file COPYING included with the source code - of this program. - </p> -</div> -<div class="section" id="ideas-questions-patches-and-bug-reports"> - <h3> - Ideas, questions, patches and bug reports - </h3> - <p> - Send it to me at enrico(dot)troeger(at)uvena(dot)de or report them at <a class= - "reference external" href= - "http://sourceforge.net/tracker/?group_id=222729">http://sourceforge.net/tracker/?group_id=222729</a>. - </p> -</div> Deleted: www/staging/content/treebrowser.html =================================================================== --- www/staging/content/treebrowser.html 2010-07-17 20:34:09 UTC (rev 1475) +++ www/staging/content/treebrowser.html 2010-07-17 20:45:19 UTC (rev 1476) @@ -1,11 +0,0 @@ -<h2>treebrowser</h2> -<p>The treebrowser plugin unfortunately does not have a README file yet, -where the contents for this page could be obtained from. If you are the -maintainer of the treebrowser plugin you are appreciated to write a -README file for your plugin as a small documentation about what your plugin -does, how to use it and so on. You can get some inspiration on how to write -that by having a look at the other plugin pages.<br /> If you like to -contribute, feel free to write a README file for the treebrowser plugin -and send it to someone who as write access to the Subversion repositorys of -Geany Plugins. Most likely a <a href="http://www.geany.org/Main/Authors"> -Geany developer</a> is such a person.</p> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1475] www
by dmaphy＠users.sourceforge.net 17 Jul '10

17 Jul '10

Revision: 1475 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1475&view=rev Author: dmaphy Date: 2010-07-17 20:34:09 +0000 (Sat, 17 Jul 2010) Log Message: ----------- create www directory to manage code for the plugins.geany.org website Added Paths: ----------- www/ www/stable/ www/staging/ www/staging/content/ www/staging/content/404.html www/staging/content/README www/staging/content/README.html www/staging/content/about.html www/staging/content/addons.html www/staging/content/codenav.html www/staging/content/externdbg.html www/staging/content/geany-mini-script.html www/staging/content/geany-plugins-listing.html www/staging/content/geanydoc.html www/staging/content/geanyembrace.html www/staging/content/geanyextrasel.html www/staging/content/geanygdb.html www/staging/content/geanygendoc.html www/staging/content/geanyinsertnum.html www/staging/content/geanylatex.html www/staging/content/geanylipsum.html www/staging/content/geanylua.html www/staging/content/geanyprj.html www/staging/content/geanysendmail.html www/staging/content/geanyvc.html www/staging/content/licensing.html www/staging/content/pretty-printer.html www/staging/content/rst2html_config.conf www/staging/content/rst2html_template.txt www/staging/content/shiftcolumn.html www/staging/content/spellcheck.html www/staging/content/start.html www/staging/content/tidy.conf www/staging/content/treebrowser.html www/staging/favicon.ico www/staging/gencontent.sh www/staging/gencontent_logs/ www/staging/gencontent_logs/addons_log_2010-07-17 www/staging/gencontent_logs/codenav_log_2010-07-17 www/staging/gencontent_logs/geanydoc_log_2010-07-17 www/staging/gencontent_logs/geanyextrasel_log_2010-07-17 www/staging/gencontent_logs/geanygdb_log_2010-07-17 www/staging/gencontent_logs/geanygendoc_log_2010-07-17 www/staging/gencontent_logs/geanyinsertnum_log_2010-07-17 www/staging/gencontent_logs/geanylipsum_log_2010-07-17 www/staging/gencontent_logs/geanylua_log_2010-07-17 www/staging/gencontent_logs/geanyprj_log_2010-07-17 www/staging/gencontent_logs/geanyvc_log_2010-07-17 www/staging/gencontent_logs/pretty-printer_log_2010-07-17 www/staging/gencontent_logs/shiftcolumn_log_2010-07-17 www/staging/gencontent_logs/spellcheck_log_2010-07-17 www/staging/gencontent_logs/treebrowser_log_2010-07-17 www/staging/images/ www/staging/images/geany.png www/staging/index.php www/staging/rst2html_template.txt www/staging/stylesheets/ www/staging/stylesheets/mainstyle.css www/staging/templates/ www/staging/templates/no-readme-template.html www/staging/templates/template.html www/staging/tidy.conf Added: www/staging/content/404.html =================================================================== --- www/staging/content/404.html (rev 0) +++ www/staging/content/404.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,6 @@ +<h2>Content not found</h2> +<p>Sorry, the content you requested could not be found. Any content +plugins.geany.org is able to provide can be found by clicking one of the links +in the navigation bar on the left side. If you think there is some content +missing, please contact the maintainer of this site:<br /> +Dominic Hopf <dmaphy(a)googlemail.com></p> Added: www/staging/content/README =================================================================== --- www/staging/content/README (rev 0) +++ www/staging/content/README 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,69 @@ +How to get your plugin listed here +================================== + +.. contents:: + +There are different ways to get your plugin listed here. Every possibility +ends with contacting Dominic Hopf. He is the maintainer of this website and +takes care of uploading the HTML files and including new plugins into +navigation and so on. + + +Note +---- +If your plugin already is part of the Geany Plugins project, you should find +your plugin listed here. There is a cronjob running every night, which +updates the plugins.geany.org website with latest information from the +README files of the plugins. For this to work correctly, it is necessary +you have a README file in trunk/geany-plugins/{your plugin name}/ which is +written in restructuredText. + +If the README file is there, but still not listed on the plugins.geany.org +website, make sure you gave the cronjob a chance to find your README and +wait a night before contacting Dominic to have a deeper look on the issue. + + +1. Way +------ + +* create a file {your plugin name}.html +* edit the file manually, get inspired by the plugin sites already existing + and keep an eye on the validity of the HTML code. It should be XHTML 1.1 - + which is very strict. +* when your HTML file is finished, contact Dominic by mail and send him + your file. He will do the rest for you. + + +2. Way +------ + +This one will only work, if you write your README file in restructuredText +as some other plugin authors do. You will need to use two tools: rst2html +and HTML Tidy. Dominic wrote some configuration files for use with those +tools. If you do not have them yet, feel free to contact Dominic to get +them. The result should be an almost perfect HTML file which can be +included into the plugins.geany.org website. Do this steps to generate the +file: + + rst2html --config=rst2html_config.conf README > {your plugin name}.html + tidy -config tidy.conf {your plugin name}.html + +While {your plugin name} is the actual UNIX name (lowercase!) of your plugin. +Note: There is no need for HTML headers and body and so on. Those will be +provided by the website itself. Your HTML file should just provide pure +XHTML 1.1 validating content, it will appear within the body tags on the +plugins.geany.org website. + +When you're done, have a look if your HTML file looks good (get some +inspiration from already existing plugin sites) and send it to Dominic then. + + +Contact +------- + +The website plugins.geany.org is currently maintained by `Dominic Hopf +<http://dominichopf.de>`_. His mail address is dmaphy(a)googlemail.com. If +you have any questions concerning this site, please consider to contact him +first of all. If it may takes too long for an answer, feel free to kick his +butt at the `#geany <irc://chat.freenode.net/geany>`_ IRC channel on +chat.freenode.net. Added: www/staging/content/README.html =================================================================== --- www/staging/content/README.html (rev 0) +++ www/staging/content/README.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,64 @@ +<div class="contents topic" id="contents"> +<p class="topic-title first">Contents</p> +<ul class="simple"> +<li><a class="reference internal" href="#note" id="id2">Note</a></li> +<li><a class="reference internal" href="#way" id="id3">1. Way</a></li> +<li><a class="reference internal" href="#id1" id="id4">2. Way</a></li> +<li><a class="reference internal" href="#contact" id="id5">Contact</a></li> +</ul> +</div> +<p>There are different ways to get your plugin listed here. Every possibility +ends with contacting Dominic Hopf. He is the maintainer of this website and +takes care of uploading the HTML files and including new plugins into +navigation and so on.</p> +<div class="section" id="note"> +<h3>Note</h3> +<p>If your plugin already is part of the Geany Plugins project, you should find +your plugin listed here. There is a cronjob running every night, which +updates the plugins.geany.org website with latest information from the +README files of the plugins. For this to work correctly, it is necessary +you have a README file in trunk/geany-plugins/{your plugin name}/ which is +written in restructuredText.</p> +<p>If the README file is there, but still not listed on the plugins.geany.org +website, make sure you gave the cronjob a chance to find your README and +wait a night before contacting Dominic to have a deeper look on the issue.</p> +</div> +<div class="section" id="way"> +<h3>1. Way</h3> +<ul class="simple"> +<li>create a file {your plugin name}.html</li> +<li>edit the file manually, get inspired by the plugin sites already existing +and keep an eye on the validity of the HTML code. It should be XHTML 1.1 - +which is very strict.</li> +<li>when your HTML file is finished, contact Dominic by mail and send him +your file. He will do the rest for you.</li> +</ul> +</div> +<div class="section" id="id1"> +<h3>2. Way</h3> +<p>This one will only work, if you write your README file in restructuredText +as some other plugin authors do. You will need to use two tools: rst2html +and HTML Tidy. Dominic wrote some configuration files for use with those +tools. If you do not have them yet, feel free to contact Dominic to get +them. The result should be an almost perfect HTML file which can be +included into the plugins.geany.org website. Do this steps to generate the +file:</p> +<blockquote> +rst2html --config=rst2html_config.conf README > {your plugin name}.html +tidy -config tidy.conf {your plugin name}.html</blockquote> +<p>While {your plugin name} is the actual UNIX name (lowercase!) of your plugin. +Note: There is no need for HTML headers and body and so on. Those will be +provided by the website itself. Your HTML file should just provide pure +XHTML 1.1 validating content, it will appear within the body tags on the +plugins.geany.org website.</p> +<p>When you're done, have a look if your HTML file looks good (get some +inspiration from already existing plugin sites) and send it to Dominic then.</p> +</div> +<div class="section" id="contact"> +<h3>Contact</h3> +<p>The website plugins.geany.org is currently maintained by <a class="reference external" href="http://dominichopf.de">Dominic Hopf</a>. His mail address is <a class="reference external" href="mailto:dmaphy%40googlemail.com">dmaphy<span>@</span>googlemail<span>.</span>com</a>. If +you have any questions concerning this site, please consider to contact him +first of all. If it may takes too long for an answer, feel free to kick his +butt at the <a class="reference external" href="irc://chat.freenode.net/geany">#geany</a> IRC channel on +chat.freenode.net.</p> +</div> Added: www/staging/content/about.html =================================================================== --- www/staging/content/about.html (rev 0) +++ www/staging/content/about.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,11 @@ +<h2>About</h2> +<p>This site is maintained by <a href="http://dominichopf.de/">Dominic Hopf</a>. +Please contact him if you like to add some information or a new plugin or found +an error or anything else.</p> + +<p>You will find him and any other plugin developer either on the +<a href="http://www.geany.org/Support/MailingList">Geany mailing lists</a> or on +the <a href="http://www.geany.org/Support/IRC">Geany IRC channels</a>.<br /> +Any detailed information on how to contact a developer can be found in the +concerning README file of the plugin or on the concerning plugin page on this +site.</p> Added: www/staging/content/addons.html =================================================================== --- www/staging/content/addons.html (rev 0) +++ www/staging/content/addons.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,174 @@ +<div class="section" id="about"> + <h3> + About + </h3> + <p> + This plugin adds various small addons to Geany which aren't worth an own plugin but might still + useful for people. + </p> + <div class="section" id="doclist"> + <h4> + DocList + </h4> + <p> + This addon places a new item in the toolbar and when clicked offers a menu listing all open + files plus the 'Close All' and 'Close Other Documents' menu items. This can be useful to + quickly access open files and switch to them. + </p> + </div> + <div class="section" id="openuri"> + <h4> + OpenURI + </h4> + <p> + Adds 'Open URI' and 'Copy URI' menu items to the editor menu when the word under the cursor + looks like a URI. 'Open URI' uses the browser command configured in Geany to open it. + </p> + </div> + <div class="section" id="tasks"> + <h4> + Tasks + </h4> + <p> + The tasks plugin goes through a file being edited and picks out lines with configurable + keywords (e.g. "TODO" or "FIXME") in them. It collects the text after + those words and puts them in a new "Tasks" tab in the message window. Clicking on a + task in that tab takes you to the line in the file where the task was defined. + </p> + </div> + <div class="section" id="systray"> + <h4> + Systray + </h4> + <p> + Adds a status icon to the notification area (systray) and provides a simple popup menu with + some basic actions. It can also be used to quickly show and hide the Geany main window. + </p> + </div> + <div class="section" id="bookmark-list"> + <h4> + Bookmark List + </h4> + <p> + Add a list of defined bookmarks (line markers) to the sidebar. This list contains all + bookmarks defined in the current file for faster overview and access. + </p> + </div> + <div class="section" id="mark-word"> + <h4> + Mark Word + </h4> + <p> + When double-clicking a word, all occurences of this word are searched and then highlighted + (similar to Geany's 'Mark All' Find option). + </p> + </div> + <div class="section" id="strip-trailing-blank-lines"> + <h4> + Strip trailing blank lines + </h4> + <p> + This addon removes excessive trailing blank lines from the document when it is saved. If you + have 'Ensure new line at file end' option checked in Preferences, one trailing newline will + be left. + </p> + </div> + <div class="section" id="xmltagging"> + <h4> + XMLtagging + </h4> + <p> + XMLtagging allows to easy tag a selected text, by checking for a selection, offering a little + dialog for inserting a tag and replacing a selection. + </p> + </div> +</div> +<div class="section" id="downloads"> + <h3> + Downloads + </h3> + <p> + The Addons plugin is part of the combined Geany Plugins release. For more information and + downloads, please visit <a class="reference external" href= + "http://plugins.geany.org/geany-plugins/">http://plugins.geany.org/geany-plugins/</a> + </p> + <div class="section" id="development-code"> + <h4> + Development Code + </h4> + <p> + Get the code from: + </p> + <blockquote> + svn checkout <a class="reference external" href= + "http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…">http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…</a> + </blockquote> + </div> +</div> +<div class="section" id="requirements"> + <h3> + Requirements + </h3> + <p> + For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries and header + files. You will also need its dependency libraries and header files, such as Pango, Glib and + ATK. All these files are available at <a class="reference external" href= + "http://www.gtk.org">http://www.gtk.org</a>. + </p> + <p> + And obviously, you will need have Geany installed. If you have Geany installed from the + sources, you should be ready to go. If you used a prepared package e.g. from your distribution + you probably need to install an additional package, this might be called geany-dev or + geany-devel. Please note that in order to compile and use this plugin, you need Geany 0.16 or + later. + </p> + <p> + Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these + tools are recommended. + </p> +</div> +<div class="section" id="installation"> + <h3> + Installation + </h3> + <p> + Compiling and installing the code is done by the following three commands: $ ./configure $ make + $ make install + </p> + <p> + For more configuration details run $ ./configure --help + </p> + <p> + If there are any errors during compilation, check your build environment and try to find the + error, otherwise contact one of the authors. + </p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + After installed successfully, simply load the plugin in Geany's plugin manager. In the + configuration dialog you can enable or disable the various components of this plugin. + </p> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + Addons is distributed under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 2 of the License, or (at your option) any later + version. A copy of this license can be found in the file COPYING included with the source code + of this program. + </p> +</div> +<div class="section" id="ideas-questions-patches-and-bug-reports"> + <h3> + Ideas, questions, patches and bug reports + </h3> + <p> + Report them at <a class="reference external" href= + "http://sourceforge.net/tracker/?group_id=222729">http://sourceforge.net/tracker/?group_id=222729</a>. + </p> +</div> Added: www/staging/content/codenav.html =================================================================== --- www/staging/content/codenav.html (rev 0) +++ www/staging/content/codenav.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,76 @@ +<div class="section" id="about"> + <h3> + About + </h3> + <p> + This plugin adds some facilities for navigating in the code. Actually, it will make it possible + to : - switch between header and implementation - go to a file by typing its name + </p> +</div> +<div class="section" id="requirements"> + <h3> + Requirements + </h3> + <p> + For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries and header + files. You will also need its dependency libraries and header files, such as Pango, Glib and + ATK. All these files are available at <a class="reference external" href= + "http://www.gtk.org">http://www.gtk.org</a>. + </p> +</div> +<div class="section" id="installation"> + <h3> + Installation + </h3> + <p> + Compiling and installing the code is done by the following three commands: $ ./configure $ make + $ make install + </p> + <p> + For more configuration details run $ ./configure --help + </p> + <p> + If there are any errors during compilation, check your build environment and try to find the + error, otherwise contact one of the authors. + </p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + After installed successfully, load the plugin in Geany's plugin manager and new menu items in + the Edit menu will appear. You can change the keyboard shortcuts in Geany's preferences dialog. + </p> +</div> +<div class="section" id="known-issues"> + <h3> + Known issues + </h3> + <blockquote> + <ul class="simple"> + <li>still in development... + </li> + </ul> + </blockquote> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + "Code navigation plugin" is distributed under the terms of the GNU General Public + License as published by the Free Software Foundation; either version 2 of the License, or (at + your option) any later version. A copy of this license can be found in the file COPYING + included with the source code of this program. + </p> +</div> +<div class="section" id="ideas-questions-patches-and-bug-reports"> + <h3> + Ideas, questions, patches and bug reports + </h3> + <p> + Lionel Fuentes <<a class="reference external" href= + "mailto:funto66%40gmail.com">funto66<span>@</span>gmail<span>.</span>com</a>> + </p> +</div> Added: www/staging/content/externdbg.html =================================================================== --- www/staging/content/externdbg.html (rev 0) +++ www/staging/content/externdbg.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1 @@ +<h2>externdbg</h2> Added: www/staging/content/geany-mini-script.html =================================================================== --- www/staging/content/geany-mini-script.html (rev 0) +++ www/staging/content/geany-mini-script.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1 @@ +<h2>Geany Mini Script</h2> Added: www/staging/content/geany-plugins-listing.html =================================================================== --- www/staging/content/geany-plugins-listing.html (rev 0) +++ www/staging/content/geany-plugins-listing.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,14 @@ +<li><a href="index.php?site=addons">addons</a></li> +<li><a href="index.php?site=codenav">codenav</a></li> +<li><a href="index.php?site=geanydoc">geanydoc</a></li> +<li><a href="index.php?site=geanyextrasel">geanyextrasel</a></li> +<li><a href="index.php?site=geanygdb">geanygdb</a></li> +<li><a href="index.php?site=geanyinsertnum">geanyinsertnum</a></li> +<li><a href="index.php?site=geanylatex">geanylatex</a></li> +<li><a href="index.php?site=geanylipsum">geanylipsum</a></li> +<li><a href="index.php?site=geanylua">geanylua</a></li> +<li><a href="index.php?site=geanyprj">geanyprj</a></li> +<li><a href="index.php?site=geanysendmail">geanysendmail</a></li> +<li><a href="index.php?site=geanyvc">geanyvc</a></li> +<li><a href="index.php?site=shiftcolumn">shiftcolumn</a></li> +<li><a href="index.php?site=spellcheck">spellcheck</a></li> Added: www/staging/content/geanydoc.html =================================================================== --- www/staging/content/geanydoc.html (rev 0) +++ www/staging/content/geanydoc.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,294 @@ +<div class="contents topic" id="contents"> + <p class="topic-title first"> + Contents + </p> + <ul class="simple"> + <li> + <a class="reference internal" href="#about" id="id1" name="id1">About</a> + </li> + <li> + <a class="reference internal" href="#usage" id="id2" name="id2">Usage</a> + </li> + <li> + <a class="reference internal" href="#settings" id="id3" name="id3">Settings</a> + </li> + <li> + <a class="reference internal" href="#license" id="id4" name="id4">License</a> + </li> + <li> + <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id5" name= + "id5">Ideas, questions, patches and bug reports</a> + </li> + <li> + <a class="reference internal" href="#coding" id="id6" name="id6">Coding</a> + </li> + <li> + <a class="reference internal" href="#style" id="id7" name="id7">Style</a> + </li> + <li> + <a class="reference internal" href="#download" id="id8" name="id8">Download</a> + <ul> + <li> + <a class="reference internal" href="#gentoo" id="id9" name="id9">Gentoo</a> + </li> + <li> + <a class="reference internal" href="#arch-linux" id="id10" name="id10">Arch linux</a> + </li> + <li> + <a class="reference internal" href="#windows" id="id11" name="id11">Windows</a> + </li> + </ul> + </li> + <li> + <a class="reference internal" href="#author" id="id12" name="id12">Author</a> + </li> + </ul> +</div> +<div class="section" id="about"> + <h3> + About + </h3> + <p> + Geanydoc is plugin for Geany IDE that allow execute specified commands on the current word at + the cursor position. This word is passed as an argument to these commands. It allow either + place output of these commands in geany buffer *DOC* or just execute external program. Geanydoc + is intended to be used for searching documentation API in different sources. + </p> + <p> + In order to use it you need Geany >= 0.16 or svn version. + </p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + geanydoc define 2 keyboard shortcut "Document current word" and "Document + interactive" First you need to assign key to them in + "Edit->Preferences->Keybinding->Doc". + </p> + <p> + "Document current word" search documentation on the current word near cursor + position. "Document interactive" search documentation on word you enter in + interactive dialog. + </p> +</div> +<div class="section" id="settings"> + <h3> + Settings + </h3> + <p> + geanydoc allow to execute different commands for different filetypes. Use combobox to select + type you need. + </p> + <p> + "Put output in buffer" if you check this checkbox geanydoc will execute command wait + for it's exit and place it's output in geany buffer. If you have this button unchecked geanydoc + will simply spawn command and forgot about it. + </p> + <p> + NOTE: if you have multiple command all commands but last are treated as "Put output in + buffer" true. This checkbox is used only for last command. + </p> + <p> + If you specify several commands, second command will be called only if first one didn't return + something in output. + </p> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + geanydoc is distributed under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 3 of the License, or (at your option) any later + version. A copy of this license can be found in the file COPYING included with the source code + of this program. + </p> +</div> +<div class="section" id="ideas-questions-patches-and-bug-reports"> + <h3> + Ideas, questions, patches and bug reports + </h3> + <p> + If you add something, or fix a bug, please send a patch (in 'diff -u' format) to the geany + mailing list or to one of the authors listed bellow. + </p> +</div> +<div class="section" id="coding"> + <h3> + Coding + </h3> + <p> + Use static functions where possible. Try to use GLib types and functions - e.g. g_free instead + of free and try to use only GLib 2.6 and GTK 2.6 functions. + </p> +</div> +<div class="section" id="style"> + <h3> + Style + </h3> + <p> + The file indent-all.sh contains information about the current code style. Run this script + before commit. + </p> +</div> +<div class="section" id="download"> + <h3> + Download + </h3> + <p> + The current version is: + </p> + <table border="1" class="docutils"> + <colgroup> + <col width="15%" /> + <col width="18%" /> + <col width="67%" /> + </colgroup> + <thead valign="bottom"> + <tr> + <th class="head"> + Geany Version + </th> + <th class="head"> + GeanyDoc Version + </th> + <th class="head"> + Download + </th> + </tr> + </thead> + <tbody valign="top"> + <tr> + <td> + 0.16 + </td> + <td> + 0.5 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4.tar.gz</a> + </td> + </tr> + </tbody> + </table> + <p> + Up to date source code can be downloaded here: + </p> + <pre class="literal-block"> +svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyd… +</pre> + <p> + If you have old version of Geany installed you need old version of plugin as well. These + versions of plugin are no longer supported and if you find bug in one of them, it won't be + fixed unless you do it yourself. + </p> + <table border="1" class="docutils"> + <colgroup> + <col width="15%" /> + <col width="18%" /> + <col width="67%" /> + </colgroup> + <thead valign="bottom"> + <tr> + <th class="head"> + Geany Version + </th> + <th class="head"> + GeanyDoc Version + </th> + <th class="head"> + Download + </th> + </tr> + </thead> + <tbody valign="top"> + <tr> + <td> + 0.16 + </td> + <td> + 0.4 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4.tar.gz</a> + </td> + </tr> + <tr> + <td> + 0.15 + </td> + <td> + 0.3 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.3.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.3.tar.gz</a> + </td> + </tr> + <tr> + <td> + 0.14 + </td> + <td> + 0.2 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.2.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.2.tar.gz</a> + </td> + </tr> + <tr> + <td> + 0.13 + </td> + <td> + 0.1 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.1.tar.gz">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.1.tar.gz</a> + </td> + </tr> + </tbody> + </table> + <div class="section" id="gentoo"> + <h4> + Gentoo + </h4> + <p> + Gentoo ebuild is available here: <a class="reference external" href= + "http://bugs.gentoo.org/show_bug.cgi?id=218493">http://bugs.gentoo.org/show_bug.cgi?id=218493</a> + </p> + </div> + <div class="section" id="arch-linux"> + <h4> + Arch linux + </h4> + <p> + A package for Arch Linux is available here: <a class="reference external" href= + "http://aur.archlinux.org/packages.php?ID=16475">http://aur.archlinux.org/packages.php?ID=16475</a> + </p> + </div> + <div class="section" id="windows"> + <h4> + Windows + </h4> + <p> + A windows installer is available here: <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4_setup.exe">http://users.cosmostv.by/yurand/geanydoc/geanydoc-0.4_setup.exe</a> + </p> + </div> +</div> +<div class="section" id="author"> + <h3> + Author + </h3> + <p> + Yura Siamashka <a class="reference external" href= + "http://users.cosmostv.by/yurand/cv.html">http://users.cosmostv.by/yurand/cv.html</a> + </p> +</div> Added: www/staging/content/geanyembrace.html =================================================================== --- www/staging/content/geanyembrace.html (rev 0) +++ www/staging/content/geanyembrace.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1 @@ +<h2>GeanyEmbrace</h2> Added: www/staging/content/geanyextrasel.html =================================================================== --- www/staging/content/geanyextrasel.html (rev 0) +++ www/staging/content/geanyextrasel.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,134 @@ +<div class="section" id="about"> + <h3> + About + </h3> + <p> + The Extra Selection adds the following functions: + </p> + <p> + Goto matching brace and select (Select to matching brace). + </p> + <p> + Goto line and select (Select to line). + </p> + <p> + Ctrl-Shift-Alt-Left/Right/Home/End keys - same as Ctrl-Shift, but for rectangular selection. + </p> + <p> + Column mode - while active, all (Ctrl)-Shift-movement keys do rectangle selection instead of + stream. + </p> + <p> + "Movement keys" refers to the arrows, Home, End, Page Up and Page Down. + </p> + <p> + For more information, see the Usage section below. + </p> +</div> +<div class="section" id="requirements"> + <h3> + Requirements + </h3> + <p> + Geany 0.18 or later and the respective headers and development libraries. + </p> +</div> +<div class="section" id="installation"> + <h3> + Installation + </h3> + <p> + Compiling and installing the code is done by the following three commands: + </p> + <p> + $ ./waf configure $ ./waf build $ ./waf install + </p> + <p> + For more configuration details run $ ./waf --help + </p> + <p> + If there are any errors during compilation, check your build environment. + </p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + Under Tools -> Extra Selection, there are 3 new items: "Column mode", "Select + to line" and "Select to matching brace". Normally these should be bound to keys, + for example Alt-c, Alt-Shift-l and Control-Shift-b. Now: + </p> + <ol class="arabic"> + <li> + <p class="first"> + Position the cursor on an opening brace and invoke "Select to matching brace". + The cursor will move to the closing brace, and the braced area will be selected. + </p> + </li> + <li> + <p class="first"> + Position the cursor on line 10, invoke "Select to line" and enter 15. The cursor + will move to line 15, and the area between the previous and the new current cursor position + will be selected. + </p> + </li> + <li> + <p class="first"> + Select a small rectangular area and press Control-Alt-Shift-Right. The cursor will move to + the next word, extending the rectangurar selection. The complete new keys list is: + </p> + <p> + Control-Alt-Shift Extends the selection to ----------------- ------------------------ Left + Previous word Right Next word Up Previous paragraph Down Next paragraph Home Start of file + End End of file + </p> + </li> + </ol> + <p> + Unfortunately, holding Alt for rectangular selection has some problems, which apply both to the + standard Geany keys and these added by the plugin. Under Windows, Alt and the keypad keys + generate unicodes, even if used with Shift or Control. With X11, some + Alt-(Ctrl)-(Shift)-movement keys may be used by the window manager for switching to the + previous/next desktop, moving windows etc. So then: + </p> + <ol class="arabic simple" start="4"> + <li>Turn "Column mode" on. While active, the (Control)-Shift-movement keys will + select a rectangle instead of stream without the need to hold Alt (in fact, the + (Control)-Alt-Shift-movement keys will be temporarily blocked). This way, you will avoid the + Alt key problems mentioned above, and it's move convinient to select while holding Shift only. + </li> + </ol> +</div> +<div class="section" id="known-issues"> + <h3> + Known issues + </h3> + <p> + The column mode is global, not per-document. However, (de)activating it will change the + selection (if any) to stream/rectangle for the current document only. + </p> + <p> + The column mode applies to the movement keys only - not to mouse selection, find functions etc. + </p> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + Extra Selection is distributed under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 2 of the License, or (at your option) any later + version. A copy of this license can be found in the file COPYING included with the source code + of this program. + </p> +</div> +<div class="section" id="ideas-questions-patches-and-bug-reports"> + <h3> + Ideas, questions, patches and bug reports + </h3> + <p> + Dimitar Zhekov <<a class="reference external" href= + "mailto:dimitar.zhekov%40gmail.com">dimitar<span>.</span>zhekov<span>@</span>gmail<span>.</span>com</a>> + </p> +</div> Added: www/staging/content/geanygdb.html =================================================================== --- www/staging/content/geanygdb.html (rev 0) +++ www/staging/content/geanygdb.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,241 @@ +<div class="contents topic" id="contents"> + <p class="topic-title first"> + Contents + </p> + <ul class="simple"> + <li> + <a class="reference internal" href="#about" id="id2" name="id2">About</a> + </li> + <li> + <a class="reference internal" href="#current-version" id="id3" name="id3">Current Version</a> + </li> + <li> + <a class="reference internal" href="#requirements" id="id4" name="id4">Requirements</a> + </li> + <li> + <a class="reference internal" href="#installation" id="id5" name="id5">Installation</a> + </li> + <li> + <a class="reference internal" href="#documentation" id="id6" name="id6">Documentation</a> + </li> + <li> + <a class="reference internal" href="#download" id="id7" name="id7">Download</a> + <ul> + <li> + <a class="reference internal" href="#id1" id="id8" name="id8">Current Version</a> + </li> + <li> + <a class="reference internal" href="#older-versions" id="id9" name="id9">Older + Versions</a> + </li> + </ul> + </li> + <li> + <a class="reference internal" href="#contact" id="id10" name="id10">Contact</a> + </li> + </ul> +</div> +<div class="section" id="about"> + <h3> + About + </h3> + <p> + GeanyGDB is a plugin for Geany which provides integrated debugging support within Geany via the + GNU Debugger (GDB). + </p> + <p> + Geany is a small and lightweight integrated development environment using the GTK2 toolkit. + </p> + <p> + The GNU Debugger is a source-level debugger for C, C++, Fortran, Modula 2 and Java programs. + </p> + <p> + It was developed and tested on openSUSE-10.3 with GDB-6.7.50. Other recent versions of GDB will + probably work, but operating systems other than Linux-PC will not work, at least not without + some considerable hacking. + </p> +</div> +<div class="section" id="current-version"> + <h3> + Current Version + </h3> + <p> + GeanyGDB now is part of the Geany-Plugins project. The current version of Geany-Plugins is + 0.18. The last stable release of GeanyGDB is 0.0.2. You are recommended to use the more current + versions of GeanyGDB shipped with Geany-Plugins. + </p> +</div> +<div class="section" id="requirements"> + <h3> + Requirements + </h3> + <p> + If you like to compile Geany-Plugins yourself, you will need the GTK (>= 2.8.0) libraries + and header files. You will also need its dependency libraries and header files, such as Pango, + Glib and ATK. All these files are available at <a class="reference external" href= + "http://www.gtk.org">http://www.gtk.org</a> or as package via your distributor. + </p> + <p> + And obviously, you will need have Geany installed. If you have Geany installed from the + sources, you should be ready to go. If you are using a prepared package e.g. from your + distribution you probably need to install an additional package, which might be called + geany-dev or geany-devel. Please note that in order to compile and use GeanyGDB, you will need + Geany 0.16 or later. + </p> + <p> + Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these + tools are recommended. + </p> + <p> + And last but not least: GDB. + </p> +</div> +<div class="section" id="installation"> + <h3> + Installation + </h3> + <p> + Please consider to compile and/or install the Geany-Plugins project, as GeanyGDB now is part of + Geany-Plugins. + </p> +</div> +<div class="section" id="documentation"> + <h3> + Documentation + </h3> + <p> + There is no real documentation, but if you hover your mouse over the buttons in the GeanyGDBs + sidebar panel in Geany the tooltips should give you some idea of what to do next. There are + also a few "rough draft" notes below: + </p> + <p> + Most of the console output from GDB is sent to the "Compiler" message window in + Geany, and you can send standard commands to GDB using the "Console" entry on the + debug sidebar. This should be used with caution, since GDB's machine interface and console + interface don't always play well together. + </p> + <p> + Also note that the plugin sets its own internal breakpoint #1 to grab the program's PID on + startup, so any user-specified breakpoint numbers begin at #2, and if you manually delete the + #1 breakpoint it will likely cause you some problems. + </p> + <p> + Whenever the target program hits a breakpoint or encounters a segfault etc. it will try to open + the appropriate source file and jump to the correct line. + </p> + <p> + To examine the state of the program's variables, you can click on the "Stack" button + in the debug sidebar. Note that the interaction between the plugin and GDB can sometimes be + quite slow, so please be patient when waiting for the dialogs to open. + </p> + <p> + The "Add breakpoint", "Add watchpoint", and "Run to" dialogs will + try to suggest some values based on your current position in whatever file you have open in + Geany, but if you don't like the choice, just click the "Clear" button and type in + whatever you please. + </p> + <p> + GeanyGDB tries to enable only the buttons that are relevant to the current state, but + ocassionally it might end up getting things wrong. If this happens, you should be able to click + the "Unload" button and everything will be reset. + </p> + <p> + If you try to unload the plugin using the plugin manager while it has a program loaded, the + plugin manager might appear to hang for a few seconds, while GDB tries to shut down. Again, + just be patient, but note that it is much better use the "Unload" button in the debug + sidebar before trying to disable the plugin. + </p> +</div> +<div class="section" id="download"> + <h3> + Download + </h3> + <div class="section" id="id1"> + <h4> + Current Version + </h4> + <p> + Current versions of Geany-Plugins can be found at <a class="reference external" href= + "http://plugins.geany.org/geany-plugins/">http://plugins.geany.org/geany-plugins/</a>. + </p> + <p> + You can also check out more current sources of Geany-Plugins from SVN, but note that SVN + checkouts may not run stable. + </p> + <blockquote> + svn checkout <a class="reference external" href= + "https://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany…">https://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany…</a> + </blockquote> + </div> + <div class="section" id="older-versions"> + <h4> + Older Versions + </h4> + <table border="1" class="docutils"> + <colgroup> + <col width="24%" /> + <col width="17%" /> + <col width="59%" /> + </colgroup> + <thead valign="bottom"> + <tr> + <th class="head"> + Geany Version + </th> + <th class="head"> + GeanyGDB Version + </th> + <th class="head"> + Download + </th> + </tr> + </thead> + <tbody valign="top"> + <tr> + <td> + known to work with 0.14 + </td> + <td> + 0.0.1 + </td> + <td> + <a class="reference external" href= + "http://plugins.geany.org/geanygdb/geanydebug-0.0.1.tar.gz">http://plugins.geany.org/geanygdb/geanydebug-0.0.1.tar.gz</a> + </td> + </tr> + <tr> + <td> + 0.16 + </td> + <td> + 0.0.2 + </td> + <td> + <a class="reference external" href= + "http://plugins.geany.org/geanygdb/geanygdb-0.0.2.tar.gz">http://plugins.geany.org/geanygdb/geanygdb-0.0.2.tar.gz</a> + </td> + </tr> + </tbody> + </table> + </div> +</div> +<div class="section" id="contact"> + <h3> + Contact + </h3> + <p> + Geanys official homepage is <a class="reference external" href= + "http://geany.org/">http://geany.org/</a> + </p> + <p> + mailing list is <a class="reference external" href= + "mailto:geany%40uvena.de">geany<span>@</span>uvena<span>.</span>de</a> + </p> + <p> + eMail to <a class="reference external" href= + "mailto:dmaphy%40googlemail.com">dmaphy<span>@</span>googlemail<span>.</span>com</a> + </p> + <p> + meet us in IRC on channels #geany or #geany-de using chat.freenode.net + </p> +</div> Added: www/staging/content/geanygendoc.html =================================================================== --- www/staging/content/geanygendoc.html (rev 0) +++ www/staging/content/geanygendoc.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,11 @@ +<h2>geanygendoc</h2> +<p>The geanygendoc plugin unfortunately does not have a README file yet, +where the contents for this page could be obtained from. If you are the +maintainer of the geanygendoc plugin you are appreciated to write a +README file for your plugin as a small documentation about what your plugin +does, how to use it and so on. You can get some inspiration on how to write +that by having a look at the other plugin pages.<br /> If you like to +contribute, feel free to write a README file for the geanygendoc plugin +and send it to someone who as write access to the Subversion repositorys of +Geany Plugins. Most likely a <a href="http://www.geany.org/Main/Authors"> +Geany developer</a> is such a person.</p> Added: www/staging/content/geanyinsertnum.html =================================================================== --- www/staging/content/geanyinsertnum.html (rev 0) +++ www/staging/content/geanyinsertnum.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,72 @@ +<div class="section" id="about"> + <h3> + About + </h3> + <p> + This plugin replaces a (possibly zero-width) rectangular selection with integer numbers, using + start/step/base etc. specified by the user. For practical reasons, the number of lines is + limited to 500000. + </p> +</div> +<div class="section" id="requirements"> + <h3> + Requirements + </h3> + <p> + Geany 0.18 or later and the respective headers and development libraries. + </p> +</div> +<div class="section" id="installation"> + <h3> + Installation + </h3> + <p> + Compiling and installing the code is done by the following three commands: + </p> + <p> + $ ./waf configure $ ./waf build $ ./waf install + </p> + <p> + For more configuration details run $ ./waf --help + </p> + <p> + If there are any errors during compilation, check your build environment. + </p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + Select a rectangle and choose Tools -> Insert Numbers. + </p> +</div> +<div class="section" id="known-issues"> + <h3> + Known issues + </h3> + <p> + If you reload the current file while the plugin is running (after pressing OK), the insertion + may fail. Use Edit -> Undo to fix the file if needed. + </p> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + Insert Numbers is distributed under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or (at your option) any later + version. A copy of this license can be found in the file COPYING included with the source code + of this program. + </p> +</div> +<div class="section" id="ideas-questions-patches-and-bug-reports"> + <h3> + Ideas, questions, patches and bug reports + </h3> + <p> + Dimitar Toshkov Zhekov <<a class="reference external" href= + "mailto:jimmy%40is-vn.bg">jimmy<span>@</span>is-vn<span>.</span>bg</a>> + </p> +</div> Added: www/staging/content/geanylatex.html =================================================================== --- www/staging/content/geanylatex.html (rev 0) +++ www/staging/content/geanylatex.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,6 @@ +<h2>GeanyLaTeX</h2> +<p> + The documentation for the GeanyLaTeX plugin can be found at + <a class="reference external" href= + "http://frank.uvena.de/en/Geany/geanylatex">http://frank.uvena.de/en/Geany/geanylatex</a>. +</p> Added: www/staging/content/geanylipsum.html =================================================================== --- www/staging/content/geanylipsum.html (rev 0) +++ www/staging/content/geanylipsum.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,127 @@ +<div class="section" id="geanylipsum"> + <h3> + GeanyLipsum + </h3> + <div class="contents topic" id="contents"> + <p class="topic-title first"> + Contents + </p> + <ul class="simple"> + <li> + <a class="reference internal" href="#geanylipsum" id="id1" name="id1">GeanyLipsum</a> + </li> + <li> + <a class="reference internal" href="#about" id="id2" name="id2">About</a> + </li> + <li> + <a class="reference internal" href="#installation" id="id3" name="id3">Installation</a> + </li> + <li> + <a class="reference internal" href="#usage" id="id4" name="id4">Usage</a> + </li> + <li> + <a class="reference internal" href="#development" id="id5" name="id5">Development</a> + </li> + <li> + <a class="reference internal" href="#known-issues" id="id6" name="id6">Known issues</a> + </li> + <li> + <a class="reference internal" href="#license" id="id7" name="id7">License</a> + </li> + <li> + <a class="reference internal" href="#bugs-questions-bugs-homepage" id="id8" name= + "id8">Bugs, questions, bugs, homepage</a> + </li> + </ul> + </div> +</div> +<div class="section" id="about"> + <h3> + About + </h3> + <p> + GeanyLipsum is a plugin for Geany that implements a Lorem Ipsum generator to insert placeholder + text into your document. + </p> +</div> +<div class="section" id="installation"> + <h3> + Installation + </h3> + <p> + This version of the plugin is installed with the combined geany-plugins release. Please check + README of this package + </p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + After installed successfully, load the plugin in Geany's plugin manager and a new menu item in + the Tools menu will appear. + </p> + <p> + To insert Lorem Ipsum to your document, either use the appearing menu item or use the keystroke + which you can configure inside Geany's preferences dialog. Inside the dialog you can set up a + length of the text. Values between 1 and 5000 chars are available here. If you choose a length + that is not fitting with the length of the Lipsum snippet shipped with this plugin it will be + repeated and cut so you will always get the wished number of chars inserted. + </p> +</div> +<div class="section" id="development"> + <h3> + Development + </h3> + <p> + You can checkout the current source code from the Subversion repository at Sourceforge.net. Get + the code from: + </p> + <p> + svn checkout <a class="reference external" href= + "http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyl…">http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyl…</a> + </p> + <p> + If you want to create a patch, please respect the license of GeanyLipsum as well as + intellectual property of third. Patches that should be included to the default distribution + must be licensed under the same conditions as GeanySendMail by the copyright owner. + </p> +</div> +<div class="section" id="known-issues"> + <h3> + Known issues + </h3> + <p> + At the moment, there is no known issue. + </p> + <p> + For more recent information all reported issues will be tracked at <a class= + "reference external" href= + "http://sourceforge.net/tracker/?group_id=222729">http://sourceforge.net/tracker/?group_id=222729</a> + </p> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + GeanyLipsum and all its parts is distributed under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 of the License, or (at your + option) any later version. A copy of this license can be found in the file COPYING included + with the source code of this program. If not, you will be able to get a copy by contacting the + Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + </p> +</div> +<div class="section" id="bugs-questions-bugs-homepage"> + <h3> + Bugs, questions, bugs, homepage + </h3> + <p> + If you found any bugs or want to provide a patch, please contact Frank Lanitz + (frank(at)geany(dot)org). Please also do so, if you got any questions and visiting <a class= + "reference external" href= + "http://frank.uvena.de/en/Geany/geanylipsum">http://frank.uvena.de/en/Geany/geanylipsum</a> + didn't help you to figure out the answer. Visiting the website is also a good start if you want + to check for any update on this plugin. + </p> +</div> Added: www/staging/content/geanylua.html =================================================================== --- www/staging/content/geanylua.html (rev 0) +++ www/staging/content/geanylua.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,4 @@ +<p> + Please see the <a href="./geanylua/geanylua-index.html">GeanyLua + documentation</a> for information on using this plugin. +</p> Added: www/staging/content/geanyprj.html =================================================================== --- www/staging/content/geanyprj.html (rev 0) +++ www/staging/content/geanyprj.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,385 @@ +<div class="contents topic" id="contents"> + <p class="topic-title first"> + Contents + </p> + <ul class="simple"> + <li> + <a class="reference internal" href="#about" id="id1" name="id1">About</a> + <ul> + <li> + <a class="reference internal" href="#why-it-was-created" id="id2" name="id2">Why it was + created?</a> + </li> + <li> + <a class="reference internal" href= + "#why-different-project-manager-why-don-t-improve-existing-code-in-geany" id="id3" name= + "id3">Why different project manager, why don't improve existing code in Geany?</a> + </li> + </ul> + </li> + <li> + <a class="reference internal" href="#usage" id="id4" name="id4">Usage</a> + <ul> + <li> + <a class="reference internal" href="#project-properties" id="id5" name="id5">Project + properties</a> + </li> + <li> + <a class="reference internal" href="#example-of-usage" id="id6" name="id6">Example of + usage</a> + </li> + </ul> + </li> + <li> + <a class="reference internal" href="#license" id="id7" name="id7">License</a> + </li> + <li> + <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id8" name= + "id8">Ideas, questions, patches and bug reports</a> + </li> + <li> + <a class="reference internal" href="#coding" id="id9" name="id9">Coding</a> + </li> + <li> + <a class="reference internal" href="#style" id="id10" name="id10">Style</a> + </li> + <li> + <a class="reference internal" href="#download" id="id11" name="id11">Download</a> + <ul> + <li> + <a class="reference internal" href="#gentoo" id="id12" name="id12">Gentoo</a> + </li> + <li> + <a class="reference internal" href="#arch-linux" id="id13" name="id13">Arch linux</a> + </li> + <li> + <a class="reference internal" href="#windows" id="id14" name="id14">Windows</a> + </li> + </ul> + </li> + </ul> +</div> +<div class="section" id="about"> + <h3> + About + </h3> + <p> + geanyprj is alternative project manager for Geany fast light IDE. In order to use it you need + Geany 0.16. + </p> + <div class="section" id="why-it-was-created"> + <h4> + Why it was created? + </h4> + <p> + Open source is great, there are a lot of nice sources that you can use for your projects in + Internet. But there are also a lot of crappy sources and when you want steal something you + need to check if it is good or not. Ability to jump to definition/declaration and back is + great help for such task. But no other text editor or IDE I know allow this without a lot of + setuping. You have to create/import project add files. When you finish with one project you + need to close it and repeat procedure for all other. Great time wasting. If you are checking + about 10 potential places you want steal code from, you won't create any project and don't + get "jump to definition/declaration" just because it is too much bother. + </p> + <p> + geanyprj aims to provide "jump to definition/declaration" functions with as little + setup as possible. + </p> + </div> + <div class="section" id="why-different-project-manager-why-don-t-improve-existing-code-in-geany"> + <h4> + Why different project manager, why don't improve existing code in Geany? + </h4> + <p> + That's because current project manager in Genny more about sessions. It is not something real + project manager should do (IMHO). It allow/require user manually open/close project and allow + to store project files in different locations from project sources. + </p> + <p> + geanyprj takes different approach: + </p> + <p> + 1) Never save session information (this way project files can be stored in version control + without constant noise from changes of opened files or cursor position) + </p> + <p> + 2) Never open/close project manually. If .geanyprj file is found somewhere up in path it will + be opened automatically. + </p> + </div> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + geanyprj add "Tools->Project" menu and sidebar "Project" tab. + </p> + <div class="section" id="project-properties"> + <h4> + Project properties + </h4> + <p> + Name - This is just project name you will see it in status window on open/close project. + </p> + <p> + Location - This is directory where .geanyprj file will be saved. + </p> + <p> + Base Path - If defined Geany will use this directory as current directory for make and run + commands + </p> + <p> + Generate file list on load - This option tell Geany to recreate project file list on project + load using selected type. If it is unchecked you should manually select files you want to be + parsed by tagmanager. + </p> + <p> + Type - This is type of files that needed to be parsed by tagmanager. + </p> + <blockquote> + <ul class="simple"> + <li>All - All files that is known to Geany + </li> + <li>C/C++ - This match any C or C++ files (.c, .cpp, .cxx, .h etc.) + </li> + <li>C - This match only C files (.c, .h) + </li> + <li>Python - This match python files (.py) + </li> + <li>None - This doesn't match any files + </li> + </ul> + </blockquote> + </div> + <div class="section" id="example-of-usage"> + <h4> + Example of usage + </h4> + <p> + Lets see plugin work at Geany source code example: + </p> + <ol class="arabic simple"> + <li>Download geany-0.15.tar.gz (<a class="reference external" href= + "http://prdownloads.sourceforge.net/geany/geany-0.15.tar.gz?download">http://prdownloads.sourceforge.net/geany/geany-0.15.tar.gz?download</a>) + </li> + <li>Unpack it somewhere, for example in ~/src/geany-0.15 + </li> + <li>Open ~/src/geany-0.15/configure.in + </li> + <li>Click "Tools->Project->New Project", and click "Create" button + </li> + </ol> + <blockquote> + This will create and save .geanyprj file in ~/src/geany-0.15. From now, every time you open + file from ~/src/geany-0.15 dirrectory or it's subdirrectory .geanyprj will be opened. So next + time you don't have to create or open project manually. + </blockquote> + <ol class="arabic simple" start="5"> + <li>Open any geany source code code file + </li> + </ol> + <blockquote> + "go to tag declaration/definition" should work for any geany function. (Not limited + to opened files). + </blockquote> + <ol class="arabic simple" start="6"> + <li>Now you open file that doesn't belong to Geany. For example ~/src/myprj/a.c Geany project + will be closed. If ~/src/myprj/.geanyprj exists it will be opened as current project. + </li> + <li>Switching back to any Geany file will open Geany project again. + </li> + </ol> + </div> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + geanyprj is distributed under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 3 of the License, or (at your option) any later + version. A copy of this license can be found in the file COPYING included with the source code + of this program. + </p> +</div> +<div class="section" id="ideas-questions-patches-and-bug-reports"> + <h3> + Ideas, questions, patches and bug reports + </h3> + <p> + If you add something, or fix a bug, please send a patch (in 'diff -u' format) to the geany + mailing list or to one of the authors listed bellow. + </p> +</div> +<div class="section" id="coding"> + <h3> + Coding + </h3> + <p> + Use static functions where possible. Try to use GLib types and functions - e.g. g_free instead + of free and try to use only GLib 2.6 and GTK 2.6 functions. + </p> +</div> +<div class="section" id="style"> + <h3> + Style + </h3> + <p> + The file indent-all.sh contains information about the current code style. Run this script + before commit. + </p> +</div> +<div class="section" id="download"> + <h3> + Download + </h3> + <p> + The current version is: + </p> + <table border="1" class="docutils"> + <colgroup> + <col width="15%" /> + <col width="18%" /> + <col width="67%" /> + </colgroup> + <thead valign="bottom"> + <tr> + <th class="head"> + Geany Version + </th> + <th class="head"> + GeanyPrj Version + </th> + <th class="head"> + Download + </th> + </tr> + </thead> + <tbody valign="top"> + <tr> + <td> + 0.16 + </td> + <td> + 0.6 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5.tar.gz</a> + </td> + </tr> + </tbody> + </table> + <p> + Up to date source code can be downloaded here: + </p> + <pre class="literal-block"> +svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyp… +</pre> + <p> + If you have old version of Geany installed you need old version of plugin as well. These + versions of plugin are no longer supported and if you find bug in one of them, it won't be + fixed unless you do it yourself. + </p> + <table border="1" class="docutils"> + <colgroup> + <col width="15%" /> + <col width="18%" /> + <col width="67%" /> + </colgroup> + <thead valign="bottom"> + <tr> + <th class="head"> + Geany Version + </th> + <th class="head"> + GeanyPrj Version + </th> + <th class="head"> + Download + </th> + </tr> + </thead> + <tbody valign="top"> + <tr> + <td> + 0.16 + </td> + <td> + 0.5 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5.tar.gz</a> + </td> + </tr> + <tr> + <td> + 0.15 + </td> + <td> + 0.4 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.4.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.4.tar.gz</a> + </td> + </tr> + <tr> + <td> + 0.14 + </td> + <td> + 0.3 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.3.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.3.tar.gz</a> + </td> + </tr> + <tr> + <td> + 0.13 + </td> + <td> + 0.2 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.2.tar.gz">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.2.tar.gz</a> + </td> + </tr> + </tbody> + </table> + <div class="section" id="gentoo"> + <h4> + Gentoo + </h4> + <p> + Gentoo ebuild is available here: <a class="reference external" href= + "http://bugs.gentoo.org/show_bug.cgi?id=218506">http://bugs.gentoo.org/show_bug.cgi?id=218506</a> + </p> + </div> + <div class="section" id="arch-linux"> + <h4> + Arch linux + </h4> + <p> + A package for Arch Linux is available here: <a class="reference external" href= + "http://aur.archlinux.org/packages.php?ID=16477">http://aur.archlinux.org/packages.php?ID=16477</a> + </p> + </div> + <div class="section" id="windows"> + <h4> + Windows + </h4> + <p> + A windows installer is available here: <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5_setup.exe">http://users.cosmostv.by/yurand/geanyprj/geanyprj-0.5_setup.exe</a> + </p> + <p> + 2007-2008 by Yura Siamashka yurand2(at)gmail(dot)com + </p> + </div> +</div> Added: www/staging/content/geanysendmail.html =================================================================== --- www/staging/content/geanysendmail.html (rev 0) +++ www/staging/content/geanysendmail.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,220 @@ +<h2>GeanySendMail</h2> +<div class="contents topic" id="contents"> + <h3 class="topic-title first"> + Contents + </h3> + <ul class="simple"> + <li> + <a class="reference internal" href="#about" id="id1" name="id1">About</a> + </li> + <li> + <a class="reference internal" href="#requirements" id="id2" name="id2">Requirements</a> + </li> + <li> + <a class="reference internal" href="#installation" id="id3" name="id3">Installation</a> + </li> + <li> + <a class="reference internal" href="#usage" id="id4" name="id4">Usage</a> + </li> + <li> + <a class="reference internal" href="#configuration" id="id5" name="id5">Configuration</a> + </li> + <li> + <a class="reference internal" href="#development" id="id6" name="id6">Development</a> + </li> + <li> + <a class="reference internal" href="#known-issues" id="id7" name="id7">Known issues</a> + </li> + <li> + <a class="reference internal" href="#license" id="id8" name="id8">License</a> + </li> + <li> + <a class="reference internal" href="#bugs-questions-bugs-homepage" id="id9" name="id9">Bugs, + questions, bugs, homepage</a> + </li> + </ul> +</div> +<div class="section" id="about"> + <h3> + About + </h3> + <p> + GeanySendMail is a little plugin to send a document as attachment using the preferred mail + client from inside Geany. It is similar to the envelope symbol of most office tools and + requires a mail client that is supporting remote calls. + </p> + + <p><a href="#contents">back to top</a></p> +</div> +<div class="section" id="requirements"> + <h3> + Requirements + </h3> + <p> + For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries and header + files. You will also need its dependency libraries and header files, such as Pango, Glib and + ATK. All these files are available at <a class="reference external" href= + "http://www.gtk.org">http://www.gtk.org</a>. + </p> + <p> + And obviously, you will need to have Geany installed. If you have Geany installed from the + sources, you should be ready to go. If you used a prepared package e.g. from your distribution + you probably need to install an additional package, this might be called geany-dev or + geany-devel. Please note that in order to compile and use this plugin, you need Geany 0.16 or + later (Geany Plugin API v116 or higher). + </p> + <p> + Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these + tools are recommended. + </p> + + <p><a href="#contents">back to top</a></p> +</div> +<div class="section" id="installation"> + <h3> + Installation + </h3> + <p> + This version of the plugin is installed with the combined geany-plugins release. Please check + README of this package or download stand alone version of plugin from <a class= + "reference external" href= + "http://frank.uvena.de/en/Geany/geanysendmail/">http://frank.uvena.de/en/Geany/geanysendmail/</a> + </p> + + <p><a href="#contents">back to top</a></p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + After installed successfully, load the plugin in Geany's plugin manager and a new menu item in + the Tools menu will appear. Before you can start you need to configure your mail client. This + can be done in the configuration dialog (details on it later). You can also assign a keyboard + shortcut in Geany's preferences dialog to send your document. + </p> + + <p><a href="#contents">back to top</a></p> +</div> +<div class="section" id="configuration"> + <h3> + Configuration + </h3> + <p> + In the configuration dialog you can set up a command that is called by the plugin to + communicate with your mail client. Depending on what's your favorite mailer, the command will + differ. A number of placeholders are available for doing this: + </p> + <ul> + <li> + %s: Will be replaced by the complete path of the file that should be send. + </li> + <li> + %r: Will be replaced by one or more recipient's email address that can be + entered inside a separate dialog. (Please remember during input, what your mail client + is expecting here) + </li> + <li> + %b: Will be replace by the file name. For a file /tmp/foo.baa it will be + replaced by foo.baa. + </li> + </ul> + <p> + Depending on how you like to use, you can combine all of the placeholders to build up your + command. It is possible to use one placeholder several times. When using keep care, as the + placeholders are replace step by step, so a filename containing %b might have some funny + outcome. However, examples could be: + </p> + <p>Sylpheed:</p> + <code>sylpheed --attach "%f" --compose "%r"</code> + + <p>mutt:</p> + <code>mutt -s "Sending '%b'" -a "%f" "%r"</code> + + <p>Mozilla Thunderbird at Windows:</p> + <code>"C:Program FilesMozilla Thunderbirdthunderbird.exe" + -compose to="%r",subject="%b",attachment="%f"</code> + + <p> + In theory it should also work together with tools like Microsoft Outlook - Unfortunately the + author wasn't able to bring it up running. Input for the correct commandline is highly welcome. + </p> + + <p><a href="#contents">back to top</a></p> +</div> +<div class="section" id="development"> + <h3> + Development + </h3> + <p> + You can checkout the current source code from the Subversion repository at Sourceforge.net. Get + the code from: + </p> + <code> + svn checkout <a class="reference external" href= + "http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanys…">http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanys…</a> + </code> + <p> + As this plugin is part of the combined geany-plugins release, you may also like to check its + Subversion repository by checking ou + </p> + <code> + svn checkout <a class="reference external" href= + "http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…">http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…</a> + </code> + <p> + If you want to create a patch, please respect the license of GeanySendMail (GPLv2 or above) as + well as intellectual property of third. Patches that should be included to the default + distribution must be licensed under the same conditions as GeanySendMail by the copyright + owner. + </p> + + <p><a href="#contents">back to top</a></p> +</div> +<div class="section" id="known-issues"> + <h3> + Known issues + </h3> + <p> + In case you are working with white spaces either in your path names, file names or at mail + addresses (e.g. for separating two addresses) you should keep care of proper quoting since %s, + %b and %r will be replaced without any quotes. + </p> + <p> + For more recent information all reported issues will be tracked at <a class= + "reference external" href= + "http://sourceforge.net/tracker/?group_id=222729">http://sourceforge.net/tracker/?group_id=222729</a> + </p> + + <p><a href="#contents">back to top</a></p> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + GeanySendMail and all its parts is distributed under the terms of the GNU General Public + License as published by the Free Software Foundation; either version 2 of the License, or (at + your option) any later version. A copy of this license can be found in the file COPYING + included with the source code of this program. If not, you will be able to get a copy by + contacting the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + 02110-1301, USA. + </p> + + <p><a href="#contents">back to top</a></p> +</div> +<div class="section" id="bugs-questions-bugs-homepage"> + <h3> + Bugs, questions, bugs, homepage + </h3> + <p> + If you found any bugs or want to provide a patch, please contact Frank Lanitz + (frank(at)geany(dot)org). Please also do so, if you got any questions and visiting <a class= + "reference external" href= + "http://frank.uvena.de/en/Geany/geanysendmail">http://frank.uvena.de/en/Geany/geanysendmail</a> + didn't help you to figure out the answer. Visiting the website is also a good start if you want + to check for any update on this plugin. + </p> + + <p><a href="#contents">back to top</a></p> +</div> Added: www/staging/content/geanyvc.html =================================================================== --- www/staging/content/geanyvc.html (rev 0) +++ www/staging/content/geanyvc.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,379 @@ +<div class="contents topic" id="contents"> + <p class="topic-title first"> + Contents + </p> + <ul class="simple"> + <li> + <a class="reference internal" href="#about" id="id1" name="id1">About</a> + </li> + <li> + <a class="reference internal" href="#features" id="id2" name="id2">Features</a> + </li> + <li> + <a class="reference internal" href="#requirements" id="id3" name="id3">Requirements</a> + </li> + <li> + <a class="reference internal" href="#usage" id="id4" name="id4">Usage</a> + </li> + <li> + <a class="reference internal" href="#license" id="id5" name="id5">License</a> + </li> + <li> + <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id6" name= + "id6">Ideas, questions, patches and bug reports</a> + </li> + <li> + <a class="reference internal" href="#coding" id="id7" name="id7">Coding</a> + </li> + <li> + <a class="reference internal" href="#style" id="id8" name="id8">Style</a> + </li> + <li> + <a class="reference internal" href="#download" id="id9" name="id9">Download</a> + <ul> + <li> + <a class="reference internal" href="#gentoo" id="id10" name="id10">Gentoo</a> + </li> + <li> + <a class="reference internal" href="#arch-linux" id="id11" name="id11">Arch linux</a> + </li> + <li> + <a class="reference internal" href="#source-mage" id="id12" name="id12">Source Mage</a> + </li> + <li> + <a class="reference internal" href="#windows" id="id13" name="id13">Windows</a> + </li> + </ul> + </li> + </ul> +</div> +<div class="section" id="about"> + <h3> + About + </h3> + <p> + geanyvc is plugin that provides a uniform way of accessing the different version-control + systems inside Geany IDE. Only small subset of vc is implemented, but, hey, you don't need + anything besides diff, log, status, revert and commit most time. + </p> + <p> + In order to use it you need Geany 0.16. + </p> +</div> +<div class="section" id="features"> + <h3> + Features + </h3> + <p> + geanyvc currently support the following version control systems: + </p> + <p> + Bazaar, GIT, Mercurial, Subversion, SVK: + </p> + <pre class="literal-block"> +* diff file +* diff directory +* diff base directory +* blame +* log file +* log directory +* log base directory +* status +* revert file +* revert directory +* revert base directory +* show unmodified original file +* add file +* remove file +* update +* commit +</pre> + <p> + CVS: + </p> + <pre class="literal-block"> +* diff file +* diff directory +* diff base directory +* log file +* log directory +* log base directory +* status +* revert file +* revert directory +* revert base directory +* update +</pre> +</div> +<div class="section" id="requirements"> + <h3> + Requirements + </h3> + <p> + For compiling the plugin yourself, you will need the GTK (>= 2.6.0) libraries and header + files. You will also need its dependency libraries and header files, such as Pango, Glib and + ATK. All these files are available at <a class="reference external" href= + "http://www.gtk.org">http://www.gtk.org</a>. If you like to use spellchecking for your commit + messages you will also need gtkspell (>=2.0), but this is only optional. + </p> + <p> + And obviously, you will need have Geany installed. If you have Geany installed from the + sources, you should be ready to go. If you used a prepared package e.g. from your distribution + you probably need to install an additional package, this might be called geany-dev or + geany-devel. Please note that in order to compile and use this plugin, you need Geany 0.15 or + later. + </p> + <p> + Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these + tools are recommended. + </p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + After compiling and/or installing geanyvc, start Geany and go to menu Tools->Plugin Manager + and set checkbox at VC plugin. + </p> + <p> + You can configure the following options: + </p> + <ul class="simple"> + <li>Set Change flag for document tabs created with pluging. + </li> + </ul> + <p> + If this option is activated, every new by the VC-plugin created document tab will be marked as + changed. Even thus this option is useful in some cases, it could cause a big number of + sometimes annoying "Do you want to save"-dialogs. + </p> + <ul class="simple"> + <li>Confirm adding new files to a VCS + </li> + </ul> + <p> + Shows a confirmation dialog on adding a new (created) file to VCS. If not set you will not see + dialog "Do you want to add <file>?" + </p> + <ul class="simple"> + <li>Maximize commit dialog + </li> + </ul> + <p> + If this option is activated, commit dialog will fit the full size of your monitor. If it is not + set commit dialog size will be 700x500. + </p> + <ul class="simple"> + <li>Use external diff viewer + </li> + </ul> + <p> + If this option is activated and you have <strong>meld</strong>, <strong>kompare</strong>, + <strong>kdiff3</strong>, <strong>diffuse</strong> or <strong>tkdiff</strong> available from + command line, one of these program will be used to show differences for "Diff From Current + File" command. + </p> + <ul class="simple"> + <li>Enable CVS/GIT/SVN/SVK/Bazaar/Mercurial + </li> + </ul> + <p> + geanyvc detect if opened file is in version control by checking directories and executing + commands from version control systems toolchain. These options disable checking for particular + version control system. Disabling not required ones can speed up things. So it is recommended + to activate svk only if you want to use it, since it is quiet slow. + </p> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + geanyvc is distributed under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 2 of the License, or (at your option) any later + version. A copy of this license can be found in the file COPYING included with the source code + of this program. + </p> +</div> +<div class="section" id="ideas-questions-patches-and-bug-reports"> + <h3> + Ideas, questions, patches and bug reports + </h3> + <p> + If you add something, or fix a bug, please send a patch (in 'diff -u' format) to the geany + mailing list or to one of the authors listed bellow. + </p> +</div> +<div class="section" id="coding"> + <h3> + Coding + </h3> + <p> + Use static functions where possible. Try to use GLib types and functions - e.g. g_free instead + of free and try to use only GLib 2.6 and GTK 2.6 functions. At least for the moment, we want to + keep the minimum requirement for GTK at 2.6. + </p> +</div> +<div class="section" id="style"> + <h3> + Style + </h3> + <p> + The file indent-all.sh contains information about the current code style. Run this script + before commit. + </p> +</div> +<div class="section" id="download"> + <h3> + Download + </h3> + <p> + The current version is: + </p> + <table border="1" class="docutils"> + <colgroup> + <col width="15%" /> + <col width="17%" /> + <col width="67%" /> + </colgroup> + <thead valign="bottom"> + <tr> + <th class="head"> + Geany Version + </th> + <th class="head"> + Geanyvc Version + </th> + <th class="head"> + Download + </th> + </tr> + </thead> + <tbody valign="top"> + <tr> + <td> + 0.16 + </td> + <td> + 0.5 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.5.tar.gz">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.5.tar.gz</a> + </td> + </tr> + </tbody> + </table> + <p> + Up to date source code can be downloaded here: + </p> + <pre class="literal-block"> +svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyvc +</pre> + <p> + If you have old version of Geany installed you need old version of plugin as well. These + versions of plugin are no longer supported and if you find bug in one of them, it won't be + fixed unless you do it yourself. + </p> + <table border="1" class="docutils"> + <colgroup> + <col width="15%" /> + <col width="17%" /> + <col width="67%" /> + </colgroup> + <thead valign="bottom"> + <tr> + <th class="head"> + Geany Version + </th> + <th class="head"> + Geanyvc Version + </th> + <th class="head"> + Download + </th> + </tr> + </thead> + <tbody valign="top"> + <tr> + <td> + 0.15 + </td> + <td> + 0.4 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4.tar.gz">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4.tar.gz</a> + </td> + </tr> + <tr> + <td> + 0.14 + </td> + <td> + 0.3 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.3.tar.gz">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.3.tar.gz</a> + </td> + </tr> + <tr> + <td> + 0.13 + </td> + <td> + 0.2 + </td> + <td> + <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.2.tar.gz">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.2.tar.gz</a> + </td> + </tr> + </tbody> + </table> + <div class="section" id="gentoo"> + <h4> + Gentoo + </h4> + <p> + Gentoo ebuild is available here: <a class="reference external" href= + "http://bugs.gentoo.org/show_bug.cgi?id=218522">http://bugs.gentoo.org/show_bug.cgi?id=218522</a> + </p> + </div> + <div class="section" id="arch-linux"> + <h4> + Arch linux + </h4> + <p> + A package for Arch Linux is available here: <a class="reference external" href= + "http://aur.archlinux.org/packages.php?ID=16484">http://aur.archlinux.org/packages.php?ID=16484</a> + </p> + </div> + <div class="section" id="source-mage"> + <h4> + Source Mage + </h4> + <p> + To install geanyvc, just run the following command: + </p> + <pre class="literal-block"> +cast geanyvc +</pre> + </div> + <div class="section" id="windows"> + <h4> + Windows + </h4> + <p> + A windows installer is available here: <a class="reference external" href= + "http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4_setup.exe">http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4_setup.exe</a> + </p> + <p> + -- 2007-2008 by Yura Siamashka and Frank Lanitz yurand2(at)gmail(dot)com + frank(at)frank(dot)uvena(dot)de + </p> + </div> +</div> Added: www/staging/content/licensing.html =================================================================== --- www/staging/content/licensing.html (rev 0) +++ www/staging/content/licensing.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,16 @@ +<h2>Licensing</h2> +<h3>Geany Plugins project</h3> +<p>Any plugin delivered with the Geany Plugins project is either +<a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GPLv2 or later</a> +or <a href="http://www.fsf.org/licensing/licenses/gpl.html">GPLv3 or later</a>. +The resulting license for the whole Geany Plugins project is +<a href="http://www.fsf.org/licensing/licenses/gpl.html">GPLv3 or later</a>.</p> + +<h3>other Third Party plugins</h3> +<p>Any other third party plugin not delivered with the Geany Plugins project has +it's own license.</p> +<ul> + <li>externdbg is GPLv3+</li> + <li>GeanyEmbrace is GPLv2+</li> + <li>Geany Mini Script is GPLv2+</li> +</ul> Added: www/staging/content/pretty-printer.html =================================================================== --- www/staging/content/pretty-printer.html (rev 0) +++ www/staging/content/pretty-printer.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,11 @@ +<h2>pretty-printer</h2> +<p>The pretty-printer plugin unfortunately does not have a README file yet, +where the contents for this page could be obtained from. If you are the +maintainer of the pretty-printer plugin you are appreciated to write a +README file for your plugin as a small documentation about what your plugin +does, how to use it and so on. You can get some inspiration on how to write +that by having a look at the other plugin pages.<br /> If you like to +contribute, feel free to write a README file for the pretty-printer plugin +and send it to someone who as write access to the Subversion repositorys of +Geany Plugins. Most likely a <a href="http://www.geany.org/Main/Authors"> +Geany developer</a> is such a person.</p> Added: www/staging/content/rst2html_config.conf =================================================================== --- www/staging/content/rst2html_config.conf (rev 0) +++ www/staging/content/rst2html_config.conf 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,43 @@ +[general] +datestamp: %Y-%m-%d %H:%M UTC +debug: no +dump_internals: no +dump_psuedo_xml: no +dump_settings: no +dump_transforms: no +error_encoding: UTF-8 +error_encoding_error_handler: strict +footnote_backlinks: yes +generator: no +#halt_level: strict +input_encoding: UTF-8 +input_encoding_error_handler: strict +language_code: en +output_encoding: UTF-8 +output_encoding_error_handler: strict +report_level: warning +sectnum_xform: yes +source_link: yes +strip_comments: yes +toc_backlinks: toc-top-backlinks + +[restructuredtext parser] +tab_width: 4 + +[docutils_xml writer] +doctype_declaration: no +indents: yes +newlines: yes +xml_declaration: no + +[html4css1 writer] +cloak_email_addresses: yes +compact_lists: yes +compact_field_lists: yes +embed_stylesheet: no +footnote_references: superscript +initial_header_level: 3 +template: ./rst2html_template.txt +xml_declaration: no +indents: yes +newlines: yes Added: www/staging/content/rst2html_template.txt =================================================================== --- www/staging/content/rst2html_template.txt (rev 0) +++ www/staging/content/rst2html_template.txt 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1 @@ +%(body)s Added: www/staging/content/shiftcolumn.html =================================================================== --- www/staging/content/shiftcolumn.html (rev 0) +++ www/staging/content/shiftcolumn.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,105 @@ +<div class="contents topic" id="contents"> + <p class="topic-title first"> + Contents + </p> + <ul class="simple"> + <li> + <a class="reference internal" href="#about" id="id1" name="id1">About</a> + </li> + <li> + <a class="reference internal" href="#requirements" id="id2" name="id2">Requirements</a> + </li> + <li> + <a class="reference internal" href="#installation" id="id3" name="id3">Installation</a> + </li> + <li> + <a class="reference internal" href="#usage" id="id4" name="id4">Usage</a> + </li> + <li> + <a class="reference internal" href="#known-issues" id="id5" name="id5">Known issues</a> + </li> + <li> + <a class="reference internal" href="#license" id="id6" name="id6">License</a> + </li> + <li> + <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id7" name= + "id7">Ideas, questions, patches and bug reports</a> + </li> + </ul> +</div> +<div class="section" id="about"> + <h3> + About + </h3> + <p> + This plugin allows you to move blocks of text horizontally + </p> +</div> +<div class="section" id="requirements"> + <h3> + Requirements + </h3> + <p> + For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries and header + files. You will also need its dependency libraries and header files, such as Pango, Glib and + ATK. All these files are available at <a class="reference external" href= + "http://www.gtk.org">http://www.gtk.org</a>. + </p> +</div> +<div class="section" id="installation"> + <h3> + Installation + </h3> + <p> + Compiling and installing the code is done by the following three commands: $ ./configure $ make + $ make install + </p> + <p> + For more configuration details run $ ./configure --help + </p> + <p> + If there are any errors during compilation, check your build environment and try to find the + error, otherwise contact one of the authors. + </p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + After installed successfully, load the plugin in Geany's plugin manager and a new menu item in + the Tools menu will appear. Alternatively, you can assign a keyboard shortcut in Geany's + preferences dialog. By default the mappings are to <Ctrl>9 and <Ctrl>0 + </p> +</div> +<div class="section" id="known-issues"> + <h3> + Known issues + </h3> + <blockquote> + <ul class="simple"> + <li>none, my code rocks.. (well I can hope) + </li> + </ul> + </blockquote> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + Shift Column is distributed under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or (at your option) any later + version. A copy of this license can be found in the file COPYING included with the source code + of this program. + </p> +</div> +<div class="section" id="ideas-questions-patches-and-bug-reports"> + <h3> + Ideas, questions, patches and bug reports + </h3> + <p> + Andrew Janke <<a class="reference external" href= + "mailto:a.janke%40gmail.com">a<span>.</span>janke<span>@</span>gmail<span>.</span>com</a>> + </p> +</div> Added: www/staging/content/spellcheck.html =================================================================== --- www/staging/content/spellcheck.html (rev 0) +++ www/staging/content/spellcheck.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,195 @@ +<div class="contents topic" id="contents"> + <p class="topic-title first"> + Contents + </p> + <ul class="simple"> + <li> + <a class="reference internal" href="#about" id="id1" name="id1">About</a> + </li> + <li> + <a class="reference internal" href="#downloads" id="id2" name="id2">Downloads</a> + <ul> + <li> + <a class="reference internal" href="#development-code" id="id3" name="id3">Development + Code</a> + </li> + </ul> + </li> + <li> + <a class="reference internal" href="#requirements" id="id4" name="id4">Requirements</a> + </li> + <li> + <a class="reference internal" href="#installation" id="id5" name="id5">Installation</a> + </li> + <li> + <a class="reference internal" href="#usage" id="id6" name="id6">Usage</a> + </li> + <li> + <a class="reference internal" href="#known-issues" id="id7" name="id7">Known issues</a> + </li> + <li> + <a class="reference internal" href="#license" id="id8" name="id8">License</a> + </li> + <li> + <a class="reference internal" href="#ideas-questions-patches-and-bug-reports" id="id9" name= + "id9">Ideas, questions, patches and bug reports</a> + </li> + </ul> +</div> +<div class="section" id="about"> + <h3> + About + </h3> + <p> + This plugin checks the content of the current document in Geany with the spell check library + Enchant. You can also select a certain text passage, then the plugin will only check the + selected text. All lines with misspelled words are highlighted with a red squiggly underline + and the wrong words are printed in the messages window at the bottom of Geany together with + available suggestions. For the plugin to work at all, you need to have the Enchant library + installed together with at least one backend (Aspell, Myspell, Hunspell, ...). The plugin's + configure dialog lists all available languages/dictionaries which can be used for the spell + check. + </p> +</div> +<div class="section" id="downloads"> + <h3> + Downloads + </h3> + <p> + Spell Check is part of the combined Geany Plugins release. For more information and downloads, + please visit <a class="reference external" href= + "http://plugins.geany.org/geany-plugins/">http://plugins.geany.org/geany-plugins/</a> + </p> + <div class="section" id="development-code"> + <h4> + Development Code + </h4> + <p> + Get the code from: + </p> + <blockquote> + svn checkout <a class="reference external" href= + "http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…">http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-…</a> + </blockquote> + </div> +</div> +<div class="section" id="requirements"> + <h3> + Requirements + </h3> + <p> + For compiling the plugin yourself, you will need the GTK (>= 2.8.0) libraries and header + files. You will also need its dependency libraries and header files, such as Pango, Glib and + ATK. All these files are available at <a class="reference external" href= + "http://www.gtk.org">http://www.gtk.org</a>. Furthermore, you need to have installed enchant + with its development files (libenchant-dev or enchant-devel). + </p> + <p> + And obviously, you will need have Geany installed. If you have Geany installed from the + sources, you should be ready to go. If you used a prepared package e.g. from your distribution + you probably need to install an additional package, this might be called geany-dev or + geany-devel. Please note that in order to compile and use this plugin, you need Geany 0.16 or + later. + </p> + <p> + Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these + tools are recommended. + </p> +</div> +<div class="section" id="installation"> + <h3> + Installation + </h3> + <p> + Compiling and installing the code is done by the following three commands: $ ./configure $ make + $ make install + </p> + <p> + For more configuration details run $ ./configure --help + </p> + <p> + If there are any errors during compilation, check your build environment and try to find the + error, otherwise contact one of the authors. + </p> +</div> +<div class="section" id="usage"> + <h3> + Usage + </h3> + <p> + After installed successfully, load the plugin in Geany's plugin manager and a new menu item in + the Tools menu will appear. Alternatively, you can assign a keyboard shortcut in Geany's + preferences dialog to perform a spell check. + </p> +</div> +<div class="section" id="known-issues"> + <h3> + Known issues + </h3> + <blockquote> + <ul> + <li> + <p class="first"> + Spell checking with some languages like Hindi might be incorrect, i.e. some words are + incorrectly marked as correctly spelled or marked incorrectly as misspelled. + </p> + </li> + <li> + <p class="first"> + Crashes of Geany when loading the Spell Check plugin after it was unloaded. This can + happen when you are using a dictionary from the Zemberek provider of Enchant (mostly + Turkish dictionaries). It can also happen when you tried to use a non-existing dictionary + and the Zemberek provider is installed on your system. To avoid these crashes you have + the following options: + </p> + <blockquote> + <ul class="simple"> + <li>Do not load the plugin after it was unloaded, restart Geany first + </li> + <li>Do not use any of the dictionaries provided by the Zemberek provider + </li> + <li>Update your Enchant version at least to 1.4.3 (once it is released) + </li> + <li>Uninstall the Zemberek provider + </li> + </ul> + </blockquote> + </li> + </ul> + <blockquote> + <dl class="docutils"> + <dt> + Background: + </dt> + <dd> + These crashes are all related to the Zemberek provider in Enchant. In version 1.4.2 and + prior of Enchant, this provider/backend always claimed to support any given invalid + dictionary name and so it was active and caused these crashes on load after unload of the + plugin. This provider is DBus-based and uses the GObject type registration system which + is not really capable of being unloaded and loaded again. + </dd> + </dl> + </blockquote> + </blockquote> +</div> +<div class="section" id="license"> + <h3> + License + </h3> + <p> + Spell Check is distributed under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or (at your option) any later + version. A copy of this license can be found in the file COPYING included with the source code + of this program. + </p> +</div> +<div class="section" id="ideas-questions-patches-and-bug-reports"> + <h3> + Ideas, questions, patches and bug reports + </h3> + <p> + Send it to me at enrico(dot)troeger(at)uvena(dot)de or report them at <a class= + "reference external" href= + "http://sourceforge.net/tracker/?group_id=222729">http://sourceforge.net/tracker/?group_id=222729</a>. + </p> +</div> Added: www/staging/content/start.html =================================================================== --- www/staging/content/start.html (rev 0) +++ www/staging/content/start.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1 @@ +<h2>Welcome</h2> Added: www/staging/content/tidy.conf =================================================================== --- www/staging/content/tidy.conf (rev 0) +++ www/staging/content/tidy.conf 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,34 @@ +# This is a configuration file for HMTL Tidy. See 'man tidy' for details about +# the settings wrote in here. +# This configuration file is especially written to beautify the output of +# rst2html for use in the plugins.geany.org website. If you have questions +# concerning this, feel free to contact the plugins.geany.org maintainer +# Dominic Hopf <dmaphy(a)googlemail.com> + +wrap: 100 +write-back: yes +indent: yes +tab-size: 4 +newline: LF +clean: yes +output-xhtml: yes +repeated-attributes: keep-last +doctype: strict +add-xml-decl: no +drop-empty-paras: yes +fix-uri: yes +hide-comments: yes +logical-emphasis: yes +literal-attributes: yes +lower-literals: yes +preserve-entities: yes +show-body-only: yes +show-warnings: yes +break-before-br: yes +markup: yes +sort-attributes: alpha +vertical-space: no +wrap-attributes: yes +char-encoding: utf8 +output-bom: auto +quiet: yes Added: www/staging/content/treebrowser.html =================================================================== --- www/staging/content/treebrowser.html (rev 0) +++ www/staging/content/treebrowser.html 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,11 @@ +<h2>treebrowser</h2> +<p>The treebrowser plugin unfortunately does not have a README file yet, +where the contents for this page could be obtained from. If you are the +maintainer of the treebrowser plugin you are appreciated to write a +README file for your plugin as a small documentation about what your plugin +does, how to use it and so on. You can get some inspiration on how to write +that by having a look at the other plugin pages.<br /> If you like to +contribute, feel free to write a README file for the treebrowser plugin +and send it to someone who as write access to the Subversion repositorys of +Geany Plugins. Most likely a <a href="http://www.geany.org/Main/Authors"> +Geany developer</a> is such a person.</p> Added: www/staging/favicon.ico =================================================================== (Binary files differ) Property changes on: www/staging/favicon.ico ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: www/staging/gencontent.sh =================================================================== --- www/staging/gencontent.sh (rev 0) +++ www/staging/gencontent.sh 2010-07-17 20:34:09 UTC (rev 1475) @@ -0,0 +1,172 @@ +#!/bin/bash + +# debug mode +#~ set -x + +# gencontent.sh +# Generates the *.html files in the content/ directory on the +# plugins.geany.org website +# +# (C) Copyright 2010 by Dominic Hopf <dh(a)dmaphy.de> +# Version: 1.0.0 +# Last Change: 2010-07-17 + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# ChangeLog: +# 2010-01-21 Dominic Hopf <dh@dmaphy> +# * remove unneccessary code which is trying to patch files but not working +# correctly +# +# 2010-01-21 Dominic Hopf <dh@dmaphy> +# * add a sanity check, if the README file for a plugin exists +# +# 2010-01-09 Dominic Hopf <dh(a)dmaphy.de> +# * write first version of this file with basic functionality + +# ATTENTION: If you change any path below, don't forget the trailing slashes, +# they are very important and the script will not work correctly if they are +# missing! + +# SOURCESDIR is the directory, where the README files will be found +SOURCESDIR=$HOME"/projects/geany-plugins/trunk/geany-plugins/" + +# CONTENTDIR is the directory, where the generated HTML files will be pushed +CONTENTDIR="./content/" + +# LOGDIR is the directory where to put any logfiles and information about the +# generation of the content files +LOGDIR="./gencontent_logs/" + +# plugins to exclude from the nightly re-generation via rst2html because they +# have a separate HTML page not generated from the README file +EXCLUDE_PLUGINS=( geanylatex geanysendmail geanylua ) + +RST2HTML="/usr/bin/rst2html" +TIDY="/usr/bin/tidy" + + +if [ ! -x "$RST2HTML" ] +then + echo "rst2html not found. Exiting." + exit 127 +fi + + +if [ ! -x "$TIDY" ] +then + echo "tidy not found. Exiting." + exit 127 +fi + + +# small function to check an array if an element is included +in_array() +{ + NEEDLE=$1 + shift + + # search for the NEEDLE $1 in the haystack $@ + for j in $@; + do + if [ $NEEDLE == $j ]; then + return 0; + fi; + done; + + return 1; +} + + +if [ ! -d $SOURCESDIR ]; then + echo -e "Directory containing sources $SOURCESDIR could not be found!\n" + exit 1 +fi + + +if [ ! -d $CONTENTDIR ]; then + echo -e "Directory containing contents $CONTENTDIR could not be found!\n" + exit 1 +fi + + +mkdir -p $LOGDIR + + +# reset geany-plugins-listing.html, the file which is included as navigation +rm -f $CONTENTDIR"geany-plugins-listing.html" +touch $CONTENTDIR"geany-plugins-listing.html" + +for i in `ls $SOURCESDIR`; +do + if [ -d $SOURCESDIR$i -a $i"x" != "buildx" -a $i"x" != "pox" ]; then + # check if the current plugin is included in the exclusion-list... + in_array $i ${EXCLUDE_PLUGINS[@]} + + if [ $? -eq 0 ]; then # ... if yes, ... + # ... add it to the navigation ... + echo "<li><a href=\"index.php?site=$i\">$i</a></li>" >> $CONTENTDIR"geany-plugins-listing.html" + continue # ... and jump to the next one + fi; + + LOGFILE=$LOGDIR$i"_log_"`date "+%Y-%m-%d"` + + echo -e "Generating content file $i.html...\n\n" > $LOGFILE + + if [ -s $SOURCESDIR$i/README ]; then + # TODO: there is still output from rst2html to the shell, that ideally should'nt be + # TODO: newer versions of rst2html may face problems with the configuration files encoding + $RST2HTML -s --config=$CONTENTDIR"rst2html_config.conf" $SOURCESDIR$i/README | tee .README.html >> $LOGFILE 2>&1 + echo "<li><a href=\"index.php?site=$i\">$i</a></li>" >> $CONTENTDIR"geany-plugins-listing.html" + + if [ $? -ne 0 ]; then + echo -e "$RST2HTML exited with $?.\n\n" + continue + fi + else + echo -e "File $SOURCESDIR$i/README not found.\nYou might want to have a look whats up there.\nCopying no-readme-template instead.." + cp "./templates/no-readme-template.html" $CONTENTDIR$i.html + sed -i "s/{plugin_name}/$i/g" $CONTENTDIR$i.html + continue + fi + echo -e "\n\n" >> $LOGFILE + + + $TIDY -config $CONTENTDIR"tidy.conf" .README.html >> $LOGFILE 2>&1 + case "$?" in + 1) + echo -e "$TIDY exited with 1. There were warnings, but this is okay." + echo -e "You maybe should have another look at $CONTENTDIR$i.html yourself.'\n" + ;; + 2) + echo "$TIDY exited with 2. There were errors.\n\n" + continue + ;; + *) + echo -e "$TIDY exited with $?. Everything should be fine.\n" + ;; + esac + echo -e "\n\n" >> $LOGFILE + + # since tidy just outputs spaces, not tabs, we'll replace those spaces + # with tabs again ourself @@ Diff output truncated at 100000 characters. @@ This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

Plugins-Commits July 2010