/[drupal]/contributions/modules/front/README.txt
ViewVC logotype

Diff of /contributions/modules/front/README.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.16, Sat Jan 20 15:07:36 2007 UTC revision 1.17, Sat Jan 20 15:45:13 2007 UTC
# Line 1  Line 1 
1  $Id: README.txt,v 1.15 2006/09/18 11:46:58 jasonm3m Exp $  $Id: README.txt,v 1.12 2005/12/08 14:45:40 jasonm3m Exp $
2    
3  Introduction:  Introduction:
4    
5  This module is for people who want a custom front page to their Drupal sites.  This module is for people who want a custom front page to their Drupal sites.
6    
7  The key functionality of this module is outlined below.  The key functionality of this module is outlined below. I recommend drupal site administrators
8    look at SECTIONS.MODULE if you are looking to vary the theme/look of different sections of your site.
9    
10  If you are comfortable with theming using a mix of php/html, I recommend you check out the  This module is intended for Drupal Version 4.7. It will not work with earlier versions.
 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 5.0  
 It will not work with earlier versions.  
11    
12    
13  Key Functionality:  Key Functionality:
14    
15  1. Allows you to specify a custom front page based on role type.  1. Allows you to specify a custom front page to your site for visitors who are not-logged in (Anonymous Users)
16    and an alternative front page to your site for users who are already logged in (Authenticatd Users).
 e.g. For a musicians website, you could have a different front page for Drummers, Guitarists, Singers, Bass Players etc.  
17    
18  3. Allows you to have a FULL front page or SPLASH page - a completely different layout to your  3. Allows you to have a FULL front page or SPLASH page - a completely different layout to your
19  main drupal site - or alternatively as a THEMED full page, i.e. it loads with your default drupal site theme & layout.  main drupal site - or alternatively as a THEMED full page, i.e. it loads with your default drupal site theme & layout.
20    
21  4. Automatically REDIRECT users to a specific page or path.  4. Allows you to automatically REDIRECT users to a specific page or path.
22    
23  5. Disable your site for everyone but Administrators and display a custom "under maintenance" message.  5. You can include PHP/HTML or both in your frontpage
24    
 6. Display a custom "mission" style message for authenticated users who have not visited the site for a set period.  
25    
26  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  ######### (update Sept. 10th 2005) #########
 visited for 1 month, or 1 week etc.  
27    
28  7. Override your HOME and Breadcrumb links on your site.  6. Updated to allow you to override the HOME links on your site including the breadcrumb HOME links.
29       Useful if you have a splash page or flash intro on your site and when people click on HOME from within
30       your site they don't go back to that.
31    
32  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.  
33    
 8. You can include PHP/HTML or both in your frontpage  
34    
35    
36    
37  Installation:  Installation:
 ---------------  
38    
39  1. Upload front_page.module to your MODULES folder.  1. Upload front_page.module to your MODULES folder.
40    
# Line 52  Installation: Line 44  Installation:
44    
45  4. Enable the front_page.module  4. Enable the front_page.module
46    
47  5(a). (Drupal 4.6.x and Drupal 4.7.x) Go to ADMINISTER - SETTINGS - FRONT_PAGE  5. Go to ADMINISTER - SETTINGS - FRONT_PAGE
 5(b). (Drupal 5.x) Go to ADMINISTER - SITE CONGIFURATION - ADVANCED FRONT PAGE SETTINGS  
48    
49  6. Paste in the TEXT/HTML/PHP contents of your front pages.  6. Paste in the TEXT/HTML/PHP contents of your front pages.
50    
51  7. Once you are happy with your front_pages, set the DEFAULT FRONT PAGE setting to be front_page.  7. To test your front_pages, use the following link http://www.example.com/?q=front_page
   
   
 ############################################  
 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(a) (Drupal 4.6.x and Drupal 4.7.x)  Go to ADMINISTER -> SETTINGS and change the default front page to something other than 'front_page' (e.g. 'node').  
 1(b) (Drupal 5.x) Go to ADMINISTER -> SITE CONFIGURATION -> ADVANCED FRONT PAGE SETTINGS and change the default front page to something other than 'front_page' (e.g. 'node').  
52    
53  2(a) (Drupal 4.6.x and Drupal 4.7.x) Go to ADMINISTER -> MODULES and de-select the front_page.module from your list of modules.  8. Once you are happy with your front_pages, set the DEFAULT FRONT PAGE setting to be front_page.
54  2(b) (Drupal 5.x) Go to ADMINISTER -> MODULES and de-select the front_page.module from your list of modules.     You can do this at the bottom of the front_page configuration page (ADMINISTER -> SETTINGS -> FRONT_PAGE)
55       or under ADMINISTER -> SETTINGS.
56    
57  3. Using FTP or other file manager, remove the front_page.module files and folder.  
   
   
58  Hope you find it useful.  Hope you find it useful.
59    
60  This module has been developed by a few members of the drupal community and  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.
 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.  
61    
62  Dublin Drupaller  Dublin Drupaller
63    
64    
65  gus@modernmediamuse.com  dub@m3m.eu.com

Legend:
Removed from v.1.16  
changed lines
  Added in v.1.17

  ViewVC Help
Powered by ViewVC 1.1.2