You are here

Home » API reference » Homebox 6

README.txt in Homebox 6

Same filename and directory in other branches
  1. 6.3 README.txt
  2. 6.2 README.txt
  3. 7.3 README.txt
  4. 7.2 README.txt
Welcome to Home box.

CONTENTS OF THIS FILE
---------------------

 * Requirements
 * Optional requirements
 * Installation
 * Things to know

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

 * jQuery UI 6.x-1.2 - 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

OPTIONAL REQUIREMENTS
---------------------

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

 * Path 6.x (provided with Drupal core)
 * Color picker 6.x-1.0-beta1 - http://drupal.org/project/colorpicker
 * Views 6.x-2.10 -  http://drupal.org/project/views
 * Advanced Help 6.x-1.2 - 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 Home box module
 * Go to Administer > Site building > Home box
 * Create an new page
 * Edit your newly created page to fill in the desired path alias
 * Visit your page settings, set the number of columns, etc.
 * Visit your page layout and assign some blocks
 * A menu item is automatically created in the navigation menu
 * Don't forget to visit Drupal permissions' page to allow access to your page by some roles
 
THINGS TO KNOW
--------------
 * Empty home box page (404)
   If you do not assign any block for a page, Drupal will return a 404 error, this is by design

 * Permissions
   Homebox tries to respect Drupal permissions system, so if you don't see some blocks,
   maybe they are only visible by some roles
 
 * Views 2
   You can add blocks created with Views, but you must be aware of the followings:
   - Your View must have a "block display"
   - Give a "Title" to your Block
   - In "Block settings" give an "Admin" value to your block
   - If you use "Exposed filters":
     - You should check the option "Remember (Remember the last setting the user gave this filter.)"
       for exposed filter you set.
     - "Use AJAX" must be set to "Yes" (otherwise, user will be sent to the page display of the View when clicking the Apply button)
     - "Empty text" should be set, if no value is given, then exposed filters won't work if initial view result is empty

File

README.txt
View source 
  1. 

  2. Welcome to Home box.

  3. 

  4. CONTENTS OF THIS FILE

  5. ---------------------

  6. 

  7.  * Requirements

  8.  * Optional requirements

  9.  * Installation

  10.  * Things to know

  11. 

  12. REQUIREMENTS

  13. ------------

  14. 

  15.  * jQuery UI 6.x-1.2 - http://drupal.org/project/jquery_ui

  16.  * jQuery UI 1.6

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

  18. 

  19. OPTIONAL REQUIREMENTS

  20. ---------------------

  21. 

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

  23. 

  24.  * Path 6.x (provided with Drupal core)

  25.  * Color picker 6.x-1.0-beta1 - http://drupal.org/project/colorpicker

  26.  * Views 6.x-2.10 -  http://drupal.org/project/views

  27.  * Advanced Help 6.x-1.2 - http://drupal.org/project/advanced_help

  28. 

  29. INSTALLATION

  30. ------------

  31. 

  32.  * Enable jQuery UI modules

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

  34. 

  35.    --- IMPORTANT ---- Begin

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

  37. 

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

  39.    --- IMPORTANT ---- End

  40. 

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

  42.  * Enable Home box module

  43.  * Go to Administer > Site building > Home box

  44.  * Create an new page

  45.  * Edit your newly created page to fill in the desired path alias

  46.  * Visit your page settings, set the number of columns, etc.

  47.  * Visit your page layout and assign some blocks

  48.  * A menu item is automatically created in the navigation menu

  49.  * Don't forget to visit Drupal permissions' page to allow access to your page by some roles

  50.  

  51. THINGS TO KNOW

  52. --------------

  53.  * Empty home box page (404)

  54.    If you do not assign any block for a page, Drupal will return a 404 error, this is by design

  55. 

  56.  * Permissions

  57.    Homebox tries to respect Drupal permissions system, so if you don't see some blocks,

  58.    maybe they are only visible by some roles

  59.  

  60.  * Views 2

  61.    You can add blocks created with Views, but you must be aware of the followings:

  62.    - Your View must have a "block display"

  63.    - Give a "Title" to your Block

  64.    - In "Block settings" give an "Admin" value to your block

  65.    - If you use "Exposed filters":

  66.      - You should check the option "Remember (Remember the last setting the user gave this filter.)"

  67.        for exposed filter you set.

  68.      - "Use AJAX" must be set to "Yes" (otherwise, user will be sent to the page display of the View when clicking the Apply button)

  69.      - "Empty text" should be set, if no value is given, then exposed filters won't work if initial view result is empty