MO References: mo_references.module File Reference
Definition of the MO References module. More...
Enumerations | |
| enum | MO_REFERENCES_VERSION |
Define the version of the MO References module. More... | |
Functions | |
| mo_references_init () | |
| Implementation of hook_init(). | |
| mo_references_perm () | |
| Implementation of hook_perm(). | |
| mo_references_menu () | |
| Implementation of hook_menu(). | |
| mo_references_theme () | |
| Implementation of hook_theme(). | |
| mo_references_load ($reference) | |
| Read a reference from the database. | |
| mo_references_save ($ref) | |
| Write a reference to the database. | |
Detailed Description
The MO References module helps you handle documentations on your Drupal website. Many systems will generate static HTML pages for software development documentation or reference. This module integrates such documents into your Drupal website.
Copyright (c) 2009-2011 Made to Order Software Corp.
http://www.m2osw.com/mo_references contact@m2osw.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Enumeration Type Documentation
This variable defines the version of the MO References module. This will always be the same as the version defined in Drupal (throught the .info file.)
Function Documentation
| mo_references_init | ( | ) |
Initialize the mo_references module.
The function adds a CSS to support different documentation styles.
| mo_references_load | ( | $ | reference | ) |
This function reads the specified reference from the database.
If it is not defined in the database, a default reference object is returned. This does not mean the reference exists on the server.
- Parameters:
-
[in] $reference The name of the reference to be read.
- Returns:
- A reference object.
Referenced by mo_references_download(), mo_references_edit(), and mo_references_view().
| mo_references_menu | ( | ) |
Expects /mo_references/<name of the reference>/<name of the page>
- Returns:
- An array of menu items
| mo_references_perm | ( | ) |
This function returns an array of all the permissions defined in the MO References module.
- Returns:
- The array of permission names.
| mo_references_save | ( | $ | ref | ) |
This function writes the specified reference to the database.
When not yet defined in the database, an INSERT is used to add a new entry. When already available, an UPDATE is used to just update the record.
- Parameters:
-
[in] $ref The reference object to be saved.
Referenced by mo_references_edit_submit().
| mo_references_theme | ( | ) |
This function returns the list of supported themes.
The themes can easily be overridden to implement a different better adapted output to your theme.
- Returns:
- The array of theme supported by MO References.
on Sat Mar 12 16:05:37 2011