editing1Add my vote for this tag wysiwyg1Add my vote for this tag create new tag
, view all tags

WikiwygContrib Package

WikiwygContrib 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 pattern skin (or any other skin thst uses COMPOSER), then when you set the COMPOSER variable to wikiwyg, the WYSIWYG edit button will use wikiwyg. Right now, it works only with FireFox, but I'm looking into getting it working in InternetExplorer etc.

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.

Caveat: WikiwygContrib 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 %<plugin>_<setting>%, e.g. %WIKIWYGCONTRIB_STUB%

  • One line description:
    • Set SHORTDESCRIPTION = Add Wikiwyg editor to Wysiwyg

  • Name of the perl package
    • Set STUB = TWiki::Contrib::WikiwygContrib

Installation Instructions

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.

  • 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.
  • Notes:
    • 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:
    1. Download and unpack one of the .zip or .tgz archives to a temporary directory.
    2. Manually copy the contents across to the relevant places in your TWiki installation.
    3. 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)
    4. Manually edit LocalSite.cfg to set any configuration variables.
    5. Run configure and enable the module, if it is a plugin.
    6. Repeat from step 1 for any missing dependencies.

Do not forget to enable the WysiwygPlugin in configure or it won't work.

If you are using pattern skin:

  • 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:
    <a href="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=wikiwyg">Wikiwyg</a>
    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!

Contrib Info

Plugin Author: TWiki:Main.SvenDowideit - SvenDowideit@wikiringPLEASENOSPAM.com - WikiRing.com
Copyright ©: 2006, SvenDowideit@WikiRingPLEASENOSPAM.com and Copyright (c) 2005,2006 Socialtext Corporation
License: LGPL (GNU Lesser General Public License)
TWiki::Plugins::WysiwygPlugin>=1.000Required. Download from TWiki:Plugins/WysiwygPlugin and install.
Version: 12119
Change History:  
12119 Minor changes since Kupu and WysiwygPlugin got divorced
  Initial version
Home: http://TWiki.org/cgi-bin/view/Plugins/WikiwygContrib
Feedback: http://TWiki.org/cgi-bin/view/Plugins/WikiwygContribDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/WikiwygContribAppraisal

Related Topics: TWikiPreferences

Topic attachments
I Attachment History Action Size Date Who Comment
Unknown file formatmd5 WikiwygContrib.md5 r5 r4 r3 r2 r1 manage 0.2 K 2008-12-12 - 12:51 SopanShewale checksum file , Uploaded as a part of Release Process
Compressed Zip archivetgz WikiwygContrib.tgz r8 r7 r6 r5 r4 manage 54.2 K 2008-12-12 - 12:51 SopanShewale See WikiwygContrib for details. Untar and run the installer script, Uploaded as a part of Release Process
Compressed Zip archivezip WikiwygContrib.zip r8 r7 r6 r5 r4 manage 83.7 K 2008-12-12 - 12:51 SopanShewale See WikiwygContrib for details. Unzip and run the installer script , Uploaded as a part of Release Process
Unknown file formatEXT WikiwygContrib_installer r5 r4 r3 r2 r1 manage 5.9 K 2008-12-12 - 12:51 SopanShewale Installer Script, Uploaded as a part of Release Process
PNGpng wikiringlogo20x20.png r1 manage 1.3 K 2007-02-17 - 22:56 SvenDowideit wikiringlogo20x20.png
Edit | Attach | Watch | Print version | History: r11 < r10 < r9 < r8 < r7 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r11 - 2012-12-03 - PeterThoeny
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.