PostNuke Help

Previous
Writing Blocks

Home
up

Next
Interacting With Other Modules


Document Your Module

Documenting your module is a vital step. There are two areas in which your module will need documentation: user information and API information. The first area is covered by producing a manual and placing it in the appropriate place in the directory hierarchy. The second area is covered by writing a short description of each API function, noting the parameters and return values that it has, and placing that at the head of the function. Coding the documentation in the style of PHPDoc will allow for automatic parsing of the documentation by other developers who wish to use your module.

Packaging Your Module

At this stage the module should be ready for packaging. The two most widely used packaging formats are WinZip (.zip extension) and compressed TAR (.tar.gz extension). If possible, package the module with both formats. If not then just package it with the format that you have and ask someone on the PostNuke modules site if they can package it in the other format.


Previous
Writing Blocks

Home
up

Next
Interacting With Other Modules