(r1) WikiwygContrib < TWiki/

TWiki/ Web>WikiwygContrib (revision 1) (raw view)~~EditAttach~~
---+!! WikiwygContrib Package

WikiwygContrib bundles up [[http://www.wikiwyg.net][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*: %TOPIC% 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 %<nop>TML%-type variables.

---++ Settings

Settings are stored as preferences variables. To reference a setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, e.g. ==%<nop>WIKIWYGCONTRIB_STUB%==

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

   * Name of the perl package
      * Set STUB = %$STUB%

---++ 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 Build<nop>Contrib.
   * If you have TWiki 4.2 or later, you can install from the =configure= interface (Go to Plugins->Find More Extensions)
      * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][installation supplement]] on TWiki.org for more information.
   * If you have any problems, then you can still install manually from the command-line:
      1 Download one of the =.zip= or =.tgz= archives
      1 Unpack the archive in the root directory of your TWiki installation.
      1 Run the installer script ( =perl &lt;module&gt;_installer= )
      1 Run =configure= and enable the module, if it is a plugin.
      1 Repeat for any missing dependencies.
   * If you are *still* having problems, then instead of running the installer script:
      1 Make sure that the file permissions allow the webserver user to access all files.
      1 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)
      1 Manually edit !LocalSite.cfg to set any configuration variables.

%IF{"defined 'SYSTEMWEB'" else="<div class='twikiAlert'>%X% WARNING: SYSTEMWEB is not defined in this TWiki. Please add these definitions to your %MAINWEB%.TWikiPreferences, if they are not already there:<br><pre>   * <nop>Set SYSTEMWEB = %<nop>TWIKIWEB%<br>   * <nop>Set USERSWEB = %<nop>MAINWEB%</pre></div>"}%


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

If you are using =pattern= skin:
   * set the COMPOSER variable to 'wikiwyg' in %MAINWEB%.TWikiPreferences
Otherwise:
	* 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:<br /><code>&lt;a href="%<nop>SCRIPTURLPATH%/edit%<nop>SCRIPTSUFFIX%/%<nop>WEB%/%<nop>TOPIC%?skin=wikiwyg"&gt;Wikiwyg&lt;/a&gt;</code><br />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: <a href="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=wikiwyg">Wikiwyg</a>. Try clicking on it, but _do not save_!

---++ Contrib Info

|  Plugin Author: | TWiki:Main.SvenDowideit - SvenDowideit@wikiring.com - <img src="%ATTACHURLPATH%/wikiringlogo20x20.png" /> [[http://www.wikiring.com][WikiRing.com]] |
|  Copyright &copy;: | 2006, SvenDowideit@WikiRing.com and Copyright (c) 2005,2006 Socialtext Corporation |
|  License: | LGPL ([[http://www.gnu.org/copyleft/lesser.txt][GNU Lesser General Public License]])  |
|  Dependencies: | <table border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">TWiki::Plugins::WysiwygPlugin</td><td align="left">&gt;=1.000</td><td align="left">Required. Download from TWiki:Plugins/WysiwygPlugin and install.</td></tr></table> |
|  Version: | 15571 (12 Dec 2008) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  12119 | Minor changes since Kupu and WysiwygPlugin got divorced |
|  | Initial version |
|  Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %TWIKIWEB%.TWikiPreferences
Form definition 'PackageForm' not found
Topic revision: r2 - 12 Apr 2009 - 20:25:18 - TWikiAdminGroup
TWiki/
Webs
DnD
Main
Support
TWiki
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback