You are here

README.txt in Config Pages 7

Same filename and directory in other branches
  1. 8 README.txt
Credits
------------
This module is derivative from Model module (https://drupal.org/project/model)

Do I need it?
------------
At some point i was tired of creating custom pages using menu and form api,
writing tons of code just to have a page with ugly form where client can enter some settings,
and as soon as client want to add some interactions to the page (drag&drop, ajax etc) thing starts to get hairy.
If this sounds familiar then this module may be just a thing you looking for :)

Introduction
------------
This module provide fieldable entity that allows to create customisable feature-rich configuration
pages and place them where you like in menu system, you are able to use fieldAPI
with fine widgets created by community, so multi values drag&drop, autocomplete, file uploads
looks pretty and just works out of the box!

Main features are:

- Fieldable entity (config page)
Create fieldable entity using BO, FieldAPI, Features and other entity modules are supported.

- Mount your config page into menu structure as you like
Your can choose how (where) user will access this config page, so it can have proper path like
'admin/config/mysettings' and not explain customer that he needs to create "a special node" in node/add.

- Context-awareness
You need to have same page with different settings based on current language or domain or some other factor?
Config pages controller will automatically load proper config page based on current context. You can copy settings
from one context to another, import and export text values using Features. Language and Domain (Domain module)
contexts are supplied with this module, but you can add your custom context in no time using module's API.

- Create "singleton" pages
You no longer need to create a new content type that will store fields for your "singleton" pages like homepage
and explain to client that this page is a content but he can't create 2 nodes in it.

- Themable
Config pages are themable as any other entity, so with proper view mode configuration you can just drop CCT provided by this module
on the Page (in Panel module) and have your config page rendered.

- Nodequeue replacement.
In 95% cases using config pages will give you more flexibility than nodequeue module,
if you use EntityReference field, and use views as autocomplete source, so you have all the power of
views at your hands. And it will have all the features above - context awareness, themable and more.

Installation
-------------
Install this module as any other module

Generic workflow
-------------------------------
1. After module installed you can navigate to "admin/config/development/config_pages_types" and click on "Add config page"
2. Enter config page title and mount point, for example "admin/config/mysettings" and page type
3. Choose context if you need (if for example you want to have different settings for different languages) and save config page
4. Go to "admin/config/development/config_pages_types" and find your config page there, you can add desired fields as you do for any other entity.
5. If this config page is expected to be rendered (for exmaple if this is homepage config) manage display for your config page as you do for any other entity
6. At this point you can find you page using the path from pt2. (admin/config/mysettings)
7. Give appropriate user roles access to config page you created.

8. How can i access my settings?
8.1 If this config page is used to store settings then you should use config_pages_get() or config_pages_get() functions.
8.2 If this config page is singleton page like custom homepage, you can use config_pages_render(), config_pages_render_field() to
use in your code or CTools Content Type called 'Config Pages: Content' to place on panels.

9. I want more!
9.1 Saving your config pages to features is essential to make them part of site code.
9.2 Saving config pages values to features is possible but not always usefull.
9.3 If you need different configurations based on some custom context - create one using provided contexts as example!

File

README.txt
View source
  1. Credits
  2. ------------
  3. This module is derivative from Model module (https://drupal.org/project/model)
  4. Do I need it?
  5. ------------
  6. At some point i was tired of creating custom pages using menu and form api,
  7. writing tons of code just to have a page with ugly form where client can enter some settings,
  8. and as soon as client want to add some interactions to the page (drag&drop, ajax etc) thing starts to get hairy.
  9. If this sounds familiar then this module may be just a thing you looking for :)
  10. Introduction
  11. ------------
  12. This module provide fieldable entity that allows to create customisable feature-rich configuration
  13. pages and place them where you like in menu system, you are able to use fieldAPI
  14. with fine widgets created by community, so multi values drag&drop, autocomplete, file uploads
  15. looks pretty and just works out of the box!
  16. Main features are:
  17. - Fieldable entity (config page)
  18. Create fieldable entity using BO, FieldAPI, Features and other entity modules are supported.
  19. - Mount your config page into menu structure as you like
  20. Your can choose how (where) user will access this config page, so it can have proper path like
  21. 'admin/config/mysettings' and not explain customer that he needs to create "a special node" in node/add.
  22. - Context-awareness
  23. You need to have same page with different settings based on current language or domain or some other factor?
  24. Config pages controller will automatically load proper config page based on current context. You can copy settings
  25. from one context to another, import and export text values using Features. Language and Domain (Domain module)
  26. contexts are supplied with this module, but you can add your custom context in no time using module's API.
  27. - Create "singleton" pages
  28. You no longer need to create a new content type that will store fields for your "singleton" pages like homepage
  29. and explain to client that this page is a content but he can't create 2 nodes in it.
  30. - Themable
  31. Config pages are themable as any other entity, so with proper view mode configuration you can just drop CCT provided by this module
  32. on the Page (in Panel module) and have your config page rendered.
  33. - Nodequeue replacement.
  34. In 95% cases using config pages will give you more flexibility than nodequeue module,
  35. if you use EntityReference field, and use views as autocomplete source, so you have all the power of
  36. views at your hands. And it will have all the features above - context awareness, themable and more.
  37. Installation
  38. -------------
  39. Install this module as any other module
  40. Generic workflow
  41. -------------------------------
  42. 1. After module installed you can navigate to "admin/config/development/config_pages_types" and click on "Add config page"
  43. 2. Enter config page title and mount point, for example "admin/config/mysettings" and page type
  44. 3. Choose context if you need (if for example you want to have different settings for different languages) and save config page
  45. 4. Go to "admin/config/development/config_pages_types" and find your config page there, you can add desired fields as you do for any other entity.
  46. 5. If this config page is expected to be rendered (for exmaple if this is homepage config) manage display for your config page as you do for any other entity
  47. 6. At this point you can find you page using the path from pt2. (admin/config/mysettings)
  48. 7. Give appropriate user roles access to config page you created.
  49. 8. How can i access my settings?
  50. 8.1 If this config page is used to store settings then you should use config_pages_get() or config_pages_get() functions.
  51. 8.2 If this config page is singleton page like custom homepage, you can use config_pages_render(), config_pages_render_field() to
  52. use in your code or CTools Content Type called 'Config Pages: Content' to place on panels.
  53. 9. I want more!
  54. 9.1 Saving your config pages to features is essential to make them part of site code.
  55. 9.2 Saving config pages values to features is possible but not always usefull.
  56. 9.3 If you need different configurations based on some custom context - create one using provided contexts as example!