Community
Participate
Working Groups
Enable Mylyn WikiText users to specify a set of MediaWiki pages to be converted to Eclipse help format. Currently Mylyn WikiText users can easily convert a single page to Eclipse Help, however it's somewhat limiting in that all help content must be on a single wiki page. With this feature, users will be able to specify a set of wiki pages from which to generate help content. relevant issues: * bug 283734: Documentation Best Practices * bug 214139: Tool to create Eclipse documentation plug-ins from subset of Eclipse wiki An initial implementation could take the form of an Ant task.
Created attachment 156301 [details] an initial cut (partially complete) Attaching a work in progress. This implementation is an Ant task that provides an Ant task. Sample modifications are made to the mylyn.help.ui Ant script to show its usage. Outstanding items in this implementation include: * navigation image single location * cross-page anchor id resolution when splitting to multiple pages * table of contents
Created attachment 156302 [details] mylyn/context/zip
Nice, +1!
Created attachment 156341 [details] continued work in progress updated: multiple documents cross-page linking now works, shared navigation images, and toc.xml implemented.
Created attachment 156342 [details] mylyn/context/zip
Created attachment 156667 [details] updated implementation
Created attachment 156668 [details] mylyn/context/zip
Created attachment 156963 [details] updated implementation Attached implementation nearing completion. Still in need of a way to provide page content for the top-level page of the unified table of contents.
Created attachment 156964 [details] mylyn/context/zip
This feature has been implemented in CVS. Documentation on this feature is still outstanding. In the meantime, here's how it's used with Mylyn: bc.. <mediawiki-to-eclipse-help wikiBaseUrl="${mylyn.help.doc.url.base}" validate="true" failonvalidationerror="true" prependImagePrefix="${imageFolder}" formatoutput="true" defaultAbsoluteLinkTarget="mylyn_external" dest="${basedir}" title="Mylyn" generateUnifiedToc="false"> <path name="Mylyn/User_Guide" title="Mylyn User Guide" generateToc="true"/> <path name="Mylyn/FAQ" title="Mylyn FAQ" generateToc="true"/> <stylesheet url="book.css"/> <pageAppendum> = Updating This Document = This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit {url}</pageAppendum> </mediawiki-to-eclipse-help>
Created attachment 158403 [details] mylyn/context/zip
Hi, This new implementation is very useful. I made a patch to enable users to organize their path, because I needed to organize topic in my unified toc.xml A first I was thinking in doing something like a pathSet <pathSet name="MoDisco" title="KDM" topicId="KDM"> <path name="MoDisco/Components" title="MoDisco"/> <path name="MoDisco/Documentation" title="MoDisco Doc"/> <pathSet/> But I thought it implied a lot of modifications"in your code So I implemented this: <path name="MoDisco/KDM" title="KDM" topicId="KDM"/> <path name="MoDisco/KDM/Component" title="KDM Component" topicParentId="KDM"/> <path name="MoDisco/Components/KDM/New" title="KDM New" topicParentId="KDM"/> Tell me what you think of this Nicolas (In reply to comment #11) > Created an attachment (id=158403) [details] > mylyn/context/zip
Created attachment 160204 [details] Patch to organize topic in the unified toc.xml
Nicolas, thanks for the excellent patch and feature request. I've taken a look and implemented it a little differently than the patch. Instead of specifying it as you suggest by assigning ids to paths, paths are connected as follows: pre. <path name="MoDisco/KDM" title="KDM"/> <path name="MoDisco/KDM/Component" title="KDM Component" topicParentName="MoDisco/KDM"/> <path name="MoDisco/Components/KDM/New" title="KDM New" topicParentName="MoDisco/KDM"/> I was a little wary of assigning ids to paths, since to me it implies that the ids would somehow appear in the generated table of contents, which they don't. You'll find these latest changes in CVS. I hope that's what you had in mind, please let me know.
Documented in the latest *Mylyn WikiText User Guide*. Please file requests for changes, enhancements and issues as new bugs.
Created attachment 161072 [details] mylyn/context/zip
Hi David, This is exactly what I had in mind, and easier now than how I did it. Do you already know when it will be included in your update site ? Thanks Nicolas (In reply to comment #16) > Created an attachment (id=161072) [details] > mylyn/context/zip
There's a new standalone distribution available and it should also be available on the weekly update site (see http://www.eclipse.org/mylyn/downloads)
For future reference: an excellent example of this task in use and documentation explaining how it works is available: http://wiki.eclipse.org/DocumentationGuidelines/CrowdSourcingExample Thanks to Chris for putting it all together.
