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

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

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


Revision 1.16 - (show annotations) (download)
Sat Jan 20 15:07:36 2007 UTC (2 years, 10 months ago) by jasonm3m
Branch: MAIN
Changes since 1.15: +23 -8 lines
File MIME type: text/plain
updating the front page module read me text
1 $Id: README.txt,v 1.15 2006/09/18 11:46:58 jasonm3m Exp $
2
3 Introduction:
4
5 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.
8
9 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:
18
19 1. Allows you to specify a custom front page based on role type.
20
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
24 main drupal site - or alternatively as a THEMED full page, i.e. it loads with your default drupal site theme & layout.
25
26 4. Automatically REDIRECT users to a specific page or path.
27
28 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 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 7. Override your HOME and Breadcrumb links on your site.
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:
45 ---------------
46
47 1. Upload front_page.module to your MODULES folder.
48
49 2. Go to the ADMINISTER section of your drupal site.
50
51 3. Click on MODULES
52
53 4. Enable the front_page.module
54
55 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.
59
60 7. Once you are happy with your front_pages, set the DEFAULT FRONT PAGE setting to be front_page.
61
62
63 ############################################
64 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.
99
100 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
107
108
109 gus@modernmediamuse.com

  ViewVC Help
Powered by ViewVC 1.1.2