====== WYSIWYG Plugin ======

---- plugin ----
description: A WYSIWYG editor
author     : Luke Howson
email      : mail@lukehowson.com
type       : syntax
lastupdate : 2007-12-02
compatible : 2006-11-06
depends    : 
conflicts  : template:monobook
similar    : 
tags       : !obsolete, !discontinued, editing, wysiwyg

downloadurl: https://trello.com/1/cards/5d504791ae3e0b15cfb5bb55/attachments/5d504821c7e94516c3fbc2b0/download/wysiwyg2.zip
bugtracker : 
sourcerepo : 
donationurl: 

screenshot_img: https://trello.com/1/cards/5d504791ae3e0b15cfb5bb55/attachments/5d504e0e385af253488c63fa/download/wysiwyg_edit.gif
----

Recent alternative: [[plugin:ckgedit]] plugin

Conflicts with: [[:template:monobook|Monobook template]] --- Editing box hides under left side logo in Monobook.

What You See Is What You Get (WYSIWYG) editors run against the grain of DokuWiki markup. On the other hand, they are sometimes exactly what you need.

===== Use it =====

In the DokuWiki editor, use the following syntax:

  <wysiwyg name />
  <code>Regular DokuWiki markup....
  <wysiwyg name />

More regular DokuWiki markup

  <wysiwyg anothername /> </code>

and so forth. After saving this gives you something like:

{{https://trello.com/1/cards/5d504791ae3e0b15cfb5bb55/attachments/5d504e0fc503f36c24c2eb4c/download/wysiwyg_view.gif?reache}}

Click on one of the edit buttons, and:

{{https://trello.com/1/cards/5d504791ae3e0b15cfb5bb55/attachments/5d504e0e385af253488c63fa/download/wysiwyg_edit.gif?reache}}

That's pretty much all there is to it. See below for admin details.

==== Administration ====

  - You can override the "Create Page" behaviour for particular users by adding them to the 'wysiwyg' group. When they create a page now, they get an entire wysiwyg page.
  - It's a good idea to disable section edit if you're using WYSIWYG. (Set "Maximum section edit level" to 0.)

===== Technical Notes =====

==== First load ====

The first time a browser loads a page with WYSIWYG in it is slow. FCKeditor is big. But it does get cached, so subsequent pages should be quick.

==== Compatibility ====

Tested with:
  * Firefox 2.0.0.7
  * IE7
  * IE6 (Uses old-style toolbar.)
  * Safari 3.0.3 (on pc)
  * Google Chrome 2.0
  * Opera 11.1

==== Storage ====

The editable portions are stored within the DokuWiki *.txt file, in /data/pages. The reason it is stored here rather than metadata is so that if (read: 'when') files get moved about and renamed, the data won't get destroyed.

The editable portions are hidden from the user when editing from within the DokuWiki editor.1

==== Testing ====

Please report all bugs to me at [[mail@lukehowson.com|Luke Howson]]

==== Client side editor ====

The client side editor used is [[http://www.fckeditor.net/|FCKeditor]].

==== Search ====

WYSIWYG boxes are searchable.

==== Locking ====

Locking works at page-level granularity.

==== Permissions ====

These work as expected.

==== Why doesn't WYSIWYG read and write DokuWiki syntax? ====

The design philosophy of this plugin is to separate the "expert" DokuWiki syntax from the "basic" WYSIWYG editor. Lots of third party plugins can be used recursively, or require complicated or low level concepts that cannot be easily represented in a WYSIWYG editor. Further, I don't think there is a general way to allow such an editor to use arbitrary plugins.

There are several drawbacks to this separation:
  * users are unlikely to learn DokuWiki syntax. There is no simple path from "basic" to "advanced" use.
  * a few things don't work as expected. (Search currently shows unrendered HTML in its output);
  * uninstall will be difficult.

===== Spanish Localization =====

I just updated the translation file for Spanish speaking people [[http://aguas.byethost2.com/shared/WISIWYG_plugin_in_spanish.zip|here it is.]]

===== Discussion =====

Please use the [[plugin:wysiwyg:discussion|discussion]] page for general discussion.