You are here

Home » API reference » Site Status Message 8

README.txt in Site Status Message 8

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

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Customisation
 * The Future


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

Current Maintainer: Gideon Cresswell (SkidNCrashwell)
<https://www.drupal.org/u/skidncrashwell>

The Site Status Message is a simple module to display a site wide message to
your users at the top of each page. Use cases could be to inform of known
downtime in the future, to advertise a special offer on the site or some
important news that needs highlighting.

An optional link to a page with more information can be displayed after the
message.

It was completely inspired by the Drupal.org downtime message displayed October
2013 before the update of Drupal.org from Drupal 6 to Drupal 7.


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

None.


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

Install as usual, see
https://www.drupal.org/documentation/install/modules-themes/modules-7 (Druapl 7)
or https://www.drupal.org/documentation/install/modules-themes/modules-8 (Drupal
8) for further information.


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

The module can be configured on the Site Information (Drupal 7) or Basic site
settings (Drupal 8) configuration page at admin/config/system/site-information.
The message to be displayed can be up to 256 characters in length and the page
with more information can be an internal path (or external on the
Drupal 8 version) on the site. The message can optionally be displayed on all
the Admin pages of the site too.

If the message box is left blank, no message will be displayed.


CUSTOMISATION
-------------

The module ships with a template file that can be overridden in your own theme.

Copy the entire site-status-message.tpl.php (Drupal 7) or
site-status-message.html.twig (Drupal 8) into your theme directory to make
your own HTML changes.

On Drupal 7, further customisation can be made by copying the preprocess
function site_status_message_preprocess_site_status_message() to your
template.php and rename to THEME_preprocess_site_status_message().

A single CSS class #site-status is provided in the CSS file with the module
which can be overridden in your own CSS.


THE FUTURE
----------

In the future I would like to add these enhancements -

 * Allow external URLs to be used for the Read More link (Drupal 7)
 * Schedule messages
 * Show messages on specific site pages

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

  3. ---------------------

  4. 

  5.  * Introduction

  6.  * Requirements

  7.  * Installation

  8.  * Configuration

  9.  * Customisation

  10.  * The Future

  11. 

  12. 

  13. INTRODUCTION

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

  15. 

  16. Current Maintainer: Gideon Cresswell (SkidNCrashwell)

  17. 

  18. 

  19. The Site Status Message is a simple module to display a site wide message to

  20. your users at the top of each page. Use cases could be to inform of known

  21. downtime in the future, to advertise a special offer on the site or some

  22. important news that needs highlighting.

  23. 

  24. An optional link to a page with more information can be displayed after the

  25. message.

  26. 

  27. It was completely inspired by the Drupal.org downtime message displayed October

  28. 2013 before the update of Drupal.org from Drupal 6 to Drupal 7.

  29. 

  30. 

  31. REQUIREMENTS

  32. ------------

  33. 

  34. None.

  35. 

  36. 

  37. INSTALLATION

  38. ------------

  39. 

  40. Install as usual, see

  41. https://www.drupal.org/documentation/install/modules-themes/modules-7 (Druapl 7)

  42. or https://www.drupal.org/documentation/install/modules-themes/modules-8 (Drupal

  43. 8) for further information.

  44. 

  45. 

  46. CONFIGURATION

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

  48. 

  49. The module can be configured on the Site Information (Drupal 7) or Basic site

  50. settings (Drupal 8) configuration page at admin/config/system/site-information.

  51. The message to be displayed can be up to 256 characters in length and the page

  52. with more information can be an internal path (or external on the

  53. Drupal 8 version) on the site. The message can optionally be displayed on all

  54. the Admin pages of the site too.

  55. 

  56. If the message box is left blank, no message will be displayed.

  57. 

  58. 

  59. CUSTOMISATION

  60. -------------

  61. 

  62. The module ships with a template file that can be overridden in your own theme.

  63. 

  64. Copy the entire site-status-message.tpl.php (Drupal 7) or

  65. site-status-message.html.twig (Drupal 8) into your theme directory to make

  66. your own HTML changes.

  67. 

  68. On Drupal 7, further customisation can be made by copying the preprocess

  69. function site_status_message_preprocess_site_status_message() to your

  70. template.php and rename to THEME_preprocess_site_status_message().

  71. 

  72. A single CSS class #site-status is provided in the CSS file with the module

  73. which can be overridden in your own CSS.

  74. 

  75. 

  76. THE FUTURE

  77. ----------

  78. 

  79. In the future I would like to add these enhancements -

  80. 

  81.  * Allow external URLs to be used for the Read More link (Drupal 7)

  82.  * Schedule messages

  83.  * Show messages on specific site pages