modules/nodewords/README.txt

; $Id: README.txt,v 1.30.2.3 2009/11/30 23:01:41 kiam Exp $

This module allows you to set some meta tags for the different resources exposed
by your site: nodes, users, views, taxonomy filters and error pages are some
examples.

Giving more attention to the important keywords and/or description on your site
allows you to get better search engine positioning (given that you really only
provide the keywords which exist in the content itself, and do not try to lie).

This version of the module only works with Drupal 6.x.

Features
------------------------------------------------------------------------------
This is a brief of features provided by this module:

* You can seperately specify the meta tags to show on some specific pages of
  your site (the error 403 page, the error 404 page), or to use in specific
  situations, when the site is offline for example.

* A pluggable system allow the inclusion of new meta tags appart from the ones
  provided by this module.

* The current supported basic meta tags are ABSTRACT, CANONICAL, COPYRIGHT,
  GEO.POSITION, DESCRIPTION, ICBM, KEYWORDS, PICS-LABEL, REVISIT-AFTER, ROBOTS.
  These meta tags are provided by the module: Basic meta tags.

* You can select which of the available tags will be available for edition, and
  which will be exposed in the HTML of your site.

Other modules integration
-------------------------
Nodewords integrates other modules for automatic selection of meta tags.

* You can tell the module to add all terms of some specified vocabularies to
  the KEYWORDS meta tag, integrating taxonomy vocabularies and nodewords.

* Previous versions of this module provided support for Views and Panels. This
  feature has been removed from Nodewords 6.x-1.x since August 15, 2009; as the
  module provides an API allowing other modules to integrate with nodewords.

* This module may also integrate taggadelic, CCK, and other resources.

Installing Nodewords (first time installation)
------------------------------------------------------------------------------
1. Backup your database.

2. Copy the complete 'nodewords/' directory into the 'sites/all/modules/',
   'sites/default/modules' or 'sites/name_of_your_site/modules' folder of your
   Drupal setup. More information about installing contributed modules could be
   found at "Install contributed modules" (http://drupal.org/node/70151)

3. Enable the "Nodewords" module from the module administration page
   (Administer >> Site configuration >> Modules).

4. Configure the module (see "Configuration" below).

5. You should enable other modules providing meta tags. The nodewords module
   includes three meta tags modules:
   - nodewords basic: for typical DESCRIPTION, ABSTRACT, COPYRIGHT meta tags.
   - nodewords extra: for Dublin meta tag Schema
   - nodewords verification tags: for especific API meta tags by search engines.

Updating Nodewords (aka Meta tags) (module version upgrade)
------------------------------------------------------------------------------
1. Verify that the version you are going to upgrade contains all the features
   your are using in your Drupal setup. Some features could have been removed
   or replaced by others.

2. Read carefully in the project issue tracking about upgrade paths problems
   before you start the upgrade process. Some versions don't support a clean
   upgrade path that may left your site meta tags unusable.

3. Backup your database.

4. Update current module code with latest recommended version. Previous versions
   could have bugs already reported and fixed in the last version.

5. Complete the update process, set maintenance mode, call the update.php script
   and finish the update operation. For more information please go to:
   http://groups.drupal.org/node/19513

6. Verify your module configuration and check that the features you are using
   work as expected. Also verify that all required modules are enabled, and
   permissions are set as desired.

Note: Whenever you have the chance, try an update in a local or development
      copy of your site.


Configuration
------------------------------------------------------------------------------
1. On the access control administration page ("Administer >> User management
   >> Access control") you need to assign:

   + the "administer nodewords" permission to the roles that are allowed to
     administer the meta tags (such as setting the default values and/or
     enabling the possibility to edit them),

   All users will be able to see the assigned meta tags.

2. On the settings page ("Administer >> Content management >> Nodewords") you
   can specify the default settings for the module. To access this page users
   need the "administer nodewords" permission.

3. You should enable meta tags for editing before they are available for use.
   The same operation should be done for meta tag output. Only allowed Meta tags
   are available for editing or exposed in the HTML of your site.

Bugs and shortcomings
------------------------------------------------------------------------------
* See the list of project issues [1].

Credits / Contact
------------------------------------------------------------------------------
Original author of this module is Andras Barthazi. Mike Carter [2]
and Gabor Hojtsy [3]
provided some feature enhancements. Robrecht Jacques[4] is current maintainer,
and Alberto Paderno [5] is the current co-maintainer.

Best way to contact the authors is to submit a (support/feature/bug) issue in
the project issue queue at http://drupal.org/project/issues/nodewords.

[1]    http://drupal.org/project/issues/nodewords
[2]    http://drupal.org/user/13164
[3]    http://drupal.org/user/4166
[4]    http://drupal.org/user/22598
[5]    http://drupal.org/user/54793
1	; $Id: README.txt,v 1.30.2.3 2009/11/30 23:01:41 kiam Exp $
2
3	This module allows you to set some meta tags for the different resources exposed
4	by your site: nodes, users, views, taxonomy filters and error pages are some
5	examples.
6
7	Giving more attention to the important keywords and/or description on your site
8	allows you to get better search engine positioning (given that you really only
9	provide the keywords which exist in the content itself, and do not try to lie).
10
11	This version of the module only works with Drupal 6.x.
12
13	Features
14	------------------------------------------------------------------------------
15	This is a brief of features provided by this module:
16
17	* You can seperately specify the meta tags to show on some specific pages of
18	your site (the error 403 page, the error 404 page), or to use in specific
19	situations, when the site is offline for example.
20
21	* A pluggable system allow the inclusion of new meta tags appart from the ones
22	provided by this module.
23
24	* The current supported basic meta tags are ABSTRACT, CANONICAL, COPYRIGHT,
25	GEO.POSITION, DESCRIPTION, ICBM, KEYWORDS, PICS-LABEL, REVISIT-AFTER, ROBOTS.
26	These meta tags are provided by the module: Basic meta tags.
27
28	* You can select which of the available tags will be available for edition, and
29	which will be exposed in the HTML of your site.
30
31	Other modules integration
32	-------------------------
33	Nodewords integrates other modules for automatic selection of meta tags.
34
35	* You can tell the module to add all terms of some specified vocabularies to
36	the KEYWORDS meta tag, integrating taxonomy vocabularies and nodewords.
37
38	* Previous versions of this module provided support for Views and Panels. This
39	feature has been removed from Nodewords 6.x-1.x since August 15, 2009; as the
40	module provides an API allowing other modules to integrate with nodewords.
41
42	* This module may also integrate taggadelic, CCK, and other resources.
43
44	Installing Nodewords (first time installation)
45	------------------------------------------------------------------------------
46	1. Backup your database.
47
48	2. Copy the complete 'nodewords/' directory into the 'sites/all/modules/',
49	'sites/default/modules' or 'sites/name_of_your_site/modules' folder of your
50	Drupal setup. More information about installing contributed modules could be
51	found at "Install contributed modules" (http://drupal.org/node/70151)
52
53	3. Enable the "Nodewords" module from the module administration page
54	(Administer >> Site configuration >> Modules).
55
56	4. Configure the module (see "Configuration" below).
57
58	5. You should enable other modules providing meta tags. The nodewords module
59	includes three meta tags modules:
60	- nodewords basic: for typical DESCRIPTION, ABSTRACT, COPYRIGHT meta tags.
61	- nodewords extra: for Dublin meta tag Schema
62	- nodewords verification tags: for especific API meta tags by search engines.
63
64	Updating Nodewords (aka Meta tags) (module version upgrade)
65	------------------------------------------------------------------------------
66	1. Verify that the version you are going to upgrade contains all the features
67	your are using in your Drupal setup. Some features could have been removed
68	or replaced by others.
69
70	2. Read carefully in the project issue tracking about upgrade paths problems
71	before you start the upgrade process. Some versions don't support a clean
72	upgrade path that may left your site meta tags unusable.
73
74	3. Backup your database.
75
76	4. Update current module code with latest recommended version. Previous versions
77	could have bugs already reported and fixed in the last version.
78
79	5. Complete the update process, set maintenance mode, call the update.php script
80	and finish the update operation. For more information please go to:
81	http://groups.drupal.org/node/19513
82
83	6. Verify your module configuration and check that the features you are using
84	work as expected. Also verify that all required modules are enabled, and
85	permissions are set as desired.
86
87	Note: Whenever you have the chance, try an update in a local or development
88	copy of your site.
89
90
91	Configuration
92	------------------------------------------------------------------------------
93	1. On the access control administration page ("Administer >> User management
94	>> Access control") you need to assign:
95
96	+ the "administer nodewords" permission to the roles that are allowed to
97	administer the meta tags (such as setting the default values and/or
98	enabling the possibility to edit them),
99
100	All users will be able to see the assigned meta tags.
101
102	2. On the settings page ("Administer >> Content management >> Nodewords") you
103	can specify the default settings for the module. To access this page users
104	need the "administer nodewords" permission.
105
106	3. You should enable meta tags for editing before they are available for use.
107	The same operation should be done for meta tag output. Only allowed Meta tags
108	are available for editing or exposed in the HTML of your site.
109
110	Bugs and shortcomings
111	------------------------------------------------------------------------------
112	* See the list of project issues [1].
113
114	Credits / Contact
115	------------------------------------------------------------------------------
116	Original author of this module is Andras Barthazi. Mike Carter [2]
117	and Gabor Hojtsy [3]
118	provided some feature enhancements. Robrecht Jacques[4] is current maintainer,
119	and Alberto Paderno [5] is the current co-maintainer.
120
121	Best way to contact the authors is to submit a (support/feature/bug) issue in
122	the project issue queue at http://drupal.org/project/issues/nodewords.
123
124	[1] http://drupal.org/project/issues/nodewords
125	[2] http://drupal.org/user/13164
126	[3] http://drupal.org/user/4166
127	[4] http://drupal.org/user/22598
128	[5] http://drupal.org/user/54793