Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [vtp-dev] Documentation

Absolutely we will provide the traditional help plugins, thats part of the build integration that I mentioned, ie we can go from wiki source to an eclipse help plugin.

Adam Berry

On 4/29/09 3:31 PM, Mike Greenawalt wrote:
How does this relate to documentation provided under the Eclipse Help system? Will there be hooks in Help to access the Wiki-format docs? I am accustomed to accessing Help to get basic docs on Eclipse functionality that I use. Or is Eclipse encouraging a different approach now?

-- Mike

Adam Berry wrote:
I have also looked at WikiText and thought that it was pretty slick, seems to provide;

* easy authoring in different markups, with a good editor with nice preview feature

* export to DocBook, thus giving us all the flexibility that tool has for output formats

* ant tasks for build integration, which is a really critical and sometimes overlooked piece.

All in all, I think its the best solution, and nice to be a customer of another Eclipse project.

Adam Berry

On 4/26/09 7:35 AM, Trip Gilman wrote:
I've been looking for a better solution for our documentation than the
traditional Word/OpenOffice -> Export to HTML (shudder) or PDF toolchain. I
liked the concept of DocBook but haven't found current or maintained
projects for all the needed links.

I've considered migrating our project site to the eclipse wiki as many other projects have done. I think this has several benefits over using phoenix as
we do now.  However, it still doesn't solve the general documentation
problem.

While checking out Planet Eclipse I came across Peter Friese's posting about
the WikiText subproject the guys over at Mylyn have come up with.  It
provides an editor that support many different wiki markup formats and
built-in transformation capabilities. I'm going to play with this and see
how it works.

Has anyone here had a chance to use this before? What were your impressions
and experiences?  Does anyone have any other suggestions for supporting
single documentation source to multi-format export?

Trip Gilman

_______________________________________________
vtp-dev mailing list
vtp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/vtp-dev
_______________________________________________
vtp-dev mailing list
vtp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/vtp-dev

_______________________________________________
vtp-dev mailing list
vtp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/vtp-dev


Back to the top