Difference between revisions of "User's manual"

From forestDSS
Jump to: navigation, search
Line 1: Line 1:
 
==Introduction==
 
==Introduction==
This is a very brief summary of the most basic functionality of the Mediawiki platform, the same that powers Wikipedia. A more through description can be found here
+
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.
  
http://www.mediawiki.org/wiki/Manual:FAQ
+
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 
  
Section 4.1, is particularly useful for the first steps:
+
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
  
http://meta.wikimedia.org/wiki/Help:Editing
 
  
An excellent offline resource (actually online for those subscribing [http://my.safaribooksonline.com/ Safari]) is the book Mediawiki, by Daniel Barrett<ref> Barret, JD (2008) Mediawiki - wikipedia and beyond. O'Reilly. Sebastopol, CA. 358pp</ref>.
+
__TOC__
  
 +
== Brief description of the process ==
 +
 +
To insert a new DSS these are the generic steps to be followed, although variants are possible:
 +
 +
# Create a new page
 +
# 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
 +
 +
 +
== Template Use ==
 +
 +
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.
 +
 +
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'''
 +
*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.
 +
 +
 
 +
 +
== Tagging and the use of categories ==
  
 
'''VERY IMPORTANT NOTE: This is a basic wiki text manual. For entering Decision Support basic information It is highly recommended that the [[DSS Template| template provided]] is used, filling the appropriate sections as needed. An example of use can be found[[Example DSS | here]].'''
 
'''VERY IMPORTANT NOTE: This is a basic wiki text manual. For entering Decision Support basic information It is highly recommended that the [[DSS Template| template provided]] is used, filling the appropriate sections as needed. An example of use can be found[[Example DSS | here]].'''

Revision as of 16:27, 9 June 2009

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.

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


Brief description of the process

To insert a new DSS these are the generic steps to be followed, although variants are possible:

  1. Create a new page
  2. From the template provided copy the necessary section headings for the adequate description of the system in focus
  3. Fill in each section with the required level of detail
  4. Attribute the appropriate Categories


Template Use

As a first approach, users are encouraged to use the 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 template and selecting and copying the text.

Some notes are important to point regarding the use of the 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
  • 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.


Tagging and the use of categories

VERY IMPORTANT NOTE: This is a basic wiki text manual. For entering Decision Support basic information It is highly recommended that the template provided is used, filling the appropriate sections as needed. An example of use can be found here.