function fckeditor_help in FCKeditor - WYSIWYG HTML editor 5
Same name and namespace in other branches
- 5.2 fckeditor.module \fckeditor_help()
- 6.2 fckeditor.module \fckeditor_help()
- 6 fckeditor.module \fckeditor_help()
Implementation of hook_help
File
- ./
fckeditor.module, line 17 - FCKeditor Module for Drupal 5.x
Code
function fckeditor_help($section = '') {
switch ($section) {
case 'admin/settings/help#description':
$output = t("Enables the usage of FCKeditor (WYSIWYG editor) instead of plain text fields.");
break;
case 'admin/settings/fckeditor':
$output = t("<p>The FCKeditor module allows Drupal to replace textarea fields with a rich text or <acronym title=\"What You See Is What You Get\">WYSIWYG</acronym> editor. This editor brings many of the powerful functionalities of known desktop editors like Word to the web. It's relatively lightweight and doesn't require any kind of installation on the client computer.</p>\n<p>More information is located at the !fckeditorlink. A small user guide is located at !userguidelink.</p>", array(
'!fckeditorlink' => l(t('FCKeditor homepage'), 'http://www.fckeditor.net'),
'!userguidelink' => l(t('FCKeditor userguide'), 'http://wiki.fckeditor.net/UsersGuide'),
));
break;
case 'admin/help#fckeditor':
$output = t("<p>The FCKeditor module allows Drupal to replace textarea fields with a rich text or <acronym title=\"What You See Is What You Get\">WYSIWYG</acronym> editor. This editor brings many of the powerful functionalities of known desktop editors like Word to the web. It's relatively lightweight and doesn't require any kind of installation on the client computer.</p>\n<p>More information is located at the !fckeditorlink. A small user guide is located at !userguidelink.</p>", array(
'!fckeditorlink' => l(t('FCKeditor homepage'), 'http://www.fckeditor.net'),
'!userguidelink' => l(t('FCKeditor userguide'), 'http://wiki.fckeditor.net/UsersGuide'),
));
$output .= t('<h3>Installation</h3>
<p>Go to the !fckeditorlink and download the latest version. Then
uncompress the contents of the "fckeditor" directory of the download file to
%fckeditordir.</p>', array(
'!fckeditorlink' => l(t('FCKeditor homepage'), 'http://www.fckeditor.net'),
'%fckeditordir' => base_path() . drupal_get_path('module', 'fckeditor') . '/fckeditor/',
));
$output .= t('<h3>Installation troubleshooting</h3>
<p>If your FCKeditor does not show you must check if all files are extracted correctly. The directory %fckeditordir should have the following files <code>fckeditor.js, fckconfig.js, fckstyles.xml, fcktemplates.xml</code> and a directory named <code>editor</code>.</p>', array(
'!fckeditorlink' => l(t('FCKeditor homepage'), 'http://www.fckeditor.net'),
'%fckeditordir' => base_path() . drupal_get_path('module', 'fckeditor') . '/fckeditor/',
));
$output .= t('<h3>Configuration</h3>
<ol>
<li>Modify the fckeditor.config.js file to custom your needs (optional).<br />
You may copy the needed configuration lines from the default FCKeditor configuration settings (modules/fckeditor/fckeditor/fckconfig.js), the lines in fckeditor.config.js will override most settings.</li>
<li>Enable the module as usual from Drupal\'s admin pages.</li>
<li>Under Administer > Settings > FCKeditor, configure the fckeditor settings. You can choose which textareas will be replaced by FCKeditor, choose the toolbars and configure some more advanced settings.</li>
<li>Grant permissions for use of FCKeditor in Administer > User Management > Access Control (You only need to select either basic or advanced editor for each role that is allowed to use the FCKeditor)</li>
<li>For the Rich Text Editing to work you also need to configure your !filterlink for the users that may access Rich Text Editing. Either grant those users Full HTML access or use the following: <code>!filter</code>. Users that need access to tables might be better of using Full HTML.</li>
</ol>', array(
'!filter' => htmlentities('<a> <em> <strong> <small> <sup> <sub> <cite> <blockquote> <code> <ul> <ol> <li> <dl> <dt> <dd> <h2> <h3> <h4> <img> <br> <br /> <p> <div> <span> <b> <i>'),
'!filterlink' => l(t('filters'), 'admin/settings/filters'),
));
$output .= t('<h3>Uploading images and files</h3>
<p>There are three ways of uploading files: By using the built-in file browser, by using a module like !imce or using the core upload module.</p>', array(
'!imce' => l(t('IMCE'), 'http://drupal.org/project/imce'),
));
$output .= t('<h3>Security</h3>
<p>Note that enabling file uploads is <strong>a security risk</strong>. That\'s why there is a
separate permission in Administer > User Management > Access Control for enabling the file
browser to certain groups.</p>');
// the rest is untranslated for the moment
$output .= "<h3>How to enable the file browser (in FCKeditor 2.3.x)</h3>\n<p>The editor gives the end user the flexibility to create a custom file browser that can be integrated on it. The included file browser allows users to view the content of a specific directory on the server and add new content to that directory (create folders and upload files).</p>\n<p>To enable file browsing you need to edit the connector configuration file in your fckeditor module directory, the file should be in:<br /><code>" . base_path() . drupal_get_path('module', 'fckeditor') . "/fckeditor/editor/filemanager/browser/default/connectors/php/config.php</code> and <code>" . base_path() . drupal_get_path('module', 'fckeditor') . "/fckeditor/editor/filemanager/upload/php/config.php</code></p>\n<p>In this file you will need to enable the file browser:<br /><code>$Config['Enabled'] = true;</code></p>\n<p>To use the drupal files directory you also need to remove or comment out the following line in the connector configuration:<br /><code>$Config['UserFilesPath'] = '/UserFiles/';</code><br />You may also edit this line to reflect a custom upload path.</p>\n<p>Furthermore, you will need to create a <em>'File'</em>, <em>'Image'</em>, <em>'Flash'</em> and <em>'Media'</em> subdirectory in your drupal files directory ('" . file_directory_path() . "'). These directories must have the same privileges as the drupal files directory. In some cases these directories must be world writable (chmod 0777).</p>";
break;
}
return $output;
}