You are here

Home » API reference » Homebox 6.3

README.txt in Homebox 6.3

Same filename in this branch
  1. 6.3 README.txt
  2. 6.3 homebox_og/README.txt
Same filename and directory in other branches
  1. 6 README.txt
  2. 6.2 README.txt
  3. 7.3 README.txt
  4. 7.2 README.txt
 _                          _                  ____
| |__   ___  _ __ ___   ___| |__   ___ __  __ |___ \
| '_ \ / _ \| '_ ` _ \ / _ \ '_ \ / _ \\ \/ /   __) |
| | | | (_) | | | | | |  __/ |_) | (_) |>  <   / __/
|_| |_|\___/|_| |_| |_|\___|_.__/ \___//_/\_\ |_____|


Welcome to Homebox 2.


REQUIREMENTS
------------

 * jQuery UI 6.x-1.3 - http://drupal.org/project/jquery_ui
 * jQuery UI 1.6
   - Grab jQuery UI package from Google Code - http://jquery-ui.googlecode.com/files/jquery.ui-1.6.zip
 * PHP >= 5.2
   - This is required for JSON support.


RECOMMENDED
---------------------

The following modules are not required but recommended for integration or ease of use:

 * Color picker - http://drupal.org/project/colorpicker
 * Views -  http://drupal.org/project/views
 * Advanced Help - http://drupal.org/project/advanced_help


INSTALLATION
------------

 * Enable jQuery UI modules
 * Be sure to follow instructions from README.txt in jQuery UI module

   --- IMPORTANT ---- Begin
   Be sure to grab jQuery UI package from Google Code - http://jquery-ui.googlecode.com/files/jquery.ui-1.6.zip

   If not sure read this http://drupal.org/node/463270
   --- IMPORTANT ---- End

 * Enable optional modules if you want (see list above)
 * Enable Homebox module
 * Visit the Status Report page and make sure there are no Homebox errors
 * Go to Administer > Site building > Homebox
 * Create an new page


UPGRADING FROM 1.x TO 2.x
-------------------------

Sorry, but there is no upgrade path between the 1.x version of Homebox and the 2.x version.
In order for Homebox 2 to work correctly, you must completely uninstall any previous versions
and cleanly install this version.


NEW FEATURES
------------

Homebox 2 is loaded with new features and improvements. To get the most out of this module,
please quickly read the list of changes in CHANGELOG.txt, under the 2.x section.


CONTROLLING ACCESS TO HOME BOX PAGES
------------------------------------

Access controls for Homebox pages (not the admin interface) are no longer located in the standard
Drupal permissions table. When creating/editing each Homebox page, you can choose which roles are
allowed to view the page. Unlike other Drupal components, if you do not choose any roles, then only
admins can view the page. So, choose at least one role. For obvious reasons, anonymous users will
not be able to save pages or add custom items.


CREATING PANELS-LIKE HOME BOX LAYOUTS
-------------------------------------

One of Homebox 2's new features, is the ability to easily create panels-like layouts. After creating
a new Homebox page, click the 'Settings' link. Under the 'Custom column widths' fieldset, you can
specify the width percentage of each region. If you wanted to create a layout like:

[-----top----]
[--l--][--r--]
[---bottom---]

You'd use widths of 100, 50, 50, and 100.


"CUSTOM ITEMS"
--------------

Another new feature in Homebox 2 is the ability for users to enter custom items into their Homebox.
Each Homebox page has the option to turn this on or off. If set on, users can enter as many custom
blocks as they like - supplying a block title and body (full HTML allowed). This is useful if they want
to paste code for an external widget.


PROFILE INTEGRATION
-------------------

Homebox 2 integrates with Drupal's core profile module. After creating a page, you can navigate
to admin/user/homebox and choose any available Homebox page to reside as a tab on user's profiles.
User's can only view their own Homebox profile tab.


ORGANIC GROUPS INTEGRATION
--------------------------

Similar to the previously mentioned, Homebox integrates with the Organic Groups module. You have the option
to have a Homebox page reside as a group homepage tab, or become the new group homepage itself. You must
enable the homebox_og module then navigate to admin/og/homebox. If your site is using Panels and you set
a Homebox page to act as a group homepage, it will automatically disable any Panels that override node
views.


FEATURES INTEGRATION
--------------------

Homebox 2 has the ability to import and export pages, as well as have them live in code. Because of this,
Homebox has been made to integrate with the Features.module. For more information about Features, please
visit http://drupal.org/project/features.


API
---

Modules can now ship with a Homebox completely in code. See homebox_example.module for an example and
documentation.

File

README.txt
View source 
  1.  _                          _                  ____

  2. | |__   ___  _ __ ___   ___| |__   ___ __  __ |___ \

  3. | '_ \ / _ \| '_ ` _ \ / _ \ '_ \ / _ \\ \/ /   __) |

  4. | | | | (_) | | | | | |  __/ |_) | (_) |>  <   / __/

  5. |_| |_|\___/|_| |_| |_|\___|_.__/ \___//_/\_\ |_____|

  6. 

  7. 

  8. Welcome to Homebox 2.

  9. 

  10. 

  11. REQUIREMENTS

  12. ------------

  13. 

  14.  * jQuery UI 6.x-1.3 - http://drupal.org/project/jquery_ui

  15.  * jQuery UI 1.6

  16.    - Grab jQuery UI package from Google Code - http://jquery-ui.googlecode.com/files/jquery.ui-1.6.zip

  17.  * PHP >= 5.2

  18.    - This is required for JSON support.

  19. 

  20. 

  21. RECOMMENDED

  22. ---------------------

  23. 

  24. The following modules are not required but recommended for integration or ease of use:

  25. 

  26.  * Color picker - http://drupal.org/project/colorpicker

  27.  * Views -  http://drupal.org/project/views

  28.  * Advanced Help - http://drupal.org/project/advanced_help

  29. 

  30. 

  31. INSTALLATION

  32. ------------

  33. 

  34.  * Enable jQuery UI modules

  35.  * Be sure to follow instructions from README.txt in jQuery UI module

  36. 

  37.    --- IMPORTANT ---- Begin

  38.    Be sure to grab jQuery UI package from Google Code - http://jquery-ui.googlecode.com/files/jquery.ui-1.6.zip

  39. 

  40.    If not sure read this http://drupal.org/node/463270

  41.    --- IMPORTANT ---- End

  42. 

  43.  * Enable optional modules if you want (see list above)

  44.  * Enable Homebox module

  45.  * Visit the Status Report page and make sure there are no Homebox errors

  46.  * Go to Administer > Site building > Homebox

  47.  * Create an new page

  48. 

  49. 

  50. UPGRADING FROM 1.x TO 2.x

  51. -------------------------

  52. 

  53. Sorry, but there is no upgrade path between the 1.x version of Homebox and the 2.x version.

  54. In order for Homebox 2 to work correctly, you must completely uninstall any previous versions

  55. and cleanly install this version.

  56. 

  57. 

  58. NEW FEATURES

  59. ------------

  60. 

  61. Homebox 2 is loaded with new features and improvements. To get the most out of this module,

  62. please quickly read the list of changes in CHANGELOG.txt, under the 2.x section.

  63. 

  64. 

  65. CONTROLLING ACCESS TO HOME BOX PAGES

  66. ------------------------------------

  67. 

  68. Access controls for Homebox pages (not the admin interface) are no longer located in the standard

  69. Drupal permissions table. When creating/editing each Homebox page, you can choose which roles are

  70. allowed to view the page. Unlike other Drupal components, if you do not choose any roles, then only

  71. admins can view the page. So, choose at least one role. For obvious reasons, anonymous users will

  72. not be able to save pages or add custom items.

  73. 

  74. 

  75. CREATING PANELS-LIKE HOME BOX LAYOUTS

  76. -------------------------------------

  77. 

  78. One of Homebox 2's new features, is the ability to easily create panels-like layouts. After creating

  79. a new Homebox page, click the 'Settings' link. Under the 'Custom column widths' fieldset, you can

  80. specify the width percentage of each region. If you wanted to create a layout like:

  81. 

  82. [-----top----]

  83. [--l--][--r--]

  84. [---bottom---]

  85. 

  86. You'd use widths of 100, 50, 50, and 100.

  87. 

  88. 

  89. "CUSTOM ITEMS"

  90. --------------

  91. 

  92. Another new feature in Homebox 2 is the ability for users to enter custom items into their Homebox.

  93. Each Homebox page has the option to turn this on or off. If set on, users can enter as many custom

  94. blocks as they like - supplying a block title and body (full HTML allowed). This is useful if they want

  95. to paste code for an external widget.

  96. 

  97. 

  98. PROFILE INTEGRATION

  99. -------------------

  100. 

  101. Homebox 2 integrates with Drupal's core profile module. After creating a page, you can navigate

  102. to admin/user/homebox and choose any available Homebox page to reside as a tab on user's profiles.

  103. User's can only view their own Homebox profile tab.

  104. 

  105. 

  106. ORGANIC GROUPS INTEGRATION

  107. --------------------------

  108. 

  109. Similar to the previously mentioned, Homebox integrates with the Organic Groups module. You have the option

  110. to have a Homebox page reside as a group homepage tab, or become the new group homepage itself. You must

  111. enable the homebox_og module then navigate to admin/og/homebox. If your site is using Panels and you set

  112. a Homebox page to act as a group homepage, it will automatically disable any Panels that override node

  113. views.

  114. 

  115. 

  116. FEATURES INTEGRATION

  117. --------------------

  118. 

  119. Homebox 2 has the ability to import and export pages, as well as have them live in code. Because of this,

  120. Homebox has been made to integrate with the Features.module. For more information about Features, please

  121. visit http://drupal.org/project/features.

  122. 

  123. 

  124. API

  125. ---

  126. 

  127. Modules can now ship with a Homebox completely in code. See homebox_example.module for an example and

  128. documentation.