Difference between revisions of "Wiki editing"

From COST Action FP0804: FORSYS
Jump to: navigation, search
m (Reverted edits by Boerboom (talk) to last revision by Afalcao)
Line 1: Line 1:
−
[[Category:Forsys Case Studies]]
+
==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
  
−
'''Case study: Overcoming challenges of integrating DSS in strategic collaborative forestry scenario development'''
+
http://www.mediawiki.org/wiki/Manual:FAQ
  
 +
Section 4.1, is particularly useful for the first steps:
  
−
'''Interim report: May 8th 2012.'''
+
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>.
  
−
'''Authors:'''
+
==Basic text editing==
  
−
Dr. Valentina Ferretti, Istituto Superiore sui Sistemi Territoriali per l’Innovazione, Italy.
+
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
  
−
Dr. Luc Boerboom, University of Twente, Faculty of Geoinformation Science and Earth Observation, the Netherlands
+
Paragraphs are identified with  blank lines between them. If a blank line is not present text will continue after the initial paragraph
  
  
−
'''Background of the case study: adapting planning through collaborative DSS development.'''
 
  
−
With increasing uncertainties about variables such as climate change, demographics, future forest functions, regular forest design planning across Europe, which takes place in about 10 year cycles, needs to be steered in a systematic way by longer term 30-50 year outlook. The
+
These are the basic formatting options for writing in '''bold''' or ''italic''
−
concrete link to forest design plans is important because unless these plans change, adaptation to these new and uncertain conditions will not take place. Although individual forestry decision support systems exist, there is hardly experience about the collection of these systems into
+
<pre>
−
a collaborative process that leads to systematic development and choice of both vision and pathway scenarios as well as forest policy instruments and silvicultural measures, particularly considering various sources of model and decision uncertainty.
+
''this text should appear in italic''
 +
'''This text should appear in bold'''
  
−
The Ministry of Environment of the German state of Rheinland Pfalz (http://www.mufv.rlp.de/), wishes to develop and implement a multi-stakeholderk scenario development process, methods and tools to develop a 30-50 year outlook that guides the 10 year forest design planning.
+
'''''This is bold and italic'''''
−
Initially only climate change shall be considered. In that sense this activity is a follow up from its KlimlandRP project (http://www.klimlandrp.de/). Together with the Forestclim project (http://www.forestclim.eu/) this development and implementation takes place between fall of 2011 and summer of 2012 in a project called Regionale Waldbauplanung Rheinland Pfalz – Regional Forestry Planning Rhineland Palatinate (ReFoRP). Stakeholders are experts from different sections in the ministry who have contacts with different external agencies and organizations.
+
</pre>
  
 +
This results in
  
−
'''Motivation for the case study: the difference a DSS makes.'''
+
''this text should appear in italic''
 +
'''This text should appear in bold'''
  
−
The motivation for this mission is that the lessons learned in this process can be of great value
+
'''''This is bold and italic'''''
−
to other forest management agencies facing similar need to strategically guide forest design
+
−
planning and to developers of forest decision support systems in terms of:
+
−
* How a collaborative DSS changes the planning process.
+
−
* The embedding, i.e. choices made, of various decision support systems to address different planning and decision problems in the overall decision process.
+
−
* The strengths and weaknesses of existing DSS approaches as perceived by stakeholders and decision process “owners”.
+
  
 +
==Create a new page==
 +
There are 2 basic ways:
  
−
'''Goal of the proposed STSM and its contribution to FORSYS objectives'''
+
#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 [[#Editing_a_page | below]]), even if the page does not exist, it will allow the creation of this new page by following the link.
  
−
The goal of the proposed STSM is to develop a case study report (STSM Scientific Report)describing
+
=== Using the template ===
−
* the decision process development as well as the decision process;
+
−
* questions raised by different stakeholders;
+
−
* selection and embedding of a series of forestry decision support systems and methods (e.g. forest growth systems, forest function assessment, forest evaluation systems);
+
−
* strenghts and weaknesses of different decision support systems
+
−
* and a survey with stakeholders about experience and validity of the decision process and outcome.
+
  
 +
There are several ways of using the [[DSS_Template | template]]. Two simple alternatives are:
  
−
'''Theory, methodology, concepts'''
+
'''Alternative A'''
  
−
This case study uses the following theories. methodologies and concepts. The central question is how does forest DSS get institutionalized in forestry practice. We turn to the field of Science and Technology Studies and in particular Actor Network Theory (Latour, Law, Mol, Braa, Sahay, and other authors). It sees technology as actor made up of a network of human and technology actors.
+
#Go to the [[DSS_Template | template page]] and click on "edit" on the top of the page
−
We also use the concept of Thinklets (Briggs, Vreede) for collaboration engineering. A Thinklet A thinkLet is a named, packaged facilitation technique, captured as a pattern that collaboration engineers can incorporate into process designs. It combines technology with process.
+
#Select and copy all the wiki text
−
Finally we use case study methodology (Yin). As part of this case study we employ a survey to establish the actor network and implications for institutionalization.
+
#Create a new page as described above
 +
#When starting editing the new page, paste the template to the edit box and start filling the blanks and removing the unnecessary or unavailable parts
  
 +
'''Alternative B'''
  
−
'''Development process'''
+
#For easy reference, make a printout of the [[DSS_Template | template page]]. It is not necessary to print, to have the template present in another desktop window or browser tab may be sufficient.
 +
#Create a new page as described above and start editing
 +
#Start adding the required points to the wiki text form according to the System being described
  
−
The development process of this DSS has seen the following milestones
 
  
 +
After editing the page, categories can be added, as described [[#Categories | below]]
 +
 +
==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 "#". Example:
 +
 +
<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>
 +
 +
will appear as
 +
 +
*  a bulleted item
 +
** a bulleted item in another level
 +
# an item in a numbered list
 +
## an item in a numbered list in level 2
 +
 +
===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" ". Formatting individual rows can be done by defining the style after the "|-" sign. Here's a simple example:
 +
<pre>
 
{| border ="1"  
 
{| border ="1"  
−
!Date !! Milestones
+
!Letter !! Number
−
|- align= "align"
+
|- align="center"
−
|17.11.2010 ||'''Kickoff meeting''' of Forestclim project (www.forestclim.eu) staff and Ministerium für Umwelt, Landwirtschaft,Ernährung, Weinbau und Forsten Rheinland-Pfalz (MULEWF, http://www.mulewf.rlp.de/) about Regionale Waldbauplanung in Rhineland Palatinate, Regional Forest Planning in German state of Rhineland Pfalz (ReFoRP). Establishes the need for strategic planning instruments, including DSS and process to guide forest planning.
+
|Aleph || 1
−
|- align= "align"
+
|- align="center"
−
|18.04.2011 ||Meeting of Forestclim and MULEWF to '''establish concept of Multifunctional collaborative Decision Support System''' for regional forest planning in Rhineland Palatinate
+
|Beth || 2
−
|- align= "align"
+
−
|26.10.2011 ||Meeting of Forestclim and KlimlandRP (http://www.klimlandrp.de/) project staff initiating
+
−
* '''Forest Function Mapping''' of Rhineland Palatinate to establish valuable forests.
+
−
* '''Simulation of Forest Growth''' with key parameters tree species and tree ages under climate change on local scale (combination of SILVA and BALANCE) to get planning options
+
−
* '''DSS development process and decision process model'''
+
−
|- align= "align"
+
−
|24.02.2011 ||Meeting of Forestclim and Klimland staff
+
−
* First forest functions analysis in desktop environment
+
−
* Prototype of web application for forest function evaluation to frame ideas for communication with stakeholders.
+
−
|- align= "align"
+
−
|12-04-2012 ||Meeting with Forestclim, Klimland and MULEWFstaff
+
−
* presentation of assessment of forest response to climate change
+
−
* presentation of evaluation of forest functions
+
−
* use of touch table to test collaborative use of assessment and evaluation
+
−
* testing of desktop DSS tools
+
−
|- align= "align"
+
−
|06-2012 ||Meeting with Forestclim, KlimlandRP and MULEWF staff:
+
−
* Perform a mock-up game
+
−
|- align= "align"
+
−
|10-2012 ||Meeting stakeholders with Forestclim, KlimlandRP and MULEWF staff to assess climate change and evaluate impact, and assess adaptation strategies
+
 
|}
 
|}
 +
</pre>
 +
 +
For which the outcome is:
 +
 +
{| border ="1"
 +
!Letter !! Number
 +
|- align="center"
 +
|Aleph ||  1
 +
|-align="center"
 +
|Beth ||  2
 +
|}
 +
 +
==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>
 +
 +
which produces:
 +
 +
The [[fast | quick]] brown [[fox]] jumps over the lazy [[dog]]s
 +
 +
===Outer links===
 +
 +
Outer links are links to outside pages. Just typing the full ''http link'' is enough for automatically create an outside link. If alternate text is required, just use simple square brackets and white space as a separator. Example:
 +
 +
<pre>You can use [http://www.google.com this search engine] to find the information requested</pre>
 +
 +
producing:
 +
 +
You can use [http://www.google.com this search engine] to find the information requested
 +
 +
==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 Example DSS system is divided into two main modules:
 +
* [[Example DSS/SHRIMP | SHRIMP]], for growth and yield prediction;
 +
* [[Example DSS/OYSTER | OYSTER]] for management modeling
 +
</pre>
 +
 +
which is presented as:
 +
 +
The Example DSS is divided into two main modules:
 +
* [[Example DSS/SHRIMP | SHRIMP]], for growth and yield prediction;
 +
* [[Example DSS/OYSTER | OYSTER]] for management modeling
 +
 +
==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.
 +
 +
Categories can be further grouped into super categories, by inserting another Category tag into  the text of a Category. A simple example:
 +
 +
 +
In the Example DSS System ™ the Optimization process uses Simulated Annealing a Meta heuristic (<code><nowiki>[[Category:Simulated Annealing]]</nowiki></code>), To categorize Simulated annealing as a meta-heuristic just add this super category in the text that defines the simulated annealing category (<code><nowiki>[[Category: Optimization meta-heuristics]]</nowiki></code>)
 +
 +
An initial list of all categories is provided [[:Category:DSS_categories | here]] for initial categorization of systems introduced in the platform.
 +
 +
 +
[[Category:Help documents]]
 +
 +
==References to published work==
 +
 +
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
 +
 +
<pre>
 +
However, 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>
 +
 +
which is presented as
 +
 +
However, 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. 
 +
 +
 +
 +
Using this procedure will generate automatically a references section just by including <nowiki><references/></nowiki> anywhere in the article being edited
 +
 +
==Inserting Images==
 +
 +
Images can be added easily to wiki pages following these simple steps:
 +
#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:
 +
 +
<pre>[[Image:big_forest.jpg | right]]</pre>
 +
 +
To link to pictures not directly shown up use:
 +
 +
<pre>[[Media:bigger_forest1.jpg | A nice picture]]</pre>
 +
 +
== Inserting formulas and equations ==
 +
 +
Mediawiki allows the insertion of mathematical formulas directly in the text by using a TeX like syntax.
 +
and two special delimeters (<nowiki><math> and </math></nowiki>). For example:
 +
 +
<pre>
 +
math>\max\sum_{m=1}^M\sum_{n=1}^N\frac{mx_n-ny_n}
 +
{\left(m+n \right)^2}</math>
 +
</pre>
  
 +
prints
  
−
'''Actions'''
 
  
−
April-May: theoretical, and methodological preparation and leveling off between collaborating researchers
+
<math>\max\sum_{m=1}^M\sum_{n=1}^N\frac{mx_n-ny_n}
 +
{\left(m+n \right)^2}</math>
  
−
June: STSM and survey, draft paper,
+
==References==
  
−
Sept- Oct: case study report
+
This last section is produced automatically just by typing the <nowiki><references/></nowiki> tag:
  
−
Nov-Dec: final paper
+
<references/>

Revision as of 17:07, 4 September 2012

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

http://www.mediawiki.org/wiki/Manual:FAQ

Section 4.1, is particularly useful for the first steps:

http://meta.wikimedia.org/wiki/Help:Editing

An excellent offline resource (actually online for those subscribing Safari) is the book Mediawiki, by Daniel Barrett[1].

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

Paragraphs are identified with blank lines between them. If a blank line is not present text will continue after the initial paragraph


These are the basic formatting options for writing in bold or italic 

''this text should appear in italic''
'''This text should appear in bold'''

'''''This is bold and italic'''''

This results in

this text should appear in italic This text should appear in bold

This is bold and italic

Create a new page

There are 2 basic ways:

  1. 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"
  2. When editing a page, inserting a link to a specific definition (see below), even if the page does not exist, it will allow the creation of this new page by following the link.

Using the template

There are several ways of using the template. Two simple alternatives are:

Alternative A

  1. Go to the template page and click on "edit" on the top of the page
  2. Select and copy all the wiki text
  3. Create a new page as described above
  4. When starting editing the new page, paste the template to the edit box and start filling the blanks and removing the unnecessary or unavailable parts

Alternative B

  1. For easy reference, make a printout of the template page. It is not necessary to print, to have the template present in another desktop window or browser tab may be sufficient.
  2. Create a new page as described above and start editing
  3. Start adding the required points to the wiki text form according to the System being described


After editing the page, categories can be added, as described below

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 

= Heading 1 =  (best not to use it)
== Heading 2 ==
=== Heading 3 ===
...

Bullets and numbered lists

The basic syntax involves the use of "*" and "#". Example: 

*  a bulleted item
** a bulleted item in another level
# an item in a numbered list
## an item in a numbered list in level 2

will appear as

  • a bulleted item
    • a bulleted item in another level
  1. an item in a numbered list
    1. an item in a numbered list in level 2

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" ". Formatting individual rows can be done by defining the style after the "|-" sign. Here's a simple example: 

{| border ="1" 
!Letter !! Number
|- align="center"
|Aleph ||  1
|- align="center"
|Beth ||  2
|}

For which the outcome is:

Letter Number
Aleph 1
Beth 2

Links

Internal links

Links to the internal wiki can be specified by enveloping the relevant words with "[[" and "]]". If an alternate text is to be presented it appears separated by a "|". Example: 

The [[fast | quick]] brown [[fox]] jumps over the lazy [[dog]]s

which produces:

The quick brown fox jumps over the lazy dogs

Outer links

Outer links are links to outside pages. Just typing the full http link is enough for automatically create an outside link. If alternate text is required, just use simple square brackets and white space as a separator. Example: 

You can use [http://www.google.com this search engine] to find the information requested

producing:

You can use this search engine to find the information requested

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 

The Example DSS system is divided into two main modules: 
* [[Example DSS/SHRIMP | SHRIMP]], for growth and yield prediction;
* [[Example DSS/OYSTER | OYSTER]] for management modeling

which is presented as:

The Example DSS is divided into two main modules:

  • SHRIMP, for growth and yield prediction;
  • OYSTER for management modeling

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 [[Category:my_category]] 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.

Categories can be further grouped into super categories, by inserting another Category tag into the text of a Category. A simple example:


In the Example DSS System ™ the Optimization process uses Simulated Annealing a Meta heuristic ([[Category:Simulated Annealing]]), To categorize Simulated annealing as a meta-heuristic just add this super category in the text that defines the simulated annealing category ([[Category: Optimization meta-heuristics]])

An initial list of all categories is provided here for initial categorization of systems introduced in the platform.

References to published work

References to published work can be inserted anywhere in the text by using a special tag: <ref>and </ref> to begin and end a reference to a specific work, which is inserted directly in the text. Example 

However, 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.

which is presented as

However, as Walrus and Carpenter have referred [2] the sea is actually boiling hot.


Using this procedure will generate automatically a references section just by including <references/> anywhere in the article being edited

Inserting Images

Images can be added easily to wiki pages following these simple steps:

  1. Write the link to an image on the page [[Image:my_forest.gif]] and save the page
  2. 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: 

[[Image:big_forest.jpg | right]]

To link to pictures not directly shown up use: 

[[Media:bigger_forest1.jpg | A nice picture]]

Inserting formulas and equations

Mediawiki allows the insertion of mathematical formulas directly in the text by using a TeX like syntax. and two special delimeters (<math> and </math>). For example: 

math>\max\sum_{m=1}^M\sum_{n=1}^N\frac{mx_n-ny_n}
{\left(m+n \right)^2}</math>

prints


<math>\max\sum_{m=1}^M\sum_{n=1}^N\frac{mx_n-ny_n} {\left(m+n \right)^2}</math>

References

This last section is produced automatically just by typing the <references/> tag:

  1. ↑ Barret, JD (2008) Mediawiki - wikipedia and beyond. O'Reilly. Sebastopol, CA. 358pp
  2. ↑ Walrus M, Carpenter J(1872) "The time has come to talk of many things". Sealing Wax press, Vol.1 No.2
Retrieved from "http://fp0804.emu.ee/wiki/index.php?title=Wiki_editing&oldid=5144"