Unverified Commit c6012dcf authored by larowlan's avatar larowlan

Issue #3067614 by Scott Weston, jhodgdon, neelam_wadhwani, prabha1997,...

Issue #3067614 by Scott Weston, jhodgdon, neelam_wadhwani, prabha1997, batigolix, pratik_kamble, hash6, abhisekmazumdar, anmolgoyal74, spitzialist, ravi.shankar, benjifisher, andypost: Convert filter, ckeditor, editor module hook_help() to topic(s)
parent 2651a495
......@@ -20,11 +20,15 @@ top_level: true
<li>{% trans %}Date range (Datetime range module): Stores time/date periods with a start and and an end{% endtrans %}</li>
<li>{% trans %}Email (core system): Stores email addresses{% endtrans %}</li>
<li>{% trans %}Link (Link module): Stores URLs and link text{% endtrans %}</li>
<li>{% trans %}List (Options module): Stores values chosen from pre-defined lists; the values can be numbers or text{% endtrans %}</li>
<li>{% trans %}Reference (core system): Stores entity references{% endtrans %}</li>
<li>{% trans %}List (Options module): Stores values chosen from pre-defined lists, where the values can be numbers or text; see section below for more on list fields.{% endtrans %}</li>
<li>{% trans %}Reference (core system): Stores entity references; see section above{% endtrans %}</li>
<li>{% trans %}Telephone (Telephone module): Stores telephone numbers{% endtrans %}</li>
<li>{% trans %}Text (Text module): Stores formatted and unformatted text{% endtrans %}</li>
<li>{% trans %}Text (Text module): Stores formatted and unformatted text; see section below for more on text fields.{% endtrans %}</li>
</ul>
<h2>{% trans %}What settings are available for List field types?{% endtrans %}</h2>
<p>{% trans %}List fields associate pre-defined <em>keys</em> (or value codes) with <em>labels</em> that the user sees. For example, you might define a list field that shows the user the names of several locations, while behind the scenes a location code is stored in the database. Each list field type corresponds to one type of stored key. For example, a <em>List (integer)</em> field stores integers, while the <em>List (text)</em> field stores text strings. Once you have chosen the field type, the main setting for a list field is the <em>Allowed values</em> list, which associates the keys with the labels.{% endtrans %}</p>
<h2>{% trans %}What types of Text fields are available?{% endtrans %}</h2>
<p>{% trans %}There are several types of text fields, with different characteristics. Text fields can be either <em>plain</em> or <em>formatted</em>: plain text fields do not contain HTML, while formatted fields can contain HTML and are processed through <em>text filters</em> (these are provided by the core Filter module; if you have that module enabled, see the related topic below on filters for more information). Text fields can also be regular-length (with a limit of 255 characters) or <em>long</em> (with a very large character limit), and long formatted text fields can include a <em>summary</em> attribute. All possible combinations of these characteristics exist as text field types; for example, <em>Text (plain)</em> and <em>Text (formatted, long, with summary)</em> are two examples of text field types. {% endtrans %}</p>
<h2>{% trans %}What is a formatter?{% endtrans %}</h2>
<p>{% trans %}A <em>formatter</em> is a way to display a field; most field types offer several types of formatters, and most formatters have settings that further define how the field is displayed. It is also possible to completely hide a field from display, and you have the option of showing or hiding the field's label when it is displayed.{% endtrans %}</p>
<h2>{% trans %}What is a widget?{% endtrans %}</h2>
......
---
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')) %}
<h2>{% trans %}Goal{% endtrans %}</h2>
<p>{% 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 <a href="{{ filters }}">Managing text filters and text formats</a> for more about text formats.{% endtrans %}</p>
<h2>{% trans %}What is a text editor?{% endtrans %}</h2>
<p>{% 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 <em>visual</em> or <em>WYSIWYG (What You See Is What You Get)</em> 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 library from a third-party site.{% endtrans %}</p>
<h2>{% trans %}Steps{% endtrans %}</h2>
<ol>
<li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Configuration</em> &gt; <em>Content Authoring</em> &gt; <a href="{{ content_url }}"><em>Text formats and editors</em></a>. The <em>Text editor</em> column in the table shows the text editor that is currently connected to each text format, if any.{% endtrans %}</li>
<li>{% trans %}Follow the steps on <a href="{{ filters }}">Managing text filters and text formats</a> 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 %}</li>
<li>{% trans %}Select <em>CKEditor</em> as the <em>Text editor</em>, or another text editor that you have installed. The rest of these steps assume you selected <em>CKEditor</em>.{% endtrans %}</li>
<li>{% trans %}Under <em>Toolbar configuration</em>, drag buttons between <em>Available buttons</em> and <em>Active toolbar</em>; only buttons in <em>Active toolbar</em> will be shown to the user. If you are using a mouse, you can hover over a button to see a tooltip explaining what the button does.{% endtrans %}</li>
<li>{% trans %}Drag buttons within <em>Active toolbar</em> to the desired order, and group buttons by dragging them into the grouping boxes; click <em>Add group</em> to add additional groups.{% endtrans %}</li>
<li>{% trans %}Under <em>CKEditor plugin settings</em>, configure the buttons that have configuration. This section will not be present if there are no active buttons with configuration.{% endtrans %}</li>
<li>{% trans %}Return to <a href="{{ filters }}">Managing text filters and text formats</a> to complete the text format configuration, and be sure to save the text format.{% endtrans %}</li>
</ol>
......@@ -8,7 +8,7 @@ related:
{% set content_types = render_var(url('entity.node_type.collection')) %}
{% set content_structure = render_var(url('help.help_topic', {'id': 'core.content_structure'})) %}
<h2>{% trans %}Goal{% endtrans %}</h2>
<p>{% trans %}Add a field to an entity sub-type; see <a href="{{ content_structure }}">Managing content structure</a> for an overview of entity types and sub-types.{% endtrans %}</p>
<p>{% trans %}Add a field to an entity sub-type; see <a href="{{ content_structure }}">Managing content structure</a> for an overview of entity types and sub-types, as well as an overview of field types.{% endtrans %}</p>
<h2>{% trans %}Steps{% endtrans %}</h2>
<ol>
<li>{% trans %}Navigate to the page for managing the entity sub-type you want to add the field to. For example, to add a field to a content type, in the <em>Manage</em> administrative menu, navigate to <em>Structure</em> &gt; <a href="{{ content_types }}"><em>Content types</em></a>.{% endtrans %}</li>
......
---
label: 'Managing text filters and text formats'
related:
- core.security
- core.content_structure
- field_ui.manage_form
- field_ui.manage_display
- field_ui.add_field
---
{% set content_url = render_var(url('filter.admin_overview')) %}
<h2>{% trans %}Goal{% endtrans %}</h2>
<p>{% trans %}Configure text formats on the site.{% endtrans %}</p>
<h2>{% trans %}What are text filters and text formats?{% endtrans %}</h2>
<p>{% 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 %}</p>
<p>{% trans %}Text fields that have "formatted" in the field type name, such as <em>Text (formatted)</em>, 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 and assign permissions for who can use each format. If the core Text Editor module is enabled, administrators can also associate visual editors with text formats.{% endtrans %}</p>
<h2>{% trans %}What text filters are available?{% endtrans %}</h2>
<p>{% trans %}Some of the more commonly used text filters are:{% endtrans %}</p>
<dl>
<dt>{% trans %}Limit allowed HTML tags and correct faulty HTML{% endtrans %}</dt>
<dd>{% trans %}Limits which HTML tags can be used; useful both for site security and enforcing site design.{% endtrans %}</dd>
<dt>{% trans %}Convert line breaks into HTML{% endtrans %}</dt>
<dd>{% trans %}Line breaks in HTML source are displayed as horizontal spaces. This filter converts line breaks into HTML paragraph and line break tags.{% endtrans %}</dd>
<dt>{% trans %}Convert URLs into links{% endtrans %}</dt>
<dd>{% trans %}Takes plain URLs in text and turns them into HTML links.{% endtrans %}</dd>
<dt>{% trans %}Restrict images to this site{% endtrans %}</dt>
<dd>{% trans %}For text formats that allow HTML image tags, restricts images to URLs within this site.{% endtrans %}</dd>
</dl>
<h2>{% trans %}Steps{% endtrans %}</h2>
<ol>
<li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Configuration</em> &gt; <em>Content Authoring</em> &gt; <a href="{{ content_url }}"><em>Text formats and editors</em></a>. If you do not have the core Text Editor module installed, the menu link and page title will instead be <em>Text formats</em>.{% endtrans %}</li>
<li>{% trans %}Click <em>Configure</em> to configure an existing text format, or <em>+ Add text format</em> to create a new text format.{% endtrans %}</li>
<li>{% trans %}Enter the desired <em>Name</em> for the text format.{% endtrans %}</li>
<li>{% trans %}Check the <em>Roles</em> that can use this text format. Some HTML tags allow users to embed malicious links or scripts in text. 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. <strong>Improper text format configuration is a security risk.</strong>{% endtrans %}</li>
<li>{% trans %}If the core Text Editor module is installed, see the related topic to connect a text editor to this text format.{% endtrans %}</li>
<li>{% trans %}Under <em>Enabled filters</em>, check the text filters that you want to use.{% endtrans %}</li>
<li>{% trans %}Under <em>Filter processing order</em>, 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 %}</li>
<li>{% trans %}Under <em>Filter settings</em>, verify and adjust the settings for each active filter that has configuration options.{% endtrans %}</li>
<li>{% trans %}Click <em>Save configuration</em>, which will return you to the <em>Text formats and editors</em> page.{% endtrans %}</li>
<li>{% trans %}Repeat these steps if you have additional text formats to configure.{% endtrans %}</li>
</ol>
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