first import
This commit is contained in:
11
sites/all/modules/ctools/page_manager/help/about.html
Normal file
11
sites/all/modules/ctools/page_manager/help/about.html
Normal file
@ -0,0 +1,11 @@
|
||||
The Page Manager module creates and manages pages in your Drupal site. Pages are defined as items that have a path and provide output to the user. It is a complete round trip from getting user input to providing user output.
|
||||
|
||||
There are two types of pages that the Page Manager currently supports:
|
||||
<dl>
|
||||
<dt>Custom pages</dt>
|
||||
<dd>Custom pages are defined completely by the administrator. Their path, access control and visible menu characteristics are completely arbitrary.</dd>
|
||||
<dt>System pages</dt>
|
||||
<dd>System pages are defined by Drupal and Drupal modules. They primarily override pre-existing pages to provide different functionality. They often do not allow such features as access control in favor of what already exists, and they will usually 'fall back' to default Drupal behavior.
|
||||
</dl>
|
||||
|
||||
Both types of pages figure out what to show the user by using <strong>Variants</strong>. Variants are output handlers, and every page should have at least one. Most pages will simply have only one. Pages with multiple variants will choose one and only one Variant to display content to the user and will use the <strong>Selection Rules</strong> to figure out which Variant to display.
|
@ -0,0 +1,43 @@
|
||||
task handler definition:
|
||||
title -- visible title of the task handler.
|
||||
description -- description of the task handler.
|
||||
task type -- The type of the task this handler can service.
|
||||
render -- callback of the function to render the handler. The arguments to this callback are specific to the task type.
|
||||
admin title -- callback to render the admin title as this handler is listed.
|
||||
params: $handler, $task, $subtask_id
|
||||
admin summary -- callback to render what's in the collapsible info as the handler is listed. Optional.
|
||||
params: $handler, $task, $subtask_id
|
||||
default conf -- either an array() of default conf data or a callback that returns an array.
|
||||
params: $handler, $task, $subtask_id
|
||||
save -- callback to call just prior to the task handler being saved so it can adjust its data.
|
||||
params: &$handler, $update (as drupal_write_record would receive)
|
||||
export -- callback to call just prior to the task being exported. It should return text to append to the export if necessary.
|
||||
params: &$handler, $indent
|
||||
|
||||
forms => array(
|
||||
'id' => array(
|
||||
'form' => form callback (receives $form, $form_state)
|
||||
'submit' => submit callback
|
||||
'validate' => validate callback
|
||||
'include' => an optional file to include to get functionality for this form. Must include full path.
|
||||
'no return' => hide the 'return' button, meaning that the form requires extra steps if submitted
|
||||
'alternate next' => an alternate next form. Used for hidden edit forms that don't have tabs.
|
||||
'no blocks' => if TRUE, use Drupal's mechanism to not render blocks for this form.
|
||||
)
|
||||
)
|
||||
),
|
||||
|
||||
'add forms' => array(
|
||||
'form1', => t('form title'),
|
||||
'form2', => t('form title'),
|
||||
// ...etc.../
|
||||
),
|
||||
'edit forms' => array(
|
||||
'id' => t('tab name'),
|
||||
'id2' => t('tab name'),
|
||||
),
|
||||
|
||||
If a form name is blank it is a 'hidden' form -- it has no tab but can still be reached.
|
||||
|
||||
|
||||
Notes: Because #required validation cannot be skipped when clicking cancel, please don't use it.
|
@ -0,0 +1,2 @@
|
||||
|
||||
defines a task type, grouping tasks together and providing a common UI for them.
|
38
sites/all/modules/ctools/page_manager/help/api-task.html
Normal file
38
sites/all/modules/ctools/page_manager/help/api-task.html
Normal file
@ -0,0 +1,38 @@
|
||||
task definition:
|
||||
title -- visible title of the task.
|
||||
description -- description of the task.
|
||||
hook menu -- function to delegate from hook_menu. Params: &$items, $task
|
||||
hook menu alter -- function to delegate from hook_menu_alter. Params: &$items, $task
|
||||
hook theme -- function to delegate from hook_theme. Params: &$items, $task
|
||||
|
||||
admin name -- if set an admin menu will appear in the delegator UI
|
||||
admin description -- to describe the admin menu
|
||||
|
||||
admin access callback -- if set, the callback to use to determine administrative
|
||||
access to this task. Defaults to user_access. Note that this is required even
|
||||
if delegator isn't handling administration, since this gets used to on handler
|
||||
edit forms.
|
||||
admin access arguments -- If set, the arguments to use to determine administrative
|
||||
access to this task. Defaults to array('administer delegator');
|
||||
|
||||
type -- The type of the task, used to determine which handlers can service it.
|
||||
|
||||
subtasks -- can be TRUE in which case it supports subtasks with the default
|
||||
configuration or a string (array?) with callbacks to fetch subtask data.
|
||||
subtask callback -- A callback which returns just one subtask. Param: $task, $subtask_id
|
||||
subtasks callback -- A callback which returns an array of all subtasks.
|
||||
This MUST return an array, even if it's empty.Param: $task
|
||||
|
||||
default handlers -- If the task contains any default handlers, they can be included here.
|
||||
|
||||
task names must not contain a - as that is used to separate the task name from the subtask ID.
|
||||
|
||||
subtasks implement data very similar to their parent task. In particular, they
|
||||
implement the following items exactly like their task:
|
||||
hook menu
|
||||
hook menu alter
|
||||
description
|
||||
admin name
|
||||
admin description
|
||||
admin access callback
|
||||
admin access arguments
|
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528072">http://drupal.org/node/528072</a> to help provide this documentation page.
|
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528058">http://drupal.org/node/528058</a> to help provide this documentation page.
|
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528078">http://drupal.org/node/528078</a> to help provide this documentation page.
|
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528050">http://drupal.org/node/528050</a> to help provide this documentation page.
|
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528038">http://drupal.org/node/528038</a> to help provide this documentation page.
|
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528044">http://drupal.org/node/528044</a> to help provide this documentation page.
|
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528046">http://drupal.org/node/528046</a> to help provide this documentation page.
|
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528040">http://drupal.org/node/528040</a> to help provide this documentation page.
|
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528036">http://drupal.org/node/528036</a> to help provide this documentation page.
|
@ -0,0 +1,15 @@
|
||||
|
||||
Note: this page is currently very preliminary. Please visit <a href="http://drupal.org/node/528034">http://drupal.org/node/528034</a> to help provide this documentation page!
|
||||
|
||||
This is a quick summary:
|
||||
|
||||
<ul>
|
||||
<li>Visit administer >> site building >> pages to get to the primary page manager interface.</li>
|
||||
<li>You can add custom pages for your basic landing pages, front pages, whatever you like for normal content display.</li>
|
||||
<li>You can use the system pages to create finer control of how taxonomy vocabularies, nodes and user profiles are displayed.</li>
|
||||
<li>When you add your first custom page, do not bother with the optional features. You will not need these until you get to more advanced tasks.</li>
|
||||
<li>The selection rules are the key to creating node displays for just one node type.</li>
|
||||
<li>Everything in this system is pluggable. A little PHP knowledge and exploration of the plugins directories can take you a long way.</li>
|
||||
</ul>
|
||||
|
||||
|
@ -0,0 +1,4 @@
|
||||
|
||||
Additional 'task' keys support:
|
||||
|
||||
operations -- a list of operations suitable for theme('links')
|
@ -0,0 +1,59 @@
|
||||
[advanced help settings]
|
||||
line break = TRUE
|
||||
|
||||
[about]
|
||||
title = About Page Manager
|
||||
weight = -100
|
||||
|
||||
[getting-started]
|
||||
title = Getting Started
|
||||
weight = -80
|
||||
|
||||
[getting-started-page-list]
|
||||
title = The page list
|
||||
weight = -90
|
||||
parent = getting-started
|
||||
|
||||
[getting-started-create]
|
||||
title = Creating a page
|
||||
weight = -80
|
||||
parent = getting-started
|
||||
|
||||
[getting-started-members]
|
||||
title = Tutorial: Make a page that looks different for members
|
||||
weight = -70
|
||||
parent = getting-started
|
||||
|
||||
[getting-started-custom-nodes]
|
||||
title = Tutorial: Customize the look of a single node type
|
||||
weight = -60
|
||||
parent = getting-started
|
||||
|
||||
[getting-started-custom-vocabulary]
|
||||
title = Tutorial: Customize the look of a single taxonomy vocabulary
|
||||
weight = -50
|
||||
parent = getting-started
|
||||
|
||||
[custom-pages]
|
||||
title = Custom pages
|
||||
weight = -50
|
||||
|
||||
[custom-pages-arguments]
|
||||
title = Arguments
|
||||
weight = -100
|
||||
parent = custom-pages
|
||||
|
||||
[custom-pages-access]
|
||||
title = Access control
|
||||
weight = -90
|
||||
parent = custom-pages
|
||||
|
||||
[custom-pages-menu]
|
||||
title = Menu items
|
||||
weight = -80
|
||||
parent = custom-pages
|
||||
|
||||
[variants]
|
||||
title = Variants
|
||||
weight = -40
|
||||
|
2
sites/all/modules/ctools/page_manager/help/variants.html
Normal file
2
sites/all/modules/ctools/page_manager/help/variants.html
Normal file
@ -0,0 +1,2 @@
|
||||
|
||||
Please visit <a href="http://drupal.org/node/528078">http://drupal.org/node/528078</a> to help provide this documentation page.
|
Reference in New Issue
Block a user