| 1 |
// $Id: README.txt,v 1.2 2007/06/17 16:07:13 agentken Exp $ |
// $Id: README.txt,v 1.3 2007/06/17 16:18:59 agentken Exp $ |
| 2 |
|
|
| 3 |
------------------------------------------------------------- |
Skeleton Outlines |
| 4 |
README.txt for Skeleton version 5.x.1.0 |
================= |
|
------------------------------------------------------------- |
|
|
Drupal version: 5.x |
|
| 5 |
|
|
| 6 |
Author: Ken Rickard |
== Current Maintainer == |
| 7 |
|
|
| 8 |
|
Andrew Berry |
| 9 |
|
Email: andrewberry@sentex.net |
| 10 |
|
Drupal: deviantintegral |
| 11 |
|
CVS: deviantintegral |
| 12 |
|
IRC: deviantintegral |
| 13 |
|
|
| 14 |
|
== Original Author == |
| 15 |
|
|
| 16 |
|
Ken Rickard |
| 17 |
Email: agentrickard [at] gmail [dot] com |
Email: agentrickard [at] gmail [dot] com |
| 18 |
Drupal: agentrickard |
Drupal: agentrickard |
| 19 |
CVS: agentken |
CVS: agentken |
| 20 |
IRC: agentrickard |
IRC: agentrickard |
| 21 |
|
|
| 22 |
|
|
| 23 |
CONTENTS |
Contents |
| 24 |
======= |
======== |
| 25 |
|
|
| 26 |
1. Overview |
1. Overview |
| 27 |
2. Requirements |
2. Requirements |
| 58 |
This way, you set up the skeleton rules once, including all default node data and settings. |
This way, you set up the skeleton rules once, including all default node data and settings. |
| 59 |
Then you simply create a new "instance" of the book for each customer. |
Then you simply create a new "instance" of the book for each customer. |
| 60 |
|
|
| 61 |
|
The Token module is used to allow for tokenized replacements within Title, Body, and CCK Text |
| 62 |
|
fields. Tokens can be defined by site administrators. When a custom token is used within a |
| 63 |
|
template, users are asked to fill in a value for that token when creating a skeleton instance. |
| 64 |
|
This feature is best used for snippets of text within node bodies; for more complicated data, |
| 65 |
|
consider if a CCK field would be a better fit. |
| 66 |
|
|
| 67 |
|
Skeletons templates can also be syncronized to existing content, provided that content hasn't |
| 68 |
|
been modified. Once the content has been modified, future changes to the template are always |
| 69 |
|
ignored to prevent overwriting customized content. Syncronization supports adding or deleting |
| 70 |
|
templates, as well as the content within templates. |
| 71 |
|
|
| 72 |
-------- |
-------- |
| 73 |
2. Requirements |
2. Requirements |
| 74 |
|
|
| 75 |
The Skeleton module requires that the Book module is enabled and configured. Book is a core Drupal |
The Skeleton module requires that the Book module is enabled and configured. Book is a core Drupal |
| 76 |
module. |
module. The Token (http://drupal.org/project/token) module is also required. |
| 77 |
|
|
| 78 |
|
The current development release is dependent on patches from two core issues: |
| 79 |
|
|
| 80 |
|
* http://drupal.org/node/364529: menu_tree_all_data() static cache can become stale |
| 81 |
|
* http://drupal.org/node/360377: book_get_books() cache becomes stale when batch-inserting book pages. |
| 82 |
|
|
| 83 |
|
You must apply the latest Drupal 6 patches from those issues for this module to work. For information |
| 84 |
|
about patching, please see the patch documentation at http://drupal.org/patch. |
| 85 |
|
|
| 86 |
-------- |
-------- |
| 87 |
3. Installation |
3. Installation |
| 88 |
|
|
| 89 |
Skeleton uses the standard Drupal install system. When installed, the module should create three new |
Skeleton uses the standard Drupal install system. Extract the module to your modules directory |
| 90 |
tables in your Drupal database: |
(usually sites/all/modules) and enable it on the modules page. |
|
|
|
|
{skeleton} -- stores definitions of skeleton outlines |
|
|
{skeleton_data} -- stores the relationshup between a skeleton and its templates |
|
|
{skeleton_template} -- stores the preconfigured node data for creating skeleton-defined book pages |
|
| 91 |
|
|
| 92 |
Skeleton can be cleanly uninstalled by using the module Uninstall tab on the modules overview page. |
Skeleton can be cleanly uninstalled by using the module Uninstall tab on the modules overview page. |
| 93 |
|
|
| 96 |
|
|
| 97 |
There are two permission settings (Access Rules) for the Skeleton module. |
There are two permission settings (Access Rules) for the Skeleton module. |
| 98 |
|
|
| 99 |
"configure skeleton outlines" -- this is the admin privilege; it allows users to create, edit, and delete |
"configure skeleton outlines" -- this is the admin privilege; it allows users to create, edit, syncronize, |
| 100 |
skeletons and templates. At least one user must have this permission. |
and delete skeletons and templates. At least one user must have this permission. |
| 101 |
|
|
| 102 |
"create new instances" -- an 'instance' is a new book created from a skeleton. Users with this |
"create new instances" -- an 'instance' is a new book created from a skeleton. Users with this |
| 103 |
privlege can only create new books from existing skeletons. This permission is designed for |
privilege can only create new books from existing skeletons. This permission is designed for |
| 104 |
non-technical users. |
non-technical users. |
| 105 |
|
|
| 106 |
-------- |
-------- |
| 138 |
a skeleton outline. There are likely efficiencies to be gained by optimizing this function. |
a skeleton outline. There are likely efficiencies to be gained by optimizing this function. |
| 139 |
|
|
| 140 |
skeleton_get_tree() is in skeleton_common.inc |
skeleton_get_tree() is in skeleton_common.inc |
|
|
|
|
b) node creation needs review |
|
|
Currently, there doesn't seem to be a way to grab the node id of a node created with drupal_execute(). |
|
|
The module fakes this by grabbing ids from a query to the {sequences} table. Without locking that |
|
|
table during instance creation, it is possible that nodes will be created by other users during the processing |
|
|
of skeleton_create_instance_form_submit(). |
|
|
|
|
|
skeleton_create_instance_form_submit() is in skeleton_admin.inc |
|
|
|
|
|
c) select fields, checkboxes, and radio buttons |
|
|
These form types may not work correctly with CCK and contributed modules. There are some workarounds |
|
|
in skeleton_form_alter() that account for core modules and node_access module. See especially lines |
|
|
183-200 of skeleton_template.inc which process some known exceptions. |
|
|
|
|
|
skeleton_form_alter() is in skeleton_template.inc |
|
|
|
|
|
If you are interested in this module, I am looking for a co-maintainer. |
|
| 141 |
|
|
| 142 |
|
For all other issues, please see the issue queue at http://drupal.org/project/issues/skeleton. |
| 143 |
|
|
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch