Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 286862 - Eclipse Help documentation needed
Summary: Eclipse Help documentation needed
Status: RESOLVED FIXED
Alias: None
Product: PTP
Classification: Tools
Component: Photran.Documentation (show other bugs)
Version: 4.0   Edit
Hardware: PC Windows Vista
: P3 enhancement (vote)
Target Milestone: 6.0   Edit
Assignee: Jeffrey Overbey CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-08-17 15:53 EDT by Matt Scarpino CLA
Modified: 2011-01-31 08:05 EST (History)
2 users (show)

See Also:

Attachments
Screenshot of the Photran help plug-in (512.00 KB, image/jpeg)
2009-08-23 22:48 EDT, Matt Scarpino CLA 		no flags Details
Archive of the Photran Eclipse Help plug-in project (1.59 MB, application/zip)
2009-08-23 22:50 EDT, Matt Scarpino CLA 		g.watson: iplog+
Details
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Matt Scarpino CLA 2009-08-17 15:53:02 EDT 
Currently, Photran's documentation can only be found online at the Wiki site. There is no Photran plug-in that provides help documentation within Eclipse.

Ideally, there would be a tool that would read in the wiki markup files (currently photran5 and photran5advanced) and produce an Eclipse Help project. Let me see what I can do.
Comment 1 Matt Scarpino CLA 2009-08-23 22:48:58 EDT 
Created attachment 145362 [details]
Screenshot of the Photran help plug-in
Comment 2 Matt Scarpino CLA 2009-08-23 22:50:49 EDT 
Created attachment 145363 [details]
Archive of the Photran Eclipse Help plug-in project

When this plug-in is incorporated into Eclipse, the Photran Guide will appear among the Eclipse Help topics.
Comment 3 Jeffrey Overbey CLA 2009-08-24 09:55:17 EDT 
Thanks a lot.  Can you please confirm that

1. you wrote 100% of the code without incorporating content from elsewhere or
relying on the intellectual property of others,

2. you have the right to contribute the code to Eclipse, and

3. you have included the EPL license header in all source files?
Comment 4 Matt Scarpino CLA 2009-08-24 12:02:55 EDT 
Hi Jeff,

I confirm that...

1. I wrote 100% of the code without incorporating content from elsewhere or
relying on the intellectual property of others.

2. I have the right to contribute the code to Eclipse.

3. I have included the EPL license header in all source files.

Matt
Comment 5 Jeffrey Overbey CLA 2009-09-08 14:58:49 EDT 
Thanks, Matt.  I will need to submit this to the IP team for review...
Comment 6 Jeffrey Overbey CLA 2009-11-11 17:00:52 EST 
The IP team approved the use of the generated help content.  This is ready for check in...
Comment 7 Jeffrey Overbey CLA 2010-02-24 22:57:35 EST 
Committed to CVS.  Waiting on response from Greg/ptp-dev on release engineering issues...
Comment 8 Jeffrey Overbey CLA 2010-03-02 17:38:16 EST 
Greg is taking care of the release engineering and Helios issues.  Closing this out.  Thanks again for your help on this, Matt!