modules/front/README.txt

$Id: README.txt,v 1.25 2007/08/15 02:49:47 augustin Exp $

Introduction
================

This module is for people who want a custom front page to their Drupal sites.

The key functionality of this module is outlined below. 

If you are comfortable with theming using a mix of php/html, I recommend you check out the
handbook pages I have added to Drupal.org which explains how a more advanced method of theming
your front page. http://drupal.org/node/46017 

This module is intended for Drupal Version 6.x 
It will not work with earlier versions.


Key Functionality
=====================

1. Allows you to specify a custom front page based on role type.

e.g. For a musicians website, you could have a different front page for Drummers, Guitarists, Singers, Bass Players etc.

3. Allows you to have a FULL front page or SPLASH page - a completely different layout to your 
main drupal site - or alternatively as a THEMED full page, i.e. it loads with your default drupal site theme & layout.

4. Automatically REDIRECT users to a specific page or path.

5. Disable your site for everyone but Administrators and display a custom "under maintenance" message.

6. Display a custom "mission" style message for authenticated users who have not visited the site for a set period.

e.g. If you have had a significant update to the site, you might want to have a special notice for users who haven't 
visited for 1 month, or 1 week etc.

7. Override your HOME and Breadcrumb links on your site.

e.g. you might have a splash front page that you don't want visitors already on your site returning to when they
click on HOME.

8. You can include PHP/HTML or both in your frontpage


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

1. Upload or copy the 'front' directory and its content to your MODULES folder.

2. Go to the ADMINISTER section of your drupal site.

3. Click on MODULES

4. Enable the front_page.module

5 Go to ADMINISTER - SITE CONGIFURATION - ADVANCED FRONT PAGE SETTINGS

6. Paste in the TEXT/HTML/PHP contents of your front pages. 

7. Once you are happy with your front_pages, set the DEFAULT FRONT PAGE setting to be front_page. 
    
8. Go to ADMINISTER - USER MANAGEMENT - PERMISSIONS and enable ACCESS FRONT PAGE for anonymous/authenticated users.  
   
############################################
IMPORTANT NOTE FOR THOSE USING PATH.MODULE (URL ALIAS):
Please ensure you have no other pages 
setup with the URL ALIAS 'front_page' when
installing the front_page.module which uses the
'front_page' URL Alias by default.
##############################################  


PROMOTED TO FRONT PAGE Example snippet
=======================================
The default front page when you install Drupal for the first time, is 'node' which displays a list of node teasers, where
the nodes have been tagged as pages that are 'Promoted to Front Page'. 

If you want to recreate that node listing after installing the front_page.module, simply paste the following snippet into 
the text area provided on the front_page settings page and select the PHP filter before saving your new configuration.  

<?php
   print node_page_default();
?>

   
Uninstall
=========

1. Go to ADMINISTER -> SITE CONFIGURATION -> ADVANCED FRONT PAGE SETTINGS and change the default front page to something other than 'front_page' (e.g. 'node').

2. Go to ADMINISTER -> MODULES and de-select the front_page.module from your list of modules.

3. Using FTP or other file manager, remove the front_page.module files and folder.

  
Hope you find it useful. 

This module has been developed by a few members of the drupal community and 
we're always looking for ideas for improving it. 

Email me or post a message on the drupal.org site if you have any ideas on 
how we can improve the module. 

Dublin Drupaller


dub@dublindrupaller.com
1	augustin	1.26	$Id: README.txt,v 1.25 2007/08/15 02:49:47 augustin Exp $
2	jasonm3m	1.9
3	augustin	1.26	Introduction
4			================
5	uwe	1.1
6	jasonm3m	1.3	This module is for people who want a custom front page to their Drupal sites.
7
8	jasonm3m	1.18	The key functionality of this module is outlined below.
9	jasonm3m	1.5
10	jasonm3m	1.18	If you are comfortable with theming using a mix of php/html, I recommend you check out the
11			handbook pages I have added to Drupal.org which explains how a more advanced method of theming
12			your front page. http://drupal.org/node/46017
13
14	augustin	1.26	This module is intended for Drupal Version 6.x
15	jasonm3m	1.18	It will not work with earlier versions.
16	jasonm3m	1.3
17
18	augustin	1.26	Key Functionality
19			=====================
20	jasonm3m	1.3
21	jasonm3m	1.18	1. Allows you to specify a custom front page based on role type.
22
23			e.g. For a musicians website, you could have a different front page for Drummers, Guitarists, Singers, Bass Players etc.
24	jasonm3m	1.3
25	jasonm3m	1.11	3. Allows you to have a FULL front page or SPLASH page - a completely different layout to your
26			main drupal site - or alternatively as a THEMED full page, i.e. it loads with your default drupal site theme & layout.
27	jasonm3m	1.10
28	jasonm3m	1.18	4. Automatically REDIRECT users to a specific page or path.
29	jasonm3m	1.3
30	jasonm3m	1.18	5. Disable your site for everyone but Administrators and display a custom "under maintenance" message.
31	jasonm3m	1.3
32	jasonm3m	1.18	6. Display a custom "mission" style message for authenticated users who have not visited the site for a set period.
33	jasonm3m	1.4
34	jasonm3m	1.18	e.g. If you have had a significant update to the site, you might want to have a special notice for users who haven't
35			visited for 1 month, or 1 week etc.
36	jasonm3m	1.7
37	jasonm3m	1.18	7. Override your HOME and Breadcrumb links on your site.
38	jasonm3m	1.4
39	jasonm3m	1.18	e.g. you might have a splash front page that you don't want visitors already on your site returning to when they
40			click on HOME.
41	jasonm3m	1.3
42	jasonm3m	1.18	8. You can include PHP/HTML or both in your frontpage
43	jasonm3m	1.5
44
45
46	augustin	1.26	Installation
47			===============
48	jasonm3m	1.3
49	augustin	1.25	1. Upload or copy the 'front' directory and its content to your MODULES folder.
50	jasonm3m	1.3
51			2. Go to the ADMINISTER section of your drupal site.
52
53			3. Click on MODULES
54
55	jasonm3m	1.21	4. Enable the front_page.module
56	jasonm3m	1.3
57	augustin	1.26	5 Go to ADMINISTER - SITE CONGIFURATION - ADVANCED FRONT PAGE SETTINGS
58	jasonm3m	1.3
59	jasonm3m	1.11	6. Paste in the TEXT/HTML/PHP contents of your front pages.
60	jasonm3m	1.6
61	jasonm3m	1.21	7. Once you are happy with your front_pages, set the DEFAULT FRONT PAGE setting to be front_page.
62	jasonm3m	1.18
63	augustin	1.26	8. Go to ADMINISTER - USER MANAGEMENT - PERMISSIONS and enable ACCESS FRONT PAGE for anonymous/authenticated users.
64	jasonm3m	1.18
65			############################################
66			IMPORTANT NOTE FOR THOSE USING PATH.MODULE (URL ALIAS):
67			Please ensure you have no other pages
68	jasonm3m	1.21	setup with the URL ALIAS 'front_page' when
69			installing the front_page.module which uses the
70			'front_page' URL Alias by default.
71	jasonm3m	1.18	##############################################
72
73
74			PROMOTED TO FRONT PAGE Example snippet
75	augustin	1.26	=======================================
76	jasonm3m	1.18	The default front page when you install Drupal for the first time, is 'node' which displays a list of node teasers, where
77			the nodes have been tagged as pages that are 'Promoted to Front Page'.
78
79	jasonm3m	1.21	If you want to recreate that node listing after installing the front_page.module, simply paste the following snippet into
80			the text area provided on the front_page settings page and select the PHP filter before saving your new configuration.
81	jasonm3m	1.18
82			<?php
83			print node_page_default();
84			?>
85
86
87
88	augustin	1.26	Uninstall
89			=========
90	jasonm3m	1.18
91	augustin	1.26	1. Go to ADMINISTER -> SITE CONFIGURATION -> ADVANCED FRONT PAGE SETTINGS and change the default front page to something other than 'front_page' (e.g. 'node').
92	jasonm3m	1.17
93	augustin	1.26	2. Go to ADMINISTER -> MODULES and de-select the front_page.module from your list of modules.
94	jasonm3m	1.16
95	jasonm3m	1.21	3. Using FTP or other file manager, remove the front_page.module files and folder.
96	jasonm3m	1.18
97
98	jasonm3m	1.7	Hope you find it useful.
99
100	jasonm3m	1.18	This module has been developed by a few members of the drupal community and
101			we're always looking for ideas for improving it.
102
103			Email me or post a message on the drupal.org site if you have any ideas on
104			how we can improve the module.
105	jasonm3m	1.3
106	jasonm3m	1.5	Dublin Drupaller
107	jasonm3m	1.7
108	jasonm3m	1.3
109	augustin	1.26	dub@dublindrupaller.com