/[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.12, Thu Dec 8 14:45:40 2005 UTC revision 1.12.2.1, Tue Jul 10 04:36:08 2007 UTC
# Line 1  Line 1 
1  $Id: README.txt,v 1.11 2005/09/10 19:40:13 jasonm3m Exp $  $Id: README.txt,v 1.24 2007/01/22 19:44:27 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. I recommend drupal site administrators  The key functionality of this module is outlined below.
 look at SECTIONS.MODULE if you are looking to vary the theme/look of different sections of your site.  
8    
9  This module is intended for Drupal Version 4.7. It will not work with earlier versions.  If you are comfortable with theming using a mix of php/html, I recommend you check out the
10    handbook pages I have added to Drupal.org which explains how a more advanced method of theming
11    your front page. http://drupal.org/node/46017
12    
13    This module is intended for Drupal Version 5.0
14    It will not work with earlier versions.
15    
16    
17  Key Functionality:  Key Functionality:
18    
19  1. Allows you to specify a custom front page to your site for visitors who are not-logged in (Anonymous Users)  1. Allows you to specify a custom front page based on role type.
20  and an alternative front page to your site for users who are already logged in (Authenticatd Users).  
21    e.g. For a musicians website, you could have a different front page for Drummers, Guitarists, Singers, Bass Players etc.
22    
23  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
24  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.
25    
26  4. Allows you to automatically REDIRECT users to a specific page or path.  4. Automatically REDIRECT users to a specific page or path.
27    
28  5. You can include PHP/HTML or both in your frontpage  5. Disable your site for everyone but Administrators and display a custom "under maintenance" message.
29    
30    6. Display a custom "mission" style message for authenticated users who have not visited the site for a set period.
31    
32  ######### (update Sept. 10th 2005) #########  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
33    visited for 1 month, or 1 week etc.
34    
35  6. Updated to allow you to override the HOME links on your site including the breadcrumb HOME links.  7. Override your HOME and Breadcrumb links on your site.
    Useful if you have a splash page or flash intro on your site and when people click on HOME from within  
    your site they don't go back to that.  
36    
37  ############################################  e.g. you might have a splash front page that you don't want visitors already on your site returning to when they
38    click on HOME.
39    
40    8. You can include PHP/HTML or both in your frontpage
41    
42    
43    
44  Installation:  Installation:
45    ---------------
46    
47  1. Upload front_page.module to your MODULES folder.  1. Upload front_page.module to your MODULES folder.
48    
# Line 44  Installation: Line 52  Installation:
52    
53  4. Enable the front_page.module  4. Enable the front_page.module
54    
55  5. Go to ADMINISTER - SETTINGS - FRONT_PAGE  5(a). (Drupal 4.6.x and Drupal 4.7.x) Go to ADMINISTER - SETTINGS - FRONT_PAGE
56    5(b). (Drupal 5.x) Go to ADMINISTER - SITE CONGIFURATION - ADVANCED FRONT PAGE SETTINGS
57    
58  6. Paste in the TEXT/HTML/PHP contents of your front pages.  6. Paste in the TEXT/HTML/PHP contents of your front pages.
59    
60  7. To test your front_pages, use the following link http://www.example.com/?q=front_page  7. Once you are happy with your front_pages, set the DEFAULT FRONT PAGE setting to be front_page.
61    
62  8. Once you are happy with your front_pages, set the DEFAULT FRONT PAGE setting to be front_page.  
63     You can do this at the bottom of the front_page configuration page (ADMINISTER -> SETTINGS -> FRONT_PAGE)  ############################################
64     or under ADMINISTER -> SETTINGS.  IMPORTANT NOTE FOR THOSE USING PATH.MODULE (URL ALIAS):
65    Please ensure you have no other pages
66    setup with the URL ALIAS 'front_page' when
67    installing the front_page.module which uses the
68    'front_page' URL Alias by default.
69    ##############################################
70    
71    
72    PROMOTED TO FRONT PAGE Example snippet
73    ----------------------------------------
74    The default front page when you install Drupal for the first time, is 'node' which displays a list of node teasers, where
75    the nodes have been tagged as pages that are 'Promoted to Front Page'.
76    
77    If you want to recreate that node listing after installing the front_page.module, simply paste the following snippet into
78    the text area provided on the front_page settings page and select the PHP filter before saving your new configuration.
79    
80    <?php
81       print node_page_default();
82    ?>
83    
84    
85    
86    Uninstall:
87    -------------
88    
89    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').
90    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').
91    
92    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.
93    2(b) (Drupal 5.x) Go to ADMINISTER -> MODULES and de-select the front_page.module from your list of modules.
94    
95    3. Using FTP or other file manager, remove the front_page.module files and folder.
96    
97    
98  Hope you find it useful.  Hope you find it useful.
99    
100  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.  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    
106  Dublin Drupaller  Dublin Drupaller
107    
108    
109  dub@m3m.eu.com  gus@modernmediamuse.com

Legend:
Removed from v.1.12  
changed lines
  Added in v.1.12.2.1

  ViewVC Help
Powered by ViewVC 1.1.2