Figure 1: Plugin manager with GeanyLATEX 0.5 at Geany 0.19
GeanyLATEX is a little plugin to improve LATEX support in Geany. It implements a couple of hopefully useful functions:
Please note: This section of documentation is only valid with standalone distribution of GeanyLATEX. If you are planning to use the common geany-plugins project, please check documentation over there as there are some specialties you might like to know.
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 http://www.gtk.org.
And obviously, you will need to have Geany with its header files installed (in case you are compiling the plugin on your own). If you installed Geany 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, probably called geany-dev or geany-devel. Please note that in order to compile and use this plugin, you need Geany 0.20svn or later (Geany Plugin API v199 or higher).
Furthermore you need, of course, a C compiler and python installed. The GNU version of the C compiler is recommended. Furthermore, there should be a working LATEX-environment on your System.
There is no special need in RAM or CPU, so the plugin should compile and run on all systems Geany is able to run.
Please note: This section of documentation is only valid for the standalone distribution of GeanyLATEX. If you are about to use the common geany-plugins project, please check their documentation as there are some specialties you might like to know.
Compiling and installing the code is done by the following three commands:
For more configuration details, run ./waf --help
By default, the plugin is installed into the lib subfolder of your Geany installation. So if you have installed Geany to /usr/local/ the plugin will be installed to /usr/local/lib/geany/. Translation files will be installed to /usr/local/share/locale/ in this case.
If there are any errors during compilation, check your build environment and try to find the error, otherwise contact one of the authors1
Sources of this documentation are available throught doc/geanylatex.tex inside source tree. To compile the sources, usage of pdflatex (should be delivered with your favorite LATEX distribution) is recommended. For compiling into HTML format you might like to use htlatex. The HTML version of this documentation shipped with source tarball has been compiled with
After GeanyLATEX has been installed successful the plugin can be loaded through Geany’s plugin manager. Depending on configuration a new menu inside Geany’s main menu will appear, an menu entry for the LATEX-wizard will appear inside the Tools menu as well as new key bindings will be available inside Geany’s key binding interface. Inside the new menu you will find entries for functions supported by this version of the plugin. The main menu entry will be called something like LaTeX, depending on your locale.
Also if the option for showing the toolbar is activated on configuration dialog, the toolbar with common used format functions appears on at top of editor widget. This feature is turned off by default.
Let’s go into more detail on some features.
The LATEX-Wizard is implementing a easy way creating a number of default documents.
The wizard is offering a chance to choose from a couple of templates with the possibility of adding customer templates. This can be chosen from Templates pulldown on top of dialog.
This can be set by choosing the needed entry form Documentclass pulldown menu.
Encoding is configuring the packages inputenc to for example \usepackage[utf8]{inputenc} in case of the document encoding should be UTF-8. Also it sets the encoding Geany is using for the newly created document.
Font size as well as Paper size will set class option for font/paper size of the new created document. Author, Date, Title will be also passed to the corresponding command inside the file header.
Option Use draft mode will add draft to list of document options which allows some help during debugging of document.
Since KOMA script is quiet popular the option Use KOMA script if possible allows to activate the usage of KOMA script. If this options is activated instead of book, scrbook will be used as document class. Default is activated here. This option is deactivated by default and can be set through GeanyLATEX’s configuration dialog mentioned earlier in this document.
This wizard can also be called by a shortcut. Please have a look onto Section 2, page 53.
Document types that are currently supported by the wizard are:
GeanyLATEX is offering a way for extending the wizard by user defined templates. This templates will be stored inside the plugin configuration dir with file extension glt. For creating a customized template you will need to create a normal *.tex file and store it inside the directory. On most Linux systems this should be ~/.config/geany/geanyLaTeX/.
Inside your template you can refer to wizard’s field by using some special strings which are:
| Symbol | Usage |
| {CLASSOPTION} | Will be replaced by the classoptions set on the wizard as for example font size or paper size. |
| {DOCUMENTCLASS} | Will be replaced by the choosen document class based on the pulldown of wizard and whether option for KOMA script has been set. |
| {DATE} | Will be replaced by the input given on the date field of wizard. |
| {TITLE} | Will be replaced by the input given on the title field of wizard. |
| {AUTHOR} | Will be replaced by the input given on the author field of wizard. |
| {ENCODING} | Will be replace by choosen encoding from pulldown of wizard |
| {OPENING} | Will be replaced by ≫Dear Sir or Madame≪ in local geanyLATEX is running with. If you like to overwrite it, please don’t use the symbol and hardcode the phrase instead. |
| {CLOSING} | Will be replaced by ≫With kind regards≪ in local geanyLATEX is running with. If you like to overwrite it, please don’t use the symbol and hardcode the phrase instead. |
If you have other than the default templates defined they will be add to templates pulldown. So when creating a template, please keep care to set up a good name for the file, as the filename will be the identifier you can choose from on pulldown.
In future a number of templates should be available also online at http://frank.uvena.de/files/geany/data/geanyLaTeX/. Please feel also free to publish templates in case of you have some useful one.
If you need more general templates, you may have a look onto Geany’s build in template feature – briefly introduced on Chapter 11.2, page 66.
An often used feature on writing of documents is adding and referring to labels. GeanyLATEX is adding some support here for more comfortable adding new labels and reference offering a GUI.
After an label was added GeanyLATEX is offering a dialog for inserting normal references and page references to a label.
The suggestions inside the pull down are based on the aux files creating by processing of *.tex file located inside directory of current TEX-file. When first step was successful the files are parsed for \newlabel{}{}{} and outcome is tried to interpret them properly. The found entries will be inserted into pull down sorted by alphabet.
Both, the inserting labels as well as the inserting reference dialog can be accessed by key binding also. See Chapter 2 here.
GeanyLATEX is offering a number of often used templates for BibTeX catalogue entries. They can be access by the plugin submenu in Geany’s tools menu:
When choosing an entry from list on menu a templace with common used fields will be generated and inserted into the document. The template will be inserted on position of cursor which will no be moved during the process. As an example for a book, this will be inserted to the document:
GeanyLATEX is searching here for *.bib-files inside the directory of current active file. Its filtering for all references inside these files and putting it sorted and cleared from duplicated entries into the pulldown of the dialog.
With selecting one of the entries inside the pull down or by typing in your own reference name, pushing enter or hitting OK will insert a \cite{} into your document with your given reference.
GeanyLATEX is able to replace special characters to their there TEX substitute. This can be done in two different ways:
For both functions there are also shortcuts available.
The plugin is offering a number of special characters with their TEX substitutes to be inserted on easy accessing through the plugin menu.
GeanyLATEX is offering a feature for inserting environments into your documents. It can be chosen from a pulldown menu and will be inserted at current position of cursor. If there is a selection activ, the selection will be included into environment.
In case of an empty (= no selection) an empty environment with
will be inserted to the document.
GeanyLATEX is able to help on formation of text. For doing this its offering you to insert often use format patterns to your document. Patterns that are currently supported are:
GeanyLATEX will add the correct format pattern to the document. If there is an selection active, that pattern will be placed around so the selected text will be formatted with this chosen style.
Following items are also accessible using the GeanyLATEX toolbar:
Since version 0.5 GeanyLaTeX is supporting autocompletion for closing \end and \endgroup for begin commands. Before Geany 0.19 this has been part of the Geany core but has been moved out as it is something LATEX specific.
After the feature has been enabled (Please check 7.1.5, page 51 here for more detailed information), in every case you enter a \begin{} or \begingroup{} the plugin will automatically add the fitting \end{} or \endgroup{} if its not finding a closing tag within the definded context length – by default this means inside following 5 lines. If you like to change this size, please check Chapter 7.3.4, page 55.
This feature is by default file type depending, so it will only work on TEX-like file types as well its turned on by default.
From time you need to insert a new package into header of a document, but don’t want to change to top of document and scroll back to where you were.
Since version 0.5 GeanyLATEX is offering an easy to use dialog which is taking over the package name and possible package options to insert them into header of document. Right now, its placed direct in top of the \begin{document} statement if there is any.
GeanyLaTeX can be configured in three major ways:
With version 0.4 the configuration dialog is offering two options which can be changed:
KOMA script bei Markus Kohm is a very popular set of document classes mainly used in Europe. With this option the default setting for e.g. LATEX-Wizard can be configured2 . Option is turned off by default.
Decides whether toolbar with some format icons should appear in the top of editor widget. Option is turned off by default. Just give it a try.
If this option is enabled, GeanyLATEX will look for ., ! or ? followed by a space. The next letter will be inserted in capital letters. Currenty this is not working for multichar letters as German Umlauts as well as the overwriting is not supported very well at this point. In case of you don’t want to have the capital version of a letter in a particular case, just hit undo (Ctrl + z in most cases).
This adds an icon for GeanyLATEX wizard to Geany’s main toolbar so its easy to access via mouse even the toolbar of GeanyLATEX is not active and the tools menu is a way to far away.
Here you can choose, whether the GeanyLATEX should do some autocompletion or not. Values are either
Keybindings which are available:
| Shortcut | Description |
| Run LaTeX-Wizard | Starts the LaTeX-Wizard for creating a new document |
| Insert \label | Runs the dialog for inserting a new label into your document. |
| Insert \ref | Starts an dialog for easy inserting \ref and\pageref into your document. The dialog is supporting easy parsing of aux files so it can suggest a couple of already set labels. |
| Insert linebreak \\ | Inserts a a newline \\ into the document. |
| Turn input replacement on/off | A shortcut for turning input replacement on or off. When input replacement is activated special characters like ě are replaced by there TEX substitute like \v{e} |
| Replacement of special characters | A selected text will be parsed and all known special characters will be replaced by their TEX substitute. This can be very useful on importing a large amount of text into your document including characters like ö or ≫. |
| Run insert environment dialog | Runs a dialog for easy inserting an environment. If there is some text selected, the environment will be placed around. |
| Insert \item | This shortcut will add an simple \item to the document. This can be very useful during writing of lists with a huge number of items. |
| Format selection in bold font face | Format a selection with bold font face. This is done be adding \textbf{...} around selection. |
| Format selection in italic font face | Format a selection with italic font face. This is done be adding \textit{...} around selection. |
| Format selection in typewriter font face | Format a selection with typewriter font face. This is done be adding \texttt{...} around selection. |
| Format selection centered | Formats selected text centered on page (uses \centering |
| Format selection left-aligned | Formats selected text left-aligned on page (uses \raggedleft |
| Format selection right-alignedm | Formats selected text right-aligned on page (uses \raggedright |
| Insert description list | Inserts an description environment as well as a 1st \item element. |
| Insert itemize list | Inserts an itemize environment as well as a 1st \item element. |
| Insert enumerate list | Inserts an enumerate environment as well as a 1st \item element. |
As not all users need to configure everything on there plugin, Geany LATEX has some hidden preferences which can be set through command line.
By default, GeanyLATEX is deactivating buttons inside toolbar, which don’t make much sense to be applied on non-TEX file types. As this is not always wished, its possible to turn this feature off via a hidden preferences.
If you want to do so, just add a new section called toolbar into your general.conf file of GeanyLATEX plugin which stats glatex_deactivate_toolbaritems_with_non_latex=false. As a result, your config file could look similar to this:
Setting this option back to true will go back to default behaviour.
Please ensure, you reload the plugin once this option has been changed.
GeanyLATEX is enabling a separate menu inside Geany’s main menu. On default, its getting activated and deactivated based on the file type of the current document. However, from time to time its annying to have the menu entry switched maybe each time on switching between two documents it can be set to keep even there is no LaTeX document activ.
This option might make sense in combination with deactivation of toolbar items on changing to a non-TEX document at 7.3.1, page 54.
In case of you want to see always the LATEX-menu independent of you have a LATEX document open. To add the menu direct at startup time you might set glatex_add_menu_on_startup inside menu section of configuration file to true.
This options makes only sense in combination with glatex_deactivate_menubarentry_with_non_latex as described in chapter 7.3.2, page 54.
Inside configuration file you can add a value to adjust the size of context, which is being searched for autocompletion of \end and \endgroup. The default value is 5. If you want to reset it, just add a new line to your configuration file with glatex_set_autocompletion_contextsize followed by an integer value. An example could look like this:
With this option, you can force GeanyLATEX to apply all autocompletion functions also to non-TEX file types as for example an C-source code file. As this is only in a very low number of cases a really good idea, the option is by default turned on.
GeanyLATEX is able to insert references to a label where its using some default value. As this value is not always optimal, it can be changed using a hidden preference by setting glatex_reference_page, glatex_reference_chapter or glatex_reference_all inside configuration file as shown inside the example configuration snippet.
Please take care in this case {{reference}} will be replace by label name.
Also \t, \r, \n will be handled as known from C so you will need to add a second \ in front of in such cases. Even this seems to be annyoing on the first hand, it allows you to insert some more complicated constructs over here which might require a new line inside.
GeanyLATEX is able to autocomplete {} after typing _ and ^. This might by useful on typing mathematic text and formula. However, as this option is turn on by default and it might get annoying you can deactivate it by setting glatex_set_autobraces inside [autocompletion] section of configuration file. An example which is turning off the feature might can look like this:
Note: The feature in general is only working, if glatex_set_autocompletion=true is also set to true.
The plugin can autoadd a pair of braces {} on hitting return after typing a command. The function will search for a \ and will stop once it founds a space, some {} or a second \ as on \\. This can be configured also by using the hidden preference glatex_set_autobraces described in chapter 7.3.7, page 61.
If you like the plugin, there are a number of ways, how to contribute to the development of the plugin.
Currently the plugin is available in English and German language but we are always looking for other translations to. There are two major topics in translation:
New features are always highly welcome. The TODO file inside source code archive gives a good idea of current wished features and which are being worked on. Also you can have a look onto the feature request tracker of geany-plugins project at http://sourceforge.net/tracker/?group\_id=222729 whether you find something interesting. Of course we are also open for not in the sources mentioned before listed items. Just contact one of the authors (see Chapter 13).
When sending a patch which is adding a new feature, please check whether you did also care about some documentation for it. As the user will need some, it might can increase the speed a patch is applied. Of course you should also check chapter 9.1.1, page 65 for maybe some more detailed information before.
GeanyLATEX is tested mainly on x86 and x86_64 architecture running GNU/Linux. Also it was tested on some Windows 32 versions like XP SP3 very briefly. Since there are also other systems available, testing on other platforms and maybe reporting of issues is highly appreciate.
GeanyLATEX is part of the geany-plugins project even though there are releases independent of a major release of the project. Therefor there are two things you can do here:
Documentation is never complete. There are spelling mistakes, paragraphs that needs to be extended or rewritten because they are not clear or topics that were missed out at all.
The documentation is written in LATEX so all you need is to get the tex file from doc folder and add or update the content. After this, just send a diff or complete file to one of the authors.
You can also contribute to the plugin’s development by providing additional data as for example customized templates for the LATEX-Wizard. If you build up one, you might like to send it to one of the authors.
And of course, tell others of Geany and this plugin. If you like to do a talk about GeanyLATEX and/or Geany in general, there is some code available on http://git.geany.org/talks/ you might can use as a start point for preparing your own presentation. If your favourite language is not yet available there, please feel free to do your own translation and in best case send your translation to one of Geany’s3 development team so it can be added to archive.
You can checkout the current source code from the Subversion repository at Sourceforge.net. Get the code from:
svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanylatex
If you want to create a patch, please respect the license of GeanyLATEX as well as intellectual property of third. Patches that should be included to the default distribution must be licensed under the same conditions as GeanyLATEX by the copyright owner.
At time of the the documentation was created no issue were known. Since this is only a snapshot, you will find more
recent information for all reported issues bug tracking system of SF at
http://sourceforge.net/tracker/?group\_id=222729
Geany is offering a number of nice features that can be used to make daily work more easy without need to write a new plugin or extend GeanyLATEX.
On Geany you can define a couple of commands for the build system to improve work with your source file.
When working on a document it happens taht you find a typing error or some more generic issue on your document. Once this happend, its hard to find the correct position in your tex file. If you are using xdvi you can use the backward search function to jump to the right place of your document. An example configuration line for Geany’s build system could look similar to this snippet:
If you don’t need a dynamic template as described in Chapter 6.1.3, page 18 you can also use Geany’s buildin template function which allows to also add customised templates, including placeholders for e.g. author’s name, but in a more general and nonLATEX-specific way. Nevertheless you should give it a try as it is useful in many cases. For information on how to create your own template using Geany’s built-in feature, please check the manual.
Geany allows you to define code snippets and re-insert them easily at different places throughout your document.
A possible snippet for snippets.conf could be:
A snapshot of the authors’ last version for LaTeX can be found on http://www.geany.org/Download/Extras
As mentioned before, a number of useful functions are already implemented in other plugins. Below you will find a list with the authors’s recommendations. More nice plugins can be found on Geany’s plugins page at http://www.geany.org.
This plugin implements an easy way for inserting Lorem Ipsum text into a document. The length of the inserted text
if configurable so the plugin can be very helpful on testing layout.
Homepage: http://frank.uvena.de/en/Geany/geanylipsum/
When working on bigger documents a version control system like Subversion could be useful to keep versions.
GeanyVC is adding a easy to use frontend for a number of popular version controll systems such as git, Subversion,
CVS, Bazaar or Mercural.
Homepage: http://plugins.geany.org/geanyvc/
Nobody is perfect - in special with typing mistakes on writing a text. Spellcheck is offering a way on Geany to make
usage of a common spellchecking sytem as aspell, myspell or hunspell. Wrong spelled words can be marked with an
red line and the plugin is offering suggestions for correct the word. Unfortunately right now its not supporting some
special things common in TEX and LATEX.
Homepage: http://plugins.geany.org/spellcheck/
A plugin that is recognising TODO or FIXME tags inside a document and allows to easy jump to these entries. This
function is similar to the todo package but doesn’t require recompiling of the document. Recognised tags will be
inserted to another tab in Geany’s message widget.
Homepage: http://plugins.geany.org/addons/
GeanyLATEX 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.
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
http://frank.uvena.de/en/Geany/geanylatex/ 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.
