Documentation 5.01
Rearranging module output
The modular design of dadaIMC means that each component of the system can be managed individually, allowing you a great deal of control over the placement and display of information.
Modules are placed on the page by way of a limited number of "hooks." In other words, there are certain places in the code that ask "Are there any modules who want to insert output here?".
Those hooks are:
- Admin: Should this module appear in the Site Administration section?
- Editor: Should this module appear in the Editorial Administration section?
- Top Row: Should a link to the module home page be included in the top navigation row?
- Publish: Should a link to the default editing form for this module be included in the second navigation row?
- Left Bar: Does this module have a modulebox to insert into the left-hand column?
- Right Bar: Does this module have a modulebox to insert into the right-hand column?
- Home Page: Does this module have a modulebox to insert into the center column of the home page?
- Userlogin: Does this module output content on the user's list of contributions?
- Toolbar: Does this module add links to the toolbar of content objects that have one?
- Object Body: Does this module manipulate the body text of content objects?
- Object Bottom: Does this module add content below the text of other content objects?
- Page Bottom: Does this module add content at the bottom of the page?
For each of these hooks, a variety of pertinent options are available:
- Sort order allows you to control the position of the output relative to other modules.
- Link text, where appropriate, allows you to control the text of the link.
- Restriction function allows you to call a custom function that controls whether or not the link text is displayed (allowing you to restrict its appearance to only Editors, for example).
- The Include file menu displays the contents of the module's
componentsdirectory, to select the file used for output. - Hook function is available to modules to specify some function used to manipulate and return content.
By using the module hooks, you can control the order of display, and you can easily turn off the appearance of sidebar module boxes, navigation links, etc., without disabling the module completely.
Report Bugs
dadaIMC uses the Mantis bug-tracking system for bug reporting. Please use it! And check for existing reports of your bug before submitting a new one.
CVS
The current CVS version of dadaIMC is now browseable online. Be forewarned, though, that it is not always in a useable state as-is!
