Revision: 1985 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1985&view=re... Author: frlan Date: 2011-03-13 22:10:13 +0000 (Sun, 13 Mar 2011)

Log Message: ----------- GeanyLaTeX: Documentation: Make usage of listing caption feature and change font to LaTeX default for meanwhile

Modified Paths: -------------- trunk/geanylatex/doc/geanylatex.tex

Modified: trunk/geanylatex/doc/geanylatex.tex =================================================================== --- trunk/geanylatex/doc/geanylatex.tex 2011-03-13 22:09:48 UTC (rev 1984) +++ trunk/geanylatex/doc/geanylatex.tex 2011-03-13 22:10:13 UTC (rev 1985) @@ -16,7 +16,6 @@ \usepackage[utf8]{inputenc} \usepackage[english]{babel} \usepackage{float} -\usepackage{lmodern} \usepackage{graphicx} \usepackage{color} \usepackage{listings} @@ -62,7 +61,9 @@ \maketitle \tableofcontents \listoftables -\listoffigures +\listoffigures{} +\lstlistoflistings{} + \newpage \pagenumbering{arabic} \section{About the plugin} @@ -183,13 +184,11 @@ Compiling and installing the code is done by the following three commands:

-\begin{figure}[h!] -\begin{lstlisting} +\begin{lstlisting}[caption={Compiling with waf}] $ ./waf configure $ ./waf build $ ./waf install %$ \end{lstlisting} -\end{figure}

For more configuration details, run \texttt{./waf --help}

@@ -213,12 +212,11 @@ might like to use \texttt{htlatex}. The HTML version of this documentation shipped with source tarball has been compiled with

-\begin{figure}[h!] -\begin{lstlisting} +\begin{lstlisting}[caption={Compiling of documentation}] htlatex geanylatex.tex xhtml -cvalidate -interaction=batchmode \end{lstlisting} -\end{figure}

+ \section{Usage} \begin{figure}[h!] \centering{\includegraphics[height=7cm]{img/plugin_manager.png}} @@ -405,8 +403,7 @@ no be moved during the process. As an example for a book, this will be inserted to the document:

-\begin{figure}[h!] -\begin{lstlisting} +\begin{lstlisting}[caption={Example of BibTeX entry for a book}] @Book{ Author = {}, Editor = {}, @@ -415,8 +412,8 @@ Year = {}, } \end{lstlisting} -\end{figure}

+ \subsubsection{Inserting cite-reference}

Geany\LaTeX{} is searching here for *.bib-files inside the directory @@ -464,23 +461,21 @@ current position of cursor. If there is a selection activ, the selection will be included into environment.

-\begin{figure}[h!] \begin{lstlisting} \begin{your_environment} ... selected text ... \end{your_environment} \end{lstlisting} -\end{figure}

In case of an empty (= no selection) an empty environment with -\begin{figure}[h!] + \begin{lstlisting} \begin{your_environment} ... \end{your_environment} \end{lstlisting} -\end{figure}

+ will be inserted to the document.

\begin{figure}[h!] @@ -684,7 +679,9 @@ \texttt{glatex_deactivate_toolbaritems_with_non_latex=false}. As a result, your config file could look similar to this:

-\begin{lstlisting} +\begin{lstlisting}[caption={Configuration to enable toolbar buttons if % + no \LaTeX{} is active}] + [general] glatex_set_koma_active=false glatex_set_toolbar_active=true @@ -706,7 +703,7 @@ two documents it can be set to keep even there is no LaTeX document activ.

-\begin{lstlisting} +\begin{lstlisting}[caption={Configuration to keep \LaTeX{} menu inside menubar}] [general] glatex_set_koma_active=false glatex_set_toolbar_active=true @@ -727,7 +724,7 @@ time you might set \texttt{glatex_add_menu_on_startup} inside menu section of configuration file to true.

-\begin{lstlisting} +\begin{lstlisting}[caption={Configuration add \LaTeX{} menu on startup of Geany}] [general] glatex_set_koma_active=false glatex_set_toolbar_active=true @@ -752,8 +749,7 @@ \texttt{glatex_set_autocompletion_contextsize} followed by an integer value. An example could look like this:

-\begin{figure}[h!] -\begin{lstlisting} +\begin{lstlisting}[caption={Example configuration for contextsize of autocompletion}] [general] glatex_set_koma_active=true glatex_set_toolbar_active=false @@ -762,14 +758,12 @@ [autocompletion] glatex_set_autocompletion_contextsize=2 \end{lstlisting} -\caption{general.conf example for contextsize} -\end{figure}

\subsubsection{Apply autocompletion only to \TeX{}-like files} With this option, you can force Geany\LaTeX{} 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.

-\begin{figure}[h!] -\begin{lstlisting} +\begin{lstlisting}[caption={general.conf example for deactivating file % + type specific restrictions for autocompletion}] [general] glatex_set_koma_active=true glatex_set_toolbar_active=false @@ -778,8 +772,6 @@ [autocompletion] glatex_autocompletion_only_for_latex=false \end{lstlisting} -\caption{general.conf example for deactivating file type specific restrictions for autocompletion} -\end{figure}

\subsubsection{Customized reference strings}

@@ -790,7 +782,7 @@ \texttt{glatex_reference_all} inside configuration file as shown inside the example configuration snippet.

-\begin{lstlisting} +\begin{lstlisting}[caption={Configuration example for customized reference strings}] [general] glatex_set_koma_active=true glatex_set_toolbar_active=true @@ -820,7 +812,8 @@ inside \texttt{[autocompletion]} section of configuration file. An example which is turning off the feature might can look like this:

-\begin{lstlisting} +\begin{lstlisting}[caption={Configuration example for autocompletion of % + {} after _ and \symbol{94}}] [general] glatex_set_koma_active=true glatex_set_toolbar_active=true @@ -997,8 +990,7 @@

A possible snippet for snippets.conf could be:

-\begin{figure}[h!] -\begin{lstlisting} +\begin{lstlisting}[caption={Minimal snippets.conf for \LaTeX{}}] [LaTeX] frame=\begin{frame}\n%ws%\frametitle{%cursor%}\n%ws%%cursor%\n\end{frame} block=\begin{block}{%cursor%}\n%ws%%cursor%\n\end{block} @@ -1006,7 +998,6 @@ enumerate=\begin{enumerate}\n%ws%\item %cursor%\n\end{enumerate} description=\begin{description}\n%ws%\item %cursor%\n\end{description} \end{lstlisting} -\end{figure}

A snapshot of the authors' last version for LaTeX can be found on \url{http://www.geany.org/Download/Extras%7D

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.