www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/ckeditor_templates/README.txt

   1 This module integrates the CKEditor templates plugin.
   2
   3 It provides a dialog to offer predefined content templates - with page layout,
   4 text formatting and styles. Thus, end users can easily insert pre-defined
   5 snippets of html in CKEditor fields.
   6
   7 AUDIENCE
   8 ---------
   9 This module is intended for themers who can manage custom ckeditor templates
  10 from their theme. As is, it doesn't provide any fonctionnality.
  11
  12 DEPENDENCIES
  13 -------------
  14 This module requires to install the CKEditor "Templates" plugin.
  15 HOW TO INSTALL :
  16 - Download the plugin on the project page : http://ckeditor.com/addon/templates
  17 - Create a libraries folder in your drupal root if it doesn't exist
  18 - Extract the plugin archive in the librairies folder
  19
  20 HOW TO USE
  21 -----------
  22 - First, you need to add the plugin button in your editor toolbar.
  23 Go to the format and editor config page and click configure on the format your
  24 want to edit :
  25 http://drupalvm.dev/admin/config/content/formats
  26 - Add the templates button to the toolbar
  27 - copy the file ckeditor_templates.js.example to your theme template folder,
  28 rename it without .example and customize it :
  29     x edit the image_path variable to link to you thumbnail folder
  30     x change the templates to you will be editing the templates array
  31
  32 That's it.
  33
  34 If you want to place your template file in a different folder, you can set the
  35 path on the Editor config page.
  36
  37 WARNING
  38 --------
  39 Depending on the configuration of your formats, CKEditor can be restrictive
  40 about authorized HTML tags. Make sure to use compatible HTML tags in your
  41 templates.
  42
  43 ROAD MAP
  44 ---------
  45 Two features could be added :
  46 - Allowing to add multiple template files so that you don't have to write all
  47 your templates in one big file
  48 - Allow to restrict for one editor the template displayed. Thus you could have
  49 10 templates in a file and display only 3 of them on a specific format.