Revision: 640 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=640&view=rev Author: frlan Date: 2009-05-13 17:21:17 +0000 (Wed, 13 May 2009)
Log Message: ----------- GeanyLaTeX: Doc: Added generated HTML version of plugin documentation to dist tarball.
Modified Paths: -------------- trunk/geanylatex/Makefile.am
Added Paths: ----------- trunk/geanylatex/doc/geanylatex.css trunk/geanylatex/doc/geanylatex.html
Modified: trunk/geanylatex/Makefile.am =================================================================== --- trunk/geanylatex/Makefile.am 2009-05-13 17:19:39 UTC (rev 639) +++ trunk/geanylatex/Makefile.am 2009-05-13 17:21:17 UTC (rev 640) @@ -6,6 +6,7 @@ po/LINGUAS \ doc/geanylatex.tex \ doc/geanylatex.pdf \ + doc/geanylatex.html \ doc/img/*
dist-bzip2: distdir
Added: trunk/geanylatex/doc/geanylatex.css =================================================================== --- trunk/geanylatex/doc/geanylatex.css (rev 0) +++ trunk/geanylatex/doc/geanylatex.css 2009-05-13 17:21:17 UTC (rev 640) @@ -0,0 +1,129 @@ + +/* start css.sty */ +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10x-x-207{font-size:207%; font-family: sans-serif; font-weight: bold;} +.cmssbx-10x-x-207{ font-family: sans-serif; font-weight: bold;} +.pplr7t-x-x-144{font-size:144%;} +.pplr7t-x-x-80{font-size:80%;} +.zplmr7m-{font-style: italic;} +.pplr7t-x-x-90{font-size:90%;} +.pcrr7t-{font-family: monospace;} +.zplmr7y-x-x-60{font-size:60%;} +.pcrr7t-x-x-70{font-size:70%;font-family: monospace;} +.pplb7t-{font-weight: bold;} +.pcrr7t-x-x-80{font-size:80%;font-family: monospace;} +p.noindent { text-indent: 0em } +td p.noindent { text-indent: 0em; margin-top:0em; } +p.nopar { text-indent: 0em; } +p.indent{ text-indent: 1.5em } +@media print {div.crosslinks {visibility:hidden;}} +a img { border-top: 0; border-left: 0; border-right: 0; } +center { margin-top:1em; margin-bottom:1em; } +td center { margin-top:0em; margin-bottom:0em; } +.Canvas { position:relative; } +img.math{vertical-align:middle;} +li p.indent { text-indent: 0em } +li p:first-child{ margin-top:0em; } +li p:last-child, li div:last-child { margin-bottom:0.5em; } +li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; } +.enumerate1 {list-style-type:decimal;} +.enumerate2 {list-style-type:lower-alpha;} +.enumerate3 {list-style-type:lower-roman;} +.enumerate4 {list-style-type:upper-alpha;} +div.newtheorem { margin-bottom: 2em; margin-top: 2em;} +.obeylines-h,.obeylines-v {white-space: nowrap; } +div.obeylines-v p { margin-top:0; margin-bottom:0; } +.overline{ text-decoration:overline; } +.overline img{ border-top: 1px solid black; } +td.displaylines {text-align:center; white-space:nowrap;} +.centerline {text-align:center;} +.rightline {text-align:right;} +div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } +.fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.fbox {display:table} +div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +div.minipage{width:100%;} +div.center, div.center div.center {text-align: center; margin-left:1em; margin-right:1em;} +div.center div {text-align: left;} +div.flushright, div.flushright div.flushright {text-align: right;} +div.flushright div {text-align: left;} +div.flushleft {text-align: left;} +.underline{ text-decoration:underline; } +.underline img{ border-bottom: 1px solid black; margin-bottom:1pt; } +.framebox-c, .framebox-l, .framebox-r { padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } +.framebox-c {text-align:center;} +.framebox-l {text-align:left;} +.framebox-r {text-align:right;} +span.thank-mark{ vertical-align: super } +span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; } +div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; } +table.tabular td p{margin-top:0em;} +table.tabular {margin-left: auto; margin-right: auto;} +td p:first-child{ margin-top:0em; } +td p:last-child{ margin-bottom:0em; } +div.td00{ margin-left:0pt; margin-right:0pt; } +div.td01{ margin-left:0pt; margin-right:5pt; } +div.td10{ margin-left:5pt; margin-right:0pt; } +div.td11{ margin-left:5pt; margin-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +td.td00{ padding-left:0pt; padding-right:0pt; } +td.td01{ padding-left:0pt; padding-right:5pt; } +td.td10{ padding-left:5pt; padding-right:0pt; } +td.td11{ padding-left:5pt; padding-right:5pt; } +table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } +.hline hr, .cline hr{ height : 1px; margin:0px; } +.tabbing-right {text-align:right;} +span.TEX {letter-spacing: -0.125em; } +span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;} +a span.TEX span.E {text-decoration: none; } +span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;} +span.LATEX span.TEX{ position:relative; left: -0.4em; } +div.float, div.figure {margin-left: auto; margin-right: auto;} +div.float img {text-align:center;} +div.figure img {text-align:center;} +.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} +.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} +table.equation {width:100%;} +.equation td{text-align:center; } +td.equation { margin-top:1em; margin-bottom:1em; } +td.equation-label { width:5%; text-align:center; } +td.eqnarray4 { width:5%; white-space: normal; } +td.eqnarray2 { width:5%; } +table.eqnarray-star, table.eqnarray {width:100%;} +div.eqnarray{text-align:center;} +div.array {text-align:center;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +span.pmatrix img{vertical-align:middle;} +div.pmatrix {text-align:center;} +table.pmatrix {width:100%;} +img.cdots{vertical-align:middle;} +.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;} +.index-item, .index-subitem, .index-subsubitem {display:block} +div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;} +div.caption span.id{font-weight: bold; white-space: nowrap; } +h1.partHead{text-align: center} +p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } +.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;} +.subparagraphHead, .likesubparagraphHead { font-weight: bold;} +.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;} +.verse{white-space:nowrap; margin-left:2em} +div.maketitle {text-align:center;} +h2.titleHead{text-align:center;} +div.maketitle{ margin-bottom: 2em; } +div.author, div.date {text-align:center;} +div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; } +div.author{white-space: nowrap;} +.quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; } +.abstract p {margin-left:5%; margin-right:5%;} +div.abstract {width:100%;} +span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; } +.lstlisting .label{margin-right:0.5em; } +div.lstlisting{font-family: monospace; white-space: nowrap; margin-top:0.5em; margin-bottom:0.5em; } +div.lstinputlisting{ font-family: monospace; white-space: nowrap; } +.lstinputlisting .label{margin-right:0.5em;} +.figure img.graphics {margin-left:10%;} +/* end css.sty */ +
Added: trunk/geanylatex/doc/geanylatex.html =================================================================== --- trunk/geanylatex/doc/geanylatex.html (rev 0) +++ trunk/geanylatex/doc/geanylatex.html 2009-05-13 17:21:17 UTC (rev 640) @@ -0,0 +1,1108 @@ +<?xml version="1.0" encoding="iso-8859-1" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> +<html xmlns="http://www.w3.org/1999/xhtml" +> +<head><title>GeanyLaTeX – A LaTeX plugin for Geany +Version 0.4</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<!-- xhtml,html --> +<meta name="src" content="geanylatex.tex" /> +<meta name="date" content="2009-05-13 19:14:00" /> +<link rel="stylesheet" type="text/css" href="geanylatex.css" /> +</head><body +> +<div class="maketitle"> + + + + + +<h2 class="titleHead">Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> – A <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> plugin for Geany<br /><br /> +Version 0.4</h2> + <div class="author" ><span +class="pplr7t-x-x-144">Frank Lanitz</span> +<br /><a +href="mailto:frank@frank.uvena.de" ><span +class="pplr7t-x-x-90">frank@frank.uvena.de</span></a></div> +<br /> +<div class="date" ><span +class="pplr7t-x-x-144">May 13, 2009</span></div> +</div> +<h3 class="likesectionHead"><a + id="x1-1000"></a>Contents</h3> +<div class="tableofcontents"> +<span class="sectionToc" ><a +href="#Q1-1-3">List of Tables</a></span> +<br /><span class="sectionToc" >1 <a +href="#x1-30001" id="QQ2-1-4">About the plugin</a></span> +<br /><span class="sectionToc" >2 <a +href="#x1-40002" id="QQ2-1-5">Requirements</a></span> +<br /><span class="sectionToc" >3 <a +href="#x1-50003" id="QQ2-1-6">Installation</a></span> +<br /><span class="sectionToc" >4 <a +href="#x1-60004" id="QQ2-1-7">Usage</a></span> +<br /><span class="sectionToc" >5 <a +href="#x1-70005" id="QQ2-1-9">Features</a></span> +<br /> <span class="subsectionToc" >5.1 <a +href="#x1-80005.1" id="QQ2-1-10"><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>-Wizard</a></span> +<br /> <span class="subsectionToc" >5.2 <a +href="#x1-90005.2" id="QQ2-1-12">Inserting and replacing of special characters</a></span> +<br /> <span class="subsectionToc" >5.3 <a +href="#x1-100005.3" id="QQ2-1-13">Inserting References and Labels</a></span> +<br /> <span class="subsectionToc" >5.4 <a +href="#x1-110005.4" id="QQ2-1-16">BibTeX templates for catalogue entries</a></span> +<br /> <span class="subsectionToc" >5.5 <a +href="#x1-120005.5" id="QQ2-1-17">Replacement of special characters</a></span> +<br /> <span class="subsectionToc" >5.6 <a +href="#x1-130005.6" id="QQ2-1-18">Inserting of Environment</a></span> +<br /> <span class="subsectionToc" >5.7 <a +href="#x1-140005.7" id="QQ2-1-20">Format</a></span> +<br /><span class="sectionToc" >6 <a +href="#x1-150006" id="QQ2-1-21">Configuration</a></span> +<br /> <span class="subsectionToc" >6.1 <a +href="#x1-160006.1" id="QQ2-1-22">Key bindings</a></span> +<br /><span class="sectionToc" >7 <a +href="#x1-170007" id="QQ2-1-24">Donating to the plugin</a></span> + + +<br /> <span class="subsectionToc" >7.1 <a +href="#x1-180007.1" id="QQ2-1-25">Extending plugin</a></span> +<br /> <span class="subsectionToc" >7.2 <a +href="#x1-210007.2" id="QQ2-1-28">Testing & bug reporting</a></span> +<br /> <span class="subsectionToc" >7.3 <a +href="#x1-220007.3" id="QQ2-1-29">Packaging</a></span> +<br /> <span class="subsectionToc" >7.4 <a +href="#x1-230007.4" id="QQ2-1-30">Improving and extending of documentation</a></span> +<br /> <span class="subsectionToc" >7.5 <a +href="#x1-240007.5" id="QQ2-1-31">Propaganda</a></span> +<br /><span class="sectionToc" >8 <a +href="#x1-250008" id="QQ2-1-32">Development</a></span> +<br /> <span class="subsectionToc" >8.1 <a +href="#x1-260008.1" id="QQ2-1-33">Development version</a></span> +<br /><span class="sectionToc" >9 <a +href="#x1-280009" id="QQ2-1-35">Known issues</a></span> +<br /><span class="sectionToc" >10 <a +href="#x1-2900010" id="QQ2-1-36">Recommendations to improve work with <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> and Geany</a></span> +<br /> <span class="subsectionToc" >10.1 <a +href="#x1-3000010.1" id="QQ2-1-37">Geany’s code snippet function</a></span> +<br /> <span class="subsectionToc" >10.2 <a +href="#x1-3100010.2" id="QQ2-1-38">Other useful plugins</a></span> +<br /><span class="sectionToc" >11 <a +href="#x1-3500011" id="QQ2-1-42">License</a></span> +<br /><span class="sectionToc" >12 <a +href="#x1-3600012" id="QQ2-1-43">Bugs, questions, homepage</a></span> +</div> +<h3 class="likesectionHead"><a + id="x1-2000"></a>List of Tables</h3> +<a + id="Q1-1-3"></a> +<div class="tableofcontents"><span class="lotToc" >1 <a +href="#x1-16001r1">List of available keybindings</a></span><br /> +</div> + + +<h3 class="sectionHead"><span class="titlemark">1 </span> <a + id="x1-30001"></a>About the plugin</h3> +<!--l. 63--><p class="noindent" >Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is a little plugin to improve support of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> on Geany. It implements a couple of maybe useful +functions: +</p> + <ul class="itemize1"> + <li class="itemize">Wizard to create new <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> documents in a fast and easy way with a bunch of templates available + </li> + <li class="itemize">A front end for add labels <span +class="cmsy-10"></span>label and references <span +class="cmsy-10"></span>ref and <span +class="cmsy-10"></span>pageref with getting suggestion from aux + file of document + </li> + <li class="itemize">Inserting special characters through menu + </li> + <li class="itemize">Help entering the right field for BibTeX entries by providing templates + </li> + <li class="itemize">Easy inserting format patterns like <span +class="cmsy-10"></span>texttt through menu + </li> + <li class="itemize">Support on inserting environments by offering an dialog and recognising selections + </li> + <li class="itemize">Shortcuts for inserting <span +class="cmsy-10"></span>item and <span +class="cmsy-10"></span>newline</li></ul> +<!--l. 84--><p class="noindent" > +</p> +<h3 class="sectionHead"><span class="titlemark">2 </span> <a + id="x1-40002"></a>Requirements</h3> +<!--l. 86--><p class="noindent" >For compiling the plugin yourself, you will need the GTK (<span +class="zplmr7m-">></span><span +class="zplmr7t-">= </span>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 +href="http://www.gtk.org" class="url" ><span +class="pcrr7t-">http://www.gtk.org</span></a>. +</p><!--l. 91--><p class="noindent" >And obviously, you will need have Geany with its header files installed (in case you are compiling the plugin on +your own). 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 v130 or higher). +</p><!--l. 99--><p class="noindent" >Furthermore you need, of course, a C compiler and the Make tool. The GNU versions of these tools are +recommended. Also there should be a working <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>-environment on your System. +</p><!--l. 103--><p class="noindent" >There is no special need in RAM or CPU so the plugin should run on all systems Geany is able to +run. + + +</p><!--l. 106--><p class="noindent" > +</p> +<h3 class="sectionHead"><span class="titlemark">3 </span> <a + id="x1-50003"></a>Installation</h3> +<!--l. 107--><p class="noindent" >Compiling and installing the code is done by the following three commands: +</p> +<hr class="figure" /><div class="figure" +> + + + + +<!--l. 111--> +<div class="lstlisting" id="listing-1"><span class="label"><a + id="x1-5001r1"></a></span><span +class="pcrr7t-x-x-70">$</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">./</span><span +class="pcrr7t-x-x-70">configure</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-5002r2"></a></span><span +class="pcrr7t-x-x-70">$</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">make</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-5003r3"></a></span><span +class="pcrr7t-x-x-70">$</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">make</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">install</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">$</span> +</div> + + +</div><hr class="endfigure" /> +<!--l. 118--><p class="noindent" >For more configuration details run <span +class="pcrr7t-">./configure --help</span> +</p><!--l. 120--><p class="noindent" >If there are any errors during compilation, check your build environment and try to find the error, otherwise contact one of +the authors<span class="footnote-mark"><a +href="geanylatex2.html#fn1x0"><sup class="textsuperscript">1</sup></a></span><a + id="x1-5004f1"></a> +</p> +<h3 class="sectionHead"><span class="titlemark">4 </span> <a + id="x1-60004"></a>Usage</h3> +<hr class="figure" /><div class="figure" +> + + +<a + id="x1-6001r1"></a> + + + +<!--l. 129--><p class="noindent" ><img +src="img/plugin_manager.png" alt="PIC" + /> +<br /> </p><div class="caption" +><span class="id">Figure 1: </span><span +class="content">Plugin manager with Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> of Geany 0.16</span></div><!--tex4ht:label?: x1-6001r1 --> + + +</div><hr class="endfigure" /> +<!--l. 133--><p class="noindent" >After Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> has been installed successfully the plugin can be loaded through Geany’s plugin manager and +a new sub menu in the Tools menu will appear as well as new key bindings will be available inside Geany’s key +binding interface. Inside the sub menu you will find entries for functions supported by this version of the plugin. It +will be called <span +class="pcrr7t-">LaTeX</span>. +</p> +<h3 class="sectionHead"><span class="titlemark">5 </span> <a + id="x1-70005"></a>Features</h3> +<!--l. 143--><p class="noindent" >Go into more detail on some features. +</p><!--l. 145--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">5.1 </span> <a + id="x1-80005.1"></a><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>-Wizard</h4> +<!--l. 147--><p class="noindent" >The <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>-Wizard is implementing a easy way creating a number of default documents. </p><hr class="figure" /><div class="figure" +> + + +<a + id="x1-8001r2"></a> + + + +<!--l. 150--><p class="noindent" ><img +src="img/latexwizard.png" alt="PIC" + /> +<br /> </p><div class="caption" +><span class="id">Figure 2: </span><span +class="content"><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>-Wizard of version 0.4</span></div><!--tex4ht:label?: x1-8001r2 --> + + +</div><hr class="endfigure" /> +<!--l. 154--><p class="noindent" >Document types that are currently supported by the wizard are: </p> + <ul class="itemize1"> + <li class="itemize">book + </li> + <li class="itemize">report + </li> + <li class="itemize">article + </li> + <li class="itemize">letter (default letter class) + </li> + <li class="itemize">presentation (<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> beamer)</li></ul> +<!--l. 163--><p class="noindent" >This can be set by choosing the needed entry form <span +class="pplb7t-">Documentclass </span>pulldown menu. +</p><!--l. 166--><p class="noindent" ><span +class="pplb7t-">Encoding </span>is configuring the packages <span +class="pcrr7t-">inputenc </span>to for example <span +class="cmsy-10"></span><span +class="pcrr7t-">usepackage[utf8]</span><span +class="cmsy-10">{</span><span +class="pcrr7t-">inputenc</span><span +class="cmsy-10">} </span>in case of the +document encoding should be UTF-8. Also it sets the encoding Geany is using for the newly created +document. +</p><!--l. 171--><p class="noindent" ><span +class="pplb7t-">Font size </span>as well as <span +class="pplb7t-">Paper size </span>will set class option for font/paper size of the new created document.<span +class="pplb7t-">Author</span>, <span +class="pplb7t-">Date</span>, +<span +class="pplb7t-">Title </span>will be also passed to the corresponding command inside the file header. +</p><!--l. 176--><p class="noindent" >Option <span +class="pplb7t-">Use draft mode </span>will add <span +class="pcrr7t-">draft </span>to list of document options which allows some help during debugging of +document. +</p><!--l. 179--><p class="noindent" >Since KOMA script is quiet popular the option <span +class="pplb7t-">Use KOMA script if possible </span>allows to activate the usage of KOMA +script. If this options is activated instead of <span +class="pcrr7t-">book</span>, <span +class="pcrr7t-">scrbook </span>will be used as document class. Default is activated +here. +</p><!--l. 184--><p class="noindent" >The dialog can also be called by a shortcut. Please have a look onto section <a +href="#x1-16001r1">1<!--tex4ht:ref: kb_latex_wizard --></a>, page <a +href="#x1-16001r1">33<!--tex4ht:ref: kb_latex_wizard --></a>. +</p> +<h4 class="subsectionHead"><span class="titlemark">5.2 </span> <a + id="x1-90005.2"></a>Inserting and replacing of special characters</h4> +<!--l. 189--><p class="noindent" >At replacing a selected text will be parsed and all known special characters will be replaced by their <span class="TEX">T<span +class="E">E</span>X</span> substitute. +This can be very useful on importing a large amount of text into your document including characters like \xF6 or <span +class="zplmr7y-x-x-60">≫</span>. +This can be also called using a keybinding (see <a +href="#x1-16001r1">1<!--tex4ht:ref: kb_replacement_of_special_char --></a>, page <a +href="#x1-16001r1">33<!--tex4ht:ref: kb_replacement_of_special_char --></a>). +</p><!--l. 197--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">5.3 </span> <a + id="x1-100005.3"></a>Inserting References and Labels</h4> +<!--l. 198--><p class="noindent" >An often used feature on writing of documents is adding and referring to labels. Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is adding some +support here for more comfortable adding new labels and reference offering a GUI. +</p> +<hr class="figure" /><div class="figure" +> + + +<a + id="x1-10001r3"></a> + + + +<!--l. 203--><p class="noindent" ><img +src="img/insert_label.png" alt="PIC" + /> +<br /> </p><div class="caption" +><span class="id">Figure 3: </span><span +class="content">Insert label dialog on Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 0.4</span></div><!--tex4ht:label?: x1-10001r3 --> + + +</div><hr class="endfigure" /> +<!--l. 207--><p class="noindent" >After an label was added Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is offering a dialog for inserting normal references and page references to +an label. +</p> +<hr class="figure" /><div class="figure" +> + + +<a + id="x1-10002r4"></a> + + + +<!--l. 211--><p class="noindent" ><img +src="img/insert_reference.png" alt="PIC" + /> +<br /> </p><div class="caption" +><span class="id">Figure 4: </span><span +class="content">Insert reference dialog on Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 0.4</span></div><!--tex4ht:label?: x1-10002r4 --> + + +</div><hr class="endfigure" /> +<!--l. 215--><p class="noindent" >The suggestions inside the pull down are based on the aux file creating by processing of *.tex file. The plugin is +searching for a aux file for the current open *.tex file inside current directory. When first step was successful the file +is parsed for <span +class="cmsy-10"></span><span +class="pcrr7t-">newlabel</span><span +class="cmsy-10">{}{}{} </span>and tries to interpret them properly. The found entries will be inserted into pull +down sorted by alphabet. +</p><!--l. 222--><p class="noindent" >Both, the inserting labels as well as the inserting reference dialog can be accessed by key binding also. See chapter <a +href="#x1-16001r1">1<!--tex4ht:ref: kb_insert_label --></a> +and <a +href="#x1-16001r1">1<!--tex4ht:ref: kb_insert_reference --></a> here. +</p> +<h4 class="subsectionHead"><span class="titlemark">5.4 </span> <a + id="x1-110005.4"></a>BibTeX templates for catalogue entries</h4> +<!--l. 227--><p class="noindent" >Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 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: </p> + <ul class="itemize1"> + <li class="itemize">Article + </li> + <li class="itemize">Book + </li> + <li class="itemize">Booklet + </li> + <li class="itemize">Conference + </li> + <li class="itemize">Inbook + </li> + <li class="itemize">Incollection + </li> + <li class="itemize">Inproceedings + </li> + <li class="itemize">Manual + </li> + <li class="itemize">Mastersthesis + </li> + <li class="itemize">Misc + </li> + <li class="itemize">PhdThesis + </li> + <li class="itemize">Proceedings + </li> + <li class="itemize">Techreport + </li> + <li class="itemize">Unpublished</li></ul> + + +<!--l. 246--><p class="noindent" >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: +</p> +<hr class="figure" /><div class="figure" +> + + + + +<!--l. 253--> +<div class="lstlisting" id="listing-2"><span class="label"><a + id="x1-11001r1"></a></span><span +class="pcrr7t-x-x-70">@Book</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-11002r2"></a></span><span +class="pcrr7t-x-x-70">Author</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">=</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">{},</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-11003r3"></a></span><span +class="pcrr7t-x-x-70">Editor</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">=</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">{},</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-11004r4"></a></span><span +class="pcrr7t-x-x-70">Publisher</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">=</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">{},</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-11005r5"></a></span><span +class="pcrr7t-x-x-70">Title</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">=</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">{},</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-11006r6"></a></span><span +class="pcrr7t-x-x-70">Year</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">=</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">{},</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-11007r7"></a></span><span +class="pcrr7t-x-x-70">}</span> +</div> + + +</div><hr class="endfigure" /> +<h4 class="subsectionHead"><span class="titlemark">5.5 </span> <a + id="x1-120005.5"></a>Replacement of special characters</h4> +<!--l. 265--><p class="noindent" >Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is able to replace special characters to their there <span class="TEX">T<span +class="E">E</span>X</span> substitute. This can be done in two different +ways: +</p><!--l. 268--><p class="noindent" > + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-12002x1"><span +class="pplb7t-">On input: </span>If this switch is active all special characters will be replaced during typing of text. You can + turn the switch on/off at Replacement of special characters submenu inside. + </li> + <li + class="enumerate" id="x1-12004x2"><span +class="pplb7t-">Bulk replace of selected text: </span>A selected text will be parsed and all known special characters will be + replaced by their <span class="TEX">T<span +class="E">E</span>X</span> substitute. This can be very useful on importing a large amount of text into + your document including characters like \xF6 or <span +class="zplmr7y-x-x-60">≫</span>. This function is available through the Replacement + of special characters submenu on plugin’s submenu of Geany’s Tools menu.</li></ol> +<!--l. 282--><p class="noindent" >For both functions there are also shortcuts available. +</p><!--l. 284--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">5.6 </span> <a + id="x1-130005.6"></a>Inserting of Environment</h4> +<!--l. 285--><p class="noindent" >Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is offering a feature for inserting environments into your documents. It can be chosen fro 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. +</p> +<hr class="figure" /><div class="figure" +> + + + + +<!--l. 291--> +<div class="lstlisting" id="listing-3"><span class="label"><a + id="x1-13001r1"></a></span><span +class="pcrr7t-x-x-70"></span><span +class="pcrr7t-x-x-70">begin</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">your_environment</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-13002r2"></a></span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">...</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">selected</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">text</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">...</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-13003r3"></a></span><span +class="pcrr7t-x-x-70"></span><span +class="pcrr7t-x-x-70">end</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">your_environment</span><span +class="pcrr7t-x-x-70">}</span> +</div> + + +</div><hr class="endfigure" /> +<!--l. 298--><p class="noindent" >In case of an empty (= no selection) an empty environment with </p><hr class="figure" /><div class="figure" +> + + + + +<!--l. 300--> +<div class="lstlisting" id="listing-4"><span class="label"><a + id="x1-13004r1"></a></span><span +class="pcrr7t-x-x-70"></span><span +class="pcrr7t-x-x-70">begin</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">your_environment</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-13005r2"></a></span><span +class="pcrr7t-x-x-70">...</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-13006r3"></a></span><span +class="pcrr7t-x-x-70"></span><span +class="pcrr7t-x-x-70">end</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">your_environment</span><span +class="pcrr7t-x-x-70">}</span> +</div> + + +</div><hr class="endfigure" /> +<!--l. 307--><p class="noindent" >will be inserted to the document. +</p> +<hr class="figure" /><div class="figure" +> + + +<a + id="x1-13007r5"></a> + + + +<!--l. 310--><p class="noindent" ><img +src="img/insert_environment.png" alt="PIC" + /> +<br /> </p><div class="caption" +><span class="id">Figure 5: </span><span +class="content">Insert environment dialog on Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 0.4</span></div><!--tex4ht:label?: x1-13007r5 --> + + +</div><hr class="endfigure" /> +<h4 class="subsectionHead"><span class="titlemark">5.7 </span> <a + id="x1-140005.7"></a>Format</h4> +<!--l. 316--><p class="noindent" >Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 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: +</p> + <ul class="itemize1"> + <li class="itemize">Italic + </li> + <li class="itemize">Boldfont + </li> + <li class="itemize">Underline + </li> + <li class="itemize">Slanted + </li> + <li class="itemize">Typewriter + </li> + <li class="itemize">Small Caps + </li> + <li class="itemize">Emphasis</li></ul> +<!--l. 330--><p class="noindent" >Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 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. +</p><!--l. 334--><p class="noindent" > +</p> +<h3 class="sectionHead"><span class="titlemark">6 </span> <a + id="x1-150006"></a>Configuration</h3> +<!--l. 336--><p class="noindent" >No general configuration is needed to use the plugin. Nevertheless if you want improve and make usage of all +feature, you can define some key bindings using Geany’s key binding interface from inside the preferences +dialog. + + +</p><!--l. 341--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">6.1 </span> <a + id="x1-160006.1"></a>Key bindings</h4> +<!--l. 342--><p class="noindent" >Keybindings which are available: +</p> +<div class="table"> + + +<!--l. 344--><p class="noindent" ><a + id="x1-16001r1"></a></p><hr class="float" /><div class="float" +> + + + <div class="caption" +><span class="id">Table 1: </span><span +class="content">List of available keybindings</span></div><!--tex4ht:label?: x1-16001r1 --> +<div class="tabular"> <table id="TBL-2" class="tabular" +cellspacing="0" cellpadding="0" rules="groups" +><colgroup id="TBL-2-1g"><col +id="TBL-2-1" /></colgroup><colgroup id="TBL-2-2g"><col +id="TBL-2-2" /></colgroup><tr + style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-1-1" +class="td11"><span +class="pplb7t-">Shortcut </span></td><td style="white-space:wrap; text-align:left;" id="TBL-2-1-2" +class="td11"><!--l. 350--><p class="noindent" ><span +class="pplb7t-">Description</span> </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-2-1" +class="td11">Run LaTeX-Wizard </td><td style="white-space:wrap; text-align:left;" id="TBL-2-2-2" +class="td11"><!--l. 351--><p class="noindent" >Starts the LaTeX-Wizard for creating a new document </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-3-1" +class="td11">Insert <span +class="cmsy-10"></span>label </td><td style="white-space:wrap; text-align:left;" id="TBL-2-3-2" +class="td11"><!--l. 352--><p class="noindent" >Runs the dialog for inserting a new label into your +document. </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-4-1" +class="td11">Insert <span +class="cmsy-10"></span>ref </td><td style="white-space:wrap; text-align:left;" id="TBL-2-4-2" +class="td11"><!--l. 353--><p class="noindent" >Starts an dialog for easy inserting <span +class="cmsy-10"></span><span +class="pcrr7t-">ref </span>and<span +class="cmsy-10"></span><span +class="pcrr7t-">pageref </span>into +your document. The dialog is supporting easy parsing of +aux files so it can suggest a couple of already set labels. </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-5-1" +class="td11">Insert linebreak <span +class="cmsy-10">\ </span></td><td style="white-space:wrap; text-align:left;" id="TBL-2-5-2" +class="td11"><!--l. 354--><p class="noindent" >Inserts a a newline <span +class="cmsy-10">\ </span>into the document. </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-6-1" +class="td11">Turn input replacement on/off </td><td style="white-space:wrap; text-align:left;" id="TBL-2-6-2" +class="td11"><!--l. 355--><p class="noindent" >A shortcut for turning input replacement on or off. When +input replacement is activated special characters like ě are +replaced by there <span class="TEX">T<span +class="E">E</span>X</span> substitute like <span +class="cmsy-10"></span><span +class="pcrr7t-">v</span><span +class="cmsy-10">{</span><span +class="pcrr7t-">e</span><span +class="cmsy-10">}</span> </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-7-1" +class="td11">Replacement of special characters </td><td style="white-space:wrap; text-align:left;" id="TBL-2-7-2" +class="td11"><!--l. 356--><p class="noindent" >A selected text will be parsed and all known special +characters will be replaced by their <span class="TEX">T<span +class="E">E</span>X</span> substitute. This +can be very useful on importing a large amount of text into +your document including characters like \xF6 or <span +class="zplmr7y-x-x-60">≫</span>. </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-8-1" +class="td11">Run insert environment dialog </td><td style="white-space:wrap; text-align:left;" id="TBL-2-8-2" +class="td11"><!--l. 359--><p class="noindent" >Runs a dialog for easy inserting an environment. If there is +some text selected, the environment will be placed around.</p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-9-1" +class="td11">Insert <span +class="cmsy-10"></span>item </td><td style="white-space:wrap; text-align:left;" id="TBL-2-9-2" +class="td11"><!--l. 361--><p class="noindent" >This shortcut will add an simple <span +class="cmsy-10"></span>item to the document. +This can be very useful during writing of lists with a huge +number of items. </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-10-1" +class="td11">Format selection in bold font face </td><td style="white-space:wrap; text-align:left;" id="TBL-2-10-2" +class="td11"><!--l. 364--><p class="noindent" >Format a selection with bold font face. This is done be +adding <span +class="cmsy-10"></span><span +class="pcrr7t-">textbf</span><span +class="cmsy-10">{</span><span +class="pcrr7t-">...</span><span +class="cmsy-10">} </span>around selection. </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-11-1" +class="td11">Format selection in italic font face </td><td style="white-space:wrap; text-align:left;" id="TBL-2-11-2" +class="td11"><!--l. 366--><p class="noindent" >Format a selection with italic font face. This is done be +adding <span +class="cmsy-10"></span><span +class="pcrr7t-">textit</span><span +class="cmsy-10">{</span><span +class="pcrr7t-">...</span><span +class="cmsy-10">} </span>around selection. </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-12-1" +class="td11">Format selection in typewriter font face</td><td style="white-space:wrap; text-align:left;" id="TBL-2-12-2" +class="td11"><!--l. 368--><p class="noindent" >Format a selection with typewriter font face. This is done +be adding <span +class="cmsy-10"></span><span +class="pcrr7t-">texttt</span><span +class="cmsy-10">{</span><span +class="pcrr7t-">...</span><span +class="cmsy-10">} </span>around selection. </p></td> +</tr><tr +class="hline"><td><hr /></td><td><hr /></td></tr><tr + style="vertical-align:baseline;" id="TBL-2-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-2-13-1" +class="td11"> </td></tr></table></div> + + +</div><hr class="endfloat" /> +</div> +<h3 class="sectionHead"><span class="titlemark">7 </span> <a + id="x1-170007"></a>Donating to the plugin</h3> +<!--l. 378--><p class="noindent" >If you like the plugin, there are a number of ways, hwo to donate the development of the plugin. +</p><!--l. 381--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">7.1 </span> <a + id="x1-180007.1"></a>Extending plugin</h4> +<!--l. 383--><p class="noindent" > +</p> +<h5 class="subsubsectionHead"><span class="titlemark">7.1.1 </span> <a + id="x1-190007.1.1"></a>Adding a new translation</h5> +<!--l. 385--><p class="noindent" >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: +</p><!--l. 389--><p class="noindent" > + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-19002x1"><span +class="pplb7t-">Translation of plugin: </span>Adding a new translation and improving an existing one is easy to do. After + catching the source tarball and extracting you can find all needed files inside the po folder. <br +class="newline" />Please contact the authors if you plan to update/add a translation to ensure nobody else is currently + working on and avoid double work and to get some further information about translation (see chapter + <a +href="#x1-3600012">12<!--tex4ht:ref: contact --></a>). + </li> + <li + class="enumerate" id="x1-19004x2"><span +class="pplb7t-">Translation of documentation: </span>Since this document is currently only available in English it would be + helpful for not English speaking people to have a translated version. If you like to do an translation, + please also contact one of the authors for details (see chapter <a +href="#x1-3600012">12<!--tex4ht:ref: contact --></a>).</li></ol> + + +<!--l. 405--><p class="noindent" > +</p> +<h5 class="subsubsectionHead"><span class="titlemark">7.1.2 </span> <a + id="x1-200007.1.2"></a>Adding a new feature</h5> +<!--l. 406--><p class="noindent" >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 <a +href="http://sourceforge.net/tracker/?group%5C_id=222729" class="url" ><span +class="pcrr7t-">http://sourceforge.net/tracker/?group%5C_id=222729</span></a> 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 <a +href="#x1-3600012">12<!--tex4ht:ref: contact --></a>). +</p><!--l. 415--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">7.2 </span> <a + id="x1-210007.2"></a>Testing & bug reporting</h4> +<!--l. 416--><p class="noindent" >Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 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. +</p><!--l. 421--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">7.3 </span> <a + id="x1-220007.3"></a>Packaging</h4> +<!--l. 422--><p class="noindent" >Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 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: + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-22002x1">Package the plugin for your operating system or distribution. As you might can imagine, the authors + unfortunately cannot support all possible platforms. + </li> + <li + class="enumerate" id="x1-22004x2">Help to keep releases and packages of geany-plugins project up to date for current version of Geany.</li></ol> +<!--l. 433--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">7.4 </span> <a + id="x1-230007.4"></a>Improving and extending of documentation</h4> +<!--l. 434--><p class="noindent" >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. +</p><!--l. 438--><p class="noindent" >The documentation is written in <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 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. + + +</p><!--l. 442--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">7.5 </span> <a + id="x1-240007.5"></a>Propaganda</h4> +<!--l. 443--><p class="noindent" >And of course, tell others of Geany and this plugin. If you like to do a talk about Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> and/or +Geany in general, there is some code available on <a +href="http://git.geany.org/talks/" class="url" ><span +class="pcrr7t-">http://git.geany.org/talks/</span></a> 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’s<span class="footnote-mark"><a +href="geanylatex3.html#fn2x0"><sup class="textsuperscript">2</sup></a></span><a + id="x1-24001f2"></a> +development team so it can be added to archive. +</p><!--l. 453--><p class="noindent" > +</p> +<h3 class="sectionHead"><span class="titlemark">8 </span> <a + id="x1-250008"></a>Development</h3> +<!--l. 454--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">8.1 </span> <a + id="x1-260008.1"></a>Development version</h4> +<!--l. 455--><p class="noindent" >You can checkout the current source code from the Subversion repository at Sourceforge.net. Get the code +from: +</p><!--l. 458--><p class="noindent" >svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyla... +</p><!--l. 461--><p class="noindent" > +</p> +<h5 class="subsubsectionHead"><span class="titlemark">8.1.1 </span> <a + id="x1-270008.1.1"></a>Sending a patch</h5> +<!--l. 462--><p class="noindent" >If you want to create a patch, please respect the license of Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> as well as intellectual property of third. +Patches that should be included to the default distribution must be licensed under the same conditions as +Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> by the copyright owner. + + +</p><!--l. 467--><p class="noindent" > +</p> +<h3 class="sectionHead"><span class="titlemark">9 </span> <a + id="x1-280009"></a>Known issues</h3> +<!--l. 468--><p class="noindent" >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 <br +class="newline" /><a +href="http://sourceforge.net/tracker/?group%5C_id=222729" class="url" ><span +class="pcrr7t-">http://sourceforge.net/tracker/?group%5C_id=222729</span></a> +</p><!--l. 473--><p class="noindent" > +</p> +<h3 class="sectionHead"><span class="titlemark">10 </span> <a + id="x1-2900010"></a>Recommendations to improve work with <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> and Geany</h3> +<!--l. 474--><p class="noindent" >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 Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>. +</p><!--l. 478--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">10.1 </span> <a + id="x1-3000010.1"></a>Geany’s code snippet function</h4> +<!--l. 479--><p class="noindent" >Geany is allowing you to define code snippets and inserting them easy during writing a document. This gives you +some more flexibility than to create new commands. +</p><!--l. 483--><p class="noindent" >A possible snippet for snippets.conf could be: +</p> +<hr class="figure" /><div class="figure" +> + + + + +<!--l. 486--> +<div class="lstlisting" id="listing-5"><span class="label"><a + id="x1-30001r1"></a></span><span +class="pcrr7t-x-x-70">[</span><span +class="pcrr7t-x-x-70">LaTeX</span><span +class="pcrr7t-x-x-70">]</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-30002r2"></a></span><span +class="pcrr7t-x-x-70">frame</span><span +class="pcrr7t-x-x-70">=\</span><span +class="pcrr7t-x-x-70">begin</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">frame</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">ws</span><span +class="pcrr7t-x-x-70">%\</span><span +class="pcrr7t-x-x-70">frametitle</span><span +class="pcrr7t-x-x-70">{%</span><span +class="pcrr7t-x-x-70">cursor</span><span +class="pcrr7t-x-x-70">%}</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">ws</span><span +class="pcrr7t-x-x-70">%%</span><span +class="pcrr7t-x-x-70">cursor</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">\</span><span +class="pcrr7t-x-x-70">end</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">frame</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-30003r3"></a></span><span +class="pcrr7t-x-x-70">block</span><span +class="pcrr7t-x-x-70">=\</span><span +class="pcrr7t-x-x-70">begin</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">block</span><span +class="pcrr7t-x-x-70">}{%</span><span +class="pcrr7t-x-x-70">cursor</span><span +class="pcrr7t-x-x-70">%}</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">ws</span><span +class="pcrr7t-x-x-70">%%</span><span +class="pcrr7t-x-x-70">cursor</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">\</span><span +class="pcrr7t-x-x-70">end</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">block</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-30004r4"></a></span><span +class="pcrr7t-x-x-70">itemize</span><span +class="pcrr7t-x-x-70">=\</span><span +class="pcrr7t-x-x-70">begin</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">itemize</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">ws</span><span +class="pcrr7t-x-x-70">%\</span><span +class="pcrr7t-x-x-70">item</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">cursor</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">\</span><span +class="pcrr7t-x-x-70">end</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">itemize</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-30005r5"></a></span><span +class="pcrr7t-x-x-70">enumerate</span><span +class="pcrr7t-x-x-70">=\</span><span +class="pcrr7t-x-x-70">begin</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">enumerate</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">ws</span><span +class="pcrr7t-x-x-70">%\</span><span +class="pcrr7t-x-x-70">item</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">cursor</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">\</span><span +class="pcrr7t-x-x-70">end</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">enumerate</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70"> </span><br /><span class="label"><a + id="x1-30006r6"></a></span><span +class="pcrr7t-x-x-70">description</span><span +class="pcrr7t-x-x-70">=\</span><span +class="pcrr7t-x-x-70">begin</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">description</span><span +class="pcrr7t-x-x-70">}</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">ws</span><span +class="pcrr7t-x-x-70">%\</span><span +class="pcrr7t-x-x-70">item</span><span +class="pcrr7t-x-x-70"> </span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">cursor</span><span +class="pcrr7t-x-x-70">%</span><span +class="pcrr7t-x-x-70">n</span><span +class="pcrr7t-x-x-70">\</span><span +class="pcrr7t-x-x-70">end</span><span +class="pcrr7t-x-x-70">{</span><span +class="pcrr7t-x-x-70">description</span><span +class="pcrr7t-x-x-70">}</span> +</div> + + +</div><hr class="endfigure" /> +<!--l. 496--><p class="noindent" >A snapshot of authors’ last version for LaTeX can be found on <a +href="http://www.geany.org/Download/Extras" class="url" ><span +class="pcrr7t-">http://www.geany.org/Download/Extras</span></a> +</p> +<h4 class="subsectionHead"><span class="titlemark">10.2 </span> <a + id="x1-3100010.2"></a>Other useful plugins</h4> +<!--l. 500--><p class="noindent" >As mentioned before a number of useful functions were already implemented with 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 +<a +href="http//www.geany.org" class="url" ><span +class="pcrr7t-">http//www.geany.org</span></a>. +</p><!--l. 505--><p class="noindent" > +</p> +<h5 class="subsubsectionHead"><span class="titlemark">10.2.1 </span> <a + id="x1-3200010.2.1"></a>GeanyLipsum</h5> +<!--l. 506--><p class="noindent" >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.<br +class="newline" /><span +class="pplb7t-">Homepage: </span><a +href="http://frank.uvena.de/en/Geany/geanylipsum/" class="url" ><span +class="pcrr7t-">http://frank.uvena.de/en/Geany/geanylipsum/</span></a> +</p><!--l. 511--><p class="noindent" > +</p> +<h5 class="subsubsectionHead"><span class="titlemark">10.2.2 </span> <a + id="x1-3300010.2.2"></a>geanyVC</h5> +<!--l. 512--><p class="noindent" >When working on bigger documents an 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.<br +class="newline" /><span +class="pplb7t-">Homepage: </span><a +href="http://plugins.geany.org/geanyvc/" class="url" ><span +class="pcrr7t-">http://plugins.geany.org/geanyvc/</span></a> +</p><!--l. 518--><p class="noindent" > +</p> +<h5 class="subsubsectionHead"><span class="titlemark">10.2.3 </span> <a + id="x1-3400010.2.3"></a>tasks out of the addons plugins</h5> +<!--l. 519--><p class="noindent" >A plugin that is recognising <span +class="pcrr7t-">TODO </span>or <span +class="pcrr7t-">FIXME </span>tags inside a document and allows to easy jump to these entries. This +function is similar to the <span +class="pcrr7t-">todo </span>package but doesn’t require recompiling of the document. Recognised tags will be +inserted to another tab in Geany’s message widget.<br +class="newline" /> + + +</p><!--l. 525--><p class="noindent" > +</p> +<h3 class="sectionHead"><span class="titlemark">11 </span> <a + id="x1-3500011"></a>License</h3> +<!--l. 526--><p class="noindent" >Geany<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> 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><!--l. 535--><p class="noindent" > +</p> +<h3 class="sectionHead"><span class="titlemark">12 </span> <a + id="x1-3600012"></a>Bugs, questions, homepage</h3> +<!--l. 537--><p class="noindent" >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 +href="http://frank.uvena.de/en/Geany/geanylatex/" class="url" ><span +class="pcrr7t-">http://frank.uvena.de/en/Geany/geanylatex/</span></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> + +</body></html> + + + +
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
plugins-commits@lists.geany.org