modules/photoblog/README.txt

README file for the Photoblog Drupal module.


Description
***********

The Photoblog module provides simple photoblog-style features:

 * A single image per page.
 * Navigation links to the previous and next image (in chronological order).
 * Multiple photoblogs are possible by tagging posts with distinct categories.
 * Global photoblogs, or per-user photoblogs.
 * View the latest photoblog post on the site's frontpage.
 * A block with links to the latest post of each photoblog.

The accompanying Photoblog Views module hooks into Views to provide an "archive"
view: display photoblog posts by user, category, year, month, with corresponding
RSS feeds.

Of course, this module works with any kind of image. Photoblogs are only the
most common use for these features. Some other possible applications are online
slideshows and portfolios.

Why use this module when Views can provide something similar?

 * Simple previous/next navigation is more convenient than the standard pager.
 * Navigation links are permalinks (using node/nid, or corresponding url
   aliases if any).
 * Visitors can post comments in the same page as the photoblog posts, and
   without losing the navigation context.


Requirements
************

This module requires Drupal 5.

It also requires the following modules:

 * Image (http://drupal.org/project/image)
 * Taxonomy (part of the Drupal core)

The optional Photoblog Views module requires the following modules:

 * Views (http://drupal.org/project/views)
 * Views RSS (http://drupal.org/project/views)

The following modules are not required, but are recommended:

 * Comment (part of the Drupal core)
   Allow visitors to comment your photos.
 * Image Gallery (http://drupal.org/project/image)
   Cross-post in both your photoblog(s) and nicely organized galleries.
 * Tagadelic (http://drupal.org/project/tagadelic)
   Tag your posts with relevant keywords.
 * Exif (http://drupal.org/project/exif)
   Display shooting data along with each photo.
 * Pathauto (http://drupal.org/project/pathauto)
   Get nice url aliases effortlessly.
 * Scheduler (http://drupal.prg/project/scheduler)
   Prepare some posts in advance (and take a vacation).
 * Taxonomy Hide (http://drupal.org/project/taxonomy_hide)
   Hide those terms you may not really want to show along with each post, such as
   the photoblog and the image gallery terms.


Installation
************

1. Install and enable the required modules (following each module's installation
   instructions).

2. Extract the 'photoblog' module directory into your Drupal modules directory.

3. Enable the Photoblog module on your site's Administer > Site building >
   Modules page.

4. Go to Administer > User management > Access control, and give the "administer
   photoblogs" permission to those roles that need to be able to create
   photoblogs. Note that ordinary photobloggers need only the "create images"
   permission.

5. Go to Administer > Content management > Photoblogs, and add a photoblog. More
   than one photoblog is allowed, if you wish. Each will have its own series of
   photos.

6. Go to Administer > Site configuration > Photoblog, and:

   a. If you want your photoblog posts to occupy your site's front page, check
      "Automatically set the front page to latest post".

   b. Select the desired type of navigation.

      * If you want each user to have his own separate photoblogs, choose
        "Per-user".

      * If you want users to share common photoblogs, choose "Global". This is
        the default. If only one user is going to post, leave it as "Global".

   c. Select where you want to output the navigation links (previous/next links
      for each post). Choose the most appropriate for your theming needs. If
      unsure, choose "Links".

      * "Block" will create a block containing the links (you will need to
        enable the block in Administer > Site building > Blocks). "

      * "Content" will display the links along with the rest of each node's
        content.

      * "Links" will display the links as standard node links (same location as
        "read more" and "thumbnail" links, for example). This is the default.

7. Go to Administer > Site building > Blocks, and enable the "Photoblogs list"
   block. This is not really necessary if you have only one photoblog and have
   enabled "Automatically set the front page to latest post". This block
   provides easy entry points to your photoblogs, especially if you have more
   than one photoblog, or if the posts are not taken to the front page.

   The entry point of a photoblog will be either its first post or its latest
   post, depending on the photoblog's settings (in Administer > Content
   management > Photoblogs).

8. Optional: Install the Views module and enable Views, Views RSS and Photoblog
   Views. A "photoblog_posts" default view will become available. It supports
   user, category, year, month and "feed" arguments.

   See the Handbooks for more documentation about Views
   (http://drupal.org/node/54432).


Usage
*****

To post in your photoblog, simply create an image (with Create content > Image),
and select a photoblog in the content submission form. Only one photoblog is
allowed for any given image.

The image can still be assigned various tags, categories, or image
galleries. These won't interfere with the photoblog navigation.


Theming
*******

You may want to theme the previous/next links. This can be done by overriding
the theme_photoblog_prev() and theme_photoblog_next() functions (from
photoblog.module) in your theme's template.php. See the Handbooks on theming
(http://drupal.org/node/509).

If you are using Photoblog Views, you will also want to theme the default view's
appearance, because a list presentation is not really interesting for photos.
Some CSS work will be needed for this.


Credits
*******

David Lesieur, http://davidlesieur.com, http://drupal.org/user/17157


1	README file for the Photoblog Drupal module.
2
3
4	Description
5	***********
6
7	The Photoblog module provides simple photoblog-style features:
8
9	* A single image per page.
10	* Navigation links to the previous and next image (in chronological order).
11	* Multiple photoblogs are possible by tagging posts with distinct categories.
12	* Global photoblogs, or per-user photoblogs.
13	* View the latest photoblog post on the site's frontpage.
14	* A block with links to the latest post of each photoblog.
15
16	The accompanying Photoblog Views module hooks into Views to provide an "archive"
17	view: display photoblog posts by user, category, year, month, with corresponding
18	RSS feeds.
19
20	Of course, this module works with any kind of image. Photoblogs are only the
21	most common use for these features. Some other possible applications are online
22	slideshows and portfolios.
23
24	Why use this module when Views can provide something similar?
25
26	* Simple previous/next navigation is more convenient than the standard pager.
27	* Navigation links are permalinks (using node/nid, or corresponding url
28	aliases if any).
29	* Visitors can post comments in the same page as the photoblog posts, and
30	without losing the navigation context.
31
32
33	Requirements
34	************
35
36	This module requires Drupal 5.
37
38	It also requires the following modules:
39
40	* Image (http://drupal.org/project/image)
41	* Taxonomy (part of the Drupal core)
42
43	The optional Photoblog Views module requires the following modules:
44
45	* Views (http://drupal.org/project/views)
46	* Views RSS (http://drupal.org/project/views)
47
48	The following modules are not required, but are recommended:
49
50	* Comment (part of the Drupal core)
51	Allow visitors to comment your photos.
52	* Image Gallery (http://drupal.org/project/image)
53	Cross-post in both your photoblog(s) and nicely organized galleries.
54	* Tagadelic (http://drupal.org/project/tagadelic)
55	Tag your posts with relevant keywords.
56	* Exif (http://drupal.org/project/exif)
57	Display shooting data along with each photo.
58	* Pathauto (http://drupal.org/project/pathauto)
59	Get nice url aliases effortlessly.
60	* Scheduler (http://drupal.prg/project/scheduler)
61	Prepare some posts in advance (and take a vacation).
62	* Taxonomy Hide (http://drupal.org/project/taxonomy_hide)
63	Hide those terms you may not really want to show along with each post, such as
64	the photoblog and the image gallery terms.
65
66
67	Installation
68	************
69
70	1. Install and enable the required modules (following each module's installation
71	instructions).
72
73	2. Extract the 'photoblog' module directory into your Drupal modules directory.
74
75	3. Enable the Photoblog module on your site's Administer > Site building >
76	Modules page.
77
78	4. Go to Administer > User management > Access control, and give the "administer
79	photoblogs" permission to those roles that need to be able to create
80	photoblogs. Note that ordinary photobloggers need only the "create images"
81	permission.
82
83	5. Go to Administer > Content management > Photoblogs, and add a photoblog. More
84	than one photoblog is allowed, if you wish. Each will have its own series of
85	photos.
86
87	6. Go to Administer > Site configuration > Photoblog, and:
88
89	a. If you want your photoblog posts to occupy your site's front page, check
90	"Automatically set the front page to latest post".
91
92	b. Select the desired type of navigation.
93
94	* If you want each user to have his own separate photoblogs, choose
95	"Per-user".
96
97	* If you want users to share common photoblogs, choose "Global". This is
98	the default. If only one user is going to post, leave it as "Global".
99
100	c. Select where you want to output the navigation links (previous/next links
101	for each post). Choose the most appropriate for your theming needs. If
102	unsure, choose "Links".
103
104	* "Block" will create a block containing the links (you will need to
105	enable the block in Administer > Site building > Blocks). "
106
107	* "Content" will display the links along with the rest of each node's
108	content.
109
110	* "Links" will display the links as standard node links (same location as
111	"read more" and "thumbnail" links, for example). This is the default.
112
113	7. Go to Administer > Site building > Blocks, and enable the "Photoblogs list"
114	block. This is not really necessary if you have only one photoblog and have
115	enabled "Automatically set the front page to latest post". This block
116	provides easy entry points to your photoblogs, especially if you have more
117	than one photoblog, or if the posts are not taken to the front page.
118
119	The entry point of a photoblog will be either its first post or its latest
120	post, depending on the photoblog's settings (in Administer > Content
121	management > Photoblogs).
122
123	8. Optional: Install the Views module and enable Views, Views RSS and Photoblog
124	Views. A "photoblog_posts" default view will become available. It supports
125	user, category, year, month and "feed" arguments.
126
127	See the Handbooks for more documentation about Views
128	(http://drupal.org/node/54432).
129
130
131	Usage
132	*****
133
134	To post in your photoblog, simply create an image (with Create content > Image),
135	and select a photoblog in the content submission form. Only one photoblog is
136	allowed for any given image.
137
138	The image can still be assigned various tags, categories, or image
139	galleries. These won't interfere with the photoblog navigation.
140
141
142	Theming
143	*******
144
145	You may want to theme the previous/next links. This can be done by overriding
146	the theme_photoblog_prev() and theme_photoblog_next() functions (from
147	photoblog.module) in your theme's template.php. See the Handbooks on theming
148	(http://drupal.org/node/509).
149
150	If you are using Photoblog Views, you will also want to theme the default view's
151	appearance, because a list presentation is not really interesting for photos.
152	Some CSS work will be needed for this.
153
154
155	Credits
156	*******
157
158	David Lesieur, http://davidlesieur.com, http://drupal.org/user/17157
159
160