Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "DocumentationGuidelines/CrowdSourcingExample"
m (DocumentationGuidelines/Example moved to DocumentationGuidelines/CrowdSourcingExample: Because it makes more sense.) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
=Introduction= | =Introduction= | ||
| − | There are many ways to generate help content in Eclipse. | + | 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== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | =Eclipse.org Reference Projects= | ||
| + | |||
| + | * EGit | ||
| + | * Mylyn | ||
| + | * Xtext (use textile) | ||
| + | * EclipseLink (dita?) | ||
Revision as of 14:53, 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
Eclipse.org Reference Projects
- EGit
- Mylyn
- Xtext (use textile)
- EclipseLink (dita?)