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

Diff of /contributions/modules/nodewords/README.txt

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

revision 1.27.2.16 by kiam, Tue Nov 17 05:27:16 2009 UTC revision 1.27.2.17 by kiam, Thu Nov 26 12:38:49 2009 UTC
# Line 1  Line 1 
1  ; $Id: README.txt,v 1.27.2.15 2009/11/14 20:05:45 kiam Exp $  ; $Id: README.txt,v 1.27.2.16 2009/11/17 05:27:16 kiam Exp $
2    
3  This module allows you to set some meta tags for each node.  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  Giving more attention to the important keywords and/or description on some of  examples.
6  your nodes allows you to get better search engine positioning (given that you  
7  really only provide the keywords which exist in the node body itself, and do  Giving more attention to the important keywords and/or description on your site
8  not try to lie).  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.  This version of the module only works with Drupal 6.x.
12    
13  Features  Features
14  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
15  Some features include:  This is a brief of features provided by this module:
   
 * The current supported meta tags are ABSTRACT, CANONICAL, COPYRIGHT,  
   GEO.POSITION, DESCRIPTION, ICBM, KEYWORDS, PICS-LABEL, REVISIT-AFTER, ROBOTS  
   and the site verification meta tags used by Google Webmaster Tools,  
   Microsoft Bing Webmaster Center, Yahoo! Site Explorer.  
   
 * You can tell "nodewords" to add all terms of some specified vocabularies  
   to the KEYWORDS meta tag.  
   
 * You can specify a default meta tag ROBOTS value to use for all pages. You can  
   override it on each page.  
   
 * On taxonomy pages, the term description is used as the DESCRIPTION  
   tag. The term itself is added to the list of KEYWORDS. You can override  
   the description to use if you wish.  
16    
17  * You can seperately specify the meta tags to show on some specific pages of  * You can seperately specify the meta tags to show on some specific pages of
18    your site (in example, the front page, the error 403 page, the error 404    your site (the front page, the error 403 page, the error 404 page, the tracker
19    page, the tracker page), or to use in specific situations (in example, when    page), or to use in specific situations, when the site is offline for example.
20    the site is offline).  
21    * A pluggable system allow the inclusion of new meta tags appart from the ones
22  * The support for Views, and Panels has been removed from Nodewords    provided by this module.
23    6.x-1.x on August 15, 2009; successive versions for Drupal 6 replaced it with  
24    a more generic support for third-party module pages.  * The current supported basic meta tags are ABSTRACT, CANONICAL, COPYRIGHT,
25      GEO.POSITION, DESCRIPTION, ICBM, KEYWORDS, PICS-LABEL, REVISIT-AFTER, ROBOTS.
26  * You can select which of these tags you want to output on each page. You    These meta tags are provided by the module: nodewords_basic.
27    can also remove the edit box for these tags from the node edit page if  
28    you don't like using it.  * Additionally, you may include site verification meta tags used by external
29      sources: Google Webmaster Tools, Microsoft Bing Webmaster Center, Yahoo! Site
30      Explorer.
31      These meta tags are provided by the module: nodewords_verification.
32    
33    * Additionally you may include the Dublin Core meta tag schema.
34      These meta tags are provided by the module: nodewords_extra.
35    
36    * You can select which of the available tags will be available for edition, and
37      which will be exposed in the html of your site.
38    
39    * You can specify a default meta tag ROBOTS value used for all pages, but easily
40      overide it for every page.
41    
42  * All text of the DESCRIPTION and KEYWORDS meta tags are added to the search  * All text of the DESCRIPTION and KEYWORDS meta tags are added to the search
43    system so they are searable too; other meta tags could be added to the search    system so they are searable too; other meta tags could be added to the search
44    system too (depending on the code implemented from the module).    system too (depending on the code implemented from the module).
45    
46    Other modules integration
47    -------------------------
48    Nodewords integrates other modules for automatic selection of meta tags.
49    
50    * You can tell "nodewords" to add all terms of some specified vocabularies to
51      the KEYWORDS meta tag, integrating taxonomy vocabularies and nodewords.
52    
53    * On taxonomy pages, the term description is used as the DESCRIPTION tag. The
54      term itself is added to the list of KEYWORDS. You can override the description
55      to use if you wish.
56    
57    * Previous versions of this module provided support for Views and Panels. This
58      feature has been removed from Nodewords 6.x-1.x since August 15, 2009; as the
59      module provides an API allowing other modules to integrate with nodewords.
60    
61    * This module may also integrate taggadelic, cck, and other resources.
62    
63  Installing Nodewords (aka Meta tags) (first time installation)  Installing Nodewords (aka Meta tags) (first time installation)
64  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
65  1. Backup your database.  1. Backup your database.
66    
67  2. Copy the complete 'nodewords/' directory into the 'modules/' directory of  2. Copy the complete 'nodewords/' directory into the 'sites/all/modules/',
68     your Drupal site.     'sites/default/modules' or 'sites/name_of_your_site/modules' folder of your
69       Drupal setup. More information about installing contributed modules could be
70       found at "Install contributed modules" (http://drupal.org/node/70151)
71    
72  3. Enable the "Nodewords" module from the module administration page  3. Enable the "Nodewords" module from the module administration page
73     (Administer >> Site configuration >> Modules).     (Administer >> Site configuration >> Modules).
74    
75  4. Configure the module (see "Configuration" below).  4. Configure the module (see "Configuration" below).
76    
77    5. You should enable other modules providing meta tags. The nodewords module
78       includes three meta tags modules:
79       - nodewords basic: for typical DESCRIPTION, ABSTRACT, COPYRIGHT meta tags.
80       - nodewords extra: for Dublin meta tag Schema
81       - nodewords verification tags: for especific API meta tags by search engines.
82    
83    Updating Nodewords (aka Meta tags) (module version upgrade)
84    ------------------------------------------------------------------------------
85    1. Verify that the version you are going to upgrade contains all the features
86       your are using in your Drupal setup. Some features could have been removed
87       or replaced by others.
88    
89    2. Read carefully in the project issue tracking about upgrade paths problems
90       before you start the upgrade process. Some versions don't support a clean
91       upgrade path that may left your site meta tags unusable.
92    
93    3. Backup your database.
94    
95    4. Update current module code with latest recommended version. Previous versions
96       could have bugs already reported and fixed in the last version.
97    
98    4. Complete the update process, set maintenance mode, call the update.php script
99       and finish the update operation. For more information please go to:
100       http://groups.drupal.org/node/19513
101    
102    4. Verify your module configuration and check that the features you are using
103       work as expected. Also verify that all required modules are enabled, and
104       permissions are set as desired.
105    
106    Note: whenever you have the chance, try an update in a local or development
107          copy of your site.
108    
109    
110  Configuration  Configuration
111  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
112  1. On the access control administration page ("Administer >> User management  1. On the access control administration page ("Administer >> User management
# Line 72  Configuration Line 122  Configuration
122    
123     All users will be able to see the assigned meta tags.     All users will be able to see the assigned meta tags.
124    
125  2. On the settings page ("Administer >> Content management >>  2. On the settings page ("Administer >> Content management >> Nodewords") you
126     Nodewords") you can specify the default settings for the module.     can specify the default settings for the module. To access this page users
127     Users need the "administer nodewords" permission to do this.     need the "administer nodewords" permission.
128    
129  3. The front page is an important page for each website. Therefor you can  3. You should enable meta tags for editing before they are available for use.
130     specifically set the meta tags to use on the front page meta tags     The same operation should be done for meta tag output. Only allowed Meta tags
131     settings page ("Administer >> Content management >> Nodewords >>     are available for editing or exposed in the HTML of your site.
132     Front page").  
133     Users need the "administer nodewords" permission to do this.  4. The front page is an important page for each website. Therefor you can
134       specifically set the meta tags to use on the front page meta tags settings
135     Alternatively, you can opt not to set the meta tags for the front page     page ("Administer >> Content management >> Nodewords >> Front page").
136     on this page, but to use the meta tags of the view, panel or node the     Users need the "administer nodewords" permission to do this. When there are
137     front page points to. To do this, you need to uncheck the "Use front     resources providing meta tags promoted in the front page, you may Force the
138     page meta tags" option on the settings page.     usage of "Front page" meta tags superseeding all of them.
139    
140     Note that, in contrast to previous versions of this module, the site     Alternatively, you can opt not to set the meta tags for the front page on
141     mission and/or site slogan are no longer used as DESCRIPTION or ABSTRACT     this page, but to use the meta tags of the view, panel or node the front page
142     on the front page!     points to. To do this, you need to uncheck the "Use front page meta tags"
143       option on the settings page.
144  4. You can completely disable the possibility to edit meta tags for each  
145     individual content type by editing the content type workflow options     Note that, in contrast to previous versions of this module, the site mission
146       and/or site slogan are no longer used as DESCRIPTION or ABSTRACT on the front
147       page!
148    
149    5. You can completely disable the possibility to edit meta tags for each
150       individual content type by editing the content type workflow options, by
151       default meta tags are enabled for all content types.
152     ("Administer >> Content management >> Content types").     ("Administer >> Content management >> Content types").
153    
154     Note that this will still output the default values for the meta tags.     Note: this will still output the default values for the meta tags.
155    
 How to define meta tags in third-party modules  
 ------------------------------------------------------------------------------  
 Modules that need to intregrate with Nodewords to define new meta tags need to  
 define two hooks: hook_nodewords_tags_info(), and hook_nodewords_api().  
 Optionally, when NODEWORDS_API_VERSION is equal or greater than 1.3, the module  
 can also, optionally, implement hook_nodewords_type_id(), which allow to a  
 third-party module to change the type and the ID detected from Nodewords (the  
 module already implements it for forum.module, image.module, node.module,  
 taxonomy.module, taxonomy_menu.module, tracker.module, user.module).  
   
 To better understand how to write the code for custom meta tags, see  
 nodewords_basic.module, nodewords_extra.module, and  
 site_verification.module.  
   
 Using Nodewords and Tagadelic  
 ------------------------------------------------------------------------------  
 The Tagadelic module (http://drupal.org/project/tagadelic) allows one to  
 create a cloud of all terms used. The keywords you assign to nodes with  
 the Nodewords module will not appear in these clouds.  
   
 If you want to use tagclouds and have the same terms in the KEYWORDS meta  
 tag, you can configure nodewords as follows:  
   
 1. Create a "Free tagging" vocabulary at "Administer >> Content management  
    >> Categories". For example, call this vocabulary "Keywords".  
   
 2. On the meta tags settings page ("Administer >> Content management >>  
    Nodewords"), select the "Keywords" vocabulary as one of the "Auto-keywords  
    vocabularies". This will make sure that all terms you assign to nodes  
    will appear in the KEYWORDS meta tag.  
   
 3. On the same page, deselect the checkbox "Keywords" in the "Tags to  
    show on edit form" fieldset. This will remove the meta tag KEYWORDS  
    input box on all node edit forms. The only way to assign KEYWORDS then  
    is to enter them in the vocabulary "Keywords" input box (which will  
    appear in the "Categories" box instead of the "Meta tags" one).  
   
 The result is that the meta tag KEYWORDS will only contain the keywords  
 assigned to nodes by entering them in the free-tagging input box of the  
 "Keywords" vocabulary. Nodewords will add them to the KEYWORDS meta tag  
 and you can use a tagcloud to show all keywords too.  
   
 Auto-generated meta DESCRIPTION for CCK content types  
 ------------------------------------------------------------------------------  
 It is recommended to use the contemplate (Content Template) module to  
 create a nicer looking node teaser that can also be used as auto-generated  
 DESCRIPTION.  
   
 Required:  
   
 A valid backup of your Drupal site having Nodewords 1.0 installed. If you don't  
 have a backup, there is now way to recover.  
   
 Step by step instruction:  
   
 1.  Disable all Nodewords modules (Basic meta tags, Extra meta tags, Site  
     verification and Nodewords) with version 1.1 or 1.2 or other DEV versions up  
     to <1.3 at admin/build/modules.  
 2.  Uninstall the modules Basic meta tags, Extra meta tags, Site verification  
     and Nodewords at admin/build/modules/uninstall.  
 3.  Remove the nodewords folder from your installation. Typically it can be  
     found in the folder sites/all/modules.  
 4.  Execute "DELETE FROM variable WHERE name IN ('nodewords-repeat',  
     'nodewords-use_front', 'nodewords_page', 'nodewords_story');"  
     on your database. You need to see that 4 rows have been affected (deleted).  
     If you use a table prefix, prepend the variable with your table prefix.  
     You can execute this query via MySQL Query Browser or myPHPAdmin, whatever  
     your preferred tool for DB administration is.  
 5.  Install Nodewords 1.0 to your modules folder e.g. sites/all/modules.  
 6.  Enable Meta tags 1.0 module (this is Nodewords).  
 7.  Restore the table nodewords from your backup and replace/overwrite the  
     existing table. You can use MySQL Administrator for this task and go to  
     "Restore > Restore content" by selecting the nodewords table only.  
 8.  If you haven't changed any settings in your Drupal installation that are  
     saved in "variable" table you can restore "variable" table the same way.  
     Otherwise you need to extract the 3 settings from your SQL backup file by  
     searching for 'nodewords', 'nodewords-repeat' and 'nodewords-use_front'.  
     Replace below with your settings and execute the query on your DB server.  
     Example:  
     INSERT INTO `variable` (`name`,`value`) VALUES  
     ('nodewords','your settings array is here...'),  
     ('nodewords-repeat','i:0;'),  
     ('nodewords-use_front','i:1;');  
 9.  Clear all caches in admin/settings/performance.  
 10. Finished. Now you are able to review your previous meta tag settings.  
 11. Wait until Nodewords 1.3 final has been released.  
156    
157  Bugs and shortcomings  Bugs and shortcomings
158  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
159  * See the list of issues at http://drupal.org/project/issues/nodewords.  * See the list of project issues[1].
160    
161  Credits / Contact  Credits / Contact
162  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
163  The original author of this module is Andras Barthazi.  Original author of this module is Andras Barthazi. Mike Carter[2]
164  Mike Carter (http://drupal.org/user/13164) and Gabor Hojtsy  and Gabor Hojtsy[3]
165  (http://drupal.org/user/4166) provided some feature enhancements.  provided some feature enhancements. Robrecht Jacques[4] is current maintainer,
166  Robrecht Jacques (http://drupal.org/user/22598) is the current maintainer;  and Alberto Paderno[5] is the current co-maintainer.
167  Alberto Paderno (http://drupal.org/user/55077) is the current co-maintainer.  
168    Best way to contact the authors is to submit a (support/feature/bug) issue in
169  Best way to contact the authors is to submit a (support/feature/bug) issue at  the project issue queue at http://drupal.org/project/issues/nodewords.
170  the projects issue page at http://drupal.org/project/issues/nodewords.  
171    [1]    http://drupal.org/project/issues/nodewords
172    [2]    http://drupal.org/user/13164
173    [3]    http://drupal.org/user/4166
174    [4]    http://drupal.org/user/22598
175    [5]    http://drupal.org/user/55077
Legend:
Removed from v.1.27.2.16  
changed lines
  Added in v.1.27.2.17
  ViewVC Help
Powered by ViewVC 1.1.3