Summary: | [Doc] Documentation needs to be updated for criteria | ||
---|---|---|---|
Product: | [Eclipse Project] Platform | Reporter: | Chris Goldthorpe <cgold> |
Component: | User Assistance | Assignee: | platform-ua-inbox <platform-ua-inbox> |
Status: | RESOLVED FIXED | QA Contact: | |
Severity: | normal | ||
Priority: | P3 | CC: | zhhaohh |
Version: | 3.6 | Keywords: | Documentation |
Target Milestone: | 3.6 RC2 | ||
Hardware: | PC | ||
OS: | Windows XP | ||
Whiteboard: | |||
Attachments: |
Description
Chris Goldthorpe
2010-03-05 16:40:02 EST
Created attachment 168470 [details]
New help page on defining scopes
Created attachment 168472 [details]
New images for platform.doc.user
The last two attachment are a patch and images for a new page which I plan to add to platform.doc.user to describe how to use scopes. I will wait until after RC1 is declared before I commit these changes. Created attachment 168486 [details]
Patch which adds a page to platform.doc.isv
This patch creates a page in the table of contents. The body of the page needs to be completed. The hyperlinks are to generated pages, they will work in a build but will not work if Eclipse is launched from your workspace.
Created attachment 168508 [details]
Add page in org.eclipse.platform.doc.isv to show how to add criteria in help content
Chris, I've added page to describe how to add criteria in help content. Please have a review on that.
And also, in this page, I need your help to fill some detail information in section -- 'Define criteria using criteria provider'.
Created attachment 168612 [details]
Updated patch to platform.doc.isv
I made a few revisions to your version of the page to improve the readability.
I have committed all of the non obsolete patches, this will be in the nightly build, from there we can continue to review the documents and make changes if necessary. Fixed in 3.6 RC2 Chris, After reviewing the doc, I notice that I've missed one instruction. Such format is supportted when define criteria in table of contents: <criteria name="Platform" value="AIX,Linux"/> which equals to: <criteria name="Platform" value="AIX"/> <criteria name="Platform" value="Linux"/> And you miss one important rule, comma is not supported in id of criteria 'name' and 'value'. Can you help to update the Doc? Thanks! Created attachment 168979 [details]
Additional patch describes comma separated values
Is this the kind of change you were wanting to add? If this is not correct please attach a revised patch.
Chris, It's definitely what I want to add. And one more issue, have we finished on org_eclipse_help_criteriaDefinition.html and org_eclipse_help_criteriaProvider.html? Missing end tag for 'criteriaDefinition' element in section -- Criteria localization: <extension point="org.eclipse.help.criteriaDefinition"> <criteriaDefinition file="criteria.xml"> </extension> should be: <extension point="org.eclipse.help.criteriaDefinition"> <criteriaDefinition file="criteria.xml"/> </extension> I have committed "Additional patch describes comma separated values" and made the change suggested in Comment 12. |