bundles up WikiWyg
wiki editor, and adds it to the options that you can use for Wysiwyg editing using the WysiwygPlugin
. If you are using
skin (or any other skin thst uses
), then when you set the
, the WYSIWYG edit button will use wikiwyg. Right now, it works only with FireFox
, but I'm looking into getting it working in InternetExplorer
This is a work in progress, using Wikiwyg version 0.12 , and it is not advisable to be used on topics that contain inline html.
is designed for editing TWiki topics, not as a general purpose HTML editor. It will work fine on topics that contain text, TML formatting, and most HTML. However, because of the complexity of transforming TML into HTML and back, complex TML, and mixing HTML and TML may not give the results you expect. You are recommended to use the standard browser textarea editor for editing existing topics that contain mixed HTML and TML, or complex %TML%-type variables.
Settings are stored as preferences variables. To reference a setting write
- One line description:
- Set SHORTDESCRIPTION = Add Wikiwyg editor to Wysiwyg
- Name of the perl package
- Set STUB = TWiki::Contrib::WikiwygContrib
You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.
Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.
Do not forget to enable the WysiwygPlugin in
- If you have TWiki 4.1 or later, and Perl 5.8, you can install from the
configure interface (Go to Plugins->Find More Extensions)
- The webserver user has to have permission to write to all areas of your installation for this to work.
- If you have a permanent connection to the internet (and Perl 5.8), you are recommended to use the automatic installer script
- Just download the
WikiwygContrib_installer perl script and run it.
- The installer script will:
- Automatically resolve dependencies,
- Copy files into the right places in your local install (even if you have renamed data directories),
- check in new versions of any installed files that have existing RCS histories files in your existing install (such as topics).
- If the $TWIKI_PACKAGES environment variable is set to point to a directory, the installer will try to get archives from there. Otherwise it will try to download from twiki.org or cpan.org, as appropriate.
- (Developers only: the script will look for twikiplugins/WikiwygContrib/WikiwygContrib.tgz before downloading from TWiki.org)
- If you don't have a permanent connection, you can still use the automatic installer, by downloading all required TWiki archives to a local directory.
- Point the environment variable
$TWIKI_PACKAGES to this directory, and the installer script will look there first for required TWiki packages.
$TWIKI_PACKAGES is actually a path; you can list several directories separated by :
- If you are behind a firewall that blocks access to CPAN, you can build a local CPAN mini-mirror, as described at http://twiki.org/cgi-bin/view/Codev/BuildingDakar#CPAN_local_minimirror
- If you don't want to use the installer script, or have problems on your platform (e.g. you don't have Perl 5.8), then you can still install manually:
- Download and unpack one of the
.tgz archives to a temporary directory.
- Manually copy the contents across to the relevant places in your TWiki installation.
- Check in any installed files that have existing
,v files in your existing install (take care not to lock the files when you check in)
- Manually edit LocalSite.cfg to set any configuration variables.
configure and enable the module, if it is a plugin.
- Repeat from step 1 for any missing dependencies.
configure or it won't work
If you are using
- To enable the editor in one of your skins, add the following link to the skin alongside or in place of the existing 'edit' link:
As you can see this is just a standard edit link with the wikiwyg skin in place of the usual edit skin. Here it is for this topic: Wikiwyg. Try clicking on it, but do not save!
Related Topics: TWikiPreferences