Special THANKS to Michèle Garoche
for correcting some typo errors in previous version of this document.
Read INSTALL
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.
Some new features:
any many more. See NEWS and CHANGES for details.
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:
- Editor / Highlighting Syntax by Default
- Files / Create Backup On Save
- Users Interface / *
- TeXbox / Save, Show
- Miscellaneous / Templates Directory
If you do not move $HOME/.winefish/rcfile_v2 to $HOME/.winefish/rcfile,
winefish will start with default settings and of course ignore your old ones.
There is also new color scheme for hilighting. Backup then remove your
$HOME/.winefish/highlighting to enjoy the new one.
- Start "autocompletion": control + Space
- Start "autotext": shift + Space
- Update syntax highlighting: meta + Space
- Go to a line: control + /
- Start a numbered section: control + {0,1,2,3,4,5,6}
- Start an unnumbered section: control + meta + {0,1,2,3,4}
- Insert an image: control + I
- Insert a table or array: control + T
- Insert a list: control + L
- Insert `verbatim': shift + control + V, shift + control + meta + V
- (Un)comment selected text: control + %, control + meta + %
- Increase/Decrease Indent: control + , / control + .
- Insert source separator: control + =
- Delete the first char of each line in the selected text: control + <
- Delete current line: control + K
- Templates manager: control + meta + shift + F
- Advanced Find in Files: control + meta + F
- Brace Finder: control + ], control + [
By default, Winefish requires LaTeX, xdvi and xpdf.
You may change these from Preferences Page.
- Convert to DVI format: F1
- View DVI document (with DVI SYNC): control + F1
- Convert to PDF: F2
- View PDF document: control + F2
- Stop running tools: Escape
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 the project, you may use control + ESC
to turn project mode ON/OFF, *OR* select menu External/Project Mode
- Each project requires a base directory and a base file
- The "base file" must be located in "base directory"
- Project's files should be located in "base directory"
In order to get the document structure, you may try this:
- Press control + F to start the search engine
- Type exactly the following string:
^\\(sub){0,2}section.*?$
- Select PERL type as type (regular expression)
- Select Bookmark Results
- Press OK.
If $HOME/.winefish/autotext has not been 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.
You should not try to modify it directly, as Winefish will override it when existing.
But you could modify it from the Preferences Page, Automation panel.
As long as you click on Apply after editing it, the changes will survive 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 form: att: /foo:begin:end:
where /foo is the new definition 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:
- Length of /foo should be at most AUTOTEXT_MAX_LENGTH
(defined in src/config_spec.h)
- one of the two strings `begin' and `end' should not be NULL.
- If foo is defined twice or more, for e.g.,
- only the first one is used.
- some special characters must be escaped:
- \n for the new line
- \t for a tab
- \: for a colon
- \\ for the backslash
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.
You should not try to modify it directly, as Winefish will override it when existing.
But you could modify it from the Preferences Page, Automation panel.
As long as you click on Apply after editing it, the changes will survive exiting.
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:
- greater than 2
- less than or equal COMMAND_MAX_LENGTH (defined in src/config_spec.h)
You may add commands by using Preferences Pages / AutoX but this is not recommended
as Winefish collects commands automatically and Preferences Pages / AutoX will be
dropped some day.)
$ 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 line number. Negative value takes no effect.
-h this help screen
When you start a tool, start `Grep Function' (control + meta + F),
or start listing your templates (control + meta + shift + F),
the results are shipped out to a Outputbox.
There are some useful operations with Outputbox:
- single-click: open file at specified line
- right-click: create a popup menu
- control + click: clone file (create a new file with the same contents)
You may press shift + Escape to hide/show the Outputbox.
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* contain the pattern %%wf=.
This helps you writing description for templates. For e.g.,
%%wf=this is a template file
%%wf=this is the template's description
\documentclass{article}
...
To list all your template files, press control + meta + shift + F.
You may also use the menu Edit/Find, Replace/Templates.
Then press control + click to create a clone file (See OUTPUTBOX)
Winefish does not clean up the %%wf= string automatically.
If your editor cursor is placed beside a brace
( $, (, ), {, }, [, ] ),
you may want to find the matching one. Just press
control + ] (forward) or control + [ (backward). Here are the rules:
- escaped characters will be ignored
- characters in comment line will be ignored
- for $, control + ] starts forward-finding the matched $.
- for $, control + [ starts backward-finding the matched $.
- for other braces:
- forward: starts finding the matching for current brace.
- backward:
- if the characters on the left hand is a brace too,
start finding the matching for it;
- otherwise, treat as forward.
- for other characters:
- forward: start finding }
- backward: start finding the {
The brace finder also starts its job automatically 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 (src/config_spec.h).
NOTE: when a key is pressed and is not released yet, the color of
matching braces is dropped. This causes FLASH 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 (http://winefish.berlios.de/forum/).
There are English, French, Italian and Vietnamese translations. For e.g.,
$ LANG=vi_VN winefish # start winefish with Vietnamese frontend
$ LANG=it_IT winefish # for Italian users
$ LANG=fr_FR winefish # for French users
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 EditPlus but it seems to make people annoyed.
So the feature is disabled by default. You can turn it on via the option
--enable-column-marker when running configure script.
There are 3 markers what you can specify from Preferences Page / Miscellaneous.
The zero value is equivalent to disabled.
I am a vietnamese who loves maths, music and of course winefish ;)
Please write my name with lowercase characters -- kyanh -- as it is
my *nix* name... and it's very hard to write the vietnamese one ;(
This HTML file was generated from winefish.txt by k2h program.
$Id: winefish.txt 2267 2006-03-27 23:30:41Z kyanh $