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..9724b69628 --- /dev/null +++ b/core/modules/help_topics/help_topics/editor.overview.html.twig @@ -0,0 +1,23 @@ +--- +label: 'Connecting text editors to text formats' +related: + - core.content_structure + - field_ui.manage_form + - filter.overview +--- +{% set filters = render_var(url('help.help_topic', {'id': 'filter.overview'})) %} +{% set content_url = render_var(url('filter.admin_overview')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Configure a text format so that when a user is editing text and selects this text format, a text editor installed on your site is shown. Configure the text editor, such as choosing which buttons and functions are available. See Managing text filters and text formats for more about text formats.{% endtrans %}

+

{% trans %}What is a text editor?{% endtrans %}

+

{% trans %}A text editor is software (typically, a JavaScript library) that provides buttons and other command mechanisms to make editing HTML text easier. Some editors are called visual or WYSIWYG (What You See Is What You Get) editors; these editors hide the details of HTML from the user, and instead show formatted output on the screen. The core Text Editor module provides a framework for deploying text editors on your site. The core CKEditor module provides CKEditor, which is a widely-used JavaScript WYSIWYG editor that creates clean and valid HTML; the module also enforces the HTML tag restrictions in the associated text format. Various contributed modules provide other editors; to install a new editor, besides installing the module, you may need to download the editor software from a third-party site.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > Content Authoring > Text formats and editors. The Text editor column in the table shows the text editor that is currently connected to each text format, if any.{% endtrans %}
    2. +
  2. {% trans %}Follow the steps on Managing text filters and text formats to add a new text format or configure an existing text format; when you reach the step about text editors, return to this topic.{% endtrans %}
    3. +
  3. {% trans %}Select CKEditor as the Text editor, or another text editor that you have installed. The rest of these steps assume you selected CKEditor.{% endtrans %}
    4. +
  4. {% trans %}Under Toolbar configuration, drag buttons between Available buttons and Active toolbar; only buttons in Active toolbar will be shown to the user. If you are using a mouse, you can hover over a button to see a tool tip explaining what the button does.{% endtrans %}
    5. +
  5. {% trans %}Drag buttons within Active toolbar to the desired order, and group buttons by dragging them into the grouping boxes; click Add group to add additional groups.{% endtrans %}
    6. +
  6. {% trans %}Under CKEditor plugin settings, configure any buttons that have configuration. This section will not be present if there are no active buttons with configuration.{% endtrans %}
    7. +
  7. {% trans %}Return to Managing text filters and text formats to complete the text format configuration, and be sure to save the text format.{% endtrans %}
    8. +
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..31b4681e80 --- /dev/null +++ b/core/modules/help_topics/help_topics/filter.overview.html.twig @@ -0,0 +1,38 @@ +--- +label: 'Managing text filters and text formats' +related: + - core.security + - core.content_structure + - field_ui.manage_form +--- +{% set content_url = render_var(url('filter.admin_overview')) %} +

{% trans %}Goal{% endtrans %}

+

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

+

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

+

{% trans %}A text filter is a processing step that can be applied to text, either to transform it in some way (such as converting URLs in the text into HTML links), or to defend against potentially-dangerous input from site users. A text format is an ordered sequence of text filters. Text filters are provided by modules; text formats are managed by the core Filter module.{% endtrans %}

+

{% trans %}Text fields that have "formatted" in the field type name, such as Text (formatted), use text formats. Users choose the text format when editing the field text; when the field text is shown on the site, it is processed by the chosen text format. Administrators can configure text formats, assign permissions for who can use each format, and using the core Text Editor module, associate visual editors with text formats.{% endtrans %}

+

{% trans %}What text filters are available?{% endtrans %}

+

{% trans %}Some of the more commonly-used text filters are:{% endtrans %}

+
+
{% trans %}Limit allowed HTML tags and correct faulty HTML{% endtrans %}
+
{% trans %}Limits which HTML tags can be used; useful both for site security and enforcing site design.{% endtrans %}
+
{% trans %}Convert line breaks into HTML{% endtrans %}
+
{% trans %}Line breaks in HTML source are displayed as horizontal spaces. This filter converts line breaks into HTML paragraph and line break tags.{% endtrans %}
+
{% trans %}Convert URLs into links{% endtrans %}
+
{% trans %}Takes plain URLs in text and turns them into HTML links.{% endtrans %}
+
{% trans %}Restrict images to this site{% endtrans %}
+
{% trans %}For text formats that allow HTML image tags, restricts images to URLs within this site.{% endtrans %}
+
+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > Content Authoring > Text formats and editors. Note that if you do not have the core Text Editor module installed, the menu link and page title will instead be Text formats.{% endtrans %}
    2. +
  2. {% trans %}Click Configure to configure an existing text format, or + Add text format to create a new text format.{% endtrans %}
    3. +
  3. {% trans %}Enter the desired Name for the text format, and optionally the machine name; you cannot edit the machine name for text formats provided by modules and installation profiles (only for formats added by administrators).{% endtrans %}
    4. +
  4. {% trans %}Check the 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, because HTML tags can allow embedding malicious links or scripts in text. Improper text format configuration is a security risk.{% endtrans %}
    5. +
  5. {% trans %}If the core Text Editor module is installed, see the related topic to connect a text editor to this text format.{% endtrans %}
    6. +
  6. {% trans %}Under Enabled filters, check the text filters that you want to use.{% endtrans %}
    7. +
  7. {% trans %}Under Filter processing order, drag the filters to the correct order. Choose the order carefully; for example, if you have a filter that results in a particular HTML tag being added to the text, that should run after a filter that restricts HTML tags, to avoid deleting the new tags the first filter added.{% endtrans %}
    8. +
  8. {% trans %}Under Filter settings, verify and adjust the settings for each active filter that has configuration options.{% endtrans %}
    9. +
  9. {% trans %}Click Save configuration, which will return you to the Text formats and editors page.{% endtrans %}
    10. +
  10. {% trans %}Repeat these steps if you have additional text formats to configure.{% endtrans %}
    11. +