Winefish Documentation

CONTENTS top

FEATURES top

INSTALLATION top

Read INSTALL

INPUT METHOD top

Input Method is not a function of Winefish.

Right click on the document. In the context menu, goto Input Methods and choose your favorite input method. These various methods are selected from your system, not provided by Winefish.

NEWS top

Some new features:

IMPORTANT NOTES top

Winefish now uses $HOME/.winefish/rcfile to save configuration. Move the old one $HOME/.winefish/rcfile_v2 to $HOME/.winefish/rcfile manually then reconfigure Winefish (use Preferences Pages.) Please take care of following properties: If you donot move $HOME/.winefish/rcfile_v2 to $HOME/.winefish/rcfile, winefish will start with default set and of course ignore your old one.

HOTKEYS: EDITING top

HOTKEYS: COMPILING top

By default, Winefish requires LaTeX, xdvi and xpdf. You may changes these from Preferences Page. If you are working in project mode, by default, the above tools will start in the base directory and file of the project.

If you want to compile the current document, NOT the base document of project, you may use control + ESC to turn project mode ON/OFF, *OR* select menu External/Project Mode

PROJECT MODE top

DOCUMENT STRUCTURE top

In order to get the document structure, you may try this:

AUTOTEXT top

If $HOME/.winefish/autotext wasnot modified, you may try to open a new document, type the string /tsta then press shift + Space. Other tests are /tstd, /tstc and /tstd.

You may modify the file $HOME/.winefish/autotext Do not open it in Winefish as Winefish will override your modification when exiting. The contents are similar to
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?:
Each line is of the from
att: /foo:begin:end:
where /foo is the new defintion which must be started by a slash /. The string begin will be inserted before the cursor, the string end will be inserted after the cursor.

Here are some rules:

AUTO_COMPLETION top

Press control + Space to start autocompletion. You may delete a word from popup menu press Delete, or from Preferences page.

The words are saved in $HOME/.winefish/words. Do not open the file in Winefish as the contents will be overridden when Winefish exists.

When you're typing, Winefish collects LaTeX commands and add them to list of known words. If there's a bad command, you may `delete' it directly from PopUp menu.

A command will be added to completion list if its length is: The later constant is defined in src/config_spec.h

COMMANDLINE OPTIONS top

$ winefish -h
winefish 1.3.2.6 LaTeX editor
Usage: winefish options filenames ...
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 number set linenumber. Negative value takes no effect.
-h this help screen

OUTPUTBOX top

When you start a tool, start `Grep Function' (control + meta + F), or start listing your templates (control + meta + shift + F), the results will be shipped out to a Outputbox.

There are some usefull operations with Outputbox:

TEMPLATES SUPPORT top

Go to Preferences Pages / Miscellaneous and specify the directory which contains your templates. By default, it is $HOME/tex/templates.

The template file is of type *.tex or *.sty. Each template *MUST* contains the patterns %%wf=. This helps you writing description for templates. For e.g.,
%%wf=this is template file
%%wf=this is the description of template
\documentclass{article}
...
To list all your template files, press control + meta + shift + F. Then press control + click to create a clone file (See OUTPUTBOX)

Winefish doesnot clean up the %%wf= string automatically.

BRACE FINDER top

If your editor cursor is placed beside a brace ( $, (, ), {, }, [, ] ), you may want to find the matching one. Just press control + ] (forward) or control + [ (backward). Below the rules: The brace finder also starts it jobs automatically when you're editing: the matched braces will be hilighted. For performance reason, the finder will search in a limited area. The maxium number of lines of this area is defined via BRACE_FINDER_MAX_LINES (src/config_spec.h).

TIPS top

LOCALE SUPPORT top

There are English, French, Italian and Vietnamese. Here're examples:
$ LANG=vi_VN winefish # start winefish with Vietnamese frontend
$ LANG=it_IT winefish # for Italian users
$ LANG=fr_FR winefish # for French users

This HTML file was generated from winefish.txt by k2h program.
$Id: winefish.html 1809 2006-02-10 14:42:55Z kyanh $