We could really do with a little guide to using this bad boy.

Comments

mikeytown2’s picture

I would like to know how to use this module in comparison to http://drupal.org/project/path_redirect

Steven Jones’s picture

By the looks of it the path_redirect module just does a dumb, when you got to 'node/123' redirect to 'node/456' type redirect. Because we depend on page manager, we can hook into the loading of 'node/%node' and redirect only specific node types to different locations based on the context available from page manager.

james.williams’s picture

In basic terms, use the page manger module, and create a Redirect variant (rather than the Panel variant). On the configuration screen for your variant, you can set up where to redirect. You can use context terms (e.g. %node:nid, though these have to be surrounded with spaces if I remember correctly) in your redirection path.

Steven Jones’s picture

Status:Active» Fixed

We now have examples, and a handbook page. Woohoo!

Status:Fixed» Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

HJulien’s picture

I can't find documentation. I can't figure out how to use this module. Delete!

Steven Jones’s picture

@HJulien see the 'Read documentation' link on the project homepage.

HJulien’s picture

Three sentences that don't explain how to use the module is of no help to me. Even knowing to start with the Page doesn't explain how to use it.

james.williams’s picture

Sorry about the lack of documentation. Here's a really quick explanation...

1) Use Page Manager -- see the documentation for it (and/or Panels) to understand this if you need to.

2) Create your page/variant, and select Redirect (rather than Panel) on the first screen in the create variant wizard

3) Set up any contexts or selection rules you need (We won't provide documentation for this, as this is something provided by CTools Page Manager - find a good screencast that walks you through these concepts)

4) Finally, enter the path (and fragment/querystring) that you want to redirect to. You may use substitutions for things like a node ID or user name, which are defined on the contexts tab.

I don't think we will get round to writing full documentation now, since this module is made obsolete by the HTTP Response plugin that is now included with CTools. If you have specific questions about functionality in PMR that isn't in that plugin, then ask again. (We should probably amend that documentation page appropriately.)

Please note that this module is already in use by others who have taken the time to figure out how to use it. Calling 'Delete' is not going to achieve anything other than frustrating the module maintainers who provide & maintain this module for free.

rootwork’s picture

Status:Closed (fixed)» Active

It would be great to have some documentation about either a) how to use this module, or b) how to use CTools to achieve what this module does. I've been trying to figure out both for the last hour -- some kind of documentation would be really helpful (at least a README file!)

For the moment, the lack of either seems to still be a pending issue.

james.williams’s picture

Status:Active» Closed (fixed)

There is a link to the documentation on the project's page. (In the right sidebar, 'Read documentation'). This is the documentation page: http://drupal.org/node/938584

rootwork’s picture

Title:Needs documentation» Needs documentation in module
Status:Closed (fixed)» Active

There needs to be documentation in the module itself. The documentation link on the project page is widely acknowledged to be hard to find/notice (especially since it's not always there) -- this is one of the items in the Prairie Initiative.

In any case, the module needs a README.txt file. The module documentation guidelines clearly say:

All but the most trivial modules should provide a README.txt file. This plain-text file should contain a basic overview of what the module does and how someone may use it. It should provide enough information for the user to evaluate whether it will suit their needs before they download and install the module.

You could certainly copy the information on the d.o post into a README.txt file -- there's nothing saying they have to be different. Or you could give a quick overview and link to the d.o post for detailed information, if you're worried about maintaining things in two places. But something needs to be there.

james.williams’s picture

Status:Active» Fixed

Good point - I'd long forgotten that there was no Readme file, sorry. I have now added a simple one to 6.x-1.x and 7.x-1.x branches.

rootwork’s picture

Awesome, thanks!

Status:Fixed» Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.