www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/layouter/README.md

   1 CONTENTS OF THIS FILE
   2 ---------------------
   3
   4  * Introduction
   5  * Requirements
   6  * Installation
   7  * Configuration
   8  * Troubleshooting
   9  * For developers
  10  * Maintainers
  11
  12 INTRODUCTION
  13 ------------
  14
  15   Usually people use one of the WYSIWYG editors for adding/editing content on
  16   the websites. But they are not very easy to use for many of them in some
  17   cases. If you ever wondered how to put the content on the page formatted in
  18   some fancy way (something like two columns of text, for instance) without much
  19   burden, and if you don't know how to do that in you editor, feel free to try
  20   this module.
  21
  22   * For a full description of the module, visit the project page:
  23   https://drupal.org/project/layouter
  24
  25   * To submit bug reports and feature suggestions, or to track changes:
  26   https://drupal.org/project/issues/layouter
  27
  28 REQUIREMENTS
  29 ------------
  30
  31   This module requires the following modules:
  32
  33     * Filter
  34     * Image
  35
  36 INSTALLATION
  37 ------------
  38
  39  * Install as you would normally install a contributed Drupal module. See:
  40    https://drupal.org/documentation/install/modules-themes/modules-8
  41    for further information.
  42
  43  * Also you'll need to go to "_Administration_ » _People_ » _Permissions_"
  44    (/admin/people/permissions#module-layouter)and choose users of which roles
  45    are allowed to use Layouter for content editing. That's all, now you can go
  46    and create some content.
  47
  48 CONFIGURATION
  49 -------------
  50
  51   * Configure allowed content types for this module in
  52    "_Administration_ » _Configuration_ » _Content authoring_ » _Layouter_"
  53    (/admin/config/content/layouter)
  54
  55   * Configure user permissions in "_Administration_ » _People_ » _Permissions_"
  56     (/admin/people/permissions#module-layouter)
  57
  58     - Administer layouter
  59
  60         Users in roles with the "Administer layouter" may go to admin page and
  61         configure module settings.
  62
  63     - Use layouter
  64
  65         User in roles with the "Use layouter" may use Layouter for editing
  66         content.
  67
  68 TROUBLESHOOTING
  69 ---------------
  70
  71   * If you don't see needed text format on module admin page make sure that
  72     it has disabled html filter. Go to "_Administration_ » _Configuration_ »
  73     _Content authoring_ » _Text formats and editors_" and click to _Configure_
  74     button of your format. Then find "_Enable filters_" section and disable html
  75     filter.
  76
  77 FOR DEVELOPERS
  78 --------------
  79
  80   You can extend this module with your custom layout templates. See
  81   layouter_extension_example module for more instructions.
  82
  83 MAINTAINERS
  84 -----------
  85
  86   This module developed by ADCI Solutions team.
  87
  88   * https://www.drupal.org/adci-solutions
  89
  90   * http://www.adcisolutions.com