| 1 |
// $Id: INSTALL.txt,v 1.8 2006/03/28 11:13:11 jaza Exp $ |
// $Id: INSTALL.txt,v 1.9 2006/04/14 11:40:21 jaza Exp $ |
| 2 |
|
|
| 3 |
Requirements |
Requirements |
| 4 |
------------ |
------------ |
| 5 |
|
|
| 6 |
This module requires the latest development version of Drupal (CVS HEAD). |
This module requires the corresponding stable version of Drupal. |
| 7 |
|
No other modules are required beyond that. |
| 8 |
|
|
| 9 |
|
|
| 10 |
Installation |
Installation |
| 11 |
------------ |
------------ |
| 12 |
|
|
| 13 |
1. Copy the category folder and its contents to the Drupal modules/ directory. |
1. If you're installing Category to an existing site, save backup copies |
| 14 |
|
of your database and files first. Category module changes a lot of things, |
| 15 |
|
and therefore it may be difficult to un-install Category properly later. |
| 16 |
|
|
| 17 |
|
2. Copy the category folder and its contents to the appropriate Drupal directory, |
| 18 |
|
which is usually sites/all/modules/ or sites/your_site_name/modules/. |
| 19 |
Drupal should automatically detect it. |
Drupal should automatically detect it. |
| 20 |
|
|
| 21 |
2. Go to 'administer -> modules' and enable category (and category_menu, |
3. Go to 'Administer -> Modules' (admin/build/modules) and enable category |
| 22 |
category_display, category_export, and category_legacy, if applicable). |
(and additional modules in the Category group, such as category_menu, |
| 23 |
Note: for each module that you enable, all necessary database tables will |
category_display, and others, if applicable). |
|
be automatically created, using Drupal's new .install file system. You no |
|
|
longer need to run the category.mysql script (which is why this file no |
|
|
longer exists). |
|
| 24 |
|
|
| 25 |
3. If you wish to use taxonomy-dependent Drupal modules (e.g. forum, image, |
4. If you wish to use taxonomy-dependent Drupal modules (e.g. forum, image, |
| 26 |
glossary) with this module, you must install the taxonomy wrapper module. |
glossary) with this module, you must install the taxonomy wrapper module. |
| 27 |
There is now a script available to perform this installation for you. To |
There is a script available to perform this installation for you. To |
| 28 |
run the script, go to 'administer -> settings -> category', and in the |
run the script, go to 'Administer -> Categories -> Wrapper modules' |
| 29 |
'wrapper install / uninstall settings' box, click the 'install now' link |
(admin/content/category/wrappers), and click the 'install now' link |
| 30 |
for the taxonomy wrapper. If you experience errors with this script (usually |
for the taxonomy wrapper. If you experience errors with this script (usually |
| 31 |
due to file system permissions problems), see the instructions for |
due to file system permissions problems), see the instructions for |
| 32 |
installing the wrapper modules manually (available online). |
installing the wrapper modules manually (available online). |
| 33 |
|
|
| 34 |
4. If you wish to use book-dependent Drupal modules (e.g. export_dxml) with |
5. If you wish to use book-dependent Drupal modules (e.g. export_dxml) with |
| 35 |
this module, you must install the book wrapper module. The procedure for |
this module, you must install the book wrapper module. The procedure for |
| 36 |
doing this is similar to that for installing the taxonomy wrapper module. |
doing this is similar to that for installing the taxonomy wrapper module. |
| 37 |
To run the book wrapper installation script, go to 'administer -> settings |
To run the book wrapper installation script, go to 'Administer -> Categories |
| 38 |
-> category', and in the 'wrapper install / uninstall settings' box, click |
-> Wrapper modules' (admin/content/category/wrappers), and click |
| 39 |
the 'install now' link for the book wrapper. If you experience errors with |
the 'install now' link for the book wrapper. If you experience errors with |
| 40 |
this script (usually due to file system permissions problems), see the |
this script (usually due to file system permissions problems), see the |
| 41 |
instructions for installing the wrapper modules manually (available online). |
instructions for installing the wrapper modules manually (available online). |
| 42 |
|
|
| 43 |
5. If you have existing taxonomy terms and vocabularies, or if you have |
6. If you have existing taxonomy terms and vocabularies, or if you have |
| 44 |
existing book nodes, you can import them as categories and containeris using |
existing book nodes, you can import them as categories and containeris using |
| 45 |
category_legacy. To do this, go to 'administer -> category legacy', and |
category_legacy. To do this, go to 'Administer -> Category legacy', and |
| 46 |
follow the instructions on that page. It is recommended that you enable the |
follow the instructions on that page. It is recommended that you enable the |
| 47 |
taxonomy and book wrappers before performing an import. Additionally, using |
taxonomy and book wrappers before performing an import. Additionally, using |
| 48 |
the taxonomy wrapper with existing taxonomy data is not recommended - either |
the taxonomy wrapper with existing taxonomy data is not recommended - either |
| 49 |
import your existing taxonomy data first, disable the taxonomy wrapper, or |
import your existing taxonomy data, disable the taxonomy wrapper, or |
| 50 |
delete your site's taxonomy data. You are able to leave the book module |
delete your site's taxonomy data. You are able to leave the book module |
| 51 |
enabled, and continue to use your book data, if you wish (but as with |
enabled, and continue to use your book data, if you wish (but as with |
| 52 |
taxonomy, it is recommended that you disable book). |
taxonomy, it is recommended that you disable book). |
| 53 |
|
|
| 54 |
6. Go to 'administer -> access control' to configure access privileges for |
7. Go to 'Administer -> Permissions' (admin/user/permissions) to configure |
| 55 |
this module. |
access privileges for this module. |
| 56 |
|
|
| 57 |
7. Go to 'administer -> settings -> category' to change the settings for this |
8. Settings for this module are basically located at 'Administer -> Categories' |
| 58 |
module. You might also want to change the node type settings for the |
(admin/content/category), but you'll notice that nearly all of the wide |
| 59 |
category and container node types, at 'administer -> settings -> content |
range of options are actually set on per-container or per-node-type basis, |
| 60 |
types'. |
so you need to visit 'Administer -> Content types -> edit' (admin/content/ |
| 61 |
|
node-type/your_node_type), and especially your container's edit page, to |
| 62 |
|
make all the choices. |
| 63 |
|
|
| 64 |
8. Go to 'administer -> categories' to start managing your categories and |
9. Go to 'Administer -> Categories' to start managing your categories and |
| 65 |
containers. You can create new categories and containers from here, or |
containers. You can create new categories and containers from here, or |
| 66 |
you can go to 'create content -> category' or 'create content -> container'. |
you can go to 'Create content -> Category' or 'Create content -> Container'. |
| 67 |
|
As you'll be creating your categories and containers, you can adjust their |
| 68 |
|
behavior to your needs through various settings found in the 'Category |
| 69 |
|
information' or 'Container information' boxes. |
| 70 |
|
|
| 71 |
9. You can assign content to categories by configuring your containers to be |
10. You can assign content to categories by configuring your containers to be |
| 72 |
associated with various node types, and then creating or editing nodes of |
associated with various node types, and then creating or editing nodes of |
| 73 |
those types. |
those types. |
| 74 |
Note: content with assigned categories will only have its categories |
Note: content with assigned categories will only have its categories |
| 75 |
displayed if category_display is installed, and if your containers are |
displayed, if the taxonomy wrapper is installed, and if category_display |
| 76 |
configured to show categories on assigned nodes, and if the taxonomy |
is not set to hide them. |
| 77 |
wrapper is installed. |
|
| 78 |
|
11. You may create customized lists of content based on categories, if you |
| 79 |
|
have installed the Views module (available at http://drupal.org/project/views), |
| 80 |
|
and also use them for your categories through the category_views module. |
| 81 |
|
To use Category data with Views, you need to install the taxonomy wrapper, |
| 82 |
|
and choose taxonomy-based options in Views. |
| 83 |
|
|
| 84 |
|
|
| 85 |
|
Troubleshooting |
| 86 |
|
--------------- |
| 87 |
|
|
| 88 |
|
If something doesn't work as you expected, check all your settings first. |
| 89 |
|
Most commonly, problems are solved by just reviewing the 'Container information' |
| 90 |
|
box (while editing the container), as the settings located there are changing |
| 91 |
|
behavior of all categories (and nodes to some extent) within that container. |
| 92 |
|
(Note that some settings are hidden, unless other settings make them relevant, |
| 93 |
|
so you really want to read the descriptions.) |
| 94 |
|
|
| 95 |
|
You should also check, whether all necessary modules (such as category_display, |
| 96 |
|
category_menu, and others) are enabled where needed, and the taxonomy and/or |
| 97 |
|
book wrapper modules installed if necessary. |
| 98 |
|
|
| 99 |
|
If you're experiencing problems with menu items, with taxonomy-based modules, |
| 100 |
|
or with various content lists (including TOC trees and Views integration), |
| 101 |
|
you might need to refresh your site's data through the category_resave module. |
| 102 |
|
(This might happen after larger changes of settings, done while content |
| 103 |
|
already exists on the site.) |
| 104 |
|
|
| 105 |
|
Always keep database backups, if un/installing modules, or performing large |
| 106 |
|
operations (such as category_resave do), so that you're able to revert the |
| 107 |
|
changes if something goes wrong. |
| 108 |
|
|
| 109 |
|
For further help, visit the sites http://category.greenash.net.au/ and/or |
| 110 |
|
http://drupal.org/project/category |
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch