- Unzip the contents of the zip archive into the Moodle
<moodle_base>/lib/editor/tiny/plugins/fontcolordirectory, (<moodle_base>/public/lib/editor/tiny/plugins/fontcoloras of Moodle 5.1 onwards) - As a Moodle Admin go to Site Administration -> Plugins -> Text Editors -> TinyMCE editor -> Tiny text color/text background color settings and add a some color names and color codes for at least on of the setting "Available text colors" or "Available text background colors".
- Optional enable the color picker for text color or background color.
- Save the color palette. Afterwards color selectors appear in TinyMCE.
If no colors are available and the color picker is disabled then the menu item and button in the TinyMCE editor will not appear. This is valid for both, the text color setting and the background color setting.
The color name can be an arbitrary string e.g. Red or Dark Green or whatever you name your color. The name can be also the "corporate name" e.g. that is used in any style guides of the corporate identity at your institution.
If you want a predefined color scheme, then you may add the json from
the file colorscheme.json into the settings textcolors and/or backgroundcolors
in the plugin settings. This can be done by e.g.
UPDATE config_plugins
SET value = '<json_string>'
WHERE plugin = 'tiny_fontcolor' AND name = 'textcolors';
Color names may also use language tags for the color names. Text filters are applied. For example setting black and white with German and English labels would look like this:
[
{
"name": "<span class=\"multilang\" lang=\"de\">Schwarz</span><span class=\"multilang\" lang=\"en\">Black</span>",
"value": "#000000"
},
{
"name": "<span class=\"multilang\" lang=\"de\">Weiss</span><span class=\"multilang\" lang=\"en\">White</span>",
"value": "#ffffff"
}
]
The value of the name property can be copied as it is, in the admin settings area at
"Descriptive name of colour" fields.
The name of the color is used as a tooltip in the editor when hovering over the appropriate colored square.
Since version 1.0 there is a mode to use css classes for defining colors, instead of having
the color code defined directly in the style attribute. This feature addresses
the issue CSS Rules rather than style attribute #18.
There are a few things to mention when using css classes over the color codes:
- Export and import courses/activities across Moodle sites will loose the color information because the css classes with the colors may not exist on the target site. In most use cases you will probably duplicate activities or courses within the same instance (course copy, sharing cart). In these cases the colors will also work on the copied item.
- Deinstalling the plugin will leave the colors because the css is stored in the
theme settings. The insered css class names with their colors values are not removed
during the deinstallation routine of the plugin. In case wanted, you can edit the
setting
scssof each installed theme. - The class names are derived from the descriptive color names. Invalid characters will be filtered, html is stripped (in case you use multilanguage annotation from Moodle).
- CSS classes with the appropriate styles are stored in the custom
scsssettings of all installed themes. Whenever these settings are changed manually, be careful not to remove the fontcolor styles. They can be applied again when saving the color settings of the plugin in the site administration. - The color picker in the editor is not available when the css classes are in use. With the color picker you may use an arbitrary color that is not defined in the css classes, and so no corresponding class name can be found.
There is no easy switch between the use of css classes and the use of the style attributes. Whenever you change the setting, remember that existing content is not changed. When editing the content, the plugin will only change the colors in the specified mode. If you change to css class names, edit a text that has previously defined colors in the style attribute, these remain and must be manually changed or removed.
Until version 1.3 of this plugin, table colors were independent from the settings of this plugin and used hardcoded values that come from the table plugin of the TinyMCE shipped with Moodle. This has been changed with version 1.4.
The two icons framed in the box 1 are now added always. With these icons the user may select the background color or border color of the current cell. In the table properties and advanced settings (reachable via box 2) the colors can be changed as well.
When the setting usefortable is activated, the color selectors in the context
menu use the custom defined colors from this plugin (textcolors is used for
the border, backgroundcolors is used for the cell background). The colors
in the advanced settings of the table properties cannot changed to the custom
palette separately. Also the color picker can not be removed. Therefore, at this
place the color map is empty and the color picker and removal pen remain. It is
recommended to use the color selectors from the context menu only.
Note: the usecssclassnames setting does not apply for the table colors.
This is because the table is an additional plugin that handles color management
in it's own way. The fontcolor plugin only manipulates the color palette to
choose from. When adding a color to a cell background or as a border, the
hexcode is used always with the inline style.
See Changes
