Difference between revisions of "DocumentationGuidelines/CrowdSourcingExample"

From Eclipsepedia

Jump to: navigation, search
Line 9: Line 9:
 
=A Simple Example=
 
=A Simple Example=
  
The best way to learn is by doing.
+
The best way to learn is by doing. As an example, we will take this wiki entry and create some Eclipse help content from it. To accomplish this, we will use Ant so you can easily integrate this into a build if you wish.
  
 
==Setting up the Classpath==
 
==Setting up the Classpath==
 +
 +
The first order of business is to setup your Ant classpath so you can use the WikiText Ant tasks.
 +
 +
You can [http://www.eclipse.org/downloads/download.php?file=/tools/mylyn/update/weekly/mylyn-wikitext-standalone-latest.zip download] the WikiText SDK which contains the jars you'll need.
 +
 +
In the end, your Ant file will look something like the snippet below.
 +
 +
 
<pre style="width: 60em;">
 
<pre style="width: 60em;">
 
<path id="wikitext.tasks.classpath">
 
<path id="wikitext.tasks.classpath">
Line 24: Line 32:
 
  resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties"/>
 
  resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties"/>
 
</pre>
 
</pre>
 
==Fetching the Wiki Content==
 
 
TODO
 
 
==Fetching Images==
 
 
TODO
 
  
 
==Converting to Eclipse Help==
 
==Converting to Eclipse Help==
 +
 +
After we have setup the classpath for our task, we need to go and fetch the wiki content and convert it to Eclipse help. This is accomplished via the '''mediawiki-to-eclipse-help Ant''' task.
  
 
TODO
 
TODO

Revision as of 15:14, 10 March 2010

Contents

Introduction

There are many ways to generate help content in Eclipse. One particular method involves generating your help content from the wiki which allows you to crowdsource your documentation. By having your documentation on the wiki, you lower the barrier of entry for people to contribute documentation. The purpose of this wiki entry is to guide you through an example of how you can crowdsource your documentation using Mylyn WikiText.

What is WikiText

Mylyn WikiText provides an extensible framework and tools for parsing, editing and presenting lightweight markup. On top of that, it has a wiki text editor for Eclipse and Ant tasks for converting lightweight markup to HTML and other formats. In this specific example, we will be using WikiText's ability to convert Mediawiki content into Eclipse help content.

A Simple Example

The best way to learn is by doing. As an example, we will take this wiki entry and create some Eclipse help content from it. To accomplish this, we will use Ant so you can easily integrate this into a build if you wish.

Setting up the Classpath

The first order of business is to setup your Ant classpath so you can use the WikiText Ant tasks.

You can download the WikiText SDK which contains the jars you'll need.

In the end, your Ant file will look something like the snippet below.


<path id="wikitext.tasks.classpath">
	<fileset dir="lib">
		<include name="org.eclipse.mylyn.wikitext.*core*.jar"/>
	</fileset>
</path>

<taskdef classpathref="wikitext.tasks.classpath" 
 resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties"/>
<taskdef classpathref="wikitext.tasks.classpath" 
 resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties"/>

Converting to Eclipse Help

After we have setup the classpath for our task, we need to go and fetch the wiki content and convert it to Eclipse help. This is accomplished via the mediawiki-to-eclipse-help Ant task.

TODO

Eclipse.org Reference Projects

If you're looking for other examples on how to crowdsource your documentation at Eclipse, the best place is to look and see what other Eclipse.org projects are doing.

  • EGit
  • Mylyn
  • Xtext (use textile)
  • EclipseLink (dita?)