DOTPROJECT DOCUMENTATION GATHERING

This site is now mostly superceded by http://docs.dotproject.net (cache) - some components here may need to be referred to where we have yet to complete the transfer of data 100%. For the latest information please refer to the new site first

The aim of this website is to provide a central place for the development and accessing of documentation for dotProject.

Documentation is the bane of this project because it is always the most time consuming job, done after the programming, testing and implementation has been completed and because it then needs to be maintained for ongoing updates of software.

We have also been working on a total rewrite of this site - if you want to see where that is at please refer to Documentation Status


System and Administration Documentation links are on the left hand side of the site.

USER DOCUMENTATION links are on the right hand side of the site. Follow the in-documentation links at the top of each screen to scroll through each module section.

Please feel free to add comments to documentation pages to clarify issues, offer suggestions or record suggested corrections but please, if you are providing advice to others, ensure that your comments are accurate.

SEEING COMMENTS

To see any comments that are attached to a particular page you have to click on the comments box at the top of the page. The comments are then shown at the bottom of the page.

PLEASE DO NOT use comments to ask questions or ask for support - that's what the support forums at www.dotproject.net (cache) are for and we can guarantee that questions in comments here will be ignored and are likely to be removed with no notice.

Check Documentation Status for details of where we are up to.

At present there is no offline documentation, and this is the documentation repository for dotProject. Generating offline documentation means that we would lose the facility for many to contribute plus we are unable to actively update on an as needed basis and keep in sync with the development effort. If you want an offline manual then you could use the export option to extract the wiki pages.

The use of a WIKI means that a range of different people are able to easily contribute to the documentation phase plus the maintenance of versions of documentation can be more easily managed than large screeds of word processed pages that must be constantly reworked. The use of a WIKI also means that documentation can be worked on simultaneously by a larger number of people and it means that we don't have to distribute the documentation alongside the program and therefore manage the version differences in documentation.

Right now we welcome your adding comments on any documentation page - you may be able to provide assistance to another member of the community by clarifying an issue, providing specific information about a platform specific trick or provide a note about methods of doing things or missing elements in the documentation.

If you are unsure of how to use a WIKI or what a WIKI actually is please refer to:

http://wiki.org - All about WIKI's (cache)

As in all these things sometimes it comes down to personal choice. Whilst it would have been ideal to be able to use a WIKI integrated with PostNuke (our www.dotproject.net content management system) the level of functionality available within the modules ported did not suit our requirements. TikiWiki did. If you would like more information about TikiWiki please refer to:

http://tikiwiki.org/TikiWiki - TikiWiki Home Page (cache)

Will we change the environment? We will keep an eye on the development of integrated Wiki modules for PostNuke and if something comes along that is wonderful, then we'll give some thought to changing.

Can you make direct suggestions of an alternative Wiki that you like? No thanks. Whilst we are sure that you are convinced that your preference is better than ours, we are happy with this environment and will not be changing it just because you bombard us with alternative suggestions.

This section outlines any general issues that we're aware of in relation to this documentation site:

Problems with Konqueror displaying Tikiwiki Sites