| 1 |
// $Id: INSTALL.txt,v 1.16 2007/10/21 16:31:10 agentken Exp $
|
| 2 |
|
| 3 |
--------------------------------------------------------------------------------
|
| 4 |
INSTALL.txt for MySite version 5.x.2
|
| 5 |
--------------------------------------------------------------------------------
|
| 6 |
Drupal version: 5.x
|
| 7 |
|
| 8 |
Author: Ken Rickard
|
| 9 |
Email: agentrickard [at] gmail [dot] com
|
| 10 |
Drupal: agentrickard
|
| 11 |
CVS: agentken
|
| 12 |
IRC: agentrickard
|
| 13 |
|
| 14 |
=======
|
| 15 |
CONTENTS
|
| 16 |
=======
|
| 17 |
|
| 18 |
1. INSTALLATION
|
| 19 |
1.1 Database Tables
|
| 20 |
2. UPGRADING
|
| 21 |
2.1 Deprecated Files
|
| 22 |
2.2 Database Schema
|
| 23 |
2.3 Plugin API Changes
|
| 24 |
3. DEPENDENCIES
|
| 25 |
3.1 jQuery Update
|
| 26 |
3.2 jQuery Interface
|
| 27 |
3.3 MySite without JavaScript
|
| 28 |
4. MYSITE ICONS MODULE
|
| 29 |
4.1 Installing
|
| 30 |
4.2 Database Table
|
| 31 |
5 MYSITE FILES
|
| 32 |
5.1 Plugin Directories
|
| 33 |
5.2 Directory and File List
|
| 34 |
6. INSTALL CHECKLIST
|
| 35 |
|
| 36 |
|
| 37 |
--------
|
| 38 |
1. INSTALLATION
|
| 39 |
|
| 40 |
MySite uses the standard Drupal 5 install system. Simply unpack the tarball and put the mysite folder into your modules directory. Then navigate to Administer >> Site Building >> Modules and activate the MySite module.
|
| 41 |
|
| 42 |
After installation, you should check the Access Control settings and configure the module for use. See the README.txt for details and options.
|
| 43 |
|
| 44 |
----
|
| 45 |
1.1 Database Tables
|
| 46 |
|
| 47 |
MySite will install the following tables in your Drupal database:
|
| 48 |
|
| 49 |
{mysite}
|
| 50 |
{mysite_content}
|
| 51 |
{mysite_data}
|
| 52 |
|
| 53 |
--------
|
| 54 |
2. UPGRADING
|
| 55 |
|
| 56 |
Users of MySite 5.x.1.x must run Drupal's updater after installing MySite 5.x.2.
|
| 57 |
|
| 58 |
Users of any version of MySite 4.7.x. must run Drupal's updater after installing MySite 5.x.2. There is a new database table -- {mysite_content} -- and several database schema changes.
|
| 59 |
|
| 60 |
----
|
| 61 |
2.1 Deprecated Files
|
| 62 |
|
| 63 |
All current users should delete the following files; they have been deprecated:
|
| 64 |
|
| 65 |
mysite/plugins/styles/blue.css
|
| 66 |
mysite/plugins/styles/red.css
|
| 67 |
|
| 68 |
If your users have selected these styles, their settings will be replaced by the new "sky.css" and "fire.css" files when you run the database upgrade script.
|
| 69 |
|
| 70 |
----
|
| 71 |
2.2 Database Schema
|
| 72 |
|
| 73 |
The current version of the MySite database schema is version 7.
|
| 74 |
|
| 75 |
----
|
| 76 |
2.3 Plugin API Changes
|
| 77 |
|
| 78 |
For users who have written custom plugins, you may need to revise your code
|
| 79 |
to match changes in the API.
|
| 80 |
|
| 81 |
There have been substantial changes to the Format, Layout, and Style plugins.
|
| 82 |
|
| 83 |
Type plugins have changed in subtle ways and may not work in MySite 5.x.2
|
| 84 |
as they did in MySite 5.x.1. See section 7 of the README for notes.
|
| 85 |
|
| 86 |
For details on the API, see http://therickards.com/api.
|
| 87 |
|
| 88 |
--------
|
| 89 |
3. DEPENDENCIES
|
| 90 |
|
| 91 |
In order to provide a shared library of functions, MySite uses other modules to provide advanced JavaScript functions. If you do not install these modules, MySite will still work correctly. However, without these modules drag-and-drop sorting of content is not supported.
|
| 92 |
|
| 93 |
----
|
| 94 |
3.1 jQuery Update
|
| 95 |
|
| 96 |
Download and install the jQuery Update module from:
|
| 97 |
|
| 98 |
http://drupal.org/project/jquery_update
|
| 99 |
|
| 100 |
This module upgrades Drupal's jQuery file from version 1.0 to the newest release, which is required by the jQuery Interface library.
|
| 101 |
|
| 102 |
----
|
| 103 |
3.2 jQuery Interface
|
| 104 |
|
| 105 |
Download and install the jQuery Interface module from:
|
| 106 |
|
| 107 |
http://drupal.org/project/jquery_interface
|
| 108 |
|
| 109 |
This module provides a common method for using the Interface library with Drupal.
|
| 110 |
|
| 111 |
----
|
| 112 |
3.3 MySite without JavaScript
|
| 113 |
|
| 114 |
MySite should work without JavaScript or the jQuery update, but it may
|
| 115 |
not perform optimally.
|
| 116 |
|
| 117 |
The layout region feature of MySite was written with the assumption that
|
| 118 |
users will be able to use JavaScript drag-and-drop for region assignment
|
| 119 |
and item sorting.
|
| 120 |
|
| 121 |
In the event that your users do not have JavaScript, the 'Action Buttons'
|
| 122 |
for moving an item up and down can be used for item sorting. As of version
|
| 123 |
5.x.2.3, users can adjust the layout region of an item by configuring that
|
| 124 |
item of their collection.
|
| 125 |
|
| 126 |
Thanks to greggles for the tip. http://drupal.org/node/155172
|
| 127 |
|
| 128 |
--------
|
| 129 |
4. MYSITE ICONS MODULE
|
| 130 |
|
| 131 |
The MySite Icons module provides a graphic interface for users to browse and select content to add to their personal page. The MySite Icons module is an optional addition to MySite.
|
| 132 |
|
| 133 |
----
|
| 134 |
4.1 Installing
|
| 135 |
|
| 136 |
MySite Icons is included in the MySite download.
|
| 137 |
|
| 138 |
MySite Icons uses the standard Drupal 5 install system. Navigate to Administer
|
| 139 |
>> Site Building >> Modules and activate the MySite Icons module.
|
| 140 |
|
| 141 |
----
|
| 142 |
4.2 Database Table
|
| 143 |
|
| 144 |
The MySite Icons module will install the following table:
|
| 145 |
|
| 146 |
{mysite_icon}
|
| 147 |
|
| 148 |
|
| 149 |
--------
|
| 150 |
5. MYSITE FILES
|
| 151 |
|
| 152 |
The MySite module has more files than most Drupal modules. This section is a guide to the core MySite files. For information about these files, see the README.txt file.
|
| 153 |
|
| 154 |
----
|
| 155 |
5.1 Plugin Directories
|
| 156 |
|
| 157 |
MySite uses "plugin" files to define custom options for users. In order for the module to work, you must retain the plugins folder and all its subfolders within the mysite file directory.
|
| 158 |
|
| 159 |
----
|
| 160 |
5.2 Directory and File List
|
| 161 |
|
| 162 |
mysite/
|
| 163 |
API.php
|
| 164 |
CHANGELOG.txt
|
| 165 |
INSTALL.txt
|
| 166 |
README.txt
|
| 167 |
mysite.css
|
| 168 |
mysite.info
|
| 169 |
mysite.install
|
| 170 |
mysite.js
|
| 171 |
mysite.module
|
| 172 |
mysite/mysite_icon
|
| 173 |
mysite_icon.info
|
| 174 |
mysite_icon.install
|
| 175 |
mysite_icon.module
|
| 176 |
mysite/contrib
|
| 177 |
biblio.inc
|
| 178 |
README.txt
|
| 179 |
refine.inc
|
| 180 |
storylink.inc
|
| 181 |
weblink.inc
|
| 182 |
mysite/plugins/
|
| 183 |
README.txt
|
| 184 |
mysite/plugins/formats/
|
| 185 |
README.txt
|
| 186 |
default.theme
|
| 187 |
teasers.theme
|
| 188 |
mysite/plugins/icons/
|
| 189 |
README.txt
|
| 190 |
backing.png
|
| 191 |
cancel.png
|
| 192 |
down.png
|
| 193 |
icon-aggregator.png
|
| 194 |
icon-blog.png
|
| 195 |
icon-book.png
|
| 196 |
icon-droplet.png
|
| 197 |
icon-extra.png
|
| 198 |
icon-extra2.png
|
| 199 |
icon-extra3.png
|
| 200 |
icon-feed.png
|
| 201 |
icon-forum.png
|
| 202 |
icon-node.png
|
| 203 |
icon-term.png
|
| 204 |
icon-user.png
|
| 205 |
icon.png
|
| 206 |
menu-collapsed.png
|
| 207 |
menu-expanded.png
|
| 208 |
move.png
|
| 209 |
settings.png
|
| 210 |
up.png
|
| 211 |
mysite/plugins/layouts/
|
| 212 |
README.txt
|
| 213 |
columns.php
|
| 214 |
columns.png
|
| 215 |
default.php
|
| 216 |
default.png
|
| 217 |
left.php
|
| 218 |
left.png
|
| 219 |
stacks.php
|
| 220 |
stacks.png
|
| 221 |
triple.php
|
| 222 |
triple.png
|
| 223 |
mysite/plugins/styles/
|
| 224 |
README.txt
|
| 225 |
default.css
|
| 226 |
fire.css
|
| 227 |
forest.css
|
| 228 |
midnight.css
|
| 229 |
sky.css
|
| 230 |
sunrise.css
|
| 231 |
winter.css
|
| 232 |
mysite/plugins/types/
|
| 233 |
README.txt
|
| 234 |
aggregator.inc
|
| 235 |
blog.inc
|
| 236 |
book.inc
|
| 237 |
droplet.inc
|
| 238 |
feed.inc
|
| 239 |
forum.inc
|
| 240 |
node.inc
|
| 241 |
path.inc
|
| 242 |
popular.inc
|
| 243 |
profile.inc
|
| 244 |
term.inc
|
| 245 |
theme.inc
|
| 246 |
user.inc
|
| 247 |
|
| 248 |
|
| 249 |
--------
|
| 250 |
6. INSTALL CHECKLIST
|
| 251 |
|
| 252 |
1. Install MySite in your modules directory
|
| 253 |
2. Check to see that all MySite files are present (see section 5)
|
| 254 |
3. Go to Administer > Site Building > Modules
|
| 255 |
4. Activate the MySite and MySite Icons modules.
|
| 256 |
5. Run the Drupal upgrade script if you used MySite 5.x.1 or 4.7.x.y versions of MySite.
|
| 257 |
6. Go to Administer > User Management > Access Control
|
| 258 |
7. Set MySite access control rules.
|
| 259 |
8. Go to Administer > Site configuration > MySite
|
| 260 |
9. Configure the MySite module's basic options.
|
| 261 |
10. Enable and configure the Content Types you wish to use.
|
| 262 |
11. Configure Default page settings for users.
|
| 263 |
12. Configure Default content settings users.
|
| 264 |
|
| 265 |
For configuration details, see the README.txt file.
|
| 266 |
|
| 267 |
--------
|
| 268 |
|
| 269 |
/**
|
| 270 |
* @file
|
| 271 |
* Installation instructions for the MySite and MySite Icons modules.
|
| 272 |
*/
|
Parent Directory
| 
Revision Log
| 
Revision Graph