Note: This documentation is for Moodle 2.7. For up-to-date documentation see Text editor.

Text editor: Difference between revisions

From MoodleDocs
Main page ► Managing a Moodle course ► Editing text ► Text editor
Editing text
(98 intermediate revisions by 14 users not shown)
Line 1: Line 1:
{{Editing text}}
{{Editing text}}
The text editor (sometimes referred to as the 'HTML editor' or even 'TinyMCE') has many icons to assist the user in entering content.  Many of these icons and functions should be familiar to anyone who uses a word processor.  Some examples of where you will see the text editor include: Editing Section headings, description of an activity, writing an answer to a quiz question or editing the content of many blocks.
The text editor (sometimes referred to as the 'HTML editor') has many icons to assist the user in entering content.  Many of these icons and functions should be familiar to anyone who uses a word processor.  However, writing for the web on the web is different, and especially with accessibility and design considerations Atto sometimes you may not do what you expect with a normal editor, or even the old default editor in Moodle.


[[Image:HTMLeditor tools M2 1.png|thumb|The standard version of the text editor tool bar]]
For some comment on this, [https://moodle.org/mod/forum/discuss.php?d=265176 please see this post]


==List of groups==
Some examples of where you will see the text editor include: Editing Section headings, description of an activity, writing an answer to a quiz question or editing the content of many blocks.
For those who are not familiar with the tool bar, here are the functions listed by group using the above example.  Remember that the site administrator can edit or provide additonal toolbars.


Row 1
The default text editor in Moodle is the Atto editor, built specifically for Moodle. There is also a version of the [[TinyMCE editor]] and a plain text editor.
*[[Image:HTML_editor_group_font_style.png]] - Font, size and heading group
*[[Image:HTML_editor_group_undo_redo.png]] - Undo and Redo group
*[[Image:HTML_editor_group_find_replace.png]] - Find and Replace group
*[[Image:HTML_editor_group_fullscreen_1.png]]|Full screen toggle
Row 2
*[[Image:HTML editor group text effects.png]] - Text effect group
*[[Image:HTML editor group line format.png]] - Line format group
*[[Image:HTML_editor_group_formatting.png]] - Formatting group
*[[Image:HTML_editor_group_color.png]] - Color group
*[[Image:HTML_editor_group_paragraph.png]] - Paragraph group


Row 3
Text editors can be enabled, disabled or a different one set to default from ''Administration > Site administration > Plugins > Text editors > Manage editors''. The order of priority may also be specified here.
*[[Image:HTML_editor_group_lists.png]] - Number and Bullets and indents
*[[Image:HTML_editor_group_link.png]] - Link group
*[[Image:HTML_editor_group_insert.png]] - Insert group
*[[Image:HTML_editor_group_HTML_spell.png]] - HTML source toggle & spellchecker


==Special features==
An individual user can select an editor in their profile from ''Administration > My Profile settings > Edit profile.''


===Color pickers===
==Atto HTML editor==
*[[Image:HTML_editor_group_color.png]]
{{New features}}
There are 4 levels of selecting a font or background color,
*A quick pick 5x8 matrix of colors
*"More colors" that links to Picker, Pallet and Named tabs
<gallery>
Image:HTML_editor_color_selector_basic_1.png|A quick pick 5x8 matrix of colors
Image:HTML_editor_color_selector_more_picker_1.png|A rainbow color picker tab
Image:HTML_editor_color_selector_more_pallet_1.png|A Pallet tab with a 18x12 matrix of colors
Image:HTML_editor_color_selector_more_named_1.png|A Named tab with custom pallets
</gallery>


===Insert images and media===
[[File:Atto1.png]]
[[Image:HTML_editor_group_insert_MU_1.png|thumb|The Insert images and media group]]


* 1 Insert Image - uses [[File picker]]
Atto Row 1
* 2 Insert Emoticon (only visible if the site administrator has enabled the "show emoticons as images" ''filter in Settings>Site administration>Plugins>Filters>Manage filters'')
* 3 Insert Media - uses [[File picker]]
* 4 Insert Equation - uses java script editor
* 5 Insert Non breaking space
* 6 Insert Custom character - Special keyboard characters
* 7 Insert Table -


<gallery widths="300px">
Image:Files_File_picker_upload_files_add_1.png|File picker Upload file screen
Image:HTML editor equation editor 1.png|Equation editor
Image:HTML_editor_custom_character_selector_1.png|Custom character selector
</gallery>


====Insert table====
{| class="nicetable"
<gallery widths="300px">
|-
Image:HTMLeditor_Insert_Table_general_1.png|General tab
|-
Image:HTMLeditor_Insert_Table_advanced_1.png|Advanced tab
| 1:Expand
</gallery>
| 2.Style
| 3.Bold
| 4.Italic
|-
| 5.Bulleted list
| 6.Numbered list
| 7.Add link
| 8.Unlink
|-
| 9.Add image
| 10.Add media
| 11.Manage embedded files
|}
 
 
 
[[File:Atto22.png]]
 
Atto Row 2


'''To add borders to a table'''
{| class="nicetable"
|-
|-
| 1. Underline
| 2. Strikethrough
| 3. Subscript
| 4. Superscript
|-
| 5. Align left
| 6. Align centre
| 7. Align right
| 8. Increase indent
|-
| 9. Decrease indent
| 10. Equation editor
| 11. Special character
| 12. Table
|-
| 13. Clear formatting
| 14. Undo/redo
| 15. Undo/redo
| 16. Accessibility checker
|-
| 17. Screenreader helper
| 18. HTML/code view
|}


Cell borders are crucial for helping readers to follow the rows across the screen. If they aren’t showing already you can add them as follows:
==Equation editor==


#In the Wiki page containing your table, click its Edit tab
{{New features}}If either the [[MathJax filter|MathJax]] or the [[TeX notation filter|TeX notation]] filters are enabled (in ''Administration > Site administration > Plugins > Filters > Manage filters'') then an equation editor button is provided in the toolbar for launching the equation editor.
#Carefully select all the cells of the table
{|
#Then right click (Macs: Command+click or Ctrl+Click) over any part of your selection to get a context menu; from it select Cell > Table Cell Properties; the cell properties dialog box then loads.
| [[File:equation editor.png|thumb|Equation editor]]
#Click on its Advanced tab, set Border Color to black (for instance), then click Apply, and then click Update.
|}
#Click Save; the Wiki page containing your table will then load displaying its borders.


==Site administration settings==
==Site administration settings==


===Manage editors===
===Toolbar settings===


A site administrator can enable / disable text editors in ''Settings > Site administration > Plugins > Text editors > Manage editors''. By default the TinyMCE HTML editor and plain text area are enabled.
The administrator can specify which plugins to display and in which order from ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Atto toolbar settings''.
[[File:atto-plugins.png|thumb|center|450px|Atto Plugins]]


====Disabling the built-in spell checker====
====Toolbar config table====
If you want to disable the TinyMCE spell checker and rely on browser spell checker functionality instead, you can do this by disabling the ''spellchecker'' plugin. Navigate to ''Settings > Site administration > Plugins > Text editors > TinyMCE HTML editor > General settings'' and click the eye icon for this plugin.
The toolbar is split into groups of related buttons. The format for the config setting is:


====Spell engine settings====
groupname1 = button1, button2, button3
[[File:Spellengine.png]]
groupname2 = button1, button2, button3


The TinyMCE HTML editor used by Moodle has Google Spell as its default spell engine (spell-checker). This can be changed by a site administrator in ''Settings > Site administration > Plugins > Text editors > TinyMCE HTML editor''.
The group names on the left have no effect on how the toolbar works; they just need to be different for each button (and no spaces please). The list of buttons says which button goes in which group and in what order. The exact word to insert here for each button is listed in the "Toolbar config" column above.


If PSpellSpell is selected then aspell 0.50 or later must be installed on your server and the path to aspell set in Settings > Site administration > Server > System Paths.
The reason there are names for the groups is that it helps to make you think about how to group the buttons sensibly and not just stick new buttons in random locations. Ie. all the buttons in the "files" group interact with the file picker in some way
===Adding extra buttons===


[[File:Spellcheck.png]]
Extra plugins from the list (for example 'Font color' or 'Emoticon') may be added by typing the toolbarconfig term into the toolbar config table.


====HTML settings====
[[File:toolbarconfig.png]]


A site administrator can edit the emoticons (or smileys) used in the text editor in ''Settings > Site administration > Appearance > HTML settings''.
Here for example are the available colours when 'fontcolor' is added:


====Available fonts list====
[[File:fontcolor.png]]


In addition to the default fonts, a site administrator can add extra fonts by typing their name and string in the box in ''Settings > Site administration > Plugins > Text editors > TinyMCE HTML editor>General settings'' as demonstrated in the screencast [http://youtu.be/udP7Bnur30Y How to add extra fonts].
The icons are displayed in related groups and the administrator can decide how many groups to display in the default collapsed state of the toolbar (that is, how many groups to display on Row 1).
==== Non default Atto plugins ====
Not all plugins are enabled by default and the administrator of each site should give careful thought as to which plugins they choose to enable for their users. Here are some things to consider before enabling the non-default plugins:


===Customising the editor toolbar===
===== Background colour / Font colour =====
While these are very popular plugins, there are downsides to enabling their use on a site. Firstly - user specified colours may conflict visually with the site colours chosen by the theme designer. Even if the colours of the content does not conflict with the colours of the current theme, if the theme is changed in future, or the content is reused on a different site conflicts may be introduced. There are 2 possible types of conflicts, the first is just a visually unappealing combination of colours, the second is a combination of colours that may produce text that is hard to read for some people. It is preferable if the theme designer uses some interesting colours that meet the accessibility standards required for the site in the theme for the site, and the person creating the content simply uses the proper heading levels (for example) to make use of those styles.


An administrator can remove or add buttons to the TinyMCE editor toolbar by altering the Editor toolbar box in ''Settings>Site administration>Plugins>Text editors>TinyMCE HTML editor>General settings'' as demonstrated in the screencast [http://youtu.be/vTW1DImro9c Customise the text editor in 2.4]
===== Emoticons =====
The emoticon plugin inserts text representations of the emoticons in the content. The emoticon filter is responsible for converting these text sequences into proper smiley images. The emoticon filter is not enabled by default, which is why the emoticon plugin for Atto is not enabled by default.


{|
===== No-auto link =====
| [[File:editortoolbar.png|thumb|The Editor toolbar box]]
In general, the more plugins are added to the Atto toolbar, the harder it becomes to find specific plugins. Because the no-auto link plugin is not felt to be widely used it is not enabled by default.
 
===== Right to left =====
Because this plugin is only useful for courses where text needs to be written in a mixture of both "left to right" and "right to left" languages, it is not enabled by default.
 
==== Moodle plugins directory ====
 
There are more plugins available for Atto than just those included in a default install.
See the [https://moodle.org/plugins/browse.php?list=category&id=53 Moodle plugins directory] for additional plugins.
Some example plugins include the following.
 
===== Toggle preview =====
This plugin allows you view the content as it would be seen by a reader.
 
===== Chemistry plugins =====
There are a number of chemistry plugins that support chemistry equations and structures.
 
===== Text import plugins =====
There are a number of plugins that support importing text from other sources.
The [https://moodle.org/plugins/view/atto_pastespecial Paste special] plugin minimises the amount of superfluous HTML markup
included when pasting content from an external editor such as Microsoft Word.
 
The [https://docs.moodle.org/27/en/Atto_Word_import Word import] plugin supports dragging and dropping Word documents into the text box,
and cleanly imports the entire contents including embedded images, tables, headings, etc.
It also imports Microsoft Equation Editor equations as MathML, which can then be displayed using MathJax.
 
===Equation editor settings===
 
Equation editor commands may be removed, added or reordered in ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Equation editor settings''.


|}
[[File:equationeditor.png]]


Here is the [http://www.tinymce.com/wiki.php/Buttons/controls default list of TinyMCE buttons available for use]
==Dragging/dropping images into the text editor==
* If your browser supports it, you can drag and drop images into a [[Page]], [[Questions]] and [[Labels]].
* Images dragged into a [[Forum ]] post will not appear unless you are using Atto and have the Plugin for Drag and Drop installed. (https://moodle.org/plugins/view.php?plugin=atto_imagedragdrop)
* Images cannot be dragged and dropped using Chrome or IE, but it is possible with Firefox.
* [https://moodle.org/mod/forum/discuss.php?d=270053 This forum thread] has more discussion on the matter.
* There is a tracker item for drag and drop into Atto here: https://tracker.moodle.org/browse/MDL-43996


==See also==
==See also==


* [http://youtu.be/GNQSK_fPV98 Moodle HQ screencast demonstrating Atto editor]
* [http://youtu.be/ZoOAkpK9Oho The Moodle Text Editor - Atto] MoodleBites video on YouTube
* [[Text editor FAQ]]
* [[Text editor FAQ]]
* [[Embedded files repository]]
* [https://moodle.org/mod/forum/discuss.php?d=258631 New 2.7 Equation Editor - Missing Key Items] forum discussion and associated issue MDL-45067


[[Category:Site administration]]
[[Category:Site administration]]


[[de:Text-Editor]]
[[de:Text-Editor]]
[[es:Editor de texto]]

Revision as of 10:30, 22 October 2015

The text editor (sometimes referred to as the 'HTML editor') has many icons to assist the user in entering content. Many of these icons and functions should be familiar to anyone who uses a word processor. However, writing for the web on the web is different, and especially with accessibility and design considerations Atto sometimes you may not do what you expect with a normal editor, or even the old default editor in Moodle.

For some comment on this, please see this post

Some examples of where you will see the text editor include: Editing Section headings, description of an activity, writing an answer to a quiz question or editing the content of many blocks.

The default text editor in Moodle is the Atto editor, built specifically for Moodle. There is also a version of the TinyMCE editor and a plain text editor.

Text editors can be enabled, disabled or a different one set to default from Administration > Site administration > Plugins > Text editors > Manage editors. The order of priority may also be specified here.

An individual user can select an editor in their profile from Administration > My Profile settings > Edit profile.

Atto HTML editor

New feature
in Moodle 2.7!


Atto1.png

Atto Row 1


1:Expand 2.Style 3.Bold 4.Italic
5.Bulleted list 6.Numbered list 7.Add link 8.Unlink
9.Add image 10.Add media 11.Manage embedded files


Atto22.png

Atto Row 2

1. Underline 2. Strikethrough 3. Subscript 4. Superscript
5. Align left 6. Align centre 7. Align right 8. Increase indent
9. Decrease indent 10. Equation editor 11. Special character 12. Table
13. Clear formatting 14. Undo/redo 15. Undo/redo 16. Accessibility checker
17. Screenreader helper 18. HTML/code view

Equation editor

New feature
in Moodle 2.7! If either the MathJax or the TeX notation filters are enabled (in Administration > Site administration > Plugins > Filters > Manage filters) then an equation editor button is provided in the toolbar for launching the equation editor.

Equation editor

Site administration settings

Toolbar settings

The administrator can specify which plugins to display and in which order from Administration > Site administration > Plugins > Text editors > Atto HTML editor > Atto toolbar settings.

Atto Plugins

Toolbar config table

The toolbar is split into groups of related buttons. The format for the config setting is:

groupname1 = button1, button2, button3 groupname2 = button1, button2, button3

The group names on the left have no effect on how the toolbar works; they just need to be different for each button (and no spaces please). The list of buttons says which button goes in which group and in what order. The exact word to insert here for each button is listed in the "Toolbar config" column above.

The reason there are names for the groups is that it helps to make you think about how to group the buttons sensibly and not just stick new buttons in random locations. Ie. all the buttons in the "files" group interact with the file picker in some way

Adding extra buttons

Extra plugins from the list (for example 'Font color' or 'Emoticon') may be added by typing the toolbarconfig term into the toolbar config table.

toolbarconfig.png

Here for example are the available colours when 'fontcolor' is added:

fontcolor.png

The icons are displayed in related groups and the administrator can decide how many groups to display in the default collapsed state of the toolbar (that is, how many groups to display on Row 1).

Non default Atto plugins

Not all plugins are enabled by default and the administrator of each site should give careful thought as to which plugins they choose to enable for their users. Here are some things to consider before enabling the non-default plugins:

Background colour / Font colour

While these are very popular plugins, there are downsides to enabling their use on a site. Firstly - user specified colours may conflict visually with the site colours chosen by the theme designer. Even if the colours of the content does not conflict with the colours of the current theme, if the theme is changed in future, or the content is reused on a different site conflicts may be introduced. There are 2 possible types of conflicts, the first is just a visually unappealing combination of colours, the second is a combination of colours that may produce text that is hard to read for some people. It is preferable if the theme designer uses some interesting colours that meet the accessibility standards required for the site in the theme for the site, and the person creating the content simply uses the proper heading levels (for example) to make use of those styles.

Emoticons

The emoticon plugin inserts text representations of the emoticons in the content. The emoticon filter is responsible for converting these text sequences into proper smiley images. The emoticon filter is not enabled by default, which is why the emoticon plugin for Atto is not enabled by default.

No-auto link

In general, the more plugins are added to the Atto toolbar, the harder it becomes to find specific plugins. Because the no-auto link plugin is not felt to be widely used it is not enabled by default.

Right to left

Because this plugin is only useful for courses where text needs to be written in a mixture of both "left to right" and "right to left" languages, it is not enabled by default.

Moodle plugins directory

There are more plugins available for Atto than just those included in a default install. See the Moodle plugins directory for additional plugins. Some example plugins include the following.

Toggle preview

This plugin allows you view the content as it would be seen by a reader.

Chemistry plugins

There are a number of chemistry plugins that support chemistry equations and structures.

Text import plugins

There are a number of plugins that support importing text from other sources. The Paste special plugin minimises the amount of superfluous HTML markup included when pasting content from an external editor such as Microsoft Word.

The Word import plugin supports dragging and dropping Word documents into the text box, and cleanly imports the entire contents including embedded images, tables, headings, etc. It also imports Microsoft Equation Editor equations as MathML, which can then be displayed using MathJax.

Equation editor settings

Equation editor commands may be removed, added or reordered in Administration > Site administration > Plugins > Text editors > Atto HTML editor > Equation editor settings.

equationeditor.png

Dragging/dropping images into the text editor

See also

Retrieved from "https://docs.moodle.org/27/en/index.php?title=Text_editor&oldid=116052"
Powered by MediaWiki