You are here

Home » API reference » Publication Date 7

README.txt in Publication Date 7

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 8 README.txt
  3. 6 README.txt
  4. 7.2 README.txt
README
--------------------------------------------------------------------------
The Publication Date module adds a field to each node containing the date when
it was first published.

This published date field can be used in any templates, or views, and integrates
well with the Scheduler module: <http://drupal.org/project/scheduler>

Without this, the only dates available for nodes are their created date and
changed date, but these are often insufficient to meet the needs of publishing
workflows. Sorting nodes by their created date doesn't account for content which
is held in draft form for a time while being readied for publication. Sorting
nodes by their changed date fails to account for content needing minor
corrections after being published.

The "Published on" date can be edited through the node edit form, allowing a
custom published date to be set. If a custom date is set prior to publication,
it will be respected when the node is published. The publication date is also
retained when a node is unpublished and then republished.


INSTALLATION
--------------------------------------------------------------------------
1. Copy the publication_date folder to your modules directory
2. Go to admin > Site building > Modules, and enable this module.

This will add a new $node->published_at field to nodes, containing the published
date, or 'false' if no published date has been set. You can then use this field
in any templates. Moreover, this field is available in the views parameters.

IMPORTANT: For nodes that were published BEFORE the installation of this module,
we can not know the exact date of publication, so $node->published_at will
initially contain the creation date.


API
--------------------------------------------------------------------------
Other modules can use hook_publication_date_alter() to change the publication
date when it is set. See publication_date.api.php for more documentation.


CREDITS
--------------------------------------------------------------------------
The Publication Date module was originally written by Emmanuelle Gouleau and
Tristan Marly from Clever Age: http://www.clever-age.org

The initial D7 Port was by Joost van der Locht

File

README.txt
View source 
  1. 

  2. README

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

  4. The Publication Date module adds a field to each node containing the date when

  5. it was first published.

  6. 

  7. This published date field can be used in any templates, or views, and integrates

  8. well with the Scheduler module: 

  9. 

  10. Without this, the only dates available for nodes are their created date and

  11. changed date, but these are often insufficient to meet the needs of publishing

  12. workflows. Sorting nodes by their created date doesn't account for content which

  13. is held in draft form for a time while being readied for publication. Sorting

  14. nodes by their changed date fails to account for content needing minor

  15. corrections after being published.

  16. 

  17. The "Published on" date can be edited through the node edit form, allowing a

  18. custom published date to be set. If a custom date is set prior to publication,

  19. it will be respected when the node is published. The publication date is also

  20. retained when a node is unpublished and then republished.

  21. 

  22. 

  23. INSTALLATION

  24. --------------------------------------------------------------------------

  25. 1. Copy the publication_date folder to your modules directory

  26. 2. Go to admin > Site building > Modules, and enable this module.

  27. 

  28. This will add a new $node->published_at field to nodes, containing the published

  29. date, or 'false' if no published date has been set. You can then use this field

  30. in any templates. Moreover, this field is available in the views parameters.

  31. 

  32. IMPORTANT: For nodes that were published BEFORE the installation of this module,

  33. we can not know the exact date of publication, so $node->published_at will

  34. initially contain the creation date.

  35. 

  36. 

  37. API

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

  39. Other modules can use hook_publication_date_alter() to change the publication

  40. date when it is set. See publication_date.api.php for more documentation.

  41. 

  42. 

  43. CREDITS

  44. --------------------------------------------------------------------------

  45. The Publication Date module was originally written by Emmanuelle Gouleau and

  46. Tristan Marly from Clever Age: http://www.clever-age.org

  47. 

  48. The initial D7 Port was by Joost van der Locht