Difference between revisions of "User's manual"

Warning: require(): Unable to allocate memory for pool. in /data/home/fp0804/www/wiki/includes/AutoLoader.php on line 1191

Revision as of 19:07, 25 May 2009 (view source) Afalcao (Talk | contribs) (→‎Introduction) ← Older edit		Latest revision as of 17:11, 3 April 2013 (view source) Roc (Talk | contribs) (→‎DSS)
(47 intermediate revisions by 3 users not shown)
Line 1:		Line 1:
−	==Introduction==	+	Is currently under construction !!
−	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	+
−	http://www.mediawiki.org/wiki/Manual:FAQ
−	Section 4.1, is particularly useful for the first steps:	+	==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.
−	http://meta.wikimedia.org/wiki/Help:Editing	+
−		+
−	An excellent offline resource (actually online for these 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>.	+
−		+
−		+
−	'''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]].'''	+
−		+
−	==Basic text editing==	+
−		+
−	Any article in the wiki can be edited just by clicking the "Edit" tab in the top of the article. Doing so will provide with a very simple interface for editing text. Some basic functionalities are present with some predefined buttons for various types of editing. What follows is a basic description of the most important editing options available with examples for its application	+
−		+
−	These are the basic formatting options for writing in '''bold''' or ''italic''	+
−	<pre>	+
−	''this text should appear in italic''	+
−	'''This text should appear in bold'''	+
−	''''This is bold and italic''''	+
−	</pre>	+
−		+
−		+
−	==Create a new page==	+
−	There are 2 basic ways:	+
−		+
−	#Search for the new page in the search box (in the left of the page) – if the term does not exist it will allow the creation of this page, by pressing the link "You can create this page"	+
−	#When editing a page, inserting a link to a specific definition (see below, even if the page does not exist, will allow the creation of this new page by following the link.	+
−		+
−	==Editing a page==	+
−		+
−	These are some of the more common formatting issues	+
−		+
−	===Section headings===	+
−		+
−	To define a heading for a section just use the "=" sign to specify the heading level	+
−		+
−	<pre>	+
−	= Heading 1 =  (best not to use it)	+
−	== Heading 2 ==	+
−	=== Heading 3 ===	+
−	...	+
−	</pre>	+
−		+
−	===Bullets and numbered lists===	+
−		+
−	The basic syntax involves the use of "*" and "#"	+
−		+
−	<pre>	+
−	*  a bulleted item	+
−	** a bulleted item in another level	+
−	# - an item in a numbered list	+
−	## an item in a numbered list in level 2	+
−	</pre>	+
−		+
−	===Tables===	+
−	Each table begins with "{|" and ends with "|}" in separate lines. Columns are separated with "||" and  a new row starts with "|-" in a new line. Table headings start with “!” for the first column or "!!" for the remaining columns . To add a border, the first line should be "{| - border ="1" ". Here’s a simple example:	+
−	<pre>	+
−	{| border ="1"	+
−	!Letter !! Number	+
−	|-	+
−	|Aleph || 1</nowiki>	+
−	|-	+
−	|Beth ||2	+
−	|}	+
−	></pre>	+
−		+
−	==Links==	+
−		+
−	===Internal links===	+
−		+
−	Links to the internal wiki can be specified by enveloping the relevant words with <nowiki>"[[" and "]]"</nowiki>. If an alternate text is to be presented it appears separated by a <nowiki>"|"</nowiki>. Example:	+
−		+
−	<pre>The [[fast | quick]] brown [[fox]] jumps over the lazy [[dog]]s</pre>	+
−		+
−	===Outer links===	+
−		+
−	Links to outside pages. Just typing the full http link is enough for an outside link. If alternate text is required, It is enough to use simple square brackets and whaite space as as a separator. Example	+
−		+
−	<pre>You can use [http://www.google.com this search engine] to find the information requested</pre>	+
−		+
−	==Sub-pages==	+
−		+
−	Several systems may be composed of subsystems. Sub-pages allow for a given topic to be subdivided in several independent sections that automatically ling to the parent. To add a sub page, the procedure is similar to adding a link, including a slash to indicate the sub-page. Example	+
−		+
−	<pre>The Caribbean system is divided into two main modules:	+
−	* [Caribbean/SHRIMP | SHRIMP], for growth and yield prediction;	+
−	* [Caribbean/OYSTER OYSTER] for management modeling	+
−	</pre>	+
−		+
−	==Categories==	+
−	Pages can be grouped into Categories. A page can have several categories and a category can include several pages. To add a Category it is just necessary to include the tag  <nowiki>[[Category:my_category]]</nowiki> anywhere on the text. Categories will appear in the bottom of the page. Inserting a non-existent Category, will link to a page allowing for its definition.	+	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
−	Categories can be further grouped into super categories, by inserting another Category tag into  the text of a Category. A simple example:	+	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
−	In the Caribbean System ™ the Optimization process uses Simulated Annealing a Meta heuristic (<code>[[Category:Simulated Annealing]]</code>), To categorize Simulated annealing as a meta-heuristic just add this super category in the text that defines the simulated annealing category (<code>[[Category: Optimization meta-heuristics]]</code>)	+	__TOC__
−	An initial list of all categories is provided [[:Category:DSS_categories | here]] for initial categorization of systems introduced in the platform.
		+	== DSS ==
		+	The current list of described DSSs is here available: [[:Category:DSS|List of DSSs]]
−	[[Category:Help documents]]	+	The following form is used to describe a new DSS: [[:Form:DSS|DSS Form]]
−	==References to published work==	+	Further information can be found under: [[DSS_description_Handbook]]
−	References to published work can be inserted anywhere in the text by using a special tag: <nowiki><ref>and </ref></nowiki> to begin and end a reference to a specific work, which is inserted directly in the text. Example	+	== Case ==
		+	The current list of described Cases is here available: [[:Category:Case|List of Cases]]
−	<pre>	+	The following form is used to describe a new Case: [[:Form:Case|Case Form]]
−	as Walrus and Carpenter have referred <ref> Walrus M, Carpenter J(1872)	+
−	"The time has come to talk of many things". Sealing Wax press, Vol.1 No.2	+
−	</ref> the sea is actually boiling hot.	+
−	</pre>	+
−	Using this procedure will generate automatically a references section just by including <nowiki><references/></nowiki> anywhere in the article being edited	+	Further information can be found under: [[Case Handbook]]
−	==Inserting Images==	+	== Lesson ==
		+	The current list of described Lessons is here available: [[:Category:Lesson|List of Lessons]]
−	Images can be added easily to wiki pages following these simple steps:	+	The following form is used to describe a new Lesson: [[:Form:Lesson|Lesson Form]]
−	#Write the link to an image on the page <nowiki>[[Image:my_forest.gif]]</nowiki> and save the page	+
−	#click on the link that appears and upload the image. Make sure the name uploaded matches the link	+
−	Images can be aligned to the right or left by specifying the alignment:	+	Further information can be found under: [[Lesson Handbook]]
−	<pre>[[Image:big_forest.jpg | right]]</pre>	+	== 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]]
−	To link to pictures not directly shown up use:	+	The following form is used to describe a DSS: [[:Form:Forest planning problem type|Forest planning problem type Form]]
−	<pre>[[Media:bigger_forest1.jpg | A nice picture]]</pre>	+	Further information can be found under: [[Forest planning problem type Handbook]]

---

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