Customization and theming

Configuration

Note: This page describes Adsense_Injector release 2.5 and later

Configuration is fairly straighforward.

Enable the options that make sense (insert in node body and / or on teaser lists), enable insertion on the desired node types, and configure the insertion templates as needed.

The default templates are fairly simple.

One interesting feature as of the 2.5 releases is the ability to insert before and/or after the node teaser or body, and the ad insertion now uses the adsense module filter tag format - in other words, you insert '[adsense:nnnxnn:1:1]' style tags rather than specify ad format in the configuration options. This vastly simplifies the configuration, and, provides maximum flexibility in setting up ad insertion.

Please see the adsense module help and documentation for more information on the filter tag and ad formats available for use.

Installation

Installation is done in the usual way: just drop the module into your selected modules directory and enable the module.

More info here:

http://drupal.org/node/70151

Stupid Template Tricks

Note: This page describes the 2.5 and later releases

Consider the default node insertion template (formatted for readability):

On full node views, this will insert a 120x240 left-floating ad block before the node body, then, after the body text, a 468x60 ad will be appended, both ads using the adsense module's group 1 and channel 1 settings.

Now, then, what else can we do? How about putting an ad on both the left and right side of the top of the node, as well as at the bottom? We can do that very easily, using inline float styles (for the purposes of this example - it's cleaner to use stylesheet-defined CSS rules).

(Yes, this is probably annoying in-your-face advertising, and I wouldn't recommend it, but it serves to demonstrate capabilities.)

Give it a try.

Obviously, you can play a lot of tricks with the template strings - for example, you can insert any arbitrary text before or after the node body, including html, javascript, etc. The sky (and your imagination) is the limit, just be careful not to break anything. (At this point, the adsense_injector module can do more than just inject ads using the new template scheme.)

Please see the adsense module help and documentation for more information on the filter tag and ad formats available for use.

View an archive by type or by category

Each module that produces content may have a page that lists content of that type. For example all blog posts can be seen at the blog path. Content that has been categorized using taxonomy terms have a page for viewing that content.

Add album images to the teaser

If you've got the audio_image module enabled you can attach images to audio nodes. Currently the images are not displayed as part of the teaser. The following code snippet shows how to override the default teaser theme function on a PHPTemplate theme. Add this to your template.php file.

For Drupal 4.7

For Drupal 5

For more info see #78883, the issue that spawned this.

Audio module FAQ

Q: Why does the player stop at weird parts?
A: I'm not really sure. If you're running into this bug please leave a comment on this issue with more information.

Q: Is there an upgrade script for 4.6 to 4.7?
A: Yes, there is read more about on issue #57769.

Q: I don't want to have to upload the audio to my site and waste bandwidth. Can I use remote URLs?
A: No, but it's a feature I'd like to implement.

Q: Why do I have to click the Flash player twice?
A: You're using IE. See #70241.

Q: I can only upload 2MB files or less.
A: If you notice that you can only attach 2Mb MP3's, you need to up your limits. Assuming your host allows this - you need to add a line like this to your .htaccess file: php_value upload_max_filesize 20M or check the upload limitations of your PHP.ini settings.

Q: I screwed something up. How do I completely re-install the audio module?
A: First, you need to remove the audio module's tables:

Audio module review

This module makes use of the wonderful getID3 PHP library for reading and writing ID3 tags for mp3 and other audio files. Creating a new audio file is as simple as creating a new 'audio' node type. The ID3 tags are extracted from the audio file and displayed in the node listing. The title can optionally be automatically set using the ID3 tag information, by default it is artist - song title. The node body itself contains all of the ID3 information for the audio file, with links for each of the fields. This allows a user, for instance, to find all audio files by artist, title, album, genre, and year, by simply clicking the link. Additionally, the length and format of the file are extracted and displayed too. And the best feature, it includes the XSPF Flash player so you can play the audio file right on the website, without having to download! If a user does want the audio file, there is a download link available as well. Additionally, if the ID3 tags are incomplete upon uploading, anyone with node edit permissions can edit the audio node and update the ID3 tags automatically! This module also keeps track of how many times the audio file has been downloaded and how many times it has been played through the website.

Because this audio file is created as a node, all of the wonderful node properties can be used. The most useful would be setting up a category (or a taxonomy) to label the content in this audio file, which can be setup to use 1 or more terms to "tag" the audio file. Each audio file can also be setup so users can post comments on the same page as the audio file as well.

Also, this module adds a link to each user's profile that links to all of their recent audio files, making it very handy to find all audio files uploaded by a certain person.

This review was adapted from a review written on Lullabot.com

Change audio player in 4.7

If you want to make changes to the flash player you can over-ride the theme function. To understand "theme level" and overriding functions in drupal go here. To change the player type you need to make a template file in your theme directory. I use PHPTemplate so the file is called template.php.

The following (assuming you're using PHPTemplate) makes the flash player red:

• Background color. If it's not specified, it'll default to transparent. 'b_bgcolor' => "000000"
• Foreground (border and icon) color. 'b_fgcolor' => "ffffff"
• Foreground color by state. The order is: connecting (spinner), ready (arrow), playing (square), and ??? (not sure). The b_fgcolor value will be used for any ommitted values. 'b_colors' => "ff0000,,00000ff,000000"

Avatar Selection - FAQ

Commonly asked questions and problems

My images aren't appearing

If your transfer method is set to "private" on Administer >> Site Configuration >> File System, then you may have problems viewing the avatar selection images. Please ensure that the file system path set is an absolute path and if you've changed your transfer method from "public" to "private" since uploading the images, you may need to re-upload them again. See http://drupal.org/node/92376 for more info.

Avatar Selection - Installation

Install the files

Download the latest version of the Avatar Selection module from the project page. Untar/unzip the files and place the entire avatar_selection directory in an appropriate module directory like sites/all/modules.

Enable the module

• Go to Administer » Site Building » Modules
• Make sure "Avatar Selection" is enabled (listed under "Other").
• Click Save configuration at the bottom of this form.

Avatar Selection - Settings

The Avatar Selection module can be configured at Administer >> Site Configuration >> Avatar Selection. Users will need the 'administer avatar selection' permission to alter the settings and to upload or delete images.

• Disable users uploading pictures to profile - This allows users to pick their avatar image from the selection provided by this module but prevents them from uploading new avatars when editing their account.
• Force users to select an avatar image - This only comes into effect on the user registration screen or when image uploads are disabled.
• Upload image - This adds a new avatar image to the selection. Maximum dimensions are 85x85 and the maximum size is 30 kB. Images must have one of the following extensions (case sensitive): png, jpg, jpeg, gif, PNG, JPG, JPEG, GIF.

To delete an image from the selection, go to admin/settings/avatar_selection/delete and check the box for each image you wish to remove. Then just click on the "Delete" button to finish. There is no delete confirmation message, so please ensure you have the correct boxes checked before clicking on this button.

Avatar Selection - User Permissions

There are just two permissions you can assign a user with the Avatar Selection module.

• access avatars - users with this permission will be able to view the avatar selection list, and select an avatar from it, when they edit their account details.
• administer avatar selection - this permission enables users to upload and delete avatar images and alter the configuration settings.

Adding banners to your site

Starting with version 4.7 of the module, Banners have their very own node type. To add a graphic banner, you need to have the Upload module enabled (graphics are attached to the banner nodes). Also, you will need to add them to a taxonomy term. Click administer » categories and either create a new vocabulary with the "banner" node type or add the "banner" node type to an existing vocabulary. Once you're done, click create content » banner to create a banner.

As listed on the Banner module info page, the banners module provides an interface to manage banners. To actually display the banners on your site, you need to add a small snippet of PHP code in either a block or directly to your theme template.

If you are not comfortable with editing your theme, adding a custom PHP block is the easiest method, but you will only be able to display banners in the sidebar. To add, for example, a banner to your header, you will need to edit your theme.

The banner_display(42,1) function is what is needed to display banners.

The number in parentheses refers to the taxonomy term ID from which you would like to show banners. Banners belong to taxonomy terms, so you will need to know the term ID for which they belong. You can usually find this out by going to administer » categories, then click the "list terms" link in your banner vocabulary to find the IDs for the category you use.

Displaying banners in a custom block

1. Click administer » blocks then the add tab.
2. Type in a title. This will be shown to the user as the heading for the block.
3. Choose "PHP code" as the input filter
4. Paste in the following code: <?php return banner_display(42, 1); ?>
5. • Note: replace 42 with the taxonomy term ID from the category you assigned the block(s) you want to rotate through in this block
6. Type in a block description. Only administrators will see this.
7. Click the Save block button

See the Blocks section for more information on working with the placement and setup of blocks.

Displaying banners directly as part of your PHPTemplate-based theme

1. In your theme's page.tpl.php file where you want the banner to appear, paste in the following code:
   <?php print banner_display(42,1); ?>

As noted above, the number indicates from which taxonomy term ID to display banners. You may add this code in multiple places in your theme, with either the same or different banner group numbers.

Important note: the code is slightly different than that for a block, in that it uses 'print' instead of 'return'.

• Save your page.tpl.php file.

• See the PHPTemplate section of the theme developer's guide for more information on theming.

  This was adapted from Bryght's banner configuration guide.

1) Installation and updating

4.7 and greater

Unpack the module ".tar" file in the Drupal module directory. (Note: It is often advisable to create a "contrib" directory under the main module directory in order to make house keeping and upgrades easier).
Now visit the admin/modules page and enable the biblio module. This will install the required database tables and setup a number of pre-defined
publication types. These types can be changed or deleted on the
admin/settings/biblio/types page.

Updating: Any time you install an new version of the module you should run the update.php script in case there are any database modifications included with the new version.

4.6

Unpack the module ".tar" file in the Drupal module directory, then create the database tables using following command:

mysql -u {userid} -p {drupaldatabase} < biblio.mysql

You will also have to enable the module on the admin/modules page.

2) Configuration

Base URL

This sets the base URL used to access the biblio module (e.g. /biblio ).

Number of results per page.:

This sets the number of results that will be displayed per page.
Restrict users such that they can only view their own biblio entries
This option restricts the users capability to view biblio entries. They will only be able to see the entries which they have created and own.

Footnotes

You can integrate with the footnotes module here.
Integration with the footnotes module
Depends on: Footnotes (enabled)
This will convert tags into tags. This will cause intermingled and tags to be sequentially numbered. For this to work, you must put the filter ahead of the filter in the filter chain. If this option is not set, and tags will be handled separately.

OpenURL

You can set an openurl link here

OpenURL Base URL:

This sets your institution's base OpenURL gateway, which is used to generate OpenURL links. To implement a "Universal" OpenURL system, try using OCLC's OpenURL Resolver Registry gateway: http://worldcatlibraries.org/registry/gateway

OpenURL Image:

Enter a path to your image here, this image will be used as button which when clicked will find the entry via the OpenURL link

Sorting

You can set the default sorting and ordering for the /biblio page here.

Sort by:

Author, Title, Type, Year

Order:

Descending, Ascending

Styling

You can set the default style for the /biblio page here.

Normalize author names when displaying biblio records

Tries (doesn't always work) to reformat author names so that they are displayed in the format "Lastname, Initials" e.g. Smith, J.S. (Note: This setting does not modify the entry in the database, it only reformats it's presentation. This option can be turned off at any time to display the original format.)

Links open in new browser

This causes the Author and Title links to open in a new browser window

Node Layout:

Original

Only Fulltext if available
This alters the layout of the "node" (full) view.

Style: (This alters the layout of the "list" view)

Council of Science Editors (CSE)
American Psychological Association (APA)
Institute of Electrical and Electronics Engineers (IEEE)
Classic - This is the original biblio style

Syndication

You can set the RSS defaults here.

Allow RSS feeds of new biblio entries

This will create an rss feed of the most recent biblio entries. It will be available at /biblio/rss.xml

Number of items in the RSS feed.:

Limits the number of items in the /biblio/rss.xml feed to this number.

Taxonomy

You can set the Taxonomy defaults here.

Use keywords from biblio entries as taxonomy "free tags"

This option allows user to add keywords (free tags) to describe their documents. These keywords will be registered as taxonomy.

Vocabulary:

Select vocabulary (category) to use for free tags.

3) Basic usage

visit biblio/

(more to follow)

4) Advanced usage

(content to follow)

5) Customization

(content to follow)

6) Uninstalling

Drupal 5.x

Disable the module on the admin/modules page, then click on the uninstall tab and select the module for removal. This will remove all of the biblio entries in the node table as well as the biblio tables them selves. NOTE: You will loose any/all bibliographic entries that you have made and this action cannot be undone.
So don't say you weren't warned!

Drupal 4.6/4.7

This is a bit trickier since you must delete all "biblio" type entries out of the node table (and in 4.7 the node_revisions table), then you can drop the biblio tables.

Torrent tracker module and torrent node type

• Bit torrent tracker module
• Bit torrent node type

Remove Page Title on pages with Blog Information block

On a blog created by the blog module the page title for the blog reads like "example's blog" where the name (example in this case) is the blog authors username. On these pages you may wish to wish to remove the page title and use the Blog Information block instead.

To do this, in phptemplate, you need to modify your page.tpl.php file. Change:

To:

This will not display the $title tag on pages that are /blog or have a node type of 'blog'. On all other pages it will be displayed.

Step by Step Setup of Calendar View

Why not use the Event module?

Using the Event module is perfectly acceptable, quicker/simpler way to get a basic calendar running on your site. If you need something more flexible/extensible, here's how to create a Calendar view. If you've got other differentiating factors, list them in the comments, and I'll incorporate them here.

How to implement a Calendar View

Using

• Drupal 5.1
• CCK 5.x-1.4
• Views 5.x-1.5
• Date 5.x-1.4
• Calendar 5.x-1.4

Install the Modules

Download and extract the modules in your /sites/all/modules directory.
Go to Administer › Site building > Modules and enable:

• Content
• Date (under CCK)
• Date API (under Other)
• Calendar
• Views
• Views UI

Make a custom Content Type to go on you calendar

Go to Administer › Content management > Add Content Type

• Name=Performance (or "event" or "meeting" or whatever you want to call it)
• Type=performance
• Description = Sing, Sing a song...
• Whatever you prefer for the rest of the form
• Save the Content Type

Edit the content type again and then select Add field

• Name = Time
• Field Type = Date / Selected list (or Date / Textfield with javascript pop-up calendar - if you have jstools enabled)
• Click "Create Field" and you'll be taken to second form
• Widget = Selected List (or Textfield with javascript pop-up calendar - if you have jstools enabled)(not sure why you have to select this twice)
• Label = Time
• Help Text = whatever
• Under Data settings:
  Required: checked
  Multiple Values: not checked

• Input Options
  Granularity: Year,Month,Day,Hour, Minute (but not second) selected
  To Date: Optional
• Click Save Field Settings

• Make a Performance so you'll see something on the calendar once it's working

  Create content > Performance

  • Title = Check your calendar
  • From Date = This Friday at 3:00pm
  • To Date = blank
  • Body = Hope I'm doing something fun this weekend
  • Click Submit

  Modify the default calendar view

  Go to Administer › Site building > Views and you should have a Calendar View
  Click Add..

  • The info under Basic Information, Page, and Block are all fine.
  • Under Fields delete the Node: Updated Time
  • Then under Add Field, select Date:Time and click Add Field
  • Next to Time Field, Label can be blank, Handler needs to be Do Not Group Multiple Values
  • Arguments can all be left alone
  • Under Filters ... Add Filter, select Node: Type and click Add Filter
  • Operator = Is one of. Value = Performance
  • Exposed Filters can be left alone
  • Under Sort Criteria, delete Node: Updated Time, and Date: Time (field_time). Leave the Order Ascending

  Click Save and you're back at the Administer › Site building > Views. You should see the default calendar view with an Overridden status. And at the top will be your new calendar view that uses your CCK node called Performance

  Click on the link under URL and you should see your performance on the correct day. If everything looks OK, go back and edit the view again and in the Page > Menu section, check Provide Menu. By default, the menu link will appear in the Navigation menu, but you can move it wherever by going to Adminsiter > Site Building > Menus.

reCAPTCHA

The reCAPTCHA module uses the reCAPTCHA web service to improve the CAPTCHA system and protect email addresses. For more information on what reCAPTCHA is, please visit the official website.

Installation

1. Extract the reCAPTCHA module to your local favourite modules directory (sites/all/modules)
2. Download the reCAPTCHA PHP Library
3. Extract the files to modules/recaptcha/recaptcha so that recaptchalib.php is available at modules/recaptcha/recaptcha/recaptchalib.php

Configuration

1. Enable both the reCAPTCHA and CAPTCHA modules in admin/build/modules. Note that the reCAPTCHA module requires Captcha version 2.1 or up
2. You'll now find a reCAPTCHA tab in the CAPTCHA administration page available at admin/settings/captcha/recaptcha
3. Register for a public and private reCAPTCHA key
4. Input the keys into the reCAPTCHA settings. The rest of the settings should be fine as their defaults
5. Visit the Captcha administration page (admin/settings/captcha) and set where you want the reCAPTCHA form to be presented

Mailhide Input Format

The reCAPTCHA module also comes with an input format to protect email addresses. This, of course, is optional to use and is only there if you want it. For a demonstration of how it works, please see the official website. The following is how you use that input filter:

1. Head over to your input format settings (admin/settings/filters)
2. Edit your default input format and add the reCAPTCHA Mailhide filter
3. Click on the Configure tab and put in your public and private Mailhide keys
4. Use the Rearrange tab to change the weight of the filter depending on what filters already exist

Resources

• reCAPTCHA Project Page
• reCAPTCHA Official Website
• CAPTCHA Project Page

CiviContribute

CiviContribute allows you to accept donations online via Paypal or Moneris. Additional payment processors can be supported by extending the modular code. Read the CiviContribute Guide for more information.

You can:

• Track and store any type of contributions (time, money, in-kind, volunteer hours, etc.)
• Associate custom data with any contribution type.
• Associate contributions with a central data store.
• Create an online donation page.
• Configure possible donation amounts including user entered donation amounts.
• Customize the text of the donation page
• Add custom fields stored in CiviCRM to handle data required for political, nonprofit or other specialized donations.

Installation instructions for CiviCRM

CiviCRM installation instructions for installing CiviCRM.

Adding a CiviCRM-based Field to a CCK Data Type

To actually see CiviCRM data inside of Drupal, you need to add a CiviNode widget into one of your CCK data types. Here are some quick steps to get you started:

1. Go to Admin / Content / Content Types, and either create a new data type, or select one you'd like to add a CiviCRM field to. See the CCK Handbook for more information.
2. Choose "Add Field". If you've activated CiviNode and the CiviCRM CCK Widgets module, you'll see a couple of new widget types in the "Field Types" section: the CiviCRM Contact and CiviCRM Group widgets. The contact widget comes in two basic "flavors": a "Contact Selector", which is a simple pop-up, and the "Contact Autocompletor", which uses AJAX (i.e., JavaScript) to search for contacts. The Contact Selector is a good choice if you have a small group of contacts you want to assign to a field (say, for a "Group Leaders" or "Staff Assigned" field). Use the Autocompleter if you need to search for one contact out of a large group (say, one voter out of a hundred thousand in a voter information database). If you have ever used the Node Reference or User Reference widgets from CCK, you'll recognize how the Autocompleter works. Hit "Create Field" to continue creating your field.
3. On the next page see, you configure the field. At the bottom of the page, there are a couple of new options to configure in the "Data settings" section: Default CiviCRM Group, and Default CiviCRM Profile. The default group setting lets you restrict the contacts that a field will display to only those contacts belonging to a CiviCRM group. You will almost always want to choose this option, especially if you use a Contact Selector. The default profile setting lets you control what contact fields from CiviCRM you want displayed. This allows you to control who sees what fields, and helps keep your private data private.
4. Once you've configured your field, you will probably also want to set up the way the field will display in node pages. Go to the Display Fields section of the Manage Fields page, and choose a formatting option. You can choose to display only a single field of your contact (the default is the "display_name" field), or display the contact as a link into CiviCRM's contact viewing and editing page (you'll need to grant the web user the rights to do see this, of course), or as a Profile. You can set different settings for the Teaser display than for a full page display.

There are a lot more features to CiviNode, and the module is under active development. But hopefully, this will get you started.

Installing and Configuring CiviNode and Related Modules

To install CiviNode into Drupal and create and use CiviCRM content in your pages, you first need to set up CiviCRM and CCK, and you should look at the documentation for those modules elsewhere. If you want to take advantage of CiviNode's support of the Views module, you should install Views as well.

Once you've done that, there are a couple of things you will need to do in order to get started:

• Download the CiviNode tar ball from our project page, and "untar" it as unusual into your sites/all/modules directory.
• Activate the module in the Admin / Site Building / Modules. Note that under Drupal 5.x, you can't activate CiviNode unless CiviCRM is installed and active. You should also turn on the Content module for CCK, and the CiviCRM CCK Widgets module (note: the CiviCRM Data module is now obsolete, and is only included for those folks who have data in that format.).
• You need to have at least one CiviCRM profile defined in CiviCRM. A profile is just a grouping of contact fields you want to display together. You define a profile by going to the CiviCRM / Administer CiviCRM page (follow the link in your Navigation menu) and use the "CiviCRM Profile" tool in the Config section. You can define as many profiles as you like, and use different profiles for displaying various kinds of content on your site.
• Once you've defined some profiles, you need to tell CiviNode which profile to use as its default. Go to Admin / Settings / CiviNode, and you'll see that your profiles now appear in the setttings page. Select the one you want, and click on Save.

CiviNode is now configured, and we're ready to create CCK fields using your contacts.

Location, location, location - using the location.module to provide location-based ads.

You can use the location module to add location-based attributes to ads created using the Classified Ads module

You can see an example of the location module in use on http://gigs.exodusdev.com .

One advantage of this technique is that you can also enable google, yahoo, and other map support available in the location module.

Using location.module with classified ads.

• Install and configure location.module
• Enable locative information for ed_classified nodes
  Note: The location module requires that a zip/postal code be entered in order to auto-generate latitude and longitude information, which is required if you want to use mapping functionality - nodes with no zip/postal code entered will require manual editing of latitude/longitude information if you wish to use mapping functions. This implies that if you want ads to show google maps functionality, you should require zip/postal codes be provided for all classified ads. Check location.module access control settings to ensure that users who can create new ads are also permitted to submit latitude/longitude information, as well.

Glossary

Content Type

Content Type is a collection of fields that defines the define the structure of a piece of content. Content type is equivalent to node type in everyway. A content type maybe an "event", a "blog", a "story", ...etc.

Field Type

Field

Field Instant

Widget

Recommend Nodes

CRE is able to present a list of recommended nodes in various different ways through the use of node_recommendation.module. This module presents lists of recommended nodes in various ways and allows for some variations on how and what type of node can be presented.

Node_recommendation module provides a page for which the current logged in user will receive their recommendations. This page is located at ?q=recommendations or /recommendations depending upon if your site is using clean url's or not. You can change the title, maximum number of recommendations to display, the maximum age of the node and specify the proper votingapi tag (see VotingAPI documentation for further details). All these settings can be accessed at admin/cre/node for those using 5.x or at admin/settings/node_recommendation for those using 4.7.

Secondly, node_recommendation provides three different blocks:

1. General Recommendation block
2. Similarly Rated block
3. Recommend nodes of a particular type

The general block lists, as one would expect, of any type.

Similarly Rated Nodes block will display nodes that have been voted on in a similar pattern as the currently viewed node. Essentially, those that liked this node also liked these nodes.

Recommend nodes of a particular type will list nodes that are only of one type. For instance, you can set this block to only recommend story nodes, or page nodes, or blog nodes, or a user created node.

Important information

1. User has not voted yet
2. User authored all nodes that have been voted on
3. User has voted on every node in votingapi_vote table

This is a design decision and each one has important merits for various reasons, some obvious some not so. If you wish to remove one of these conditions, please contact me

Basic configuration

1. Enable the directory module.
2. Configure the Directory module by visiting your site's admin>>settings>>directory page.

At a minimum, you must configure the following items correctly in order to use the directory module on your site:

1. First, check off any node types that you want to exclude from the directory listings - by default, all node types are candidates for inclusion in the directory listings, and you must choose the ones that you wish to exclude. This is somewhat confusing and can be a source of frustration for directory module users - be sure to check off only those node types that you wish to exclude from the directory listings!
2. Next, select the vocabularies (taxonomy terms) you wish to expose in the directory listing index. These selections will determine which taxonomy terms appear in the top-level (and upper-level) branches of the directory listings.

The remaining settings control display behavior - set them according to your needs. Note: Items marked with an asterisk ('*') are not working correctly in the 4.7 version.

• Resource count threshold to display subcategories*
• Number of resources to display for each visible subcategory*
• Explanation guidelines - a block of text to be displayed at the top of every directory page.

01. Getting Started

Make your Drupal installation ready with Dript:

1. Download the latest copy of Dript module from the Dript project page.
2. Extract the compressed module into a folder.
3. Upload the files via FTP to a modules folder in your Drupal installation - this could be the modules/ folder, but it is recommended to create and use the folder sites/all/modules/, making it easier to update Drupal later on. Once uploaded you should have folder modules/dript.
4. Activate your Dript module. Click Administer » Site building » Modules. You need to check the box next to the Dript module, and click on 'Save configuration' at the end.

Test your Dript installation:

1. Create a page content.
2. Set the title "Dript Test".
3. Paste the following code in the body of the content:
   [driptn (print "Hello world")/]
4. Submit the content.

You should get a new page with the title "Dript Test" and the content "Hello World".

02. Why Lisp?

Why not vbscript instead? Okay, we're not going to start any debate here (a forum should be a good place to exchange ideas). We choose Lisp because the language seems not to let us take side. Most great programmers of other languages will simply praise Lisp, even if they haven't code a single pair of lisp parentheses. We have seen how AutoLisp is very successful with AutoCAD. And not to miss mentioning Emacs.

Lisp is not a proprietary language. And it is natural for Lisp to have dialects. If we were to invent a new language then we can easily create controversy. Lisp is been supported strongly by academic institutions all over the worlds. We can easily find documentation, reference and tutorials about Lisp on the Internet. Most importantly Lisp was created by a non-programmer and has been nurtured by non-programmers as well. The term non-programmer is referring to a person who doesn't use a main stream programming language such as C/C++, C#, vb.net, Java, PHP, Perl, Ruby, and Python to program, as a profession, an application for others to use.

Lisp is an easy language for starters. You don't have to read a whole lot of it before you can get started. In fact you don't have to think like a programmer to start coding. The essence of Lisp is function, like the mathematical functions we used to tweak at high schools. We just need to think what function our code is supposed to do and type it down in Lisp expression. For instance, if we want to get the average of five numbers we will then write (avg 6.2 4.1 5.7 8.3 2.9). We don't have to worry about what module to include. And we don't have to compile the code! The basic idea for non-programmer is to write small code for the job. Once it is done the code will be forgotten. Here is where Lisp excels. Lisp allows us to express our code in unlimited manners where we have ample room to be creative or expressive. However, our code may become oatmeal with fingernail clippings mixed in as Larry Wall of Perl used to say. But then again the code is supposed to be forgotten!

Those who quest for intelligent will find Lisp interesting. John McCarthy the creator of Lisp maintains the artificial intelligent as his main research where he started long ago. And Lisp is being used widely in the subject. I wish one day somebody will maintain a nice web site for him.

Read Richard Stallman's My Lisp Experiences and the Development of GNU Emacs.

03. Inspecting Dript Functions

The number of Dript functions will grow in numerous ways. We will easily get lost with what function exist in Dript. Fortunately all Dript functions are self describing.

Use the following functions to get to know all Dript functions:

1. To list all the functions in Dript, evaluate (funs).
2. To get the syntax of a function, evaluate (syntax 'function-name).
3. To get the description of a function, evaluate (desc 'function-name).

You may need to create a scratch page to play with those functions. Make sure you don't check the published box for your scratch page. Otherwise your web visitors will be wondering what you are doing.

Note: Hyphen '-' and underscore '_' in function names are treated the same. This is so because the underlaying PHP code cannot take hyphen in function or class name. While it is common to use hyphens in Lisp function's names and variables yet we have to convert them to underscores in PHP. Just treat this as a feature in Dript.

04. Dript Behaviors

Symbolic
Dript inherits fundamental Lisp behaviors. However, Dript takes symbolic expression very seriously where Dript discarded many earlier Lisp concepts that wanted to make lisp nearer to machine such as memory pointers, car-cdr link list and dotted pairs. Lisp should keep itself as far as possible from the machine. Dript also does not extend lisp to the complexity of Common Lisp or Scheme. The only data structure in Dript is the list.

Object Orientation
Dript or Lisp does not oppose OO. As Lisp, Dript is a meta language where it can be used to create dialects or sub-languages which may include OO languages. OO is actually a type of namespace. So instead of implementing OO it is better for Dript to go to the root and implement namespace. For a reference, local scoping such as the body of a function is also a namespace. A data structure is also a namespace.

Variable
A true functional language will not implement variable because variable introduces side effect. However, in real world coding, it is very tough to code without escaping to variables. Thus, Dript permits variable but does not make it mandatory. Hence there is no global variable defined by Dript. One significant different between Lisp and Dript is that all variables defined in a body of a function including the parameters have local scope in Dript. The early Lisp violates the principle of functional programming first by allowing variables and second by letting all variables global by default. For the sake of comprehension, all variables can be replaced by functions.

Parentheses
Generally every Lisp dialect will retain the parentheses which are significant in handling complex symbolic expression for both code and data. With parentheses a Lisp code can also be a data or vice versa. Hence it is a feature in Lisp where a code may not only consume data but also another code. The outcome can be very complex, indeed. This is one of the feature that is attractive to artificial intelligent research.

nil
Not in list or nil is a very fundamental concept in Lisp. There is either something in a list or nil. The concept of nil is similar to zero in digital number where even nothing need to have a representation. We may say a function will return something or nil. Hence nil is a very basic logical expression. With nil there is no need for another true or false expression.

Quote
Quote ['] is a marker that tell the evaluator not to evaluate an element that precedes with one. The evaluator is designed to evaluate every element in the list to reduce the list. An evaluation of a function will reduce the function into its return values. An evaluation of a variable will reduce the variable into its values. A quote will give a function a chance to evaluate an element itself. And a quote will let an element to be retained as data. In Dript an element can have multiple quotes where the evaluator will only deduce one of them before passing the element to a function or to the next evaluation.

Function
Dript itself has no build-in function. All functions are define externally. Even arithmetics and logical operators are implemented as external functions. There are two ways a function can be defined in Dript. Firstly, define a function using PHP which requires some understanding of Dript architecture. Secondly, define a function using (defun) function which has been defined earlier using the first approach. A function is always handled using prefix notation where the function name is the first in the list. A function call is alway enclosed in parentheses.

E-Commerce Installation

Important: Please back up your site and database first. Then proceed as follows:

Place the files

Download E-Commerce (v3) from the project page. The current recommended download is 5.x-3.x-dev. (Note that the "3" part is what people are referring to when they mention "v3" . Untar/unzip the files and place the entire ecommerce directory in an appropriate module directory like /sites/default/modules.

Download the latest Drupal 5 release of Token module as well and place this alongside ecommerce.

Enable the core modules.

While continued testing has shown things to be more stable, the installation process and E-Commerce core has changed a lot for Drupal 5. I recommend that you install your modules in a number of simple steps.

Navigate to the Modules page via Site building » Modules. Then install these modules in 3 stages. Note: you can do steps 1-3 all at once and it should be ok - however you may prefer to take extra care and avoid any disturbing warnings.

1. There is a single non-EC module to install.
   • Token
2. It is recommended at this stage to install the following E-Commerce core modules before anything else:
   • Mail Subsystem
   • Product API
   • Anonymous purchasing
3. And then these core modules:
   • Store
   • Cart
   • Payment API

Additional modules

The rest of the modules can be considered optional. E-Commerce modules are grouped into 4 major categories: core, payment, product and uncategorized.There is information next to the module defining dependencies with some modules (ec_media) requiring you to install modules from outside E-Commerce.

Standard settings

Go to E-Commerce configuration » Mail and here you can set up the emails templates that correspond to various situations. You can use special placeholders, like %user that will be replaced with the actual data.

Go to E-Commerce configuration » Store and make some simple decisions about your store:

• Can the customer purchase anonymously?
• Do you want transaction notices sent periodically (requires cron)?
• Are the E-Commerce core modules all installed?
• What text would you like to display on the user's order history page?
• Set emails for invoice, payment error, questions, cancellations
• Should "add to cart" be a link? Or allow entering a quantity?

Go to E-Commerce configuration » Payment and check that your price formatting is to taste. Also on this page is a payment testing option that you should be aware of, because this setting is usually in addition to settings used by the various payment modules.

Set the order of pages in the checkout process by going to
E-Commerce configuration » Payment. Adjust the order as required and click Update screen order.

Standard settings

Optionally, you can enable the cart block via:
Site building » Blocks

Of course, grant the proper access to user accounts under:
User management » Access control. The main access control provided by E-Commerce core is "administer store" in the Store section. Remember, each time you enable a module, you should check this page for new permissions that may need to be assigned.

E-Commerce upgrade notes

Token module

Before upgrading your site to v3, please make sure that Token module is installed. A fresh install will force you to install token module, but upgrading is a less controlled situation.

Flexicharge - adding custom charges

Flexicharge is a module which integrates into the shopping cart, and which allows you to add a range of custom charges to the cart that meet your specific business needs. To add these charges, go to E-Commerce configuration @raquo; Flexicharge.

Base features

Every Flexicharge has a number of behaviors that you can turn on and off. Some of these behaviors are not always available, if they are not relevant to the charge type. All of these are available in a simple "Site-wide charge":

Site-wide charge

This is a stock standard charge with only the complexity that Flexicharge adds to it. Flexicharge has been designed to take as much complexity from the charge providing files as possible. So if a simple "site-wide" charge doesn't fit the bill, it will be easy to develop your own or to hire a developer to do so.

Shipping charge

This is designed to be an alternative to Shipping and Shipcalc. This allows you to apply a charge based on the weight of the products multiplied by a rate. Here are some instructions to set up a simple shipping charge.

1. Install the E-Commerce Address module so that you can capture shipping details in the checkout.
2. Got to E-Commerce configuration » Location and set your default country and the default measures for your site. Currently Flexicharge shipping only requires weight.
3. Install the E-Commerce Regions module. This will allow you to combine locations together under a "region" and then configure shipping charges based on the region of the buyer combined weight of the product. Follow the instructions for groups your locations into shipping regions. The regions you will create might be called "Local", "Interstate" and "O/S".
4. Once you have your regions configured, go to E-Commerce configuration » Flexicharge and add a new "Simple shipping" charge. The first section is for your standard Flexicharge configuration settings, and beyond that is a section for each region so that you can allocation a base rate plus cost per kg/lb.

Payment: use payment gateways

The payment module allows for various payment gateways to be used such as different regional credit card gateways. The payment module is useful for enabling stores to support a choice in currency and payment gateway.

You can:

• enable dependecies like the payment module at administer >> modules.
• configure price formatting, recurring payments, and payment testing at administer >> store >> settings >> payment.
• file issues, read about known bugs, and download the latest version on the ecommerce project page.

New gateways

Because of the current development environment, we are unable to commit most new payment gateway modules that people submit to us. The is because payment gateway code is a potential risk to other users, and therefore we require at least 2 active E-Commerce contributors to provide ongoing testing and bug-fixing.

We hope that this arrangement will be more flexible in the future, but in the meantime all the payment gateway module issues that are not committed (as well as requests) are kept postponed in the queue.

The one exception to this is our desire to support Google checkout. Please register your interest (as a developer or a user/tester) on this Google checkout ticket

Product: Create products for ecommerce store

The product module allows you to sell a product which is a good or service that you wish to sell through your web site store. This is useful for generating revenue to help fund a site.

You can:

• enable the store module dependency at administer >> modules.
• configure permissions to administer, create, update, and delete products at administer >> access control.
• create products at create content >> products and then select product types.
• use image_attach module to add images to content types and then product enable content types to display products with images.
• file issues, read about known bugs, and download the latest version on the ecommerce project page.

Recurring products, role assignments and user account creation

From 4.7, subscriptions and memberships has been rewritten for Drupal E-Commerce. In E-Commerce 4.6, there was some support for recurring payments, however this did not cover many user requirements and including integration with memberships. The new code is split into the following modules:

All of these modules can be installed by downloading and installing E-Commerce, and activating the modules above via administer » modules

Developers can monitor the expiration schedules via administer » store » settings » show schedule list which becomes available when the ec_devel module is installed.

Shipping charges

E-Commerce provides you with the ability to automatically charge shipping fees during the checkout. Essentially you assign weights to your products, and then the shipping fee is calculated locally through charges you assign, or remotely via live shipping APIs (currently UPS, USPS and Canada Post are supported).

Note: For simple shipping, without the need to a shipping API like USP, please refer to Flexicharge.

After you've installed the core modules, the relevant modules you can activate for shipping in administer » modules are:

Store: configure your ecommerce site

The store module allows you to configure your ecommerce site. You can see transactions, configure store searching, and see store overiews.

You can:

• enable product, payment, and cart module dependencies at administer >> modules
• configure search, advanced search, transaction, update transaction, create new transaction, delete, and confirm delete at administration >> store.
• configure customer accounts for purchases and payment notices at administer >> strong.
• review the store transactions, store overview, and create new transactions.
• file issues, read about known bugs, and download the latest version on the ecommerce project page.

Product types

E-Commerce features several different product types, each implemented through a separate module and each having its own features.

To enable a new product type:

• Ensure you have the product.module enabled
• For contributed product types, install database tables if needed. All tables needed by core product type modules are included with the core install, so no additional database installation is needed.
• Enable the desired product type module (see their module names in the following lists).
• Under administer > permissions, set desired permissions for the product type.

Core product types

• File
  Implemented through the file.module, the file product type allows you to sell access to downloadable files. The customer will access the files they paid for by clicking on the 'my files' link in their navigation block after they log in.
• Non-Shippable
  The generic.module creates non-shippable items with no inventory management.
• Collections of Products
  The parcel.module allows you to create groups of ecommerce items. Specifically, you can create packages: groups of items that are sold as a whole.
• Shippable
  The tangible.module creates shippable products for ecommerce. Optional features include inventory control and availability estimates.

Contrib product types

As well as the above product types, a number of contributed types ship with the E-Commerce package distribution. Some of these require special installation, e.g., creating database tables.

• Auction
  The auction.module creates a very simple product that can be bid on by users.
• Donation
  The donate.module enables financial contributions.
• Hosting
  The hosting.module is used to sell web hosting services.
• Service
  The service.module module allows selling a variable rate service.

There is no price set for the service, so the user has to enter the dollar amount for the service, as per
agreement with the site owner.

This is useful for getting paid via Paypal for things like design and programming project.

When creating donation product types, choose 0 for the price and select
the 'hide' option for the 'add to cart' link.

Managing your store

This section is open to any tutorials, tips and suggestions that help people manage their E-Commerce installation.

Developer documentation

• Code documentation
• mailing list

E-Commerce comes with a developed API to facilitate extension of the suite of modules. Here is a quick introduction to the API designed to get you started developing E-Commerce solutions.

The product API

Most E-Commerce hooks involve the product API, implemented through hook_productapi().

Product API hooks options include many of the actions of the nodeapi, enabling the creation of specialized product types, as well as several custom options for accomplishing actions like adjusting prices and managing inventory.

Product API options include:

Product API also implements versions of the following hook_nodeapi() options: fields, validate, form, load, insert, update, delete.

Event mangement module comparison

There are many modules that support event organizing. This chart provides an overview and a comparison of the existing modules functionality. We need to add a pre-event plannig column to this chart. There is a full page version here.

If you're using Firefox WIN, and you cannot see the entire table's width due to the CSS float bug, try using the "print" view to see the entire table. Note that you must be logged in to access the "print" view.

This page was written by Kieran Lal from CivicSpace. If you are interested in collaborating on event management or improving this page please contact Kieran.

Making sure you got the Events entered correctly

As a recent convert to the Event family, and hitting a small bug (that has been fixed now), I found it messy to make sure I had the events entered without weird starting/ending times or the right taxonomy terms or the right durations. So I decided to check up on myself and created this little snippet to show all my events in a little more concise way. This is just a simple table that summarizes all those fields. Feel free to use it.

Note: This snippet is for 5.x-1.x of Event.

Settings Permissions for Event Mangement

There are several permissions that relate to event management that are documented below.

anonymous users: the most basic issue with permissions as it relates to anonymous users is the ability for them to view events (note that this also applies to all types of nodes, not just events, i.e. - pages, books, etc...). Simply visit admin >> access and set the node module permissions as appropriate. node module => check access content for the anonymous user role.

administering events: for permissions relating to the ability to actually administer events, look for admin >> access >> flexinode module and set role permissions that allow user roles to

• administer content types - this is required if you want the user role to be able to specify the default options - i.e. promotion, moderation, promote to front page, etc... and if you want the user role to be able to specify the default view, edit and permissions for permissions for users. To be even more specific, this permission controls all permissions which are set here - admin >> node >> configure >> types
• create event content
• edit own event content

CiviCRM integration with EventFinder

EventFinder is integrated with CiviCRM in the latest release. The level of integration currently available is:

• event registrants are recorded as individuals in the database
• registrants are tagged as event participants
• an action is recorded on an individual's record saying he or she registered for a certain event, including the title of the event

There is also a lot of experimental functionality developed using CiviCRM betas that extends this a great deal further. When I get the change to port it, you will get the following as well:

• users with permission to create events will be able to make lists of people to invite and send trackable email invitations (all data stored in CiviCRM)
• suggested events (recommends other events based on common registrations between CiviCRM individuals)

Editor Installation

Eye-drop Editor is basically an editor written in JavaScript, with module that provides an API to interact with the editor. The JavaScript ships with the editor so the only thing you need to do is install Eye-drop.

1. Go to Administer » Site building » Modules.
2. Tick "Eye-drop Editor" and Submit the form

However this will have no effect, since Eye-drop Editor is a tool that other modules must implement. Read further for a description of how to install and configure Eye-drop Field, which is essentially a CCK field that integrates with the editor.

Eye-drop Field - a CCK field for editable images.

Eye-drop Field is a CCK field that will ship with the first version of Eye-drop Editor (EE). This module is a functional example of integration with EE, and it was written due to the need for a practical solution in a new website.

Download

• Please download 5--1-0 release of Eye-drop for this demonstration.
• (18-feb) Please use the development version of Eyedrop.

Goal

This module was written specifically for the following requirements:

• The client runs a fancy dress shop, her products are often parts of other things. She uses images from her customers - say a customer has a party and sends a picture of 4 people (ie. four costumes). She wants to upload the image once and use parts of the image for different products.
• The site theming requires consistency in image size. Some have a specific height and width (thumbnails). Some just need to be a certain width.
• Images need to be applied to multiple products.
• There is no time or resources for separate image editing software.

Solution

Image Configuration

• Go to Administer » Site configuration » Image and configure the image sizes that you want to have in the site. For example, make 'thumbnail' 100 x 100 and 'preview' 500 x BLANK.
• Go to Administer » Site configuration » Image and allow images to attached to multiple nodes (not actually compulsory, just keeping in line with the goal).

New Content Type

• Go to Administer » Content management » Add content type and create a new content type, say, called "Costume".
• Click on your new content type and click Add field. Use a label that is the same as the image derivative name (eg. "thumbnail") and select "Image Selection" as the field type.
• Next you edit the field itself, and there is only one setting you need to worry about - Link this field to which derivative size configured through the Image module? Here we select the "thumbnail", which effective links the label "thumbnail" and the target width and height (100x100) that we have assigned to the thumbnail derivative in the Image module settings.

Making it work

OK, some of this stuff is a bit hacky.

• Whatever your normal files directory is, create a directory inside called eyedrop_field
• Other stuff, yada yada yada. Yes, still very much in development.

Roadmap

This is a brief outline of the next steps (bug fixes not included):

• Pretty-up the UI
• Restructure the javascript so that the main routine does not contain any editing code, just managing buttons, parameters, canvas size, layers and callbacks.
• Make the cropping script more generic so that it can be a) reusable in layers and b) reusable in different editing actions (crop, select, draw, copy/paste).
• Add new actions: rotate, effects, watermark, outline, etc. This functionality will be couple to transformer. Make these actions tied to buttons.
• Establish layers, where representations of each step can be viewed and specific actions altered.

FAQ - Installation

Install the files

Download the latest version of the FAQ module from the project page. Untar/unzip the files and place the entire faq directory in an appropriate module directory like sites/all/modules.

Enable the module

• Go to Administer » Site Building » Modules
• Make sure "Frequently Asked Questions" is enabled (listed under "Other").
• Click Save configuration at the bottom of this form.

FAQ - Settings

The layout of the FAQ page can be modified on the settings pages (Administer >> Site Configuration >> Frequently Asked Questions). There are a number of question and answer layouts to choose from. In addition, if the 'Taxonomy' module is enabled, it is possible to put the questions into different categories when editing. Users will need the 'administer faq' permission to configure the layout, etc.

You can view screenshots of the settings pages here.

FAQ - User Permissions

There are a number of different permissions you can assign a user with the FAQ module.

• view faq - users with this permission will be able to view the FAQ nodes and the automatically generated 'faq' page.
• administer faq - this permission enables users to add, update and delete FAQ nodes, regardless of who the original author was. In Drupal 5.x and later versions of the module, this permission is required for editing the configuration on the settings pages (Administer >> Site Configuration >> Frequently Asked Questions).
• create faq - allows users to add new FAQ nodes. (Drupal 5.x and later only)
• edit faq - allows users to edit FAQ nodes, even if they were not the original author. (Drupal 5.x and later only)
• edit own faq - allows users to edit FAQ nodes that they have created. They will not be able to edit FAQ nodes created by other users. (Drupal 5.x and later only)

Generating a list or table of flexinode output

Flexinode can automatically generate a teaser-style list or table of all nodes of a particular flexinode type:

Front_page vs. Static Pages

Static pages can offer you a lot of the features that the front_page module offers, but, it has a LOT more administration to do. For example, to implement these features with static pages, you'd have to:

1. Check whether the person is logged in.
2. All the blocks must be set not to display on that particular page.
3. The user must know some PHP to do #1 and also to do redirects as logic can't be used in HTML.
4. No way to disable the logo section of the theme for the page (e.g. a user might just want an enlarged version of his logo with a few bullets of text on the main page - no other themable objects), without using another module.

Front_page module makes creation of a different front page for your site very simple, and offers more choice than static pages. Static pages for customized front pages is too involved for new Drupal users (and of course lazy administrators...) and front_page module provides a completely functional alternative.

GMap 5.x API

The GMap 5.x API is significantly changed from previous releases. Maps are now proper form elements (though they can still be rendered individually) and the entire system is extensible using a system of "handlers" and "events."

Many of the features that previously required custom javascript were integrated into the core system, and can be activated by switching on "behavior flags," another new 5.x feature. Behavior flags can be toggled in code or by a macro, and the system will use the default value as set in the GMap settings page for anything not directly specified in the map code / macro.

Downloading and Installation

IMCE can be obtained from the project page. You should choose the appropriate release for your drupal installation.

After downloading the package you should extract it to the modules directory. Like any other module, IMCE can be enabled/disabled in modules page.

After enabling the module you can assign access permissions to roles in administer > access control page. The next step is to configure how IMCE will function in your site by changing the settings at administer > settings > imce page.

If IMCE is configured properly;

• tinyMCE users will be able to open IMCE by clicking the browse button in image or link dialog.
• FCKeditor users will be able to open IMCE by clicking the Browse Server button in image or link dialog.
• Plain textarea users will be able to open imce by clicking the appropriate text link under the textareas that are specified in settings.
• Images and other files can be sent to related applications from the IMCE interface by just clicking the add link or the file itself while previewing.

Javascript API for custom usage of IMCE

IMCE introduces two javascript hooks for custom usage. One of them is hookImceFinish function and the other is global hookImceUrl variable. In order to use these hooks one must open IMCE browser by specifying a proper window name with window.open method. That window name plus hook names will be the custom function and the custom URL.

Here is a sample code for opening IMCE with window.open:

window.open('imce/browse', 'windowName', 'width=640, height=480');

For this instance of imce there should be a previously declared function named as windowNameImceFinish and optionally a variable named as windowNameImceUrl. If the function exists, IMCE will call it when the user clicks "add" link. windowNameImceUrl will be used for highlighting if it matches any url in the file list.

hookImceFinish

This function is called with five parameters:

1. file path - URL of the selected file in the file list
2. image width - width of the selected image. (0 if it's not an image)
3. image height - height of the selected image.
4. file size - formatted file size (ex: 35.2 KB, 45 bytes, etc).
5. IMCE window - reference to the currently active IMCE window. it can be used for closing the pop-up.

so, one can implement a function like this:

hookImceUrl

This optional global variable is used for highlighting of the matching url in the file list. In other words, if it's value matches any of the paths in the list, that file is highlighted.

One may change the value of this variable just before opening the IMCE pop-up.

windowNameImceUrl = '/files/images/img.gif';

Using an argument with Insert view

The [view:myview=maxitem=firstargument] form can be very useful. For example, if you have a site with the following structure (every node except Home is a book page) :

• Home
  • Transport
    • Cars
    • Taxi
    • Train
    • Airplane
    • Web sites
  • Culture
    • Museum
    • Library
    • Theatre
    • Web sites

Web sites nodes may seem redundant but they only show web sites about transport or culture. If you had no argument, you should create a view for each one (for example view_culture_sites and view_transport_sites).

One might say you wouldn't need the Insert view module as the Views module already allows you to create a page view with argument. That's true, but you won't be able to attach it to the book structure.

In the example, you need a node that can store URLs (either a new CCK node or a Jan's node, or whatever you want) and a taxonomy attached to it.

You then create your view with the Views module and define an argument on Taxonomy Term ID (or Taxonomy Term name).

In every Web sites node you insert the following tags :

• [view:websites=100=transport] for the transport web sites page,
• [view:websites=100=culture] for the culture web sites page.

Basic site set up

Follow the steps below to set up a basic multilingual site with the most common options selected.

Installing and Enabling the i18n Package

• Download and install the package
• Enable the following modules: locale, internationalization, and translation
• Set up your basic modules
• Define your languages

These are the basic modules you need to enable to have a multilingual site:

Figure 1: Modules in i18n package

Once the modules are enabled, visit the module settings page and go to Administer>Site Configuration>Multilingual system

Figure 2: Basic multilingual settings

When the internationalization module is enabled, there are two additional options in the language management page: a text field to name the native language name and a check box to mark the language as LTR (left to right). This latter option has no further effect unless it is handled properly by the theme.

Figure 3: Language set up

Enabling Multilingual Content

• Enable the language block
• Enable multilingual support for specific content types

Now you have to enable the content types you want to be in multiple languages. This can be done on Administer>Content>Content types for each content type. A new option to enable/disable multilingual support will appear at the bottom of the settings page.

Figure 4: Enable content types to be multilingual

New! There's a new option for content types called extended language support. It will allow you to set all defined languages - not only enabled ones - for selected content types. With this feature enabled, it is possible to have a site in a few languages, which will be the ones enabled, showing in the languages block and used for localization, while allowing a larger number of languages for some content types.

Experimental modules and features

There are a number of new modules, grouped as i18n - Experimental, providing some new features. These are new developments with some of them proof of concept that will be extended in the future and some of them only needing some further testing before being considered production quality.

i18n Taxonomy

This allows for the translation of taxonomy terms using the localization system for chosen vocabularies. This is a temporary solution for term translation. Currently it supports node edit forms, node links, and views filters and fields. Other types of taxonomy terms cannot be translated.

Synchronization

This keeps taxonomy term translations synchronized for all nodes in a translation set. For chosen vocabularies, it automatically updates all nodes that are part of the translation of a node that has been edited or created. This module is the first step of what may be an additional synchronization layer for node translations.

Strings

This is a proof of concept implementation of 'configurable string translation' as outlined here: http://groups.drupal.org/node/1880
It provides a basic interface for string translation and a 'tt' function intended to be used by other modules to have web configurable strings tracked and translated on the fly.

i18n - Content Types

This provides translation for content types like names, descriptions, and help texts using the Strings module.

Translatable Text

This is a proof of concept implementation of a translatable text field for CCK. It requires a small one line patch in content.module to disable caching.

Feature overview

The internationalization package is a set of modules that add multilingual content capabilities to Drupal. In the collection, each module addresses a specific functionality. The main features provided by these modules are the following:

General Features

• Language selection block to switch the language
• Browser language detection
• Multilingual variables

Multilingual Content

• A new language field can be added to chosen content types (nodes).
• Only content in the selected language is displayed for each page view.
• Translations can be defined between nodes, which allows for linking a node to translations in different languages.
• Several selection modes are available for content, meaning you can have node lists for only the current language, for current and default languages, all languages, etc.
• Basic work flow management for translations.
• New! Views support.

Multilingual Taxonomy

• Language can be set up for vocabularies or terms
• Both multilingual vocabularies with terms in multiple languages and and single language vocabularies can be created
• Translations can be defined between terms in different languages
• New! Taxonomy term synchronization can be defined per vocabulary for translations
• New! Taxonomy term translation can be done using localization for selected vocabularies

Translatable Profile Fields

• Configurable profile field created with the profile module can have different names and descriptions in every language
• Options for selection lists can have a different display name in every language

Internationalization 4.7: Multilingual content

This is a collection of modules to add multi-lingual capabilities to Drupal sites.

Provides content translation -nodes and taxonomy-, interface translation for anonymous users -with the locale module- and browser language detection. Includes a block for language selection and manages translation relationships for nodes and taxonomy terms.

http://drupal.org/project/i18n

Managing multilingual content

Once you have set up the content types you want to have in multiple languages, a new language field will be added to each one. Then content will appear in the language you are browsing in. Additionally, the translation module allows for translations between nodes.

Translations are created as additional nodes related to the original node. A collection of nodes that are translations of the same content are grouped together as a translation set. When displaying content in a given language, links to different translations will be provided by the languages block and optionally as node links below the content.

A new language field is available below the content title. It will default to the current language, but another can be selected.

Figure 1 : Creating content with language.

Once you have created an original story in English, a new Translation tab becomes available. Once you've clicked on this tab, you'll find options to create a translation in any of your active languages or select an existing node that can be set as this one's translation.

Figure 2 : Translation tab for content.

Now click on Create translation for Spanish and a new node submission form with some populated fields will be displayed. Note that the taxonomy terms for the original content will be automatically translated if such a translation is available. Regarding term translation, see Multilingual categories.

Figure 2 : Creating a translation.

Multilingual categories

With the internationalization module, it will be possible to set a language for vocabularies or terms. In addition, when the translation module is enabled, translations can be created for taxonomy terms.

When a language is set for a vocabulary or term, only ones that match the the current language will appear in taxonomy listings and when creating and editing nodes. If the language is set for a vocabulary, all the terms in that vocabulary will be automatically set to that language.

Creating terms with language is simple with the internationalization package. For example, we created the vocabulary 'colours,' which has no language assigned to it, thus allowing terms in multiple languages within the same vocabulary.

Figure 1: Creating a taxonomy term with English language.

Then we created the terms 'red', 'green', and 'blue' in English and 'rojo', 'verde', and 'azul' in Spanish. If we go to the 'translation' tab and click on add translation, we can choose a term for each language that will be part of this translation.

Figure 2: Creating term translations.

If we repeat this process for the three terms, we can see all the translations in the Translation tab

Figure 3: Term translations.

Once we have terms and translations, only the correct terms for each language will show up while browsing the site. When we are editing a node, the terms for that node's language will be available.

Multilingual variables

Some text and settings are stored in Drupal as variables, and some site wide ones like 'site name' and 'site slogan,' along with module specific ones, can be edited through the administration pages. The Internationalization module makes it so these variables can be translatable.

To enable these variables to be translatable we need to identify the low level names Drupal uses for them. This can be done looking at the 'variable' table in the database or searching through the code. However, we'll show you how to translate the more common setting below.

Once you have identified the variables you want to be translated, they need to be added in the settings file as follows:

/**
 * Multilingual settings
 * 
 * This is a collection of variables that can be set up for each language when i18n enabled.
 * These are the basic ones for Drupal core, but you can add your own here.
 */
$conf['i18n_variables'] = array(
  'site_name',
  'site_slogan',
  'site_mission',
  'site_footer',
  'anonymous',
  'menu_primary_menu',
  'menu_secondary_menu',
);

The configuration file is usually under /sites/default/settings.php or another subfolder depending on the settings of your site. Also there may be more than one if you are using a multi-site set up.

Once you have the correct settings added to your configuration file, they'll be marked as 'multilingual variable' when you go to the corresponding administration pages. You must switch the site language while in the administration pages to set the value for each language

Figure 1 - Multilingual settings

Paths and block visibility

Once the internationalization module is enabled, a language prefix is added to all paths and links. This path defines the interface language - localization - and the default language for content.

The language prefix is removed at the beginning of the request and is added again for internal links to be displayed. Thus, all paths will work the same as before for all the modules enabled.

Path Aliasing

Path aliases can be created as usual without using path prefixes and the system will work just fine. The only limitation is that path aliases must be different for each language. It is also possible to define path aliases using language prefixes. The path system will still work, but this can cause some issues with path handling.

Block Visibility

When using paths for block visibility, language prefix may be used to restrict visibility to specific languages. For example,
en/* will mean all English pages
en/node/* means all node pages when browsing the site in English
Note: <front> can not be combined with languages to specify path, thus the path for the front page will depend on the actual site front page setting (i.e. 'en/node' or 'es/node' if the front page is 'node').

Site Front Page

There are two methods to specify different front pages per language:

• The first one is to add 'site_frontpage' to language dependent variables, and then define a different path for each language.
• The other option is to use the same path for all languages, but use different aliases like

Some sample sites

This list doesn't intend to be a full listing of Drupal sites using the i18n module, but rather a collection of some sample sites.

Fight Hunger, an initiative of the UN World Food Programme. Includes some bi-directional languages and theme.
Canadian Treatment Action Council
Arco Latino, an organization reaching across several European cities
Industrial Workers of the World, a union's site with 16 languages
DTRAC, the Disaster Tracking Recovery Assistance Center, in English and Thai
Khmer Software Initiative in English and Khmer
Nonviolent Radical Party Transnational and Transparty
THREES ANNA, a writer and theater directors' website
Reyero.net, the website of the module's author

If you have some other good examples just post a comment here and I'll add it to the list.

Technical overview

This is a technical overview of how the i18n module works, how it integrates with Drupal, and some tips to take advantage of the module's API for advanced customizations.

Data Model

This module adds a minimum amount of data to Drupal's database, linked to objects that may be translatable, like nodes and taxonomy terms.
The two pieces of information we need for the system to work are

• Language property: This is the 'language' text field that keeps language code for some objects, including nodes, taxonomy vocabularies, taxonomy terms, and menu items.
• Translation ID: This is the 'trid' field that provides the relationship between multiple objects that are translations of each other.

[Table explanation and link to data model picture]

Drupal Integration

As the module has evolved from a set of developer's tools to an end user's pluggable module, it has avoided as much as possible to patch Drupal core, relying instead on several powerful mechanisms built into Drupal.
Path rewriting
...
Query rewriting
...
Node system and taxonomy hooks
....
Forms API
...

i18n API

Some API functions used by the modules internally can also be used to take advantage of some of the features or to build custom pages, blocks, or theme snippets.

Views support

The internationalization package has added some support for the views module with the new i18n - views module. It adds the following fields and filters:

Fields

• Language: This displays node language.

Filters

• Language: A simple language filter that allows you to select one or more enabled languages.
• Language (extended): A language filter that allows you to select from all defined languages.
• Selection: This filter allows you to set a language selection mode for views results. It allows you to define which kind of language conditions will be applied (current language, all languages, etc...).

Integration with other contributed modules

Here are some notes about integration with other contributed modules. This about configuration and integration with other modules to use i18n features, but not about compatibility problems. If you have any issue about compatibility with other modules, please file a feature request on the issue tracker.

Pathauto

AFAIK Pathauto module plays nice with i18n module. In addition to that, there are some features added into i18n module to provide different path templates for nodes depending on language.

Note: this won't work for bulk pathauto operations

1. Add pathauto variables to language dependent variables in settings file, like:
2. $conf['i18n_variables'] = array(
..............
'pathauto_node_pattern', // General pattern for nodes
'pathauto_node_blog_pattern', // Pattern for blog nodes
'pathauto_node_story_pattern' // Pattern for story nodes
............
);
3. Set up different patterns for each node type/language on pathauto settings page (Like other variables, switch interface to set values for each language...)
4. Play!

TinyMCE

it works fine, but when setting up the paths for the visual editor to show up, the language prefix needs to be taken into account

Use
*/node/*
instead of /node/* that won't work

Event, Image, CCK...

Images, event dates and CCK fields are copied over when creating a translation of a node. It will also work for most of other content types.
For the case of images, you'll need to re-create all the translations if you update the original image file.

Theming features. RTL language support.

One of the new features of this module is some support for Right-To-Left languages like Arabic or Hebrew that needs also to be implemented on the theme side.

In the languages administration tab, there's now a new checkbox to mark languages as 'RTL' -Right to Left-. However it is at the theme stage when this should be taken into account to switch the text direction and maybe also the page layout.

Figure 3: Language set up
To make a theme i18n compatible for RTL support, one possibility is to simply switch stylesheets depending on the language settings. Here's some code example that may be added to your theme to add the right stylesheet.

Note: There are a few themes that support bidirectional text using a hardcoded list of languages. Though this will work for some predefined language list that depends on the theme, i18n language settings will be ignored.

How to create a list of links

Introduction

This module came about as a need for a solution "at the time" and was shared on Drupal.org sometime later. One of the requirements was a "list of links" on a page. This page describes how that was done.

First of all, having installed the Janode module create a vocabulary that will be dedicated to the Janodes you create (they can of course live in multiple vocabularies but in order to get a list we need a vocabulary dedicated to Janodes).

Once you have a vocabulary in place make a note of it's vid (vocabulary identification number). The easiest way to do that is, in admin > categories visit the "edit vocabulary" then look at the URL. The number at the end of the URL is your vid (write it down, you will need it later).

For the purposes of the following example this is my link:-

admin/taxonomy/edit/vocabulary/19 so my vid is 19. Replace 19 in the following section with the vid of your vocabulary.

Create the listings page

Now that you have you vid and have created some janodes and applied them to categories from you new vocabulary we'll create a listings page.

From Create content select page and start a new page. In order to create the page you will need to set the "input format" to PHP code as we are about to write a snippet.

Enter the following code into the body of your page. Remember to change the vid from 19 to what ever vid you wrote down ealier.

Note, this is your starting point. If you want to alter the appearence you will need to play with the code. Also, remember, if you get broken PHP code in the snippet then, at best, the page will not display, at worst you'll break the site (white screen of death!). So be careful.

This page was written because it's a FAQ in the Janode issue queue.

<credit> This snippet was based on this original snippet </credit>. Comments from ajayg rolled into article

Installation and Upgrades

Fresh Install
LDAP Integration module does not have any specific install instructions. Simply install the module following the Drupal contributed module installation guide.

Upgrades
Between 4.7 and 5.x versions of the module, the module's backend was overhauled and it also was being transferred to new maintainers. As such, upgrading the module from previous versions to 5.x will include a complete uninstallation of the old version and re-installation of the new version. Also, ldap configuration information will have to be re-entered.

1. uninstall the old module
2. remove the module entry from the system table
   • This sql query:
     

     SELECT name FROM system

should show you all of the modules that were in installed (active or inactive). You should see entries for ldapauth, ldapgroups or ldap_integration.

• Delete those entries. For e.g.
  

  DELETE FROM system WHERE name = 'ldapauth'

• Install the new version module following the drupal 5.x module installation guide. It will create the table and the new module.

Configuration of ldapauth module

Once the LDAP Integration module (also referred to as ldapauth module) is installed, it's time to enable the module and configure it.

• Proceed to Administer >> Site building >> Modules
• In the fieldset titled "Administration", enable the ldapauth module
• Configure the module
• Proceed to Administer >> Site Configuration >> LDAP Integration
• Click Configure LDAP Server
• Server Settings
• Name: Name of the LDAP Configuration. It must be unique
• LDAP Server: Hostname of the LDAP Server. For e.g. ldap.example.com For Active Directory, this would be the hostname of the AD domain controller. If you have multiple domain controllers, then common practice is to create a DNS Round Robin entry for all of the domain controllers and use that entry (dc.example.com).
• LDAP Port: Standard LDAP ports are 389 and 636. 389 is standard non-secure port where communications occur in cleartext (analogous to HTTP Port 80). 636 is the standard encrypted LDAP port (analogous to HTTP Port 443.
  If you are using Active Directory, then you must select the encrypted port, 636.
• Use TLS Encryption: Required for Active Directory. For encrypted communications, select this option. (TLS is the new name for SSL, so if your LDAP server requires "SSL", then you must check this box )
• Store passwords in encrypted form: This option is used by the optional ldapdata module, which allows for changing of passwords using Drupal. Using this option will cause the LDAP data module to perform MD5 encryption of the passwords before they are sent to LDAP. If your LDAP server natively performs encryption, then it could cause problems.
• Login Procedure
• Do not store users' passwords during sessions: If you are going to use the ldapdata module and allow users to modify their LDAP entries, this module will need to store the user password during the session, so that it can have write access to the LDAP directory.

  Physically, these passwords are stored in the Drupal's session table in clear text. If the database is well protected, this should not be a problem, but some admins may feel uneasy about this.

  If you are not going to use the ldapdata module, or you are, but only for read-only access, you can safely check this box and get extra security for your system.

• When logging in, Drupal will look up for the user in:
  • Drupal's own database. If it fails, look in LDAP: Self-explanatory
  • LDAP Directory only: Selecting this option will cause ONLY LDAP accounts to be authenticated and registered, except for the initial admin user (user with uid=1). Drupal's core administration relies on this user, so this user is NEVER authenticated with any database other than the local drupal database
• Base DNs: In the text area below, enter the base dn to search against when authenticating LDAP users. You can enter multiple DNs, one per line. PHP LDAP performs SUB scope searches by design. So if all of your users are organized under several sub-containers under say for e.g., cn=Users,dc=example,dc=org, then you only need to enter 1 base dn, cn=Users, dc=example, dc=com
  For OpenLDAP etc, an example would be ou=People,dc=example,dc=com
  For Active Directory, an example would be cn=Users,dc=example,dc=com
• Username Attribute: The attribute in the user's object representing the username.
  For Active Directory, it is sAMAccountName and for most Unix LDAP environments, it is uid
• Advanced Configuration
  The process of authentication starts by establishing an anonymous connection to the LDAP directory and looking up for the user on it. Once this user is found, LDAP authentication is performed on them.

• However, some LDAP configurations (specially common in Active Directory setups) restrict anonymous searches.

  If your LDAP setup does not allow anonymous searches, or these are restricted in such a way that login names for users cannot be retrieved as a result of them, then you have to specify here a DN//password pair that will be used for these searches.

  For security reasons, this pair should belong to an LDAP account with stripped down permissions.Most LDAP and Active Directories do not allow anonymous binds

• DN for non-anonymous searches: Enter the BINDDN of the account used to bind to the LDAP directory. For e.g. cn=drupalread,ou=Service Accounts,ou=People,dc=example,dc=com
• Password for non-anonymous searches: Enter the BIND password. Note: This password is stored in cleartext in the drupal database so you must take steps to protect the database

• Save the Configuration
  Save the configuration and you will be re-directed to the LDAP Integration configuration list page. You can have multiple LDAP servers configured and individually active and de-activate them. Deactivating a config will prevent it from being used by any of the LDAP modules.

  NOTE: The LDAP Servers will be consulted in the order they are listed. They are listed in the order they are created. Future releases will include an option to re-order them for authentication.

Configuration of ldapgroups module

ldapgroups module integrates LDAP Groups with Drupal roles.

Configuration

• Goto Administer >> Site configuration >> ldapgroups
• The active LDAP configuration are listed on the page. Select edit to configure Groups to Roles mapping
• There are multiple ways to configure LDAP groups to Drupal roles mappings:
  • Group is specified in user's DN:
    In some LDAP installations, users are arranged in OUs that represent their departments etc.
    For e.g.
    uid=jdoe,ou=IT,dc=example,dc=com, represents a user in the IT department
    uid=jdoe2,ou=Accounting,dc=example,dc=com, representing a user in the Accounting Department

  Checking this option will enable the mapping of these departments to Drupal roles. From the above example, this would result in the following roles being created: IT, Accounting

  Check the box and enter the attribute name in the text area. The attribute name is the attribute in the user's DN that represents the group name. In the above example, it would be ou

• Groups are specified by LDAP attributes:
  
  Use this option if the user object contains an attribute that represents the group the user belongs to. This is most commonly applicable to Active Directory environment. The attribute of the user object that holds the group DN is memberOf.

• Groups exist as LDAP entries where a multivalued attribute contains the members' CNs
  This scenario is most applicable to UNIX LDAP environments. In this scenario, the LDAP groups are stored as objects with its members represented by the attribute memberUid
  

• Click Save configuration to save this configuration.

• All active ldap configurations can be configured to map groups into roles. The same configuration that was used to authenticate the user into Drupal will be used to perform groups to roles mapping as well.

Configuration of ldapdata module

This module allows mapping of LDAP user attributes to Drupal fields. It uses the profile module.

Configuration

• Goto Administer >> Site configuration >> ldapdata
• The active LDAP configuration are listed on the page. Select edit to configure LDAP attribute mapping
• Drupal-LDAP fields mapping: Currently, the following attributes can be mapped between Drupal and LDAP
  • mail (E-mail address)
  • password (User Password)
  • signature (Signature line)

  The Drupal to LDAP mapping for these can be done in multiple ways

  1. Changes in account fields will be mapped to LDAP attributes and back: Checking this box will allow the Drupal users to modify the above attributes in Drupal and have it automatically updated in LDAP. This option requires a user account with read/write privileges to LDAP.
  2. Same, but read-only mode: Check this box if the users can view the LDAP information in the Drupal profile but not have the ability to change them
  3. No mapping: This option will clear any existing mappings that are present for this configuration

  Enter the attribute names that map to the specified drupal fields in the text boxes. Consult the LDAP Documentation and/or administrator for details on the attribute names

• Drupal-LDAP fields mapping: In this section, configure which attributes are visible to in the My account section of the user and which attributes are modifiable by the user. In order to extend the attribute list that is appearing here, the configuration file modules/ldap_integration/ldapdata.conf.php can be modified.
• Advanced configuration: In this section, enter the bind dn and bind password of an LDAP account that has read/write abilities to the user and group objects.
• Click Save configuration to save this configuration.

All active ldap configurations can be configured to map ldap attributes to drupal fields The same configuration that was used to authenticate the user into Drupal will be used to perform attribute mapping.

Advanced configuration

ldapgroups
Advanced configuration of the ldapgroups module can be performed by editing the modules/ldap_integration/ldap_integration/ldapgroups.conf.php file.

By default, when a user logs in, all of the groups are converted into roles. This may not be desirable in specific instances and the admin may want to restrict what LDAP groups are actually converted into Drupal roles. In order to achieve this,

• Edit the modules/ldap_integration/ldapgroups.conf.php file and specify your groups and their role names:
  
  $GLOBALS['ldap_group_role_mappings'] = array(
  // LDAP group => Drupal role
  'cn=users,ou=Group,dc=example,dc=com' => 'Users',
  'cn=IT,ou=Group,dc=example,dc=com' => 'SiteAdmins'
);

Add the specific groups that need to be recognized as Drupal roles and their role names. Note: Make sure that the last group-role mapping does not have a trailing comma ,

• Uncomment the function ldapgroups_roles_filter. Note: Uncommenting this function will cause the groups to be filtered through this function. The result is that only the groups specified in the global variable $GLOBALS['ldap_group_role_mappings'] will be parsed, ignoring the rest.

• ldapdata

  Advanced configuration of the ldapdata module can be performed by editing the modules/ldap_integration/ldap_integration/ldapgroups.conf.php file.

  By default, the ldapdata module presents the following attributes for read/write access to the users.

  • givenName (First Name)
  • sn (Last Name)
  • cn (First Name)
  • mail (E-Mail address)

  Access to additional attributes can be given to the users by adding to this list. Consult the configuration file modules/ldap_integration/ldap_integration/ldapgroups.conf.php for examples

Lightbox V2 - Howto add a lightbox to your images

Adding a basic lightbox

Adding a lightbox to your images couldn't be easier. Just add rel="lightbox" attribute to any link tag to activate the lightbox. For example:

The title attribute in the link tag is optional. The addition of this attribute enables the display of a caption with the image displayed in the lightbox.

Grouping images

If you have a set of related images that you would like to group, then you will need to include a group name between square brackets in the rel attribute. For example:

There are no limits to the number of image sets per page or how many images are allowed in each set.

Turning the caption into a link

If you wish to turn the caption into a link, format your caption in the following way:

Lightbox V2 - Installation

Install the module

Download the latest version of the Lightbox V2 module from the project page. Untar/unzip the files and place the entire lightbox2 directory in an appropriate module directory like sites/all/modules.

Install the Scriptaculous/Prototype libraries

Due to variation in licensing, you will need to download the Scriptaculous/Prototype libraries seperately. For Drupal 4.7, please download the latest versions of the libraries from http://script.aculo.us/download. For Drupal 5 please visit:
http://www.stellapowerdesign.net/scriptaculous-drupal.zip.

• Download the Scriptaculous/Prototype libraries using the appropriate link as mentioned above.
• Copy the files located in the 'lib' and 'src' directories of this download into the 'lightbox/js/' directory of the LightboxV2 module.

The required files are:

• lib/prototype.js
• src/builder.js
• src/dragdrop.js
• src/effects.js
• src/scriptaculous.js
• src/slider.js
• src/unittest.js

Enable the module

• Go to Administer » Site Building » Modules
• Make sure "Lightbox2" is enabled (listed under "Other").
• Click Save configuration at the bottom of this form.

Lightbox V2 - Settings

The Lightbox V2 module can be configured at Administer >> Site Configuration >> Lightbox2. Users will need the 'administer lightbox2' permission to alter the settings.

• Use Lightbox2 Plus - Un-checking this box will enable Lightbox2 Lite. The Lightbox2 Lite option does not use the Scriptaculous/Prototype libraries and is therefore less likely to conflict with other modules.
• Enable for Image Nodes - Checking this box will enable automatic URL formatting for image nodes, for example those in image galleries and in the "random image" block.
• Enable Grouping - Checking this box will enable automatic grouping of image nodes on a page. This is quite useful for image galleries and image sets.
• Disable Lightbox for Gallery Lists - Checking this box will disable the lightbox for images in gallery lists, but will still use the lightbox when viewing gallery images. This is useful when you want to be able to click on an image to enter the gallery but you want to have the lightbox appear when you click on a image when viewing the contents of a gallery.
• Enable Gallery 2 Filter - Checking this box will enable the Gallery 2 filter.

Lightbox V2 - User Permissions

There's just one permission you can assign a user using the Lightbox V2 module, "administer lightbox2". This permission enables users to modify the configuration settings on Administer >> Site Configuration >> Lightbox2.

Installing Liquid Wiki Engine Project

Important: Please download the current development release (HEAD). Some important changes have been applied.

Note: The 4.7 branch is no longer being developed. It contains heaps of bugs and should not be used.

1. From a command line, download the *.tar.gz file to your "/sites/all/modules/" directory. (wget http://ftp.osuosl.org/pub/drupal/files/projects/%filename%)
2. Expand the archive file using the tar command. (tar -xzvf %filename%)
3. Navigate to your site's module administration page. (Typically http://www.mysite.com/?q=admin/build/modules)
4. Enable each of the four Liquid modules according to your needs. If uncertain, enable them all.
   • Liquid Base - Allows wiki name-binding for nodes
   • Liquid Access - Allows more detailed access control
   • Liquid Wiki-Filter Framework - Will become a wiki-filter framework. However, at present it just delivers Mediawiki markup...
   • Liquid MoveRef - Move reference add-on for Liquid. Keeps track of what pages have been moved and redirect/refer to the new locations.
5. You're now ready to begin configuring Liquid by navigating to your site's admin by module page. (Typically http://www.mysite.com/?q=admin/by-module)

Upgrading: Liquid 0.2 (5.x-0.x) is not backward compatible with Liquid 0.1 (the heavily patched 4.7.x-0.x version). Thus, upgrading can cause a nightmare of problems. One thing to note is that the wikipage module has been removed. You must therefore add a new content type (Administer -> Content management -> Content types-> Add content type) with id "wikipage" in order for your site to work. There are also other problems since the database isn't backward compatible. Be sure to uninstall the old version of liquid before upgrading to the new version. You might want to check that the install scripts doesn't remove the wiki_name and wiki_moveref tables before uninstalling. However, make sure that the wiki_access table is dropped ( if not, do it manually before reinstalling). If you have set the access level of some of your pages to "protected" or "none" these settings will have to be reset after the upgrade.

A note on upgrading: Basically, upgrading isn't supported. If you attempt to upgrade you are pretty much on your own.

HOWTO: Integrate mailing lists with forums using listhandler and mailhandler

(To allow users to post to, and receive email from Drupal forums)

1. 
   

2. Things to do outside of Drupal
3. 
   
   1. 
      

   2. Go to your web hosting account's administrative page and create an email account (mailbox) that will be dedicated to receiving posts to your forum. Give it a non-obvious name, to prevent spammers from sending posts to your forum by addressing this mailbox directly. (Your users will not have to know, nor should they know, the name of this mailbox.)
   3. 
      

   4. While still in your hosting account, create a mailing list that will be dedicated to your forum. This is typically done through Mailman or whatever mailing list manager comes with your account. Give this mailing list an easy-to-remember name, since this is the address to which your users will email their forum posts.
   5. 
      

   6. Go to the admin page for the list you created in step 1.B, and subscribe the email address of the mailbox you set up in step 1.A to your list. Make this subscription non-public so no one will know it's there but you (in Mailman this is done using the "hide" option for that subscription). Also subscribe your own email address to the list (public or private, depending on whether you are going to allow people to see who is subscribed to your list). You should also add a "subject prefix" (e.g. "[CS Community]") to your list, so that your users will know the origin of the emails they receive. You may also wish to add any initial regular member email addresses to the list at this point, since subscription to the list will not be done automatically when a user is added in Drupal (this is one of the big headaches/maintenance chores of this approach, but I am told that the EZMLM module provides this capability if you use it instead of Mailman or another list manager). Also see the note in step 2.C.3, below.
   
   

4. Things to do in Drupal

5. 2. If you have not already done so, create your forum using administer|forums. Go to "forums" on the main sidebar menu, click on the name of the forum, and note the "tid" number at the end of the contents of your browser's address bar (e.g. http://www.mysite.com/myforum/6 – "6" is this forum's tid).
   4. Go to administer|mailhandler|add mailbox, and complete the fields as follows:

   2. E-mail address and Second E-mail address: enter the address of the list you set up in step 1.B (not the address of the mailbox you set up in step 1.A).
   3. 
      

   4. Complete either the Folder field or the mailbox fields to point Mailhandler to the mailbox you set up in step 1.A.
   6. Mime preference: as desired
   7. 
      

   8. Security: disabled (typically)
   9. 
      

   10. Send error replies: disabled
   11. 
       

   12. From header: leave blank
   13. 
       

   14. Default commands: "tid: n", where "n" is the tid of the forum you set up in step 2.A
   15. 
       

   16. Signature separator: as desired (I leave mine blank)
   18. Delete messages after they are processed?: selected
   19. 
       

   20. Cron processing: disabled while setting up, enabled thereafter (step 3.H)
   21. 
       

   22. Input format: as desired

   
   

   4. Go to administer|listhandler and complete the fields as follows:
   1. Admin address: enter a unique email address, e.g. mailto:list-admin@mysite.com
   2. 
      

   3. Strip title: anything you don't want to see added to the title or subject of your posts. Usually includes the "subject prefix" you entered in step 1.C.
   4. 
      

   5. Account status: "blocked" if you don't want anonymous posters to your list (or to the mailbox you set up in step 1.A if someone figures out what it is) to be granted any privileges on your site. "active" if you run a wide-open site to which anyone can subscribe and post. (Note: Listhandler will automatically add an anonymous poster to your site as a user. If you don't want to allow anonymous users to post to your list, thereby preventing them from automatically being made members of your site, be sure to disallow anonymous posts to your list in step 1.C.)
   6. 
      

   7. Mailing List: You will see the mailhandler you set up in step 2.B in this list. Enter the same "subject prefix" you entered in step 1.C.
   
   

   4. Testing and completing your setup

   2. Open your email client and send a message to the address of the list you set up in step 1.B (not the mailbox you set up in step 1.A).
   3. 
      

   4. The list manager you set up in step 1.B should send a copy of this message to the mailbox you set up in step 1.A, and also a copy to you, assuming you have subscribed both the mailbox (required) and yourself (optional, but recommended) to the list in step 1.C.
   6. In CS/Drupal, go to administer|mailhandler, and click "retrieve" for the mailhandler mailbox you set up in step 2.B. You should see a message saying "n" messages have been retrieved for the mailbox.
   7. 
      

   8. Go to the forum that corresponds to this mailing list. You should see your post there.
   9. 
      

   10. Go back to the inbox of your email client and reply to the copy of your own post that the list manager has sent you. Wait for your reply to appear in your inbox, indicating your list manager has processed it and sent it to the mailbox you set up in step 1.A.
   11. 
       

   12. Repeat step 3.C-D, and verify that your reply has been properly "threaded" (attached as a comment to the original post).
   14. Go to your site, click "forums", and use "post new forum topic" to post a message to the forum at the site (i.e. not via email). Repeat step 3.C. Your post should be sent to your list, and you should receive a copy of it in your email client's inbox.
   15. 
       

   16. Once you have verified that things are working properly, go to administer|mailhandler, click "edit" for the mailbox, and set Cron processing to "enabled". Mailhandler and Listhandler will now process incoming and outgoing posts every time cron.php is run.
   
   

   Congratulations! You have now linked a mailing list with your forum using Mailhandler and Listhander. If you have multiple forums, repeat the above steps using a separate mailbox (step 1.A) and mailing list (step 1.B) for each additional forum. (This will add to your maintenance tasks, though, so keep your site to as few forums as possible.)

   </</p>

00. HOWTO: Creating a multi-lingual website using Localizer

The purpose of this guide is to provide an introduction to setting up and configuring a Drupal site that has a switchable, multi-lingual user interface, as well as to show how content can be entered and managed in more than one language. This document assumes that the target site is running Drupal 5.x.

Please note that the process for installation of the Localizer module itself is not covered in this document. Please refer to the README.txt file in the downloaded archive for installation instructions. There is also a separate HOWTO for detailed installation procedures.

01. HOWTO: Installing Localizer (New install)

Note: This document is being updated to reflect changes in Localizer version 1.9, and should not be used for older versions of Localizer.

The purpose of this document is to provide a more detailed version of the installation instructions found in the README.txt file that comes with Localizer. It is geared more for beginners with shared hosting accounts than any other audience, but may be useful to others as well. If you are already a proficient Linux user, this is probably too basic for you--head on to the shorter instructions in the README.txt file. For the rest of us, hopefully this will be of use. Note that this document was based on Localizer version 1.9 when being installed on Drupal 5.1. Things may change faster than this documentation, so keep one eye on the README.txt file in any case.

First some background. Drupal uses Unicode (specifically UTF-8) encoding, so most of the languages of the world can be displayed using it--even side-by-side if that is what is necessary. While there are high hopes for true multilingual capabilities in Drupal 6, as of version 5.1, Drupal core does not provide for a true "multilingual" environment, meaning that it has very limited language switching capabilities, and no way to enter or keep track of content in multiple languages. This is done by Localizer.

As of Localizer version 1.9, brute-force patching of Drupal core is no longer necessary for installing Localizer. However there is one small modification to the settings.php file involved, and due to distribution rules on drupal.org, portions of Localizer (flag graphics and modified drupal core files) must be downloaded and installed separately. So, installation of Localizer is slightly more involved than other modules you may have dealt with. Give yourself a little extra time for the installation.

02. HOWTO: Upgrade to Localizer 1.9.x

This document may get expanded in the future to look more like the other HOWTO documents, but here is a short version that I hope will help people out a bit.

Upgrade instructions (Upgrade from older versions of Localizer to Localizer 1.9 on Drupal 5.1)

1. Download the latest Localizer module from http://drupal.org/project/localizer.
2. Download the flags icons from http://www.speedtech.it/files/localizer-flags.tgz
3. Download pre-patched core files from
   http://www.speedtech.it/files/localizer-sites-all-5.1-1.9.tgz
4. Login to your site as administrator and under Administer > Site building > modules, disable all the Localizer-related modules
5. Delete the old module/localizer directory (could be sites/all/modules/localizer)
6. Return the Drupal 5.1 modules that you previously patched for Localizer versions prior to 1.9 to their original state. (In other words, download Drupal 5.1 and extract the the following files from the tarball: block.module, menu.module, taxonomy.module, bootstrap.inc, and common.inc. Upload these to your site, overwriting the existing modules.)
7. Extract localizer-5.x-1.9.tgz archive under sites/all/modules (create the modules directory if needed) This will create sites/all/modules/localizer that contains the Localizer-related module code.
8. Extract localizer-flags.tgz under sites/all/modules/localizer. This will create sites/all/modules/localizer/flags with the flag files in it.
9. Extract localizer-sites-all-5.1-1.9.tgz under sites/all (it already has the modules and localizer directory, so the contents will go into sites/all/modules/localizer.
10. To the end of your sites/default/settings.php file, append the following code (making sure that the path is correct for your site) and save (overwrite the file):
    $conf = array(
    'cache_inc' => 'sites/all/modules/localizer/system/includes/cache.inc',
);
11. Login to your site as administrator (UID=1)
12. Under Administer > Site building > modules, enable all the Localizer-related modules you need. Click Save configuration.
13. Visit www.yoursite.com/update.php and run the update script.
14. Under Administer > Site configuration > Localizer, configure options as appropriate.
15. Enjoy!

FAQ

Here there is the list of the FAQs

Websites using localizer

• http://www.eliberatica.ro
  Portal of eLiberatica conference in Romania
  The eLiberatica Conference brings community leaders from around the world to talk about the hottest topics in FLOSS (Free/Libre/Open Source Software) movement demonstrating the advantages of adopting, using and developing Open Source and Free Software solutions.
• http://www.osgeo.org
  Open Source Geospatial Foundation Website
  The Open Source Geospatial Foundation has been created to support and build the highest-quality open source geospatial software. The foundation's goal is to encourage the use and collaborative development of community-led projects. This website serves as a portal for users and developers to share their ideas and contribute to project development.
• http://www.medec.org
  Canada's medical device technology companies association
  MEDEC is the national association created by and for the Canadian medical device industry. MEDEC is the primary source for advocacy, information and education on the medical device industry for members, the greater healthcare community, industry partners and the general public.
• http://www.flyforfun.be
  Flying in Belgium
  In Belgium there are about 10,000 people who occupy themselves with one or other form of leisure aviation or air sports. This can be scale model construction, ULM to single engine pilots, paradropping, soaring or any other form of air sport. For all these pilots and for everyone who is interested in small aviation, this portal is created.
• http://paulo.yle.fi
  International Paulo Cello Competition
  The competition, founded on the initiative of The Paulo Foundation and Professor Arto Noras, has been presented three times before, in 1991, 1996 and 2002. The Paulo Cello Competition is one of the most important competitions of today.
• http://www.sygyt.com
  Website of Overtone Analyzer software
  Overtone Analyzer is a software application for anyone interested in sound or music. It can be used as a spectrum analyzer and a visual feedback tool as well as an interactive visualization of music theory.
• http://www.fuss.bz.it/
  Free Upgrade Southtyrol's Schools
  Free Upgrade Southtyrol's Schools (FUSS) is a project funded by the European Social Fund which has upgraded the computer systems of all the italian schools in the Autonomous Province of Bolzano/Bozen, removing all the software with a proprietary license used in the school activity with the FUSS GNU/Linux Soledad distribution. The project has developed the software solution and released it under a free software license.
• http://www.nuwinfo.se
  Nuclear Waste Management in Sweden Document Archive
  The Nuclear Waste Management in Sweden Document Archive is an independent initiative supported by environmental, non-governmental organisations in Sweden.
• http://www.villa-alegria-tenerife.com
  On this site you will find a complete guide of Villa Alegria including beautiful pictures and ample information about the island of Tenerife(Canary islands).
• http://www.mb.ndp.ca
  Gary Doer
• http://www.quicktongue.com
  This website is the dictionary of the Chinese course of VHS Duesseldorf. Our students use it learn Chinese. But all visitors are welcome to participate.
• http://weller.cooper-cads.com
• http://www.unicinema.org
• http://www.spicy.hu
• http://www.infolive.tv
• http://www.abf.at
• http://www.dev20.info/
• http://www.tp1.ca/
• http://www.huayen.org
• http://www.coalitionagainsthate.org
• http://tarabut.info
• http://map.longdo.com
• http://www.karadiesberger.hu
• http://www.licnahisa.com
• http://micabucovina.ro
• http://www.indiecom.net
• http://www.berlin-kids-international.de
• http://www.clustermadera.com
• http://www.mbfpet.com
• http://www.implant-assistant.ru
• http://www.svvf.net
• http://www.artistren.net
• http://provsechny.eu
• http://www.strasbourgis.org
• http://www.auctions4you.eu
• http://ongopongo.com
• http://rhizomecollective.org
• http://www.bobek.cz
• http://www.travel-japan.eu
• http://blog.sharpplus.com
• http://www.art4thought.org
• http://www.sandklef.com
• http://www.quesco.co.th
• http://www.morganonline.nl
• http://www.intrmzzo.com
• http://www.icn-portal.com
• http://visionplanet.biz
• http://www.madryn.com
• http://www.balticstar.org
• http://www.faces.fi
• http://www.hockey-camp.eu/
• http://www.joyofbits.se/drupal/
• http://www.dp-obaly.cz/
• http://www.bikeclubosaka.com/
• http://www.mdg.loesje.org/
• http://www.gcoop.com.ar/
• http://www.azlocalaction.org/
• http://www.elreporterosf.com/
• http://www.esn-uab.org/
• http://livingsoftware.nl/
• http://www.e-chemie.cz/
• http://www.palinta.hu/
• http://provsechny.eu/
• http://www.flickoff.org/
• http://www.aulen.cn/

CiviCRM integration with Location

CiviCRM is integrated with the location module through location fields in CiviCRM profiles. If any of the following following CiviCRM profile fields are populated in a users account profile fields they will be synchronized with the location modules.

• Street Address
• Supplemental Address 1
• City
• State
• Postal Code
• Country

Creating KML feeds of location-enabled information

The KML module allows location-enabled information from your site to be viewed in Google Earth. It requires the Location module to associate geographic location with a node.

You can:

• View the location of a single node by clicking a 'KML' link on any location-enabled node.
• View a collection of nodes either as a normal KML file or as a Network Link which will regularly refresh the data from your site in Google Earth. Collections of nodes include those assigned a certain taxonomy term, results of a search or those in a group.

HOWTO: Submit Blog post by email

How to submit Blog post by Email
Note, my experiences are for simple email processing. I haven't done
anything like tying an email list to a forum.

Step 1: Turn on the mailhandler module
Admin -> Modules ... Click on the module

Step 2: Set up an email account to which you will send email. This depends
on what you are using for a mail hosting service.
I use cpanel, click on Mail , click on Manage/Add/Remove accounts.. Click on
Add accounts and set up the email address and the password. For my system,
the email can be retrieved as POP3. Again, this depends on the mail hosting
service you are using.

Step 3: Configure the mailhandler
Admin -> Mailhandler
Click on Add Mailbox, fill in the appropriate fields.

For email address, use the email address you set up in step 2
e.g. incoming@example.com

(I have not used the Second email address for my purposes)

In most cases, using INBOX and POP3 for the folder and Mailbox settings
should work, again, it depends on your mail service.

Mailbox domain
Should be the domain that you are using. e.g. example.com

Mailbox port
Again, the default of 110 should work, depending on your hosting service.

Mailbox username and password: Use the userid and password from Step 2, or
whatever has been assigned for the email address.

Mime preference: I always simply use HTML. You're choice. Not a biggie.

Security: I leave this disabled. I believe there is enough security with
the mail handler as it is. If you do enable it be sure not to use the HTML
mime preference.

Send error replies: I like to enable this and leave it enabled, unless I am
tying somehow to a mailing list. Even if I am doing that, I would initially
have send error replies on until I am sure things are doing what I want.

From header: Again, for personal mail handling, I leave this blank. As
noted, you may want to use Sender for mailing lists.

Default commands:
This is where I end up doing most of my tweaking.
Currently, as an example, I use
type: page
taxonomy: [mail]
promote: 1
format: 3

type: page causes the posts to be page entries. You can also use blog,
story, forum, etc.
taxonomy: [mail] I have a taxonomy term called mail for all posts coming
in via email. This can be omitted if you don't want to place the entries
into a taxonomy category
promote: 1 For the site I'm using, I want email entries to be promoted to
the front page. If you don't want them promoted to the front page, omit
this line
format: 3 This is my latest tweak to get it so the posts are processed as
Full HTML instead of filtered HTML. If you are going to receive HTML email,
you really should have this on.

Signature Separator: I leave this blank. This is probably most useful for
mail coming from a mailing list that appends some signature stuff, or if you
have your own signature file.

Delete Messages after they are processed: Yup. I do that. I don't want
the mail box filling up with messages that have already been processed.

cron processing: I generally leave this on.

Once you have set up an account, send an email to the account.

Step 4:
Once you have the account set up, send an email to the account. Be sure to
send it from an email address that has a userid on your site. Otherwise you
will get a message something like:

The e-mail address 'tester@example.com' may not create page items.

You sent:

From: tester@example.com
...

Step 5:
Testing the mail retrieval
When the mail has been sent, go to
Admin -> Mailhandler

You should see the email address under the list. Click on 'retrieve' next
to the email address. If everything is working properly, you should get a
message something like:
Mailhandler retrieve successful: 1 messages for incoming@example.com

You should then be able to go to
Admin -> Content
and find the message that you submitted.

Assuming this is running properly, all you need to do is make sure that cron
is running regularly and emails will be processed as they are received.

Useful command for mailhandler default commands

The "commands" referred to below get put into the Admin->mailhandler->list->Default commands field. A sample of commands that can be used to post incoming emails to a forum would be (including the square brackets):

type: forum
taxonomy: [My Forum]
promote: 0
status: 1

Where [My Forum] is the "term" in the "forums" vocabulary that was automatically created when a forum named "My Forum" was created (see Admin->Categories).

These can be put either on the configuration page for the mailbox, if you want them to be defaults, or at the beginning of the email:

pass: password
(If you required one on the configuration page.)

type: blog
(or story, or page. use type=comment to force a comment. can be used with nid= command)

taxonomy: [cat1,cat2]
(or whatever your categories are. The square brackets are needed.]

promote: 1
(0 if you don't want it promoted)

status: 1
(0 if you don't want it published)

comment: 2
(0 if no comments, 1 if read-only comments)

Also, in the headers of the email, if you put

In-Reply-To: nid=5

then the email becomes the new version of node 5. I'm told that there's a way to take it down to the level of comments, presumably by using In-Reply-To and the comment id#, but I haven't checked that.

format: #
This is set the format for your submission to be the input format # for you site.

Check your environment to see if you can run Mass Mailer

Test for Mass Mailer environment

These tests are now done automatically by the mass mailer module.

1. Use the contact feature on your profile to send yourself an email
2. Have you enabled PHPList, Mass Mailer, and configured it according to the administration help?
3. Is the command line version of PHP installed in the correct version (PHP 4.3.3 and greater)?
4. Can bash scripts be run? Is bash installed in /bin?
5. What are the permissions for modules/massmailer/engines/phplist/bin/phplist? This file must be executable. If you have command line access chmod o+x. Otherwise 757 should work.

CiviCRM integration with MassMailer module

CiviCRM module is integrated with Mass Mailer to allow mailings to be sent to CiviCRM groups. It also allows for contact management through mass mailer.

• MassMailer has a default mailing list from CiviCRM called all contacts.
• Mailings can be sent to CiviCRM groups, and contacts added to mass mailer mailing lists will be added to CiviCRM.
• Mass Mailer respects CiviCRM's do not contact properties for groups
• Mass Mailer allows for users to unsubscribe from a mailing list through mass mailer and prevent mailings while still maintaining membership in a CiviCRM group.

Manage lists

This is the documentation for managing lists. Please comment below.

Manage lists screenshot

Manage subscribers

Manage subscribers documentation.
Manage subscriber screenshot

Manage templates

Documentation needed for the mass mailer template module.
Manage templates screenshot

Resolve PHP Errors (Send Message Failures)

If you receive the following error message when sending e-mails from mailing lists, your PHP interface is not properly configured and massmailer will not work properly.

Possible causes of this error:

• You have the PHP CGI interface installed and configured for your site instead of the PHP Command Line interface
• When the PHP Command Line interface cannot be found.

To solve the problem:

• You need to contact your host to have the PHP Command Line Interface installed or configured for phplist.

For more information on installing PHP CLI (Command Line Interface or Interpreter) see PHP CLI and Cron or Using PHP from the command line.

Send messages

Documentation for the send messages page goes here.
Send messages screenshot

Subscriber info

Subscriber information documentation.
Subscriber info screenshot

MySite: configuration settings

MySite Settings

The following module settings are available.

There are additional configuration options available for some MySite plugins. These are shown as submenu tabs.

1. Display Settings

   Options that affect user interaction with MySite.

   • MySite Behavior

     This option tells MySite how to behave when a vistor goes to http://example.com/mysite. Most installation will use the default setting 'Go to User MySite,' which directs the user to http://example.com/mysite/UID/view. The additional option mirrors the menu callback for http://example.com/mysite/all and is mainly used for debugging.

   • MySite Privacy

     This option sets the default visibility of the owner's MySIte page with regard to other users. By default, all users with the 'view all mysites' privilege can see all other user personal pages. Individual users can turn this setting to 'private.'

   • Page Setup

     The administrator now has the option to turn off all block regions for MySite pages. This allows the user to have complete control over the content presented by MySite. If this feature is turned on, the 'footer' region of your site will still be printed on all MySite pages. Note: The full screen display may have unespected consequences for your theme, since it eliminates the default sidebars and most page regions. Test before you deploy.

2. Content Settings

   The Content Settings option highlights the Content Types panel, which lets you configure which content options will be available to your users. These settings control the options that MySite users will be presented.

   • Content Types

     On the MySite settings page (http://example.com/admin/settings/mysite), you have the option of enabling all content types that are available. However, you are not required to offer all content to users. Use these settings to determine which content types can be added to a MySite page.
     Note: when a new Type plug-in is added to your module, a new option should appear in this list.
     Note: Some type files have configuation settings -- these are visible as menu tabs. Be sure to configure each active content type as needed

   • Disabled Content Types

     You may also see a section labelled Disabled Content Types on the settings page. The MySite module checks to see if various options and permissions have been defined before allowing you to activate a content type. The module will present you with a link to correct the configuration error. After you make the suggested change, the content type should be available for activation.

3. Content Browser

   The Content Browser settings affect how users will be presented the content options for adding elements to their MySite page.

   • Content Browsing

     This option will only be available if you have activated the MySite Icons module. Versions prior to 5.x.2 presented users with a simple table of choices. In newer versions, MySite presents options for displaying content choices to users. The default setting is to show a plain-text table of items, with 'Add' links. The optional behavior is to show a table of icons, with each icon representing a content option.

   • Content Layout

     This options will only be available if you have activated the MySite Icons module. If you select the 'Display row of icons' option for content browsing, this option is used to set the number of items to show per row. You should test this settings to optimize the presentation for your site theme(s).

   • Items per Page

     This option sets the pagination limit for the content browser. In either table or panel mode, this setting will control the number of items to show per page.

4. User Limits

   These options determine how much content a user can add to their MySite page.

   • Item Count

     Since MySite collects content from a variety of Drupal content, it can be resource intensive. This setting puts a cap on the number of content groups a user can add to a MySite page. The default is 10.

   • Element Count

     MySite is meant to give a quick overview, not to substitute for reading the original content in context. This setting limits the number of items (links) presented under each content group. The default is 5.

5. Action Buttons

   MySite ships with a small set of GPL icons, created by agentrickard expressly for MySite, which can be used to present the action buttons to users. Select the option that you prefer. Default is 'Icons.' The icons are previewed on the settings page.

6. Cache Settings

   For high-traffic sites, MySite might cause a high volume of database requests (especially if the Item and Element Count settings are very high). If you have performance issues, you can cache the results of a MySite page view for a set amount of time.

7. Default Page Settings

   By setting s default user UID, the module can establish a default page for users to view, set at http://example.com/mysite/default. This page may be used as an optional homepage. Note: This menu item is a callback, so no link to it will be generated in your menu. You must create a link manually.

8. Default Settings

   As of MySite 5.2, the administrator can now setup the user default settings for MySite. Clicking on the 'Default Settings' tab will take you to the MySite configuration page for user 0 (zero). The settings and content that are established for user zero will be used for all anonymous users who visit http://example.com/mysite and for all users who have not yet created a MySite page. Further, when a user creates a MySite page, the user's settings will initially match the Default Settings.

9. Default Content

   As of MySite 5.2, the administrator can now select a default set of content to show to all anonymous users and to authenticated users who have not yet created a MySite page. When a user creates a new MySite page, the default content set will automatically be saved in their collection. Once saved, the user can change his or her individual content settings to remove the default content. To define the default content set, click on the 'Default Content' tab of MySite's administration page.

Initial plugin configuration

By design, the MySite module is very flexible. Administrators may turn off unwanted features. There are numerous settings options that will affect the behavior of the module. Please read this section carefully and refer to the README.txt for additional details.

The MySite module is dependent on other modules, since all MySite does is present content in a new format. To use MySite correctly, at least one of the following modules needs to be active:

• Aggregator

  If you wish to allow users to add new RSS feeds, set the appropriate Aggregator settings for MySite at http://example.com/admin/settings/mysite (the Feeds tab).

  Note that there are two types of feed handling in MySite. 'Web Feeds' refer to individual RSS feeds. 'Web Headlines' refer to Aggregator categories containing multiple RSS feeds.

• Blog

  If the Blog module is active, MySite will allow users to add any active blogger to their MySite page.

• Book

  If there are any Books present on your site, they can be added to a MySite page. MySite will show the newest additions to any book selected by a uesr.

• Forum

  If the Forum module is active, MySite will allow users to add Forum topics to their MySite page. For this feature to work, at least one forum container and one forum topic must be present.

• Path

  If the Path module is active and you turn on Path Aliasing, each MySite will be aliased to the path 'mysite/USERNAME' when the MySite is created or updated.

• Taxonomy

  If the taxonomy module is active, MySite will allow users to add tagged content to their MySite page. For this feature to work, you must have at least one Vocabulary and one Term created at http://example.com/admin/content/taxonomy. Administrators can limit the categories available to users by confuring the module at http://example.com/admin/settings/mysite/term. Note that Forum categories are not included in MySite's taxonomy-based lists.

• Theme

  MySite supports user-based theme settings. When enabled, MySite users may choose from any active site theme. Anyone viewing a MySite page will view the page in the user-selected theme.

Special Cases

• Droplets, Blocks and Views

  'Droplets' are the Drupal equivalent of Googel Gadgets: they enable the site administrators to create small widgets that add new features to the site. Droplets can be created from HTML, JavaScript, or PHP code. They can also be generated from Blocks or from Views.

  MySite does not expose Blocks or Views directly to end users; the administrator must select which elements to expose via the Dropler creation system.

• Node and CCK (Content)

  The node module is a required core module. MySite can handle requests for all posts of a specific node type. If you use the CCK (Content) module, CCK node types are also supported.

• User

  The user module is a required core module. MySite can track posts based on individual users.

MySite: writing new plugins

The MySite module is written with a plug-in format and an API that allows core features to be extended. For detailed information, see the README.txt in the file download.

This tutorial will cover creating a new "type" plugin for MySite 5.2.x.

For an updated MySite 5.x.2 API, see http://therickards.com/api.

MySite Plugins

MySite has five plugin types that can be used to control content display.

Type plugins

'Types' are content definitions. They control the content selection options available to the user and generate the data that is presented on a MySite page view.

They are named {type}.inc and stored in the /mysite/plugins/types/ folder.

Layout plugins

These plug-ins handle the page architecture of the MySite page. They are named {layout}.php and stored in the /mysite/plugins/layouts folder.

Layouts have two parts: a {layout}.php file that defines the layout theme and a {layout}.png image that is used in the layout selection form.

To create a new {layout}.png, use the provided default.png as a blank.

Format plugins

Handles the presentation theming for individual content elements on a MySite page. They are named {format}.theme and stored in the /mysite/plugins/formats/ folder.

Style Plugins

Handles stylesheets for user MySite pages. Users may select the style that they prefer. They are named {style}.css and stored in the /mysite/plugins/styles/ folder.

All stylesheets should include the core styles defined in default.css, rewritten as needed. Only the selected stylesheet is loaded on page views.

Additional Documentation

For an updated MySite 5.x.2 API, see http://therickards.com/api.