home | career | drupal | java | mac | mysql | perl | php | scala | uml | unix

Drupal example source code file (README.txt)

This example Drupal source code file (README.txt) is included in the DevDaily.com "Drupal Source Code Warehouse" project. The intent of this project is to help you "Learn Drupal by Example".

PHP - Drupal tags/keywords

and, are, for, meta, module, nodewords, of, page, tags, the, this, to, you, your

The README.txt Drupal example source code

; $Id: README.txt,v 1.27.2.17 2009/11/26 12:38:49 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 front page, the error 403 page, the error 404 page, the tracker
  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: nodewords_basic.

* Additionally, you may include site verification meta tags used by external
  sources: Google Webmaster Tools, Microsoft Bing Webmaster Center, Yahoo! Site
  Explorer.
  These meta tags are provided by the module: nodewords_verification.

* Additionally you may include the Dublin Core meta tag schema.
  These meta tags are provided by the module: nodewords_extra.

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

* You can specify a default meta tag ROBOTS value used for all pages, but easily
  overide it for every page.

* All text of the DESCRIPTION and KEYWORDS meta tags are added to the search
  system so they are searable too; other meta tags could be added to the search
  system too (depending on the code implemented from the module).

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

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

* 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.

* 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 (aka Meta tags) (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.

4. 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

4. 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),

   + the "edit XYZ tag" permission to the roles that are allowed to set and
     edit meta tags for the content (there is a permission for each of the
     meta tags currently defined).

   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.

4. The front page is an important page for each website. Therefor you can
   specifically set the meta tags to use on the front page meta tags settings
   page ("Administer >> Content management >> Nodewords >> Front page").
   Users need the "administer nodewords" permission to do this. When there are
   resources providing meta tags promoted in the front page, you may Force the
   usage of "Front page" meta tags superseeding all of them.

   Alternatively, you can opt not to set the meta tags for the front page on
   this page, but to use the meta tags of the view, panel or node the front page
   points to. To do this, you need to uncheck the "Use front page meta tags"
   option on the settings page.

   Note that, in contrast to previous versions of this module, the site mission
   and/or site slogan are no longer used as DESCRIPTION or ABSTRACT on the front
   page!

5. You can completely disable the possibility to edit meta tags for each
   individual content type by editing the content type workflow options, by
   default meta tags are enabled for all content types.
   ("Administer >> Content management >> Content types").

   Note: this will still output the default values for the meta tags.


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/55077

Other Drupal examples (source code examples)

Here is a short list of links related to this Drupal README.txt source code file:

new blog posts

"Drupal" is a registered trademark of Dries Buytaert.

my drupal tutorials and examples  

Copyright 1998-2016 Alvin Alexander, alvinalexander.com
All Rights Reserved.

Beginning in 2016, a portion of the proceeds from pages under the '/drupal-code-examples/' URI will be donated to charity.