• View
• Edit
• History
• Print

Installation

Basic Installation

Installing the rich text editor is relatively easy, but requires copying files to a number of locations. Because the recipe uses Perl scripts, you may have to ask your web host where to put them (most often the cgi-bin directory).

For more detailed information on the technical goals, decisions, and problems associated with this recipe, read the Detailed Summary.

What you need to have

RichEdit recipe for PmWiki

[Put download here.] To start off, you'll need this recipe.

Perl WikiConverter script

[Put download here.] The rich text editor uses some Perl scripts to convert between HTML and wiki markup.

Perl Dependencies

The WikiConverter script requires the following Perl modules, which are not included in the distribution:

• HTML::Tree
• HTML::Entities
• URI

Your web host may have some or all of these modules already installed. Otherwise, you can obtain them from CPAN.

Installation instructions will vary based on your individual setup, but extracting the files beneath your cgi-bin directory, with the directory structure following the namespace often works. For example, HTML::Tree would be extracted to the cgi-bin/HTML/Tree directory.

Where to put it

RichEdit extension

Extract the three richedit zip files as follows. Unless you have a previous version of this recipe, you should not be asked to overwrite any files.

1. Extract richedit_cgi-bin.zip to your cgi-bin or equivalent directory.
2. Extract richedit_cookbook.zip to your cookbook directory.
3. Extract richedit_wikidocs.zip to your wikilib.d directory.
4. Extract richedit_previewskin.zip to your pub/skins directory.

Perl WikiConverter Script

Extract these files into a directory where you are permitted to execute Perl files, such as cgi-bin.

• You may have to adjust the line at the top of WikiConverterWrapper.pl to reflect the location of the Perl interpreter.
• Make sure that all of the *.pl and *.pm files are given execute permissions.

Perl Dependencies

Comprehensive instructions for installing Perl modules are beyond the scope of this document. However:

• If your host does not have another installation procedure, you should probably put them in a directory where you are permitted to run Perl scripts.
• All scripts should be given execute permissions. Contact your host for more information.

What you need to configure

config.php

• Add the line "include_once('cookbook/richedit.php');".
• $RichEdit_PerlDirectory should be set to wherever you extracted the files from richedit_cgi-bin.zip.
• Use RichEdit_DoNotEditMarkup( $id, $pattern ) to prevent mangling of your custom markup.