Difference between revisions of "User's manual"

From forestDSS
Jump to: navigation, search
(Tagging and the use of categories)
(DSS)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
Is currently under construction !!
 +
 +
 
==Introduction==
 
==Introduction==
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.
+
This is a the basic User's Guide for entering and editing Decision Support Systems (DSS), Case Studies, Lessons Learned and Country Reports. The purpose of this document is to provide users a method for entering the required information for each system.
  
 
Associated with this document is [[Wiki editing |another which covers the basic procedures for creating and editing wiki text]]. Users with little or no experience in inserting information in media wiki, should start there, to understand the foundations of wiki text editing. In this page it will be covered the specific aspects for entering DSS information   
 
Associated with this document is [[Wiki editing |another which covers the basic procedures for creating and editing wiki text]]. Users with little or no experience in inserting information in media wiki, should start there, to understand the foundations of wiki text editing. In this page it will be covered the specific aspects for entering DSS information   
Line 9: Line 12:
 
__TOC__
 
__TOC__
  
== Brief description of the process ==
 
  
To insert a new DSS these are the generic steps to be followed, although variants are possible:
+
== DSS ==
 +
The current list of described DSSs is here available: [[:Category:DSS|List of DSSs]]
  
# Create a new page
+
The following form is used to describe a new DSS: [[:Form:DSS|DSS Form]]
# From the [[DSS Template| template provided]] copy the necessary section headings for the adequate description of the system in focus
+
# Fill in each section with the required level of detail
+
# Attribute the appropriate Categories
+
  
 +
Further information can be found under: [[DSS_description_Handbook]]
  
== Template Use ==
+
== Case ==
 +
The current list of described Cases is here available: [[:Category:Case|List of Cases]]
  
As a first approach, users are encouraged to use the [[DSS Template| template provided]]. The basic method, as outlined above, consists in copying the wiki text of the Template and pasting it to the appropriate system. This can be perfomed by pressing the edit tab in the top of the [[DSS Template| template]] and selecting and copying the text.
+
The following form is used to describe a new Case: [[:Form:Case|Case Form]]
+
Some notes are important to point regarding the use of the [[DSS Template| template]]
+
  
*The template 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'''
+
Further information can be found under: [[Case Handbook]]
*Although it was aimed that it should be as complete as possible, the template 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.
+
  
 
+
== Lesson ==
 +
The current list of described Lessons is here available: [[:Category:Lesson|List of Lessons]]
  
== Tagging and the use of categories ==
+
The following form is used to describe a new Lesson: [[:Form:Lesson|Lesson Form]]
  
After finishing editing the document It must be tagged with the appropriate Categories. Categories are useful fro grouping systems that share the same characteristics. For instance, all the Swedish DSS should be tagged with the <nowiki>[[Category: Swedish_DSS]]</nowiki> category, or all systems that use Mixed Integer Programming (MIP) for optimization should be tagged with <nowiki>[[Category: MIP_Optimization]]</nowiki>
+
Further information can be found under: [[Lesson Handbook]]
  
Categories can further be grouped into super-categories. As an example, The <nowiki>[[Category: MIP_Optimization]]</nowiki> can be further categorized into a super category of <nowiki>[[Category: Optimization algorithms]]</nowiki>
+
== Forest planning problem type (country reports) ==
 +
The current list of Forest planning problem types is here available: [[:Category:Forest planning problem type|List of Forest planning problem types]]
  
A full list of the available categories can be found [[Full DSS Category List| here]]
+
The following form is used to describe a DSS: [[:Form:Forest planning problem type|Forest planning problem type Form]]
  
Important notes related to the use of categories
+
Further information can be found under: [[Forest planning problem type Handbook]]
Categories are, in general, non exclusive. Meaning that a given DSS can have any number of Categories.
+
The [[Full DSS Category List|provided list]] is bond to be dynanmic
+

Latest revision as of 17:11, 3 April 2013

Is currently under construction !!


Introduction

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

Associated with this document is another which covers the basic procedures for creating and editing wiki text. Users with little or no experience in inserting information in media wiki, should start there, to understand the foundations of wiki text editing. In this page it will be covered the specific aspects for entering DSS information

The main idea of the wiki site is to provide a repository in which to store information related to Decision Support Tools for Forest Resources. This repository, thanks to the nature of the wiki tool used will be dynamic, continuously evolving over time. It will serve also as a storage point of a controlled vocabulary or ontology on Decision Support Tools



DSS

The current list of described DSSs is here available: List of DSSs

The following form is used to describe a new DSS: DSS Form

Further information can be found under: DSS_description_Handbook

Case

The current list of described Cases is here available: List of Cases

The following form is used to describe a new Case: Case Form

Further information can be found under: Case Handbook

Lesson

The current list of described Lessons is here available: List of Lessons

The following form is used to describe a new Lesson: Lesson Form

Further information can be found under: Lesson Handbook

Forest planning problem type (country reports)

The current list of Forest planning problem types is here available: List of Forest planning problem types

The following form is used to describe a DSS: Forest planning problem type Form

Further information can be found under: Forest planning problem type Handbook