Bug 513656 - Provide generic editor documentation in platform.isv
Summary: Provide generic editor documentation in platform.isv
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 4.7   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 4.7 RC1   Edit
Assignee: Mickael Istria CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2017-03-14 12:46 EDT by Alexander Kurtakov CLA
Modified: 2017-05-30 06:39 EDT (History)
2 users (show)

See Also:

Attachments
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 Alexander Kurtakov CLA 2017-03-14 12:46:43 EDT 
Content in Platform Plug-in Developer Guide/Programmer's Guide/Editors should be enriched with information about generic editor.
Comment 1 Mickael Istria CLA 2017-03-14 12:48:39 EDT 
I suggest we try to organize the various pages as follow

1. Writing the code that does what you want (which classes to implement and how)
2. Integrating it
2a. as a contribution to the Generic Editor: which extension point to use
2b. in your own Editor class: which methods to override
Comment 2 Alexander Kurtakov CLA 2017-04-21 11:16:18 EDT 
Mickael, is this work started?
Comment 3 Mickael Istria CLA 2017-04-24 09:23:02 EDT 
(In reply to Alexander Kurtakov from comment #2)
> Mickael, is this work started?

Not yet.
Comment 4 Eclipse Genie CLA 2017-05-11 11:05:55 EDT 
New Gerrit change created: https://git.eclipse.org/r/96861
Comment 6 Mickael Istria CLA 2017-05-16 02:47:19 EDT 
Proposal documentation got merged. Feel free to reopen if you have suggestions of improvements.
Comment 7 Mickael Istria CLA 2017-05-30 02:36:48 EDT 
Dani did have a look at it and fixed some broken links (thank you) and then I reviewed the result with Dani's patch.
I have a question though about help: do we have some snapshot help website generated we can look at to see in in the web-browser? My typical usage of help is via help.eclipse.org rather than from the IDE, so it would be nice to be able to review in a context that's closer from what many people use.
(although I have no concrete idea of what's more used of embedded help vs web help)
Comment 8 Dani Megert CLA 2017-05-30 06:39:31 EDT 
(In reply to Mickael Istria from comment #7)
> Dani did have a look at it and fixed some broken links (thank you) and then
> I reviewed the result with Dani's patch.
> I have a question though about help: do we have some snapshot help website
> generated we can look at to see in in the web-browser? My typical usage of
> help is via help.eclipse.org rather than from the IDE, so it would be nice
> to be able to review in a context that's closer from what many people use.
> (although I have no concrete idea of what's more used of embedded help vs
> web help)

Just take the next build after your change. On the Help preference page choose to use an external browser and then Help > Help Contents.