You are here

README.txt in Outline Designer 5

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 6 README.txt
  3. 7.2 README.txt
  4. 7 README.txt
ELMS: Outline Designer - Ajax book / general usability improvements for Drupal 5.x
Copyright (C) 2008  The Pennsylvania State University

Bryan Ollendyke
bto108@psu.edu

Keith D. Bailey
kdb163@psu.edu

12 Borland
University Park, PA 16802

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

INSTALATION
*Place the outline_designer directory in the correct modules folder as you would any other Drupal module
*Activate the module
*Goto your_drupal_site/admin/settings/outline_designer and configure your content types to use 
*Go to your_drupal_site/outline_designer to access the outline designer.  
*There's also a permission that you can activate to give people access to the outline_designer page / functions.

SO LETS TALK ABOUT PERSMISSIONS...

The permissions of the outline designer can get pretty granular if you want them to.  In a lot of instances I've found you won't want to give user access to this functionality but I'll outline the major settings you can give people to restrict access:

BOOK PERMISSIONS
*outline posts in books - This will enable / disable the ability to use the "Add child" menu item from the right click functionality
*create new books - This will enable / disable the appearance of the New, Duplicate and Delete buttons on the outline designer page.  For most users you'll want this disabled

OUTLINE DESIGNER PERMISSIONS
*access outline designer - Give access to the outline designer.  Ultimate shut off valve for using this.
*change content types - Disabling this will force all new content added to be the default specified in the settings page.  Usually this won't be used unless it's in conjunction with turning off access to the outline posts in books permission.
*drag-and-drop content - This will block people from being able to drag and drop content.  Turning this off could be useful if you just want a user to edit the content but not the structure
*duplicate nodes - If they have access to do any of the other things then this will just block them from duplicating content.  Useful in conjunction with outline posts in books

NODE PERMISSIONS
All content types come with "edit [type] content", "create [type] content", and "edit own [type] content" (except for book pages that have a little different naming convention but the same idea).  These SHOULD be working with the outline designer correctly.  If you create a node and have edit own you will be able to make changes to it like edit, rename, delete.  If you don't have own you souldn't etc.  Also, if you don't have the right to create a content type it won't show up in the change content type menu.  There are a lot of tricky permission situations around this and I'm sure I haven't accounted for everything so please if you notice a bug / use case where it breaks with the permissions of drupal node creation in this department let me know.  Permissions were taken into account late in development so more sufficient testing is needed before a point release.

COMPATABILITY
Since this is a intense javascript application there are unfortunately several issues. If you can identify or fix any of these it would be GREATLY appreciated.

Firefox 2 - No known issues
Firefox 3 - No known issues
Flock 1.1 - No known issues
Safari 3 - No known issues
Camino 1.5 - No known issues
SeaMonkey - No known issues
Netscape 9 - No known issues
Opera 9 - Need to double click for context menu; No known issues.

IE 7 - Adding children won't refresh the display unless that level is already open or a new node, CSS glitch with floating drop areas is way off, Need to double click for context menu, edit icon doesn't display, much slower then other browsers.

File

README.txt
View source
  1. ELMS: Outline Designer - Ajax book / general usability improvements for Drupal 5.x
  2. Copyright (C) 2008 The Pennsylvania State University
  3. Bryan Ollendyke
  4. bto108@psu.edu
  5. Keith D. Bailey
  6. kdb163@psu.edu
  7. 12 Borland
  8. University Park, PA 16802
  9. This program is free software; you can redistribute it and/or modify
  10. it under the terms of the GNU General Public License as published by
  11. the Free Software Foundation; either version 2 of the License, or
  12. (at your option) any later version.
  13. This program is distributed in the hope that it will be useful,
  14. but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. GNU General Public License for more details.
  17. You should have received a copy of the GNU General Public License along
  18. with this program; if not, write to the Free Software Foundation, Inc.,
  19. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20. INSTALATION
  21. *Place the outline_designer directory in the correct modules folder as you would any other Drupal module
  22. *Activate the module
  23. *Goto your_drupal_site/admin/settings/outline_designer and configure your content types to use
  24. *Go to your_drupal_site/outline_designer to access the outline designer.
  25. *There's also a permission that you can activate to give people access to the outline_designer page / functions.
  26. SO LETS TALK ABOUT PERSMISSIONS...
  27. The permissions of the outline designer can get pretty granular if you want them to. In a lot of instances I've found you won't want to give user access to this functionality but I'll outline the major settings you can give people to restrict access:
  28. BOOK PERMISSIONS
  29. *outline posts in books - This will enable / disable the ability to use the "Add child" menu item from the right click functionality
  30. *create new books - This will enable / disable the appearance of the New, Duplicate and Delete buttons on the outline designer page. For most users you'll want this disabled
  31. OUTLINE DESIGNER PERMISSIONS
  32. *access outline designer - Give access to the outline designer. Ultimate shut off valve for using this.
  33. *change content types - Disabling this will force all new content added to be the default specified in the settings page. Usually this won't be used unless it's in conjunction with turning off access to the outline posts in books permission.
  34. *drag-and-drop content - This will block people from being able to drag and drop content. Turning this off could be useful if you just want a user to edit the content but not the structure
  35. *duplicate nodes - If they have access to do any of the other things then this will just block them from duplicating content. Useful in conjunction with outline posts in books
  36. NODE PERMISSIONS
  37. All content types come with "edit [type] content", "create [type] content", and "edit own [type] content" (except for book pages that have a little different naming convention but the same idea). These SHOULD be working with the outline designer correctly. If you create a node and have edit own you will be able to make changes to it like edit, rename, delete. If you don't have own you souldn't etc. Also, if you don't have the right to create a content type it won't show up in the change content type menu. There are a lot of tricky permission situations around this and I'm sure I haven't accounted for everything so please if you notice a bug / use case where it breaks with the permissions of drupal node creation in this department let me know. Permissions were taken into account late in development so more sufficient testing is needed before a point release.
  38. COMPATABILITY
  39. Since this is a intense javascript application there are unfortunately several issues. If you can identify or fix any of these it would be GREATLY appreciated.
  40. Firefox 2 - No known issues
  41. Firefox 3 - No known issues
  42. Flock 1.1 - No known issues
  43. Safari 3 - No known issues
  44. Camino 1.5 - No known issues
  45. SeaMonkey - No known issues
  46. Netscape 9 - No known issues
  47. Opera 9 - Need to double click for context menu; No known issues.
  48. IE 7 - Adding children won't refresh the display unless that level is already open or a new node, CSS glitch with floating drop areas is way off, Need to double click for context menu, edit icon doesn't display, much slower then other browsers.