You are here

Home » API reference » Copyright Block module 7

README.txt in Copyright Block module 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 7.2 README.txt
About "Copyright block"
=======================

Copyright block is a simple module to add a block to your Drupal installtion
to display the copyright holder. So this block will display something like

  "© My Drupal page 2011"

Installation
============

After you activated the module (at "admin/modules") you can put the block to
any region on your page (using "admin/structure/block").

Configuration
=============

The configuration is availabe after you added the block to your site. The
easiest way is to click the configure link next to the block. Alternatively
you can use this lengthy link:
"admin/structure/block/manage/copyright_block/copyright/configure"

You can configure two aspects of the block:

1. Copyright holder

The copyright holder is the name that will be displayed next to the copyright
year. By default it will show the name of your Drupal installation (configured
at "admin/config/system/site-information"). This can be overridden in the
configuration of this module.

The variable used to store the value is "copyright_block_copyrightholder"

2. Copyright starting year

The copyright starting year is the year the copyright starts. By default only
the current year will be shown. If the copyright started in the past you can
add this information. Adding the year will change the display to something
like

  "© My Drupal page 2008-2011"

The variable used to store the value is "copyright_block_inceptionyear"

You are also allowed to configure the display of the copyright block

1. Display template

This allows you to change the overall display of the copyright block. By
default it will display the holder followed by the year. This is done using
two simple replacements. The value "[holder] [year]" contains the placeholders

"[holder]": This will be replaced by the value of the copyright holder (see
above).

"[year]": This will be replaced by the current year (or by the year range if a
starting year is set)

2. Spacer template

You can configure the spacer template that will be used to seperate two years.
It will be used only if the copyright starting year is set and is different
from the current year.

File

README.txt
View source 
  1. About "Copyright block"

  2. =======================

  3. 

  4. Copyright block is a simple module to add a block to your Drupal installtion

  5. to display the copyright holder. So this block will display something like

  6. 

  7.   "© My Drupal page 2011"

  8. 

  9. Installation

  10. ============

  11. 

  12. After you activated the module (at "admin/modules") you can put the block to

  13. any region on your page (using "admin/structure/block").

  14. 

  15. Configuration

  16. =============

  17. 

  18. The configuration is availabe after you added the block to your site. The

  19. easiest way is to click the configure link next to the block. Alternatively

  20. you can use this lengthy link:

  21. "admin/structure/block/manage/copyright_block/copyright/configure"

  22. 

  23. You can configure two aspects of the block:

  24. 

  25. 1. Copyright holder

  26. 

  27. The copyright holder is the name that will be displayed next to the copyright

  28. year. By default it will show the name of your Drupal installation (configured

  29. at "admin/config/system/site-information"). This can be overridden in the

  30. configuration of this module.

  31. 

  32. The variable used to store the value is "copyright_block_copyrightholder"

  33. 

  34. 2. Copyright starting year

  35. 

  36. The copyright starting year is the year the copyright starts. By default only

  37. the current year will be shown. If the copyright started in the past you can

  38. add this information. Adding the year will change the display to something

  39. like

  40. 

  41.   "© My Drupal page 2008-2011"

  42. 

  43. The variable used to store the value is "copyright_block_inceptionyear"

  44. 

  45. You are also allowed to configure the display of the copyright block

  46. 

  47. 1. Display template

  48. 

  49. This allows you to change the overall display of the copyright block. By

  50. default it will display the holder followed by the year. This is done using

  51. two simple replacements. The value "[holder] [year]" contains the placeholders

  52. 

  53. "[holder]": This will be replaced by the value of the copyright holder (see

  54. above).

  55. 

  56. "[year]": This will be replaced by the current year (or by the year range if a

  57. starting year is set)

  58. 

  59. 2. Spacer template

  60. 

  61. You can configure the spacer template that will be used to seperate two years.

  62. It will be used only if the copyright starting year is set and is different

  63. from the current year.