diff --git a/core/modules/help_topics/help_topics/ckeditor.overview.html.twig b/core/modules/help_topics/help_topics/ckeditor.overview.html.twig new file mode 100644 index 0000000000..814234df72 --- /dev/null +++ b/core/modules/help_topics/help_topics/ckeditor.overview.html.twig @@ -0,0 +1,27 @@ +--- +label: 'Managing CKEditor' +top_level: true +--- +{% set filters = render_var(url('filter.admin_overview')) %} +

{% trans %}Goal{% endtrans%}

+

{% trans %}Manage CKEditor for text formats on the site.{% endtrans%}

+

{% trans %}What is CKEditor?{% endtrans %}

+

{% trans %}The CKEditor module provides a highly-accessible, highly-usable visual text editor and adds a toolbar to text fields. Users can use buttons to format content and to create semantically correct and valid HTML. The CKEditor module uses the framework provided by the Text Editor module. It requires JavaScript to be enabled in the browser.{% endtrans %}

+

{% trans %}CKEditor only allows users to format content in accordance with the text filters of the specific text format. If a text format excludes certain HTML tags, the corresponding toolbar buttons are not displayed to users when they edit a text field in this format.{% endtrans %}

+

{% trans %}Steps{% endtrans%}

+
    +
  1. {% trans %}In the Configuration administrative menu, navigate to Content Authoring > Text editors and formats. The Text Editor column on the page displays the configured text editor for each text format.{% endtrans%}
    2. +
  2. {% trans %}Click Configure next to the text format to configure, or click + Add text format button to create a new text format.{% endtrans%}
    3. +
  3. {% trans %}Complete or update the options of the configuration form.{% endtrans%}
    4. +
  4. {% trans %}Select CKEditor in the Text editor select list.{% endtrans%}
    5. +
  5. {% trans %}The Toolbar configuration section shows Available buttons and Active toolbar.{% endtrans%}
    6. +
  6. {% trans %}To make an available button active, drag the button from Available buttons and place it into Active toolbar in the desired location. When dragging a button, the Active toolbar shows available button groups.{% endtrans%}
    7. +
  7. {% trans %}Use the Add group button to add additional groups for buttons.{% endtrans%}
    8. +
  8. {% trans %}To remove a button, drag the button from Active toolbar and place it into Available buttons.{% endtrans%}
    9. +
  9. {% trans %}Any active buttons that have configurable settings, such as Image button, are configurable in the CKEditor plugin settings section that appears below the Toolbar configuration section.{% endtrans%}
    10. +
+

{% trans %}Additional resources{% endtrans %}

+ diff --git a/core/modules/help_topics/help_topics/editor.install.html.twig b/core/modules/help_topics/help_topics/editor.install.html.twig new file mode 100644 index 0000000000..05b56ce2b5 --- /dev/null +++ b/core/modules/help_topics/help_topics/editor.install.html.twig @@ -0,0 +1,21 @@ +--- +label: 'Installing text editors' +related: +- editor.overview +- ckeditor.overview +--- +{% set extend = render_var(url('system.modules_list')) %} +

{% trans %}Goal{% endtrans%}

+

{% trans %}Install a new text editor for use on the site.{% endtrans%}

+

{% trans %}About installing text editors{% endtrans%}

+

{% trans %}Drupal core provides CKEditor as a module (which can be enabled in the Extend administrative menu). The Text Editor module provides a framework for other modules to provide alternative text editors.{% endtrans%}

+

{% trans %}Steps{% endtrans%}

+
    +
  1. {% trans %}Enable the desired text editor module on the Extend administrative menu. This can be either the core CKEditor module, or an editor provided by a Drupal contributed module. If enabling the core CKEditor, proceed to Managing CKEditor in related topics below. The following steps are for editors other than CKEditor.{% endtrans%}
    2. +
  2. {% trans %}When installing a contributed text editor module, refer to that module's installation instructions or readme file for complete installation information. Many modules require external libraries to be installed in addition to the module.{% endtrans%}
    3. +
  3. {% trans %}After the text editor is installed, it may provide configuration options specific to the editor . Refer to the contributed module's documentation for information on configuration options.{% endtrans%}
    4. +
+

{% trans %}Additional resources{% endtrans %}

+ diff --git a/core/modules/help_topics/help_topics/editor.overview.html.twig b/core/modules/help_topics/help_topics/editor.overview.html.twig new file mode 100644 index 0000000000..7c67e9283e --- /dev/null +++ b/core/modules/help_topics/help_topics/editor.overview.html.twig @@ -0,0 +1,24 @@ +--- +label: 'Managing text editors' +top_level: true +related: + - ckeditor.overview + - filter.overview + - editor.install +--- +{% set ckeditor_overview = render_var(url('help.help_topic', {'id': 'ckeditor.overview'})) %} +

{% trans %}Goal{% endtrans%}

+

{% trans %}Manage text editors used on the site.{% endtrans%}

+

{% trans %}What is Text Editor?{% endtrans %}

+

{% trans %}The Text Editor module provides a framework that other modules (such as CKEditor module) can use to provide toolbars and other functionality that allow users to format text more easily than typing HTML tags directly.{% endtrans %}

+

{% trans %}Steps{% endtrans%}

+
    +
  1. {% trans %}In the Configuration administrative menu, navigate to Content Authoring > Text editors and formats. The Text Editor column on the page displays the configured text editor for each text format.{% endtrans%}
    2. +
  2. {% trans %}Click Configure next to the text format to configure.{% endtrans%}
    3. +
  3. {% trans %}The Text editor shows the active text editor for this text format.{% endtrans%}
    4. +
  4. {% trans %}Any available text editor options specific to this text format will appear on this form. Refer to the contributed module's documentation for information on configuration options.{% endtrans%}
    5. +
+

{% trans %}Additional resources{% endtrans %}

+ diff --git a/core/modules/help_topics/help_topics/filter.overview.html.twig b/core/modules/help_topics/help_topics/filter.overview.html.twig new file mode 100644 index 0000000000..b3e1caa947 --- /dev/null +++ b/core/modules/help_topics/help_topics/filter.overview.html.twig @@ -0,0 +1,25 @@ +--- +label: 'Managing text filters and text formats' +top_level: true +--- +{% set content_url = render_var(url('filter.admin_overview')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Configure text filters and text formats on the site.{% endtrans %}

+

{% trans %}What are text filters and text formats?{% endtrans %}

+

{% trans %}The Filter module allows administrators to configure text formats. Text formats change how HTML tags and other text will be processed and displayed in the site. They are used to transform text, and also help to defend your web site against potentially damaging input from malicious users. Visual text editors can be associated with text formats by using the Text Editor module.

{% endtrans %} +

{% trans %}Using text fields with text formats{% endtrans%}

+

{% trans %}Text fields that allow text formats are those with "formatted" in the description. These are Text (formatted, long, with summary), Text (formatted), and Text (formatted, long). You cannot change the type of field once a field has been created.{% endtrans%}

+

{% trans %}Steps{% endtrans%}

+
    +
  1. {% trans %}In the Configuration administrative menu, navigate to Content Authoring > Text editors and formats.{% endtrans%}
    2. +
  2. {% trans %}Click Configure next to the text format to configure, or click + Add text format button to create a new text format.{% endtrans%}
    3. +
  3. {% trans %}Complete or update the options on the configuration form.{% endtrans%}
    4. +
  4. {% trans %}The Name field is the human name for this text format.{% endtrans%}
    5. +
  5. {% trans %}The Roles checkboxes indicate the user roles that can use this text format. To ensure security, anonymous and untrusted users should only have access to text formats that restrict them to either plain text or a safe set of HTML tags. This is because HTML tags can allow embedding malicious links or scripts in text. More trusted registered users may be granted permission to use less restrictive text formats in order to create rich text. Improper text format configuration is a security risk.{% endtrans%}
    6. +
  6. {% trans %}The Text editor select list allows you to choose if users will see a text editor (such as CKEditor) when using this text format.{% endtrans%}
    7. +
  7. {% trans %}The Enabled filters section allows you to select one or more text filters to apply when transforming text. Each text format uses filters that add, remove, or transform elements within user-entered text. For example, one filter removes unapproved HTML tags, while another transforms URLs into clickable links. Filters are applied in a specific order. They do not change the stored content: they define how it is processed and displayed.{% endtrans%}
    8. +
  8. {% trans %}The Filter processing order section allows you to choose the order that the enabled filters are applied to transform the text. Change the order of filters using the draggable handles or row weights.{% endtrans%}
    9. +
  9. {% trans %}If any enabled filters with configurable settings will appear in the Filter settings section.{% endtrans%}
    10. +
+

{% trans %}Additional resources{% endtrans %}

+

{% trans %}Filter module overview{% endtrans %}