[DOCU-46] Please document 'Configuration' of 'Magnolia Module' in 'Administration' section. Created: 29/Dec/06 Updated: 09/Oct/13 Resolved: 09/Oct/13 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Bug | Priority: | Minor |
| Reporter: | Giancarlo Berner | Assignee: | Antti Hietala |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Attachments: |
|
| Template: |
|
| Acceptance criteria: |
Empty
|
| Bug DoR: |
[ ]*
Steps to reproduce, expected, and actual results filled
[ ]*
Affected version filled
|
| Date of First Response: |
| Description |
|
Please document the 'Configuration' of a 'Magnolia Module' in the 'Administration' section of the /draft tree. Mention in a step-by-step procedure how you can configure Modules, perhaps with an example. In the 'Reference' topic describe all the possitble configuration parameters. |
| Comments |
| Comment by Philipp Bracher [ 14/Feb/07 ] |
|
Well this is quite hard to to since each module has it's own configuration. Do you propose to use a page per module?
And how far should it go into direction of explanation? |
| Comment by Giancarlo Berner [ 14/Feb/07 ] |
|
Most of it is done in /draft/en/developer/magnolia/cook-book/. That's perfect! To finalize the section I would like to add some sample code of a module.java (does not matter what module) and describe the sections (init, register dialogs, etc.). Do you have a sample module.java? I will create a sub page "Example of a module" and do a step-by-step (simple) example. |
| Comment by Philipp Bracher [ 15/Feb/07 ] |
|
What about using the scheduler as a workable sample? |
| Comment by Giancarlo Berner [ 15/Feb/07 ] |
|
The scheduler is a very good example. However, the scheduler is a "finished" module (jar exists). I would like to do a custom module, something very simple. Starting with the Maven Archetype, writing a module class (which does something very simple) to show how to init and run a module. |
| Comment by Philipp Bracher [ 16/Feb/07 ] |
|
A very baic example.
This shows how to add configuration (paragraph) to the module and how to initialize the module. |
| Comment by Philipp Bracher [ 16/Feb/07 ] |
|
Here the example module class. I also added the usage of a config value (format) for rendering the startup time |
| Comment by Philipp Bracher [ 16/Feb/07 ] |
|
the jsp would do: out.println(MyModule.getInstance().getFormatedStartupTime()) |
| Comment by Antti Hietala [ 09/Oct/13 ] |
|
Documented in Module management |