README.txt 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. Strongarm 2.x for Drupal 7.x
  2. ----------------------------
  3. Strongarm gives site builders a way to override the default variable values that
  4. Drupal core and contributed modules ship with. It is not an end user tool, but a
  5. developer and site builder tool which provides an API and a limited UI.
  6. An example of such a variable is `site_frontpage`. In Drupal this defaults to
  7. `node`, which ensures that the front page gets content as soon as some exists,
  8. but for many Drupal sites this setting is simply wrong. Strongarm gives the site
  9. builder a place in the equation - an opportunity to set the default value of
  10. `site_frontpage` to something that makes sense for their site.
  11. Installation
  12. ------------
  13. Strongarm can be installed like any other Drupal module -- place it in
  14. the modules directory for your site and enable it (and its requirement,
  15. CTools) on the `admin/build/modules` page.
  16. Strongarm is an API module. It does absolutely nothing for the end user out of
  17. the box without other modules that take advantage of its API.
  18. How Strongarm works
  19. -------------------
  20. Strongarm uses the CTools export API to make entries in the system module's
  21. `variable` table exportables. Exportables are Drupal configuration objects that
  22. lead a dual life -- they may be *defaults* set by code exports in modules, they
  23. may be *overridden* if a user chooses to change the value in the database, or
  24. they may be *normal* if the configuration object lives only in the database but
  25. not in code. To learn more about exportables and the CTools export API, see the
  26. CTools advanced help on "Exportable objects tool."
  27. Exporting variables
  28. -------------------
  29. If you are a developer or site builder Strongarm gives you tools to export the
  30. settings of variables in your site database and manage any overrides to default
  31. values.
  32. To export variable values, you will need to enable either the [Features][1]
  33. module or the [Bulk Export][2] module provided by CTools (as of June 29, 2010
  34. you must use a recent checkout CTools `DRUPAL-6--1` in order to use Bulk Export
  35. with Strongarm). Features provides a UI for adding variable exports to a
  36. feature. Bulk Export provides a UI for generating defaults hooks with exported
  37. variables that you can add to your own modules. You do not need to enable both
  38. modules.
  39. Maintainers
  40. -----------
  41. - jmiccolis (Jeff Miccolis)
  42. - yhahn (Young Hahn)
  43. [1]: http://drupal.org/project/features
  44. [2]: http://drupal.org/project/ctools