Commit d06b4676 authored by webchick's avatar webchick

Issue #2033471 by Pancho, Wim Leers, ifrik: Mention core WYSIWYG / CKEditor in editor_help().

parent c47c16ae
...@@ -19,17 +19,18 @@ function editor_help($path, $arg) { ...@@ -19,17 +19,18 @@ function editor_help($path, $arg) {
case 'admin/help#editor': case 'admin/help#editor':
$output = ''; $output = '';
$output .= '<h3>' . t('About') . '</h3>'; $output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The Text Editor module provides a framework to extend the user interface on text fields that allow HTML input. Without Text Editor module, fields accept only text where formatting must be typed manually, such as entering a <code>&lt;strong&gt;</code> tag to make text bold or an <code>&lt;em&gt;</code> tag to italicize text. The Text Editor module allows these fields to be enhanced with rich text editors (WYSIWYGs) or toolbars, which make entering and formatting content easier. For more information, see the online handbook entry for <a href="@editor">Editor module</a>.', array('@editor' => '')) . '</p>'; $output .= '<p>' . t('The Text Editor module provides a framework that other modules (such as <a href="@ckeditor">CKEditor module</a>) can use to provide toolbars and other functionality that allow users to format text more easily than typing HTML tags directly. For more information, see the <a href="@documentation">online documentation for the Text Editor module</a>.', array('@documentation' => '', '@ckeditor' => url('admin/help/ckeditor'))) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>'; $output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>'; $output .= '<dl>';
$output .= '<dt>' . t('Enabling or configuring a text editor') . '</dt>'; $output .= '<dt>' . t('Installing text editors') . '</dt>';
$output .= '<dd>' . t('The Text Editor module does not have its own configuration page. Instead it enhances existing configuration pages with additional options. Text editors are attached to individual text formats, which can be configured on the <a href="@formats">Text formats page</a>. Each text format may be associated with a single text editor. When entering content with that text format, the associated text editor will automatically be enabled.', array('@formats' => url('admin/config/content/formats'))) . '</dd>'; $output .= '<dd>' . t('The Text Editor module provides a framework for managing editors. To use it, you also need to enable a text editor. This can either be the core <a href="@ckeditor">CKEditor module</a>, which can be enabled on the <a href="@extend">Extend page</a>, or a contributed module for any other text editor.
$output .= '<dt>' . t('Allowing a user to choose a text editor') . '</dt>'; When installing a contributed text editor module, be sure to check the installation instructions, because you will most likely need to download and install an external library as well as the Drupal module.', array('@ckeditor' => url('admin/help/ckeditor'), '@extend' => url('admin/modules'))) . '</dd>';
$output .= '<dd>' . t('Because text editor configurations are bound to a text format, users with access to more than one text format may switch between available text editors by changing the text format for a field. For more information about text formats, see the <a href="@filter">Filter module help page</a>, which describes text formats in more detail.', array('@filter' => url('admin/help/filter'))) . '</dd>'; $output .= '<dt>' . t('Enabling a text editor for a text format') . '</dt>';
// @todo: Mention the availability of the built-in core WYSIWYG (CKEditor) $output .= '<dd>' . t('On the <a href="@formats">Text formats and editors page</a> you can see which text editor is associated with each text format. You can change this by clicking on the <em>Configure</em> link, and then choosing a text editor or <em>none</em> from the <em>Text editor</em> drop-down list. The text editor will then be displayed with any text field for which this text format is chosen.', array('@formats' => url('admin/config/content/formats'))) . '</dd>';
// when it becomes available. See $output .= '<dt>' . t('Configuring a text editor') . '</dt>';
$output .= '<dt>' . t('Installing additional text editor libraries') . '</dt>'; $output .= '<dd>' . t('Once a text editor is associated with a text format, you can configure it by clicking on the <em>Configure</em> link for this format. Depending on the specific text editor, you can configure it for example by adding buttons to its toolbar. Typically these buttons provide formatting or editing tools, and they often insert HTML tags into the field source. For details, see the help page of the specific text editor.') . '</dd>';
$output .= '<dd>' . t('The Text Editor module does not provide any text editor libraries itself. Most installations of Drupal include a module that provides a text editor library which may be enabled on the <a href="@modules">Modules page</a>. Additional modules that provide text editor libraries may be <a href="@download">downloaded from</a>.', array('@modules' => url('admin/modules'), '@download' => '')) . '</dd>'; $output .= '<dt>' . t('Using different text editors and formats') . '</dt>';
$output .= '<dd>' . t('If you change the text format on a text field, the text editor will change as well because the text editor configuration is associated with the individual text format. This allows the use of the same text editor with different options for different text formats. It also allows users to choose between text formats with different text editors if they are installed.') . '</dd>';
$output .= '</dl>'; $output .= '</dl>';
return $output; return $output;
} }
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment