/usr/share/doc/winefish/winefish.html

<HTML>
<!--
$Id: winefish.txt 2267 2006-03-27 23:30:41Z kyanh $
Winefish Documentation
Format: KTML
Convert: k2h winefish.txt > winefish.html
<br><br>
This is a generated file. !! DO NOT EDIT !!
-->
<HEAD>
<TITLE>Winefish Documentation</TITLE>
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
<META name="Keywords" content="tex,latex,vietnam,winefish,editor,kyanh">
<META name="Copyright" content="Copyright (c) 2005-2006 kyanh">
<STYLE>
<!--
body { margin: 30px; font-size: 13px; margin-right: 100px; }
b { font-weight: normal; color: navy; font-family: monospace; }
pre {color: olive; border-left: 2px solid navy; padding-left: 10px; }
a, a:visited, a:hover { text-decoration: none; }
a:hover { color: yellow; background-color: black; }
a:visited { color: green; }
-->
</STYLE>
</HEAD>
<BODY>
<H1><a href="http://winefish.berlios.de/">Winefish 1.3.2 Documentation</a></H1>

<UL>
<li>Author: kyanh <<a href="kyanh_at_viettug_dot_org">kyanh_at_viettug_dot_org</a>>
<li><font color="RED">If you had been using an older version of Winefish,
you should read <a href="#NEWS">NEWS</a> and <a href="#IMPORTANT NOTES">IMPORTANT NOTES</a></font>
<li>For further help, visit <a href="http://winefish.berlios.de/forum/">http://winefish.berlios.de/forum/</a>
<li>I'm sorry about my English :))
If you find any (spell) mistakes in this document feel free to let me know!</UL>

<H2><a name="CONTENTS">CONTENTS</a> <a href="#top">top</a></H2>

<UL>
<li><a href="#THANKS">THANKS</a>
<li><a href="#NEWS">NEWS</a>
<li><a href="#FEATURES">Features</a>
<li><a href="#INSTALLATION">Installation</a>
<li><a href="#IMPORTANT NOTES">Important Notes</a>
<li><a href="#INPUT METHOD">Input Method</a>
<li>Hotkeys: <a href="#HOTKEYS: EDITING">editing</a>
<li>Hotkeys: <a href="#HOTKEYS: COMPILING">compiling</a>
<li><a href="#PROJECT MODE">Project Mode</a>
<li><a href="#DOCUMENT STRUCTURE">Document Structure</a>
<li><a href="#AUTOTEXT">Autotext</a>
<li><a href="#AUTO_COMPLETION">AutoCompletion</a>
<li><a href="#COMMANDLINE OPTIONS">Commandline Options</a>
<li><a href="#OUTPUTBOX">Outputbox</a>
<li><a href="#TEMPLATES SUPPORT">Templates Support</a>
<li><a href="#BRACE FINDER">Brace Finder</a>
<li><a href="#TIPS">TIPS</a>
<li><a href="#LOCALE SUPPORT">Locale Support</a>
<li><a href="#COLUMN MARKER">Column Marker</a>
<li><a href="#ABOUT">About</a></UL>

<H2><a name="THANKS">THANKS</a> <a href="#top">top</a></H2>

Special THANKS to <a href="michele.garoche/at/easyconnect/dot/fr">Michèle Garoche</a>
for correcting some typo errors in previous version of this document.
<H2><a name="FEATURES">FEATURES</a> <a href="#top">top</a></H2>

<UL>
<li><a href="#AUTOTEXT">autotext</a>
<li><a href="#AUTO_COMPLETION">autocompletion</a>
<li><a href="#AUTO_COMPLETION">command collector</a>
<li>multiple encoding
<li>configurable external tools
<li>configurable highlight support
<li><a href="#TEMPLATES SUPPORT">templates support</a>
<li><a href="#BRACE FINDER">brace finder</a></UL>

<H2><a name="INSTALLATION">INSTALLATION</a> <a href="#top">top</a></H2>

Read INSTALL
<H2><a name="INPUT METHOD">INPUT METHOD</a> <a href="#top">top</a></H2>

Input Method is not a function of Winefish.
<br><br>
Right click on the document. In the context menu,
goto <B>Input Methods</B> and choose your favorite
input method. These various methods are selected from your
system, not provided by Winefish.
<H2><a name="NEWS">NEWS</a> <a href="#top">top</a></H2>

Some new features:
<UL>
<li>delete directly any command from PopUp menu. See <a href="#AUTO_COMPLETION">AUTO_COMPLETION</a>
<li>outputbox with two useful operations:
<B>single-click</B> and <B>control + single-click</B>. See <a href="#OUTPUTBOX">OUTPUTBOX</a>
<li>manage your templates easily with Grep Function. See <a href="#TEMPLATES SUPPORT">TEMPLATES SUPPORT</a>
<li>TeX filter for spell checker
<li><a href="#BRACE FINDER">Brace Finder</a>
<li><a href="#COLUMN MARKER">Column Marker</a>
<li>new syntax hilighting</UL>

any many more. See <B>NEWS</B> and <B>CHANGES</B> for details.
<H2><a name="IMPORTANT NOTES">IMPORTANT NOTES</a> <a href="#top">top</a></H2>

Winefish now uses <B>$HOME/.winefish/rcfile</B> to save configuration.
Move the old one <B>$HOME/.winefish/rcfile_v2</B> to <B>$HOME/.winefish/rcfile</B>
manually, then reconfigure Winefish (use <B>Preferences Pages</B>.)
Please take care of following properties:
<UL>
<li>Editor / Highlighting Syntax by Default
<li>Files / Create Backup On Save
<li>Users Interface / *
<li>TeXbox / Save, Show
<li>Miscellaneous / Templates Directory</UL>

If you do not move <B>$HOME/.winefish/rcfile_v2</B> to <B>$HOME/.winefish/rcfile</B>,
winefish will start with default settings and of course ignore your old ones.
<br><br>
There is also new color scheme for hilighting. Backup then remove your
<B>$HOME/.winefish/highlighting</B> to enjoy the new one.
<H2><a name="HOTKEYS: EDITING">HOTKEYS: EDITING</a> <a href="#top">top</a></H2>

<UL>
<li>Start "autocompletion": <B>control + Space</B>
<li>Start "autotext": <B>shift + Space</B>
<li>Update syntax highlighting: <B>meta + Space</B>
<li>Go to a line: <B>control + /</B>
<li>Start a numbered section: <B>control + {0,1,2,3,4,5,6}</B>
<li>Start an unnumbered section: <B>control + meta + {0,1,2,3,4}</B>
<li>Insert an image: <B>control + I</B>
<li>Insert a table or array: <B>control + T</B>
<li>Insert a list: <B>control + L</B>
<li>Insert `verbatim': <B>shift + control + V</B>, <B>shift + control + meta + V</B>
<li>(Un)comment selected text: <B>control + %</B>, <B>control + meta + %</B>
<li>Increase/Decrease Indent: <B>control + ,</B> / <B>control + .</B>
<li>Insert source separator: <B>control + =</B>
<li>Delete the first char of each line in the selected text: <B>control + <</B>
<li>Delete current line: <B>control + K</B>
<li>Templates manager: <B>control + meta + shift + F</B>
<li>Advanced Find in Files: <B>control + meta + F</B>
<li>Brace Finder: <B>control + ]</B>, <B>control + [</B></UL>

<H2><a name="HOTKEYS: COMPILING">HOTKEYS: COMPILING</a> <a href="#top">top</a></H2>

By default, Winefish requires LaTeX, xdvi and xpdf.
You may change these from <B>Preferences Page</B>.
<UL>
<li>Convert to DVI format: <B>F1</B>
<li>View DVI document (with DVI SYNC): <B>control + F1</B>
<li>Convert to PDF: <B>F2</B>
<li>View PDF document: <B>control + F2</B>
<li>Stop running tools: <B>Escape</B></UL>

If you are working in project mode, by default, the above tools
will start in the base directory and file of the project.
<br><br>
If you want to compile the current document, <B>NOT</B> the
base document of the project, you may use <B>control + ESC</B>
to turn project mode ON/OFF, *OR* select menu <B>External/Project Mode</B>
<H2><a name="PROJECT MODE">PROJECT MODE</a> <a href="#top">top</a></H2>

<UL>
<li>Each project requires a <U><font color="GREEN">base directory</font></U> and a <U><font color="GREEN">base file</font></U>
<li>The "base file" <font color="RED">must be located</font> in "base directory"
<li>Project's files should be located in "base directory"</UL>

<H2><a name="DOCUMENT STRUCTURE">DOCUMENT STRUCTURE</a> <a href="#top">top</a></H2>

In order to get the document structure, you may try this:
<UL>
<li>Press <B>control + F</B> to start the search engine
<li>Type <B>exactly</B> the following string:
<PRE>^\\(sub){0,2}section.*?$</PRE>
<li>Select PERL type as type (regular expression)
<li>Select Bookmark Results
<li>Press OK.</UL>

<H2><a name="AUTOTEXT">AUTOTEXT</a> <a href="#top">top</a></H2>

If <B>$HOME/.winefish/autotext</B> has not been modified,
you may try to open a new document, type the string
<B>/tsta</B> then press <B>shift + Space</B>. Other tests are <B>/tstd</B>,
<B>/tstc</B> and <B>/tstd</B>.
<br><br>
You may modify the file <B>$HOME/.winefish/autotext</B>.
<font color="RED">You should not try to modify it directly, as Winefish will override it when existing.
But you could modify it from the <B>Preferences Page, Automation panel</B>.
As long as you click on Apply after editing it, the changes will survive exiting.</font>
The contents are similar to
<PRE>att: /tsta:\\begin{foo\n:\n\\end{foo:
att: /tstb:\\begin{this-is-b\n:\n\\end{this-is-b:
att: /tstc:\\testofsomething::
att: /tstd:: Can you see?:</PRE>
Each line is of the form: <PRE>att: /foo:begin:end:</PRE>
where <B>/foo</B> is the new definition which <B>must be started</B> by a slash <B>/</B>.
The string begin will be inserted before the cursor,
the string end will be inserted after the cursor.
<br><br>
Here are some rules:
<UL>
<li>Length of /foo should be at most AUTOTEXT_MAX_LENGTH
(defined in <B>src/config_spec.h</B>)
<li>one of the two strings `begin' and `end' should not be NULL.
<li>If foo is defined twice or more, for e.g.,
<li>only the first one is used.
<li><font color="RED"><U>some special characters must be escaped:</U></font>
<UL>
<li><B>\n</B> for the new line
<li><B>\t</B> for a tab
<li><B>\:</B> for a colon
<li><B>\\</B> for the backslash</UL>
</UL>

<H2><a name="AUTO_COMPLETION">AUTO_COMPLETION</a> <a href="#top">top</a></H2>

Press <B>control + Space</B> to start autocompletion.
You may delete a word from popup menu press <B>Delete</B>,
or from <B>Preferences</B> page.
<br><br>
The words are saved in <B>$HOME/.winefish/words</B>.
<font color="RED">You should not try to modify it directly, as Winefish will override it when existing.
But you could modify it from the <B>Preferences Page, Automation panel</B>.
As long as you click on Apply after editing it, the changes will survive exiting.</font>
<br><br>
When you're typing, Winefish collects LaTeX commands and add them to
list of known words. If there's a bad command, you may `<B>delete</B>'
it directly from PopUp menu.
<br><br>
A command will be added to completion list if its length is:
<UL>
<li>greater than 2
<li>less than or equal COMMAND_MAX_LENGTH (defined in <B>src/config_spec.h</B>)</UL>

You may add commands by using <B>Preferences Pages / AutoX</B> but this is <U>not recommended</U>
as Winefish collects commands automatically and <B>Preferences Pages / AutoX</B> will be
dropped some day.)
<H2><a name="COMMANDLINE OPTIONS">COMMANDLINE OPTIONS</a> <a href="#top">top</a></H2>

<PRE>$ winefish -h
winefish 1.3.2.6 LaTeX editor
Usage: winefish <B>options</B> <B>filenames ...</B>
Currently accepted options are:
-s skip root check
-v current version
-n 0|1 open new window (1) or not (0)
-p filename open project
-l <B>number</B> set line <B>number</B>. Negative value takes no effect.
-h this help screen</PRE>
<H2><a name="OUTPUTBOX">OUTPUTBOX</a> <a href="#top">top</a></H2>

When you start a tool, start `Grep Function' (<B>control + meta + F</B>),
or start listing your templates (<B>control + meta + shift + F</B>),
the results are shipped out to a Outputbox.
<br><br>
There are some useful operations with Outputbox:
<UL>
<li><font color="GREEN">single-click:</font> open file at specified line
<li><font color="GREEN">right-click:</font> create a popup menu
<li><font color="GREEN">control + click:</font> clone file (create a new file with the same contents)</UL>

You may press <B>shift + Escape</B> to hide/show the Outputbox.
<H2><a name="TEMPLATES SUPPORT">TEMPLATES SUPPORT</a> <a href="#top">top</a></H2>

Go to <B>Preferences Pages / Miscellaneous</B> and specify the directory
which contains your templates. By default, it is <B>$HOME/tex/templates</B>.
<br><br>
The template file is of type <B>*.tex</B> or <B>*.sty</B>.
Each template *MUST* contain the pattern <B>%%wf=</B>.
This helps you writing description for templates. For e.g.,
<PRE>%%wf=this is a template file
%%wf=this is the template's description
\documentclass{article}
...</PRE>
To <U>list all your template files</U>, press <B>control + meta + shift + F</B>.
You may also use the menu <B>Edit/Find, Replace/Templates</B>.
Then press <B>control + click</B> to create a clone file (See <a href="#OUTPUTBOX">OUTPUTBOX</a>)
<br><br>
Winefish does not clean up the <B>%%wf=</B> string automatically.
<H2><a name="BRACE FINDER">BRACE FINDER</a> <a href="#top">top</a></H2>

If your editor cursor is placed beside a <font color="GREEN">brace</font>
( <B><font color="RED">$</font></B>, <B><font color="RED">(</font></B>, <B><font color="RED">)</font></B>, <B><font color="RED">{</font></B>, <B><font color="RED">}</font></B>, <B><font color="RED">[</font></B>, <B><font color="RED">]</font></B> ),
you may want to find the matching one. Just press
<B>control + ]</B> (forward) or <B>control + [</B> (backward). Here are the rules:
<UL>
<li>escaped characters will be ignored
<li>characters in comment line will be ignored
<li>for $, <B>control + ]</B> starts <I>forward</I>-finding the matched $.
<li>for $, <B>control + [</B> starts <I>backward</I>-finding the matched $.
<li>for other braces:
<UL>
<li><I>forward</I>: starts finding the matching for current brace.
<li><I>backward</I>:
<UL>
<li>if the characters on the left hand is a brace too,
start finding the matching for it;
<li>otherwise, treat as <I>forward</I>.</UL>
</UL>

<li>for other characters:
<UL>
<li><I>forward</I>: start finding }
<li><I>backward</I>: start finding the {</UL>
</UL>

The brace finder also <font color="GREEN"><U>starts its job automatically</U></font> when you're editing:
the matched braces will be highlighted. For performance reason, the finder
will search in a limited area. The maximum number of lines of this area
is defined via BRACE_FINDER_MAX_LINES (<B>src/config_spec.h</B>).
<br><br>
<font color="RED"><U>NOTE:</U></font> when a key is pressed and is not released yet, the color of
matching braces is dropped. This causes <font color="GREEN">FLASH</font> effect.
This is an unwanted-effect which takes place naturally after fixing the BUG#87.
I (kyanh) found this is quite nice stuff. Please give comment
via forum (<a href="http://winefish.berlios.de/forum/">http://winefish.berlios.de/forum/</a>).
<H2><a name="LOCALE SUPPORT">LOCALE SUPPORT</a> <a href="#top">top</a></H2>

There are English, French, Italian and Vietnamese translations. For e.g.,
<PRE>$ LANG=vi_VN winefish # start winefish with Vietnamese frontend
$ LANG=it_IT winefish # for Italian users
$ LANG=fr_FR winefish # for French users</PRE>
<H2><a name="TIPS">TIPS</a> <a href="#top">top</a></H2>

<UL>
<li>Press <B>shift + control + Escape</B> to hide/show the Sidebar.
<li>Press <B>shift + Escape</B> to hide/show the Outputbox.
<li>Press <B>control + I</B> to insert an image.
<li><B>Doubleclick</B> on an image in the file browser.
<li>Long line should be split into shorter ones.
<font color="GRAY">(I have a file with a very long line.
I tried to open it in Emacs, KDE applications, Bluefish and Winefish. Only the *fishes
make me annoyed! The cursor moved very very slowly when it was inside that line.
(I do not know whether this problem occurs with other GTK applicatons))</font>
<li>To open a file in existing running Winefish at specific line, try for e.g.
<PRE>winefish -n0 -l 12 foobar.tex blablabla.tex</PRE>
If you specify multiple files, all are opened at the same line numbered <num> :)

<li>What does Winefish mean?
<UL>
<li>Winefish = Wine + fish = to be drunk (Oops, I can't drink)
<li>Winefish = White fish (white not blue)
<li>Winefish = Why fish? See <a href="#ABOUT">About</a></UL>
</UL>

<H2><a name="COLUMN MARKER">COLUMN MARKER</a> <a href="#top">top</a></H2>

Column marker is a vertical line which is positioned at a specific line number.
This marker helps you find easily the document's blocks. The feature is inspired
from <a href="http://www.editplus.com/">EditPlus</a> but it seems to make people annoyed.
So the feature is disabled by default. You can turn it on via the option 
<B>--enable-column-marker</B> when running <B>configure</B> script.
<br><br>
There are 3 markers what you can specify from <B>Preferences Page / Miscellaneous</B>.
The zero value is equivalent to <B>disabled</B>.
<H2><a name="ABOUT">ABOUT</a> <a href="#top">top</a></H2>

<font color="GRAY">I am a vietnamese who loves maths, music and of course winefish ;)
<br><br>
Please write my name with lowercase characters -- <B>kyanh</B> -- as it is
my *nix* name... and it's very hard to write the vietnamese one ;(</font>
<br><br>
<BR>
<HR>
This HTML file was generated from <font color="RED">winefish.txt</font> by <font color="RED">k2h</font> program.<br>
<font color="RED">$Id: winefish.txt 2267 2006-03-27 23:30:41Z kyanh $</font>
<HR>
</BODY>
</HEAD>
winefish 1.3.3-0dl1ubuntu1 / usr / share / doc / winefish / winefish.html
