Draft documentation for Nodequeue 2

By Benjamin Melançon
on 14 Oct
0 comments

Description

Current Readme: http://www.logrus.com/nodequeue/readme.txt
Further resources: http://www.angrydonuts.com/why_node_queue_is_an_important_m
Tutorial (June 7) - http://www.drupal.org.uk/node/255

Earl Miles outline of needed documentation:

The starting point is the readme. The documentation needs to describe the following things:

1) What the most basic use of a nodequeue is good for
2) How to create one
3) What a smartqueue is and how subqueues work
4) How to create one
5) How to use nodequeue with Views
6) How to use nodequeue with Actions
7) How to write smartqueue plugins

I've been working on a nodequeue demo site; mostly I've got some fake
content almost ready, and just need to spend 2 or 3 hours on it.

Proposed 8) Based on this comment from yched, "Plus it has an API, which let your own modules use queues as a backend, independantly of the UI."

Resolution

Basic use of Nodequeue

A nodequeue can be used to feature an arbitrary set of nodes, for instance with a random view with a limit of one in a block, and furthermore have a set order and limit, such as to list "My current top 5 favorite nodes."

How to create a Nodequeue

What is a Smartqueue

How to create a Smartqueue

How to use Nodequeue with Views

How to use Nodequeue with Actions

How to write Smartqueue plugins

How to use Nodequeue with other modules: the Nodequeue API

 

Post new comment
The content of this field is kept private and will not be shown publicly.
  • Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd> <blockquote> <h1> <h2> <h3> <h4> <h5> <h6> <small> <pre> <strike> <sub> <sup> <kbd> <s>
  • Lines and paragraphs break automatically.
  • Web page addresses and e-mail addresses turn into links automatically.
  • You may post code using <code>...</code> (generic) or <?php ... ?> (highlighted PHP) tags.

More information about formatting options

CAPTCHA
This question is for testing whether you are a human visitor and to prevent automated spam submissions.
Image CAPTCHA
Copy the characters (respecting upper/lower case) from the image.