You are here

Home » API reference » Homebox 7.3

README.txt in Homebox 7.3

Same filename and directory in other branches
  1. 6.3 README.txt
  2. 6 README.txt
  3. 6.2 README.txt
  4. 7.2 README.txt
INSTALLATION
------------

 * Enable optional modules
   - Color picker - http://drupal.org/project/colorpicker
   - Views -  http://drupal.org/project/views
 * 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.


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

Homebox can 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"
--------------

Users can 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 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.


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

Homebox can 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.

File

README.txt
View source 
  1. INSTALLATION

  2. ------------

  3. 

  4.  * Enable optional modules

  5.    - Color picker - http://drupal.org/project/colorpicker

  6.    - Views -  http://drupal.org/project/views

  7.  * Enable Homebox module

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

  9.  * Go to Administer > Site building > Homebox

  10.  * Create an new page

  11. 

  12. 

  13. UPGRADING FROM 1.x TO 2.x

  14. -------------------------

  15. 

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

  17. 2.x version. In order for Homebox 2 to work correctly, you must completely

  18. uninstall any previous versions and cleanly install this version.

  19. 

  20. 

  21. CONTROLLING ACCESS TO HOME BOX PAGES

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

  23. 

  24. Access controls for Homebox pages (not the admin interface) are no longer

  25. located in the standard Drupal permissions table. When creating/editing each

  26. Homebox page, you can choose which roles are allowed to view the page. Unlike

  27. other Drupal components, if you do not choose any roles, then only admins can

  28. view the page. So, choose at least one role. For obvious reasons, anonymous

  29. users will not be able to save pages or add custom items.

  30. 

  31. 

  32. CREATING PANELS-LIKE HOME BOX LAYOUTS

  33. -------------------------------------

  34. 

  35. Homebox can create panels-like layouts. After creating a new Homebox page,

  36. click the 'Settings' link. Under the 'Custom column widths' fieldset, you can

  37. specify the width percentage of each region. If you wanted to create a layout

  38. like:

  39. 

  40. [-----top----]

  41. [--l--][--r--]

  42. [---bottom---]

  43. 

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

  45. 

  46. 

  47. "CUSTOM ITEMS"

  48. --------------

  49. 

  50. Users can enter custom items into their Homebox. Each Homebox page has the

  51. option to turn this on or off. If set on, users can enter as many custom blocks

  52. as they like - supplying a block title and body (full HTML allowed). This is

  53. useful if they want to paste code for an external widget.

  54. 

  55. 

  56. PROFILE INTEGRATION

  57. -------------------

  58. 

  59. Homebox integrates with Drupal's core profile module. After creating a page,

  60. you can navigate to admin/user/homebox and choose any available Homebox page to

  61. reside as a tab on user's profiles. User's can only view their own Homebox

  62. profile tab.

  63. 

  64. 

  65. FEATURES INTEGRATION

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

  67. 

  68. Homebox can import and export pages, as well as have them live in code. Because

  69. of this, Homebox has been made to integrate with the Features.module. For more

  70. information about Features, please visit http://drupal.org/project/features.