You are here

Home » API reference » Simplified Modules 7

README.txt in Simplified Modules 7 

HOW TO USE THIS MODULE
----------------------

This module provides an API to allow related modules on the Modules page to be
grouped under a single checkbox.

If your site's Modules page is growing uncontrollably in length and complexity,
this module can help you simplify it. You can use the API to hide less
important modules from the page, and make it so those modules are instead
turned on and off automatically behind the scenes, exactly when they are
needed.

For example, you might use the API to declare that all the modules that ship
with the XML Sitemap project should appear as a single checkbox labeled "XML
"Sitemap" on the modules page (with the component modules automatically enabled
behind the scenes whenever they can be).

Or, you might group the Views and Views UI module under a single checkbox
labeled "Views". Or hide the Date API module, but turn it on automatically
whenever any date-related module that depends on it is enabled.

See the simplified_modules.api.php file included in this directory for more
information about the API and available hooks.

REQUIRED PATCHES
----------------

Until the Drupal core bug at http://drupal.org/node/1205684 is fixed, you will
likely want to apply the patch in that issue to your installation if you are
using this module.

This will avoid hidden modules unexpectedly appearing in a confirmation form
every time the form on the Modules page is submitted.

WHAT IF I'M NOT A DEVELOPER?
----------------------------

Currently, this module does not do much on its own; it's primarily an API
module for developers to use to simplify the Modules page (e.g. on particular
sites).

When the module is installed, it does cause all non-core modules on the Modules
page to be listed together in the "Other" category, rather than scattered among
different packages. But generally, it will only be useful if you've also
implemented the API to customize the Modules page experience for the site you
are building.

MAINTAINERS
-----------

This module was contributed by Acquia as part of the Drupal Gardens project and
is currently maintained by the Acquia design and engineering teams.

File

README.txt
View source 
  1. HOW TO USE THIS MODULE

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

  3. 

  4. This module provides an API to allow related modules on the Modules page to be

  5. grouped under a single checkbox.

  6. 

  7. If your site's Modules page is growing uncontrollably in length and complexity,

  8. this module can help you simplify it. You can use the API to hide less

  9. important modules from the page, and make it so those modules are instead

  10. turned on and off automatically behind the scenes, exactly when they are

  11. needed.

  12. 

  13. For example, you might use the API to declare that all the modules that ship

  14. with the XML Sitemap project should appear as a single checkbox labeled "XML

  15. "Sitemap" on the modules page (with the component modules automatically enabled

  16. behind the scenes whenever they can be).

  17. 

  18. Or, you might group the Views and Views UI module under a single checkbox

  19. labeled "Views". Or hide the Date API module, but turn it on automatically

  20. whenever any date-related module that depends on it is enabled.

  21. 

  22. See the simplified_modules.api.php file included in this directory for more

  23. information about the API and available hooks.

  24. 

  25. REQUIRED PATCHES

  26. ----------------

  27. 

  28. Until the Drupal core bug at http://drupal.org/node/1205684 is fixed, you will

  29. likely want to apply the patch in that issue to your installation if you are

  30. using this module.

  31. 

  32. This will avoid hidden modules unexpectedly appearing in a confirmation form

  33. every time the form on the Modules page is submitted.

  34. 

  35. WHAT IF I'M NOT A DEVELOPER?

  36. ----------------------------

  37. 

  38. Currently, this module does not do much on its own; it's primarily an API

  39. module for developers to use to simplify the Modules page (e.g. on particular

  40. sites).

  41. 

  42. When the module is installed, it does cause all non-core modules on the Modules

  43. page to be listed together in the "Other" category, rather than scattered among

  44. different packages. But generally, it will only be useful if you've also

  45. implemented the API to customize the Modules page experience for the site you

  46. are building.

  47. 

  48. MAINTAINERS

  49. -----------

  50. 

  51. This module was contributed by Acquia as part of the Drupal Gardens project and

  52. is currently maintained by the Acquia design and engineering teams.