You are here

Home » API reference » Organigrams 7

README.txt in Organigrams 7

Same filename in this branch
  1. 7 README.txt
  2. 7 libraries/orgchart/README.txt
CONTENTS OF THIS FILE
----------------------

 * Introduction
 * Requirements
 * Plugins
 * Installation
 * Configuration
 * Browser support
 * References


INTRODUCTION
------------

Organigrams provides the ability to easily create and manage organization
charts, also knows as organigrams.

You can create organigram bundles (with own fields and display) and add
organigram items to that bundles. These items contain a static set of fields and
are not fieldable. An organigram will be available as dedicated page
(organigram/%organigram_machine_name) and as a block.

Organigrams are highly customizable. Almost every aspect can be modified,
from border and background colors to horizontal spacing between items.
In addition, most of these settings can be overridden per item.

An organigram is drawn in an HTML5 canvas and is supported by all major
browsers. See the section 'BROWSER SUPPORT' section for more information.

One of Organigrams' key features is responsiveness. When an organigram has a
fixed width it will divide its children over multiple rows to take the given
width into account.
When the width of an organigram is set to match the width of its parent element,
the organigram will redraw itself on window resize and rearrange its children if
necessary (provided the parent element has a dynamic width).

In short, organigrams are:

 * Highly customizable
 * Easy to manage for editors
 * Responsive
 * Supported by all major browsers


REQUIREMENTS
------------

This module requires the following modules:

 * Entity (https://www.drupal.org/project/entity)
   Organigrams and organigram items are entities so the entity API is needed.

 * Libraries (https://www.drupal.org/project/libraries)
   Needed to use external plugins.


PLUGINS
-------

 * ExplorerCanvas (excanvas)
   Provides HTML5 canvas support for Internet Explorer < 9.

   Steps:
   1. Download here: https://github.com/arv/ExplorerCanvas/archive/aa989ea.zip
   2. Place the contents of this zip in your libraries folder. See the readme of
      the libraries module for more information about this.
   3. Rename the extracted folder to 'excanvas' so the path to the javascript
      becomes 'libraries/excanvas/excanvas.js'.

 * ColorPicker by Evoluteur
   Adds a color picker to fields like border color and background color.

   Steps to enable this plugin:
   1. Download here:
      https://github.com/evoluteur/colorpicker/archive/233e15e.zip
   2. Place the contents of this zip in your libraries folder. See the readme of
      the libraries module for more information about this.
   3. Rename the extracted folder to 'colorpicker' so the path to the
      javascript becomes 'libraries/colorpicker/js/evol-colorpicker.min.js' and
      the path to the css becomes
      'libraries/colorpicker/css/evol-colorpicker.min.css'.


INSTALLATION
------------

Install as you would normally install a contributed Drupal module. See:
https://drupal.org/documentation/install/modules-themes/modules-7
for further information.

To enhance this module, several plugins are supported. See the 'PLUGINS'
section for more information.


CONFIGURATION
-------------

 * Create organigrams in Administration >> Structure >> Organigram.

 * Configure user permissions in Administration >> People >> Permissions:

   - Manage organigrams
     Administer all organigrams and items.

   - Edit organigram %organigram
     Edit the organigram and its items for a specific organigram.

   - Delete organigram %organigram
     Delete organigram items from a specific organigram.


BROWSER SUPPORT
---------------

Organigrams is tested in the following browsers:

 * Google Chrome version 43.0.2357.124
 * Mozilla Firefox version 40.0.3
 * Microsoft Internet Explorer > version 7 (ExplorerCanvas is required for
   IE < 9, see the 'PLUGINS' section for more information)


REFERENCES
----------

 * Based on the Organigram module by Frederic Hennequin, see:
   https://www.drupal.org/sandbox/daeron/1603000

 * Extended with an improved version of the orgchart library by J. van Loenen,
   see: https://jvloenen.home.xs4all.nl/orgchart

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ----------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Plugins

  7.  * Installation

  8.  * Configuration

  9.  * Browser support

  10.  * References

  11. 

  12. 

  13. INTRODUCTION

  14. ------------

  15. 

  16. Organigrams provides the ability to easily create and manage organization

  17. charts, also knows as organigrams.

  18. 

  19. You can create organigram bundles (with own fields and display) and add

  20. organigram items to that bundles. These items contain a static set of fields and

  21. are not fieldable. An organigram will be available as dedicated page

  22. (organigram/%organigram_machine_name) and as a block.

  23. 

  24. Organigrams are highly customizable. Almost every aspect can be modified,

  25. from border and background colors to horizontal spacing between items.

  26. In addition, most of these settings can be overridden per item.

  27. 

  28. An organigram is drawn in an HTML5 canvas and is supported by all major

  29. browsers. See the section 'BROWSER SUPPORT' section for more information.

  30. 

  31. One of Organigrams' key features is responsiveness. When an organigram has a

  32. fixed width it will divide its children over multiple rows to take the given

  33. width into account.

  34. When the width of an organigram is set to match the width of its parent element,

  35. the organigram will redraw itself on window resize and rearrange its children if

  36. necessary (provided the parent element has a dynamic width).

  37. 

  38. In short, organigrams are:

  39. 

  40.  * Highly customizable

  41.  * Easy to manage for editors

  42.  * Responsive

  43.  * Supported by all major browsers

  44. 

  45. 

  46. REQUIREMENTS

  47. ------------

  48. 

  49. This module requires the following modules:

  50. 

  51.  * Entity (https://www.drupal.org/project/entity)

  52.    Organigrams and organigram items are entities so the entity API is needed.

  53. 

  54.  * Libraries (https://www.drupal.org/project/libraries)

  55.    Needed to use external plugins.

  56. 

  57. 

  58. PLUGINS

  59. -------

  60. 

  61.  * ExplorerCanvas (excanvas)

  62.    Provides HTML5 canvas support for Internet Explorer < 9.

  63. 

  64.    Steps:

  65.    1. Download here: https://github.com/arv/ExplorerCanvas/archive/aa989ea.zip

  66.    2. Place the contents of this zip in your libraries folder. See the readme of

  67.       the libraries module for more information about this.

  68.    3. Rename the extracted folder to 'excanvas' so the path to the javascript

  69.       becomes 'libraries/excanvas/excanvas.js'.

  70. 

  71.  * ColorPicker by Evoluteur

  72.    Adds a color picker to fields like border color and background color.

  73. 

  74.    Steps to enable this plugin:

  75.    1. Download here:

  76.       https://github.com/evoluteur/colorpicker/archive/233e15e.zip

  77.    2. Place the contents of this zip in your libraries folder. See the readme of

  78.       the libraries module for more information about this.

  79.    3. Rename the extracted folder to 'colorpicker' so the path to the

  80.       javascript becomes 'libraries/colorpicker/js/evol-colorpicker.min.js' and

  81.       the path to the css becomes

  82.       'libraries/colorpicker/css/evol-colorpicker.min.css'.

  83. 

  84. 

  85. INSTALLATION

  86. ------------

  87. 

  88. Install as you would normally install a contributed Drupal module. See:

  89. https://drupal.org/documentation/install/modules-themes/modules-7

  90. for further information.

  91. 

  92. To enhance this module, several plugins are supported. See the 'PLUGINS'

  93. section for more information.

  94. 

  95. 

  96. CONFIGURATION

  97. -------------

  98. 

  99.  * Create organigrams in Administration >> Structure >> Organigram.

  100. 

  101.  * Configure user permissions in Administration >> People >> Permissions:

  102. 

  103.    - Manage organigrams

  104.      Administer all organigrams and items.

  105. 

  106.    - Edit organigram %organigram

  107.      Edit the organigram and its items for a specific organigram.

  108. 

  109.    - Delete organigram %organigram

  110.      Delete organigram items from a specific organigram.

  111. 

  112. 

  113. BROWSER SUPPORT

  114. ---------------

  115. 

  116. Organigrams is tested in the following browsers:

  117. 

  118.  * Google Chrome version 43.0.2357.124

  119.  * Mozilla Firefox version 40.0.3

  120.  * Microsoft Internet Explorer > version 7 (ExplorerCanvas is required for

  121.    IE < 9, see the 'PLUGINS' section for more information)

  122. 

  123. 

  124. REFERENCES

  125. ----------

  126. 

  127.  * Based on the Organigram module by Frederic Hennequin, see:

  128.    https://www.drupal.org/sandbox/daeron/1603000

  129. 

  130.  * Extended with an improved version of the orgchart library by J. van Loenen,

  131.    see: https://jvloenen.home.xs4all.nl/orgchart