You are here

Home » API reference » Site Alert 7

README.txt in Site Alert 7

Same filename and directory in other branches
  1. 8 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * Using the module



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

Current Maintainer: cecrs
The Site Alert module is a lightweight solution for allowing
site administrators to easily place an alert on their site,
for example for maintenance downtime, or any general
informational message. Alerts have start and end date/times,
and can be assigned a severity level. Messages are refreshed by
ajax and not subject to site caching, so changes made in the
ui will be automatically displayed to users without
necessitating a cache clear. The module provides a custom pane
(recommended) and a block for sites not using panels.


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

Installation requires nothing more then enabling the site alert module.
Simple!


USING THE MODULE
----------------

To use with Panels:

Enable the Site Alert module
Add the pane to your desired page/variant.
It is located in the 'Page Elements' section.
Ensure that all necessary roles have the 'administer site alerts' permission.
(All roles can view alerts)
Create an alert (admin/config/system/alerts)
Enjoy your exciting new site alert!

To use the Block:

Enable the Site Alert module
Add the 'Site Alert' block to whichever region you wish it to appear in.
Ensure that all necessary roles have the 'administer site alerts' permission.
(All roles can view alerts)
Create an alert (admin/config/system/alerts)
Enjoy your exciting new site alert!

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3. 

  4.  * Introduction

  5.  * Installation

  6.  * Using the module

  7. 

  8. 

  9. 

  10. INTRODUCTION

  11. ------------

  12. 

  13. Current Maintainer: cecrs

  14. The Site Alert module is a lightweight solution for allowing

  15. site administrators to easily place an alert on their site,

  16. for example for maintenance downtime, or any general

  17. informational message. Alerts have start and end date/times,

  18. and can be assigned a severity level. Messages are refreshed by

  19. ajax and not subject to site caching, so changes made in the

  20. ui will be automatically displayed to users without

  21. necessitating a cache clear. The module provides a custom pane

  22. (recommended) and a block for sites not using panels.

  23. 

  24. 

  25. INSTALLATION

  26. ------------

  27. 

  28. Installation requires nothing more then enabling the site alert module.

  29. Simple!

  30. 

  31. 

  32. USING THE MODULE

  33. ----------------

  34. 

  35. To use with Panels:

  36. 

  37. Enable the Site Alert module

  38. Add the pane to your desired page/variant.

  39. It is located in the 'Page Elements' section.

  40. Ensure that all necessary roles have the 'administer site alerts' permission.

  41. (All roles can view alerts)

  42. Create an alert (admin/config/system/alerts)

  43. Enjoy your exciting new site alert!

  44. 

  45. To use the Block:

  46. 

  47. Enable the Site Alert module

  48. Add the 'Site Alert' block to whichever region you wish it to appear in.

  49. Ensure that all necessary roles have the 'administer site alerts' permission.

  50. (All roles can view alerts)

  51. Create an alert (admin/config/system/alerts)

  52. Enjoy your exciting new site alert!