You are here

README.txt in Spaces 6.2

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 : )

DRUPAL-6--2 Notes
-----------------
There are some important and major changes in the 2.x branch of Spaces
that are especially relevant to those who have gotten used to some
concepts from the 1.x branch of Spaces.

1. Spaces features are now provided by the Features module.

   Amongst other things, this means that features *must live in code*.
   To make a feature exported by the Features module spaces-aware all
   you need to do is add the following key to your feature's .info file:

      spaces[types] = 'all'

   This will enable your feature for all space types. You can specify
   a subset of space types you would like to enable your feature for
   like this:

      spaces[types][] = "og"
      spaces[types][] = "user"

   A UI for making features spaces enabled is planned but not yet
   complete. Please bear with editing .info files by hand for now.

2. A single feature can contain more than one context and need not use
   the "spaces > feature > $featurename"  namespace/attribute/value
   convention. This makes it possible to make far more complex and
   interesting features.

Introduction
------------
Spaces allows a subset of features provided by the Features module [1]
to 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/features
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 example
   features spaces_blog which provides a simple blog feature. 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. DRUPAL-6--2 Notes
  10. -----------------
  11. There are some important and major changes in the 2.x branch of Spaces
  12. that are especially relevant to those who have gotten used to some
  13. concepts from the 1.x branch of Spaces.
  14. 1. Spaces features are now provided by the Features module.
  15. Amongst other things, this means that features *must live in code*.
  16. To make a feature exported by the Features module spaces-aware all
  17. you need to do is add the following key to your feature's .info file:
  18. spaces[types] = 'all'
  19. This will enable your feature for all space types. You can specify
  20. a subset of space types you would like to enable your feature for
  21. like this:
  22. spaces[types][] = "og"
  23. spaces[types][] = "user"
  24. A UI for making features spaces enabled is planned but not yet
  25. complete. Please bear with editing .info files by hand for now.
  26. 2. A single feature can contain more than one context and need not use
  27. the "spaces > feature > $featurename" namespace/attribute/value
  28. convention. This makes it possible to make far more complex and
  29. interesting features.
  30. Introduction
  31. ------------
  32. Spaces allows a subset of features provided by the Features module [1]
  33. to be enabled, disabled, or set to more specific settings per "space".
  34. A space is essentially some aspect of Drupal that might be leveraged
  35. to group content and settings together. For example, a group [2] might
  36. act as a collaborative workspace for a team, a user space might act
  37. as a personal blog, calendar, and gallery, or a taxonomy space might
  38. act as a whole thematic section to a site.
  39. 1: http://drupal.org/project/features
  40. 2: http://drupal.org/project/og
  41. Installation
  42. ------------
  43. A typical spaces setup consists of:
  44. 1. spaces.module -- the core Spaces module. Required.
  45. 2. Any number of space type modules. Currently, the following space
  46. type modules exist: spaces_site, spaces_og, spaces_user,
  47. spaces_taxonomy. At least one of these modules should be enabled,
  48. and more than one can be utilized simultaneously.
  49. 3. Any number of spaces feature modules. Spaces comes with the example
  50. features spaces_blog which provides a simple blog feature. You can
  51. build your own features for use with spaces fairly easily using CCK,
  52. Views, Context and other Drupal modules.
  53. Once some combination of these modules are installed, you will want to
  54. do some additional setup.
  55. Menu setup
  56. ----------
  57. To gain access to the current space's menu, you can set your primary
  58. or secondary navigation links to the "Spaces" menu [3]. For greater
  59. control of these links in your theme, you can use the API function
  60. spaces_features_menu() to retrieve the current space's links at any
  61. time.
  62. Spaces also provides some useful administration links that you may
  63. want to include in your theme. You can access these using the API
  64. funciton spaces_space_links().
  65. 3: admin/build/menu/settings
  66. Path prefixing
  67. --------------
  68. Spaces is based on the concept of path prefixing. A url prefix is
  69. defined for each space, and whenever that url prefix is present the
  70. associated space will be enabled.
  71. For example, when creating a new group using spaces_og, you might
  72. define a prefix "knitting" for the group. To access the group's space,
  73. simply go to /knitting on your site.
  74. Features and settings
  75. ---------------------
  76. Once you've set up your first space, you can customize the settings
  77. and features for that space using its spaces settings page. The
  78. location of this page varies by space type -- for groups and users,
  79. it is located under the "Spaces" tab on the group node [4].
  80. 4: e.g. node/43/spaces or user/7/spaces
  81. Spaces presets
  82. --------------
  83. In addition to customizing features and settings on a per-space basis,
  84. you can provide presets to your users to make setting up a new space
  85. very easy. On the spaces presets administration page [5], you can add
  86. new presets (the process is nearly identical to configuring features
  87. and settings for a space), disable/enable existing presets, and choose
  88. a default for each space type on your site.
  89. 5: admin/build/spaces
  90. Maintainers
  91. -----------
  92. alex_b (Alex Barth)
  93. jmiccolis (Jeff Miccolis)
  94. yhahn (Young Hahn)
  95. Ian Ward