modules/thisdayinhistory/README.txt

Drupal thisdayinhistory.module README.txt
==============================================================================

This module provides configurable blocks displaying past events that happened
on today's date (i.e., month/day). For example, if today was January 6th, it
might display the birth of Joan of Arc (born January 6, 1412).

BLOCKS:
- Any number of blocks can be created
- Events can be selected by taxonomy term, user, role and/or randomly
- A 'promote to block' field is also provided for content selection

EVENT IMPORTING:
Support for importing events is provided if the Node Import module is
installed.

PERMISSIONS:
The following permissions are provided:
- Administer
- Create
- Edit own
- Promote to block


Administration
------------------------------------------------------------------------------
Add/Delete/Configure Blocks:
  Administer > Site configuration > This Day in History > Configure blocks

Permissions:
  Administer  User management > Access control


Content Management
------------------------------------------------------------------------------
This Day in History module content consists of the Historical event node
type. Historical events are Drupal nodes and managed through standard
Drupal content management methods.

A Historical Event has the following fields:
- Title
- Date (Year / Month / Day)
- Event
- Promote to block


Notes on the Theming
------------------------------------------------------------------------------
- Blocks output the node teaser
- The blocks are designed for relatively short event descriptions. If you
  choose to go with longer events descriptions, you'll likely need custom
  block theming.
- The blocks don't use the node title in their output. This allows you to
  use the tolken module to create descriptive titles based on content if you 
  so choose.
- Theme functions are provided for full control of the block HTML.


Custom Block Theming
------------------------------------------------------------------------------
Changed in Drupal 6. Updated instructions coming.


Importing Content
------------------------------------------------------------------------------
Content importing is provided via the node_import module, which must be
installed seperately. The node_import module is available at:

  http://drupal.org/project/node_import

Importing notes:
- Content can be imported from a comma or tab seperated file
- The import_node module does not individually validate nodes, so it is
  possible to import content with an invalid date
- Four different date formats are supported:
    * yyyy-mm-dd    (e.g.: 2007-10-31 )
    * d/mm/yyyy     (e.g.: 31/10/2007 )
    * mm/d/yyyy     (e.g.: 10/31/2007 )
    * mmm d, yyyy   (e.g.: Oct 31, 2007 ) 
- The node_import module supports importing taxonomy


Date Support Notes
------------------------------------------------------------------------------
Drupal uses the native PHP date support, which is limited in the range of
years it can handle. The exact range depends on a number of factors. Some
modules are using the adodb date library to work around this. Unfortunately,
this is a seperate installation.

Since the "This Day in History" module has modest date handling requirements,
primarily on the display side, I've decided to not to require any additional
libraries. This means the date display is not configurable without custom
theming and data entry of the date field is more rigid than it would have
otherwise been.


Credits / Acknowledgements
------------------------------------------------------------------------------
The Quotes module provided much of starting point for this module. My thanks
go to authors and maintainers of that module.


Author / Maintainer
------------------------------------------------------------------------------
Dale McGladdery
dale at group42 dot ca
1	Drupal thisdayinhistory.module README.txt
2	==============================================================================
3
4	This module provides configurable blocks displaying past events that happened
5	on today's date (i.e., month/day). For example, if today was January 6th, it
6	might display the birth of Joan of Arc (born January 6, 1412).
7
8	BLOCKS:
9	- Any number of blocks can be created
10	- Events can be selected by taxonomy term, user, role and/or randomly
11	- A 'promote to block' field is also provided for content selection
12
13	EVENT IMPORTING:
14	Support for importing events is provided if the Node Import module is
15	installed.
16
17	PERMISSIONS:
18	The following permissions are provided:
19	- Administer
20	- Create
21	- Edit own
22	- Promote to block
23
24
25	Administration
26	------------------------------------------------------------------------------
27	Add/Delete/Configure Blocks:
28	Administer > Site configuration > This Day in History > Configure blocks
29
30	Permissions:
31	Administer User management > Access control
32
33
34	Content Management
35	------------------------------------------------------------------------------
36	This Day in History module content consists of the Historical event node
37	type. Historical events are Drupal nodes and managed through standard
38	Drupal content management methods.
39
40	A Historical Event has the following fields:
41	- Title
42	- Date (Year / Month / Day)
43	- Event
44	- Promote to block
45
46
47	Notes on the Theming
48	------------------------------------------------------------------------------
49	- Blocks output the node teaser
50	- The blocks are designed for relatively short event descriptions. If you
51	choose to go with longer events descriptions, you'll likely need custom
52	block theming.
53	- The blocks don't use the node title in their output. This allows you to
54	use the tolken module to create descriptive titles based on content if you
55	so choose.
56	- Theme functions are provided for full control of the block HTML.
57
58
59	Custom Block Theming
60	------------------------------------------------------------------------------
61	Changed in Drupal 6. Updated instructions coming.
62
63
64	Importing Content
65	------------------------------------------------------------------------------
66	Content importing is provided via the node_import module, which must be
67	installed seperately. The node_import module is available at:
68
69	http://drupal.org/project/node_import
70
71	Importing notes:
72	- Content can be imported from a comma or tab seperated file
73	- The import_node module does not individually validate nodes, so it is
74	possible to import content with an invalid date
75	- Four different date formats are supported:
76	* yyyy-mm-dd (e.g.: 2007-10-31 )
77	* d/mm/yyyy (e.g.: 31/10/2007 )
78	* mm/d/yyyy (e.g.: 10/31/2007 )
79	* mmm d, yyyy (e.g.: Oct 31, 2007 )
80	- The node_import module supports importing taxonomy
81
82
83	Date Support Notes
84	------------------------------------------------------------------------------
85	Drupal uses the native PHP date support, which is limited in the range of
86	years it can handle. The exact range depends on a number of factors. Some
87	modules are using the adodb date library to work around this. Unfortunately,
88	this is a seperate installation.
89
90	Since the "This Day in History" module has modest date handling requirements,
91	primarily on the display side, I've decided to not to require any additional
92	libraries. This means the date display is not configurable without custom
93	theming and data entry of the date field is more rigid than it would have
94	otherwise been.
95
96
97	Credits / Acknowledgements
98	------------------------------------------------------------------------------
99	The Quotes module provided much of starting point for this module. My thanks
100	go to authors and maintainers of that module.
101
102
103	Author / Maintainer
104	------------------------------------------------------------------------------
105	Dale McGladdery
106	dale at group42 dot ca