diff --git a/nodequeue.module b/nodequeue.module index 0af9da3..db1889d 100644 --- a/nodequeue.module +++ b/nodequeue.module @@ -24,6 +24,28 @@ define('NODEQUEUE_DUPLICATE_POSITION', 3); /* --- HOOKS ---------------------------------------------------------------- */ /** + * Implements hook_help(). + */ +function nodequeue_help($path, $arg) { + + $output = ''; + + switch ($path) { + case "admin/help#nodequeue": + $output .= '

' . t("This module allows to convert one or many nodes between different node types. It can transfer most fields, and node-specific options for book and forum types. Support of more basic types will be in future releases. Also the module provides an API for converting nodes and fields, hooks for processing additional options of custom node types, integrates with hook_node_operations and Drupal's Action API.") . '

'; + $output .= '

' . t("Queues can be set to allow only certain types of nodes to be added to the queue. Queue can be a fixed size or of infinite length. And the admin can select which roles have permission to add nodes to a given queue.") . '

'; + $output .= '

' . t("Once a queue is set up, a new tab will appear on eligible nodes for eligible users. This tab will allow the user--regardless of edit permissions--to add or remove that node from the queue. Queue admins can view the nodes in the queue, +and can modify the order of items already in the queue. Items may also appear in a nodes links area to add/remove them from the queue.") . '

'; + $output .= '

' . t("When a node is added to the queue, it is added to the back of the queue. If a queue is full when a node is added, the front of the queue is removed.") . '

'; + $output .= '

' . t("Nodequeue has support for nodes with i18n Internationalizations.") . '

'; + $output .= '

' . t("It is highly recommended that you use the Views module to display your queues. However, if you choose not to, here is an alternative: Writing a PHP snippet.") . '

'; + $output .= '

' . t('To Create a Block to Display Node Titles of a Queue:') . '

'; + $output .= t("You'll need the Queue ID, which is easily extracted from the URL on the queue administration page. Create a new block, and insert the following PHP snippet into the block:
print nodequeue_node_titles(QUEUEID);
If you want this queue to be printed in the reverse order, you can tell it to print backward:
print nodequeue_node_titles(QUEUEID, '', true);
The '' in the line above is an optional title field. Feel free to put something here, but it's not terribly necessary in a block."); + return $output; + } +} + +/** * Implements hook_permission(). */ function nodequeue_permission() {