You are here

Home » API reference » Regions 7

README.txt in Regions 7

Same filename in this branch
  1. 7 README.txt
  2. 7 modules/regions_top_nav/images/notifications/readme.txt
Same filename and directory in other branches
  1. 6 README.txt
ELMS: Regions
Development Sponsored by The Pennsylvania State University
The ELMS project name is Copyright (C) 2008-2014  The Pennsylvania State University

Bryan Ollendyke
bto108@psu.edu

12 Borland
University Park,  PA 16802

***** USAGE *****
This is intended to make it easier to define new regions and implement js / css files.  It provides no css / js by itself but helps in the reserving of name spaces of the regions so that they don't conflict with other css loaded on the page.

For example usage see elms_nav_right or review the API in regions.api.php which is very simple as this module does most of the heavily lifting in region creation.  Basic order of operations:
- Make a module based on the API
- Activate the module
- Go to block form or contexts and add blocks / boxes to the region

Because the API is so lightweight it will be easy to include reusable regions in features.  Here are some examples where you could use this with a feature:
-Add an image gallery and image node type where the images will be associated to image galleries via a CCK reference field.
-Make a view for displaying the gallery in a block
-Use context to tell the block from the view to display on the node type you want
-Style with CSS / JS then package it up as a Feature

Another good usage could be a standard contact form / block that's accessible from one of the edges of the screen and is consistent across various sites.  Feedback forms could also be tucked away in this manner and globally shared.

***** Notes *****
This module was inspired by Appbar and draws upon successes in that module in terms of region definition.

File

README.txt
View source 
  1. ELMS: Regions

  2. Development Sponsored by The Pennsylvania State University

  3. The ELMS project name is Copyright (C) 2008-2014  The Pennsylvania State University

  4. 

  5. Bryan Ollendyke

  6. bto108@psu.edu

  7. 

  8. 12 Borland

  9. University Park,  PA 16802

  10. 

  11. ***** USAGE *****

  12. This is intended to make it easier to define new regions and implement js / css files.  It provides no css / js by itself but helps in the reserving of name spaces of the regions so that they don't conflict with other css loaded on the page.

  13. 

  14. For example usage see elms_nav_right or review the API in regions.api.php which is very simple as this module does most of the heavily lifting in region creation.  Basic order of operations:

  15. - Make a module based on the API

  16. - Activate the module

  17. - Go to block form or contexts and add blocks / boxes to the region

  18. 

  19. Because the API is so lightweight it will be easy to include reusable regions in features.  Here are some examples where you could use this with a feature:

  20. -Add an image gallery and image node type where the images will be associated to image galleries via a CCK reference field.

  21. -Make a view for displaying the gallery in a block

  22. -Use context to tell the block from the view to display on the node type you want

  23. -Style with CSS / JS then package it up as a Feature

  24. 

  25. Another good usage could be a standard contact form / block that's accessible from one of the edges of the screen and is consistent across various sites.  Feedback forms could also be tucked away in this manner and globally shared.

  26. 

  27. ***** Notes *****

  28. This module was inspired by Appbar and draws upon successes in that module in terms of region definition.