You are here

README.txt in Spaces 6

spaces for Drupal 6.x

Note
----
Spaces for Drupal 6 is currently ALPHA. While it is functional and
relatively stable it is also under active development and not fully
polished for use by casual site builders. At the moment, you will
probably want a working knowledge of PHP and a desire to leverage
the concepts in Spaces in order to have a rewarding experience : )

Introduction
------------
Spaces leverages the context module [1] to allow administrators and
other modules to define "features" in Drupal. These features can then
be enabled, disabled, or set to more specific settings per "space".

A space is essentially some aspect of Drupal that might be leveraged
to group content and settings together. For example, a group [2] might
act as a collaborative workspace for a team, a user space might act
as a personal blog, calendar, and gallery, or a taxonomy space might
act as a whole thematic section to a site.

1: http://drupal.org/project/context
2: http://drupal.org/project/og

Installation
------------
A typical spaces setup consists of:

1. spaces.module -- the core Spaces module. Required.
2. Any number of space type modules. Currently, the following space
   type modules exist: spaces_site, spaces_og, spaces_user,
   spaces_taxonomy. At least one of these modules should be enabled,
   and more than one can be utilized simultaneously.
3. Any number of spaces feature modules. Spaces comes with the module
   spaces_core which provides integration against the Drupal core
   blog and book modules. You can build your own features for use with
   spaces fairly easily using CCK, Views, Context and other Drupal
   modules.

Once some combination of these modules are installed, you will want to
do some additional setup.

Menu setup
----------
To gain access to the current space's menu, you can set your primary
or secondary navigation links to the "Spaces" menu [3]. For greater
control of these links in your theme, you can use the API function
spaces_features_menu() to retrieve the current space's links at any
time.

Spaces also provides some useful administration links that you may
want to include in your theme. You can access these using the API
funciton spaces_space_links().

3: admin/build/menu/settings

Path prefixing
--------------
Spaces is based on the concept of path prefixing. A url prefix is
defined for each space, and whenever that url prefix is present the
associated space will be enabled.

For example, when creating a new group using spaces_og, you might
define a prefix "knitting" for the group. To access the group's space,
simply go to /knitting on your site.

Features and settings
---------------------
Once you've set up your first space, you can customize the settings
and features for that space using its spaces settings page. The
location of this page varies by space type -- for groups and users,
it is located under the "Spaces" tab on the group node [4].

4: e.g. node/43/spaces or user/7/spaces

Spaces presets
--------------
In addition to customizing features and settings on a per-space basis,
you can provide presets to your users to make setting up a new space
very easy. On the spaces presets administration page [5], you can add
new presets (the process is nearly identical to configuring features
and settings for a space), disable/enable existing presets, and choose
a default for each space type on your site.

5: admin/build/spaces

Maintainers
-----------
alex_b (Alex Barth)
jmiccolis (Jeff Miccolis)
yhahn (Young Hahn)
Ian Ward

File

README.txt
View source
  1. spaces for Drupal 6.x
  2. Note
  3. ----
  4. Spaces for Drupal 6 is currently ALPHA. While it is functional and
  5. relatively stable it is also under active development and not fully
  6. polished for use by casual site builders. At the moment, you will
  7. probably want a working knowledge of PHP and a desire to leverage
  8. the concepts in Spaces in order to have a rewarding experience : )
  9. Introduction
  10. ------------
  11. Spaces leverages the context module [1] to allow administrators and
  12. other modules to define "features" in Drupal. These features can then
  13. be enabled, disabled, or set to more specific settings per "space".
  14. A space is essentially some aspect of Drupal that might be leveraged
  15. to group content and settings together. For example, a group [2] might
  16. act as a collaborative workspace for a team, a user space might act
  17. as a personal blog, calendar, and gallery, or a taxonomy space might
  18. act as a whole thematic section to a site.
  19. 1: http://drupal.org/project/context
  20. 2: http://drupal.org/project/og
  21. Installation
  22. ------------
  23. A typical spaces setup consists of:
  24. 1. spaces.module -- the core Spaces module. Required.
  25. 2. Any number of space type modules. Currently, the following space
  26. type modules exist: spaces_site, spaces_og, spaces_user,
  27. spaces_taxonomy. At least one of these modules should be enabled,
  28. and more than one can be utilized simultaneously.
  29. 3. Any number of spaces feature modules. Spaces comes with the module
  30. spaces_core which provides integration against the Drupal core
  31. blog and book modules. You can build your own features for use with
  32. spaces fairly easily using CCK, Views, Context and other Drupal
  33. modules.
  34. Once some combination of these modules are installed, you will want to
  35. do some additional setup.
  36. Menu setup
  37. ----------
  38. To gain access to the current space's menu, you can set your primary
  39. or secondary navigation links to the "Spaces" menu [3]. For greater
  40. control of these links in your theme, you can use the API function
  41. spaces_features_menu() to retrieve the current space's links at any
  42. time.
  43. Spaces also provides some useful administration links that you may
  44. want to include in your theme. You can access these using the API
  45. funciton spaces_space_links().
  46. 3: admin/build/menu/settings
  47. Path prefixing
  48. --------------
  49. Spaces is based on the concept of path prefixing. A url prefix is
  50. defined for each space, and whenever that url prefix is present the
  51. associated space will be enabled.
  52. For example, when creating a new group using spaces_og, you might
  53. define a prefix "knitting" for the group. To access the group's space,
  54. simply go to /knitting on your site.
  55. Features and settings
  56. ---------------------
  57. Once you've set up your first space, you can customize the settings
  58. and features for that space using its spaces settings page. The
  59. location of this page varies by space type -- for groups and users,
  60. it is located under the "Spaces" tab on the group node [4].
  61. 4: e.g. node/43/spaces or user/7/spaces
  62. Spaces presets
  63. --------------
  64. In addition to customizing features and settings on a per-space basis,
  65. you can provide presets to your users to make setting up a new space
  66. very easy. On the spaces presets administration page [5], you can add
  67. new presets (the process is nearly identical to configuring features
  68. and settings for a space), disable/enable existing presets, and choose
  69. a default for each space type on your site.
  70. 5: admin/build/spaces
  71. Maintainers
  72. -----------
  73. alex_b (Alex Barth)
  74. jmiccolis (Jeff Miccolis)
  75. yhahn (Young Hahn)
  76. Ian Ward