		      Wiki Tools
		------------------------
		(c) 2009, Pauli Lindgren


 Installing
 ----------

1. Unzip all files into your Vedit USER-MAC directory.

2. Load or create a wiki file. Use some specific filename extension, for example .wik

3. Run the macro wiki_tools_setup.vdm. It loads the User and Tools menus and keyboard
configuration and sets some settings for wiki editing.

Now you are ready to use Wiki Tools.

In order to automatically load syntax highlighting and configuration settings whenever you
open a .wik file, save file specific configuration: While a .wik file is open, select
Config -> File open config -> Save filename extension config.

It is recommended to create a project for your wiki editing.
After you have run wiki_tools_setup.vdm, select
File -> Projects -> Save (new) project as...

Next time you open the project, all the settings, menus and keyboard configuration are
automatically loaded, as well as any files you had open last time you were working with
that project. Thus, you do not need to run wiki_tools_setup.vdm again.


 Editing Wiki pages with Vedit
 -----------------------------

When you are editing a wiki page with browser, you can copy-paste the text from the
browser text input area into Vedit for editing, and when you are finished editing,
copy it back to the browser.

However, note that if the page uses UTF-8 character set, copying the text to Vedit
causes the text to be converted into 8-bit ANSI character set. If the text contains
any characters not supported by ANSI character set, those characters are lost.

In order to avoid the loss of non-ANSI characters, Firefox plugin "It's all text!"
can be used (see below). The plugin copies text into Vedit with single click. When
you save the changes in Vedit, the text is automatically copied back to browser.
"It's all text!" can copy the text without doing character set conversion, so you
will not lose any data.


 Configuring IT'S ALL TEXT to work with Vedit
 --------------------------------------------

After you have installed the It's All Text! plugin, you need to configure it for Vedit.

The following instructions assume that
 - your Vedit home directory is c:\vedit
 - the wiki you are editing uses UTF-8 character set
 - you use extension .wik for wiki pages


1. Create a file vedit_wiki.bat in your Vedit home directory. Insert the following single line in the file:
	c:\vedit\vpw -x Wiki_tools_setup.vdm %1

2. Open any web form that contains an input field.

3. Right-click on the input field. On the Context menu, select "It's All Text!" -> "Preferences".

4. In the Preferences dialog, enter the following settings:
	Editor:            c:\vedit\vedit_wiki.bat
	Character set:     UTF-8
	File extensions:   .wik, .htm, ...


To edit a textarea field of a web form with Vedit, right click on the field and then select
"It's All Text!" -> "Edit as '.wik'".
Vedit will now open, configure itself for wiki editing, and load the text (as a tmp file).
When you save the file from Vedit, it will be copied back to browser.
Next time, you can just click the blue Edit button on the lower right corner of the field
in browser (It's All Text! will by default use the same file extension as last time).

If you want to open the wiki text in an already open instance of Vedit,
use a .bat file that contains the following line:
	c:\vedit\vpw -s %1
Note however that there is some delay when opening a file in an existing instance of Vedit.

