cms_init_editor tag

We need your assistance to make the documentation accurate, user friendly and understandable. Therefore we welcome any tips or suggestions regarding documentation. Thank you in advance for your contribution.

However, we will not respond to technical support questions submitted using this form. If you are having difficulty with CMSMS and cannot find the solution on this website, please submit your question appropriately on our support forum at: http://forum.cmsmadesimple.org. Please remember to follow the forum rules when posting.

CMS Made Simple™ Partner



   Purpose

This plugin is used to initialize the selected wysiwyg editor for display when wysiwyg functionalities are required for frontend data submission. This module will find the selected frontend wysiwyg, determine if it has been requested, and if so generate the appropriate html code (usually javascript links) so that the wysiwyg will initialize properly when the page is loaded. If no wysiwyg editors have been requested for the frontend request this plugin will produce no output.

Note: This plugin will work properly given the default configuration of CMSMS. If you have modified the "process_whole_template" configuration variable from its default value, you may have to adjust the parameters supplied to this plugin.

   How to use?

The first thing you must do is select the frontend WYSIWYG editor to use in the global settings page of the admin console. Next If you use frontend wysiwyg editors on numerous pages, it may be best to place the {cms_init_editor} plugin directly into your page template. If you only require the wysiwyg editor to be enabled on a limited amount of pages you may just place it into the "Page Specific Metadata" field in each page.

{cms_init_editor}

   Available parameters

  • wysiwyg - Specify the name of the wysiwyg editor module to initialize. Use with caution. If you have a different wysiwyg editor selected in the global settings, this will force the specified editor to be initialized.
  • force=0 - Normally this plugin will not initialize the specified (or detected) editor if it has not been marked as "active". This parameter will override that behavior.
  • assign - Assign the output of the plugin to the named smarty variable.