Bug 203553 - Template Engine help is misleading
Summary: Template Engine help is misleading
Status: RESOLVED FIXED
Alias: None
Product: CDT
Classification: Tools
Component: cdt-doc (show other bugs)
Version: 4.0   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 4.0.1   Edit
Assignee: Andrew Ferguson CLA
QA Contact:
URL:
Whiteboard:
Keywords: contributed
Depends on:
Blocks:
 
Reported: 2007-09-17 00:17 EDT by Beth Tibbitts CLA
Modified: 2008-06-22 02:22 EDT (History)
3 users (show)

See Also:


Attachments
Fix initial setup info for writing a template (3.51 KB, patch)
2007-09-17 00:17 EDT, Beth Tibbitts CLA
bjorn.freeman-benson: iplog+
Details | Diff
more updates to html documentation (4.20 KB, patch)
2007-09-17 10:11 EDT, Beth Tibbitts CLA
bjorn.freeman-benson: iplog+
Details | Diff
replacement for org_eclipse_cdt_core_templates.html (6.65 KB, text/html)
2007-09-17 22:01 EDT, Beth Tibbitts CLA
bjorn.freeman-benson: iplog+
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Beth Tibbitts CLA 2007-09-17 00:17:22 EDT
Created attachment 78528 [details]
Fix initial setup info for writing a template

Build ID: Build id: I20070625-1500

Steps To Reproduce:
1. Help > Help Contents
2. Under CDT Plug-in developer guide
   select Programmer's Guide then Project Template Engine
3. Try to follow directions


More information:
The packages and some names have changed since this
help was written.
I believe the attached patch fixes them, to the best of my knowledge.
However I still can't get my template to work. So I'll ask on cdt-dev.
Comment 1 James Blackburn CLA 2007-09-17 03:34:17 EDT
I (and another) have had similar problems with the templateengine documentation bug 201087. Thanks for looking into it!
Comment 2 Beth Tibbitts CLA 2007-09-17 10:11:22 EDT
Created attachment 78548 [details]
more updates to html documentation

More changes based on discussion with Bala and more investigation.
Comment 3 Andrew Ferguson CLA 2007-09-17 10:18:58 EDT
thanks Beth, I've applied this patch and made clarified some other areas.

After speaking with Bala, I've also removed the "usageDescription" attribute from the template extension point as it no longer used.
Comment 4 Beth Tibbitts CLA 2007-09-17 10:55:56 EDT
Thanks Andrew, looking lots better.
One old straggling line is left: need to remove (part of) the line:

<code class="ProgramOutput">projectType</code> drop-down list. This is an mandatory attribute.

Half the line from the reference to the drop-down list is still there,
before the mandatory attribute sentence.
Comment 5 Andrew Ferguson CLA 2007-09-17 11:12:40 EDT
thanks, I've corrected this now. 
Comment 6 Andrew Ferguson CLA 2007-09-17 11:40:17 EDT
marking as FIXED
Comment 7 Beth Tibbitts CLA 2007-09-17 22:01:21 EDT
Created attachment 78599 [details]
replacement for org_eclipse_cdt_core_templates.html

This is a possible replacement for 
org_eclipse_cdt_core_templates.html in the reference/extension-points directory.

For some reason I couldn't make a patch, it didn't detect the diffs
(there are several).  Mostly I cleaned up grammar and completed/cleaned up
some sections to match the other docs.

Please read thru it to assure I accurately represented your intentions.
Comment 8 Andrew Ferguson CLA 2007-09-18 05:03:59 EDT
(In reply to comment #7)
> Created an attachment (id=78599) [details]
> replacement for org_eclipse_cdt_core_templates.html
> This is a possible replacement for 
> org_eclipse_cdt_core_templates.html in the reference/extension-points
> directory.
> For some reason I couldn't make a patch, it didn't detect the diffs
> (there are several).  Mostly I cleaned up grammar and completed/cleaned up
> some sections to match the other docs.
> Please read thru it to assure I accurately represented your intentions.

hi Beth, 

 this file is autogenerated from the extension point schema
   org.eclipse.cdt.core\schema\templates.exsd
which is why creating a patch is not possible. I've had a go at merging in your changes with the updates I made yesterday. thanks!
Comment 9 Beth Tibbitts CLA 2007-09-18 09:35:02 EDT
I was afraid of that. After I made the changes I notice the help description info down in the schema with the same data!

How does 'category' work?
Comment 10 Bala Torati CLA 2007-09-20 10:56:39 EDT
Hi Beth,

That came from New project model and became part of the templates extension point to facilitate integration of templates into new project model. The following is an extract from the original design doc which can be found with
https://bugs.eclipse.org/bugs/attachment.cgi?id=63886

isCategory:
Specifies whether or not the given entry is a category entry (i.e. not itself a projectType, but a category grouping some project types).
The category entry can have a wizardHandler. In this case it will be used for all category children that do not specify their own handlers. This is ptional.
By default the entry is treated as non-cathegory.
Comment 11 Beth Tibbitts CLA 2007-09-20 11:13:02 EDT
Thanks Bala.  I'll try it.

Is there any more detail available on using the 
PagesAfterTemplateSelectionProvider?
I can't get mine to be called.

Here is the question i asked on cdt-dev:

my PagesAfterTemplatSelectionProvider  implements IWizardDataPage (I took my MBSCustom page and added the 1 method to make it implement IWizardDataPage).
But it's not getting called.
Where should it show up, in the middle, or at the end, of the new project wizard pages?

And another question.  In the MBS wizard page system, it calls a special class after the wizard is complete (OperationClass), so you can do any processing that
can be done with the information collected in the wizard pages.
Where do I do processing like that?  (When do I know my wizard page has been completed by the user? when getPageData() is called?)
And, what does it do with the Map that I must return in getPageData()?

Point me to an example if there's one already in there somewhere.
Comment 12 Bala Torati CLA 2007-09-20 11:23:22 EDT
I am looking into the PagesAfterTemplateSelectionProvider now. I will shortly update you on that. The expected behaviour is pages must appear after the pages created from information within template.xml.