4.8. Document Manager

The Document Manager provided with FusionForge gives you a simple way to publish documents on the site.

4.8.1. Submit new documentation

Here you can submit new documents for approving/publishing on the site. The form requires you to insert the following information:

Document Title

The document title refers to the relatively brief title of the document

Description

A brief description to be placed just under the title.

Upload File

Here you should select the file to be uploaded. You can upload text files (.html, .txt) or binary files (.zip, .doc, .pdf).

Reference File (by an URL)

Instead of uploading a file, you can specify the URL where the document is located.

Language

You should select here the language of the document.

Group that document belongs in

You should select here the group of the document. This feature is used to categorize documents.

Fill in all the fields, select the group from the drop down list and click Submit Information. The document will then be placed in the Pending Submissions section of the DocManager Admin page, to be approved or rejected.

4.8.2. Viewing existing docs

The View Documentation page shows you a list of documents published and approved for viewing; grouped by Document groups. You can click on a document to view the entire content.

4.8.3. Admin

Clicking on this will present you with a page showing pending and active documents. In order to allow users to submit a document, you must first set up the document groups for the project.

The Admin section allows you to:

Approve/publish pending submissions

The Pending Submissions list shows the list of submissions that are waiting for your approval. Clicking on the document name, the Edit Document form will be displayed.

Edit Documents

The Edit Document links shows all states of the documents, and the documents in the state:

Active Documents

Active Documents are displayed in the View Documentation list.

Pending Documents

Pending Documents are waiting for your approval.

Hidden Documents

Hidden documents are not displayed.

Deleted Documents

Deleted Documents are old, outdated documents.

Private Documents

Private documents are displayed only for members of the project.

Edit Document Groups

Clicking on this will present you with a box and a button to add document groups, and it also shows the document groups associated with this project. Submit as many document categories as you wish - eg Howto, Release notes, FAQ, etc. These groups will be the categories the documents will fall into when users submit documents.

4.8.4. Edit Document

When you select a document from one of the lists, a form will be displayed. In this form you can change the Document Title, the Short Description, the Language, the Document Group and the State.

If the Document is a text file with .txt, .html or .htm extension, a textbox appears where you can edit the content of the document.

If the Document is a binary document, you can upload a new version of the document.