Bug 304888 - [Doc] Documentation needs to be updated for criteria
Summary: [Doc] Documentation needs to be updated for criteria
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.6   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.6 RC2   Edit
Assignee: platform-ua-inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2010-03-05 16:40 EST by Chris Goldthorpe CLA
Modified: 2010-05-19 10:52 EDT (History)
1 user (show)

See Also:


Attachments
New help page on defining scopes (4.34 KB, patch)
2010-05-13 16:51 EDT, Chris Goldthorpe CLA
no flags Details | Diff
New images for platform.doc.user (48.77 KB, application/octet-stream)
2010-05-13 16:55 EDT, Chris Goldthorpe CLA
no flags Details
Patch which adds a page to platform.doc.isv (2.59 KB, patch)
2010-05-13 18:27 EDT, Chris Goldthorpe CLA
no flags Details | Diff
Add page in org.eclipse.platform.doc.isv to show how to add criteria in help content (6.36 KB, patch)
2010-05-14 02:39 EDT, Hao Zhang CLA
no flags Details | Diff
Updated patch to platform.doc.isv (6.54 KB, patch)
2010-05-14 16:58 EDT, Chris Goldthorpe CLA
no flags Details | Diff
Additional patch describes comma separated values (984 bytes, patch)
2010-05-18 13:48 EDT, Chris Goldthorpe CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Goldthorpe CLA 2010-03-05 16:40:02 EST
I20100302-0800

The Eclipse documentation needs information on how to create table of content files with criteria and also on how to use the criteria section of the scope dialog.
Comment 1 Chris Goldthorpe CLA 2010-05-13 16:51:26 EDT
Created attachment 168470 [details]
New help page on defining scopes
Comment 2 Chris Goldthorpe CLA 2010-05-13 16:55:11 EDT
Created attachment 168472 [details]
New images for platform.doc.user
Comment 3 Chris Goldthorpe CLA 2010-05-13 17:01:29 EDT
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.
Comment 4 Chris Goldthorpe CLA 2010-05-13 18:27:19 EDT
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.
Comment 5 Hao Zhang CLA 2010-05-14 02:39:50 EDT
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'.
Comment 6 Chris Goldthorpe CLA 2010-05-14 16:58:54 EDT
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.
Comment 7 Chris Goldthorpe CLA 2010-05-15 16:28:18 EDT
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.
Comment 8 Chris Goldthorpe CLA 2010-05-17 14:02:52 EDT
Fixed in 3.6 RC2
Comment 9 Hao Zhang CLA 2010-05-17 23:00:51 EDT
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!
Comment 10 Chris Goldthorpe CLA 2010-05-18 13:48:08 EDT
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.
Comment 11 Hao Zhang CLA 2010-05-19 01:47:41 EDT
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?
Comment 12 Hao Zhang CLA 2010-05-19 02:47:27 EDT
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>
Comment 13 Chris Goldthorpe CLA 2010-05-19 10:52:03 EDT
I have committed "Additional patch describes comma separated values" and made the change suggested in Comment 12.