Difference between revisions of "DSS description Handbook"

Revision as of 22:49, 18 September 2012

This is a the basic User's Guide for entering and editing Decision Support Systems (DSS) Information information. The purpose of this document is to provide users a method for entering the required information for each system.

1. Here you find the list of semantic DSS description pages: DSSs with semantic properties
2. Here you find the list of DSS description pages, based on common wiki syntax an generated with a deprecated version of the DSS description form. This pages should be migrated soon: DSSs which need to be migrated

The Handbook is divided into three parts: how to create, update or migrate an DSS description page

How to create a new DSS description

1. Open the following link to create a new DSS description page: DSS description form
2. Enter the name of your DSS into the text box and press "Create or edit"
3. Fill out the form. Some fields are required and some not. The last property of every topic is called "Additional information", it can be used for common wiki text, including links, images, etc.
4. Save the page and the resulting DSS page will show up

If the text is already available, as it may have been described in user's manuals, help systems or publications, the whole procedure should take max one hour for each system described.

Some notes are important to point regarding the use of the DSS form

• The form provided has been defined as a consensus document and is not specific for any DSS. It also does not need no be fully filled. It is expected that several sections may be absent for the presentation of a given DSS
• Although it was aimed that it should be as complete as possible, the form may not encompass all the features and characteristics required for the description of a given system. It is therefore possible to add sub-sections where appropriate. Whenever possible, subsections should be added instead of full sections.

How to update a semantic DSS description page

1. Navigate to the DSS page. (Use the common wiki search or the list of DSS's
2. Use the "Edit with form" link to edit the DSS. (Link is only visible when logged in)
3. Edit and save the DSS

Attention: Because of changes in the form and the templates, it may be that certain fields must be filled-out again. Have also a look at the "free text" field. Beside the references, it should be more or less empty, so try to migrate the text into the corresponding form fields.

How to migrate a non-semantic DSS description page

1. Copy the following link by using CRTL + C: fp0804.emu.ee/wiki/index.php/Special:FormEdit?form=DSS_description&target=DSS-NAME
2. Paste the link to your browser's address bar and DON'T press Enter
3. Replace the last part of the link ("DSS-NAME") with your DSS name (for example "Agflor")
4. Press Enter to open your DSS description page with the new semantic form
5. A warning message that the page already exists should appear (otherwise something with the link is wrong or your DSS does not exist, then follow the chapter "How to create a new DSS description"
6. Scroll down to the end of the form page and you will find your DSS description text in the "free text" field. Use that text to fill out the form.
7. Remove the existing category definitions for the DSS in the free text section. The form is meant to replace the 'old-style' categories
8. Save your DSS description page