Difference between revisions of "DocumentationGuidelines/CrowdSourcingExample"

From Eclipsepedia

Jump to: navigation, search
Line 12: Line 12:
  
 
==Setting up the Classpath==
 
==Setting up the Classpath==
 
+
<pre style="width: 50em;">
 
<path id="wikitext.tasks.classpath">
 
<path id="wikitext.tasks.classpath">
 
<fileset dir="lib">
 
<fileset dir="lib">
Line 21: Line 21:
 
<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/internal/wikitext/mediawiki/core/tasks/tasks.properties"/>
 
<taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties"/>
 
<taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties"/>
 +
</pre>
  
 
==Fetching the Wiki Content==
 
==Fetching the Wiki Content==
  
 +
TODO
  
 +
==Fetching Images==
  
 +
TODO
 +
 +
==Converting to Eclipse Help==
 +
 +
TODO
  
 
=Eclipse.org Reference Projects=
 
=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
 
* EGit

Revision as of 14:57, 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.

Setting up the Classpath

<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"/>

Fetching the Wiki Content

TODO

Fetching Images

TODO

Converting to Eclipse Help

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?)