You are here

README.txt in Workspace 5

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
********************************************************************
                     D R U P A L    M O D U L E
********************************************************************
Name: Workspace Module
Author: John VanDyk <jvandyk at iastate dot edu>
Drupal: 5
********************************************************************
DESCRIPTION:

This is a module designed for users to have a central place to
view and manage their content.

Thanks to Matt Westgate for his hand-holding during the creation
of this, my first Drupal module.

********************************************************************
INSTALLATION:

1. Place the entire workspace directory into the sites/all/modules
   directory of your Drupal installation.

2. Enable the workspace module by navigating to:

     Administer > Site building > Modules

   When enabled, a "My workspace" menu should appear in the menu 
   system.
   
3. Under Administer > User management > Access control you may wish
   to give users the ability to configure their own workspace.

********************************************************************
SYNERGISTIC MODULES:

The nodeperm_role module (http://drupal.org/project/nodeperm_role)
allows nodes to be edited by users in a given role. 
When the nodeperm_role module is enabled, the workspace module
shows not only nodes you own but also nodes that you may edit
because of the role that has been assigned to your user.

********************************************************************
NOTES:

The workspace module is not compatible with MySQL 3 because it uses
a UNION clause, which is supported by MySQL 4 and higher only. The
UNION clause is necessary to unify nodes and comments (which are
not nodes).

There is a workaround for MySQL 3's lack of a UNION clause:

http://www.google.com/search?&q=union+%22mysql+3%22

but I have no intentions of implementing this myself because I use
MySQL 4.

********************************************************************
KEEPING UP TO DATE:

If you wish to keep up to date with the latest developments of this
module using CVS, here is a recipe:

To check the latest version out of CVS for the first time, login 
by running the command:

cvs -d:pserver:anonymous@cvs.drupal.org:/cvs/drupal login

Enter anonymous as the password. Now you are logged in.

To check out the latest workspace module, run the command:

cvs -d:pserver:anonymous@cvs.drupal.org:/cvs/drupal checkout contributions/modules/workspace

This will create a directory called contributions containing 
a directory called modules that contains the workspace directory. 
Move the workspace directory to the modules directory of your 
Drupal installation.

Once you have a copy of the workspace module in your Drupal 
installation, use the following (much easier) command to keep 
your copy of workspace.module up to date:

cd /path/to/drupal/modules/workspace
cvs update -dP

File

README.txt
View source
  1. ********************************************************************
  2. D R U P A L M O D U L E
  3. ********************************************************************
  4. Name: Workspace Module
  5. Author: John VanDyk
  6. Drupal: 5
  7. ********************************************************************
  8. DESCRIPTION:
  9. This is a module designed for users to have a central place to
  10. view and manage their content.
  11. Thanks to Matt Westgate for his hand-holding during the creation
  12. of this, my first Drupal module.
  13. ********************************************************************
  14. INSTALLATION:
  15. 1. Place the entire workspace directory into the sites/all/modules
  16. directory of your Drupal installation.
  17. 2. Enable the workspace module by navigating to:
  18. Administer > Site building > Modules
  19. When enabled, a "My workspace" menu should appear in the menu
  20. system.
  21. 3. Under Administer > User management > Access control you may wish
  22. to give users the ability to configure their own workspace.
  23. ********************************************************************
  24. SYNERGISTIC MODULES:
  25. The nodeperm_role module (http://drupal.org/project/nodeperm_role)
  26. allows nodes to be edited by users in a given role.
  27. When the nodeperm_role module is enabled, the workspace module
  28. shows not only nodes you own but also nodes that you may edit
  29. because of the role that has been assigned to your user.
  30. ********************************************************************
  31. NOTES:
  32. The workspace module is not compatible with MySQL 3 because it uses
  33. a UNION clause, which is supported by MySQL 4 and higher only. The
  34. UNION clause is necessary to unify nodes and comments (which are
  35. not nodes).
  36. There is a workaround for MySQL 3's lack of a UNION clause:
  37. http://www.google.com/search?&q=union+%22mysql+3%22
  38. but I have no intentions of implementing this myself because I use
  39. MySQL 4.
  40. ********************************************************************
  41. KEEPING UP TO DATE:
  42. If you wish to keep up to date with the latest developments of this
  43. module using CVS, here is a recipe:
  44. To check the latest version out of CVS for the first time, login
  45. by running the command:
  46. cvs -d:pserver:anonymous@cvs.drupal.org:/cvs/drupal login
  47. Enter anonymous as the password. Now you are logged in.
  48. To check out the latest workspace module, run the command:
  49. cvs -d:pserver:anonymous@cvs.drupal.org:/cvs/drupal checkout contributions/modules/workspace
  50. This will create a directory called contributions containing
  51. a directory called modules that contains the workspace directory.
  52. Move the workspace directory to the modules directory of your
  53. Drupal installation.
  54. Once you have a copy of the workspace module in your Drupal
  55. installation, use the following (much easier) command to keep
  56. your copy of workspace.module up to date:
  57. cd /path/to/drupal/modules/workspace
  58. cvs update -dP