Community
Participate
Working Groups
Build ID: 4.0.0 I've been trying to migrate our simple 'Standard Make' system to use the new Project Model, and have so far found there to be many sets of documentation in many places (bugzilla, the ISV documentation, random pointers on the mailing list), most of which are out of date. The difficulty is that there doesn't seem to be a simple single repository of documentation which states how this is all meant to fit together, making it very difficult for new developers to grasp what's going on. What I've found so far: Template Engine: ISV Documentation: "How to register a template with Eclipse" is out of date. The instructions here refer to "org.eclipse.cdt.templateengine.templates" (which doesn't exist) and a wizardID attribute which must be specified, which also doesn't exist (also listed in the XML example for the extension point). Bugzilla: In the initial New Project Model(185049) and Template Engine(160012) bugzillas there are a number of design documents that seem large and thorough (though they do not seem to map nicely to what is actually in CDT 4...). There isn't anything equivalent in the ISV documentation. Would it be possible for these to be updated to match what made it into CDT as well as made available in the default SDK documentation? The following relevant Extension points have limited/no documentation: org.eclipse.cdt.ui.CDTWizard org.eclipse.cdt.core.templateAssociations Incorrect Example: org.eclipse.cdt.core.templates Many of the rest could do with small examples/elaboration to save hunting through the various plugin.xml files. I hope that with just a bit more documentation the explanation Bala gave for project migration - http://dev.eclipse.org/mhonarc/lists/cdt-dev/msg10276.html - might be easier than "hunt through these packages/plugin.xml files and see how CDT does it"... [I've notice Mikhail's bug 185049, and think this one is different. Asking for a bit more meta documentation on how the template engine/New Project Model fit together and integrate with CDT, and how they're meant to be used by integrators.]
I'm interested in using the template engine feature as well. I got stuck looking for org.eclipse.cdt.templateengine. Adding myself to CC list.
I've made the following changes * applied a patch from Beth T. that updates the package references in the template engine help, via https://bugs.eclipse.org/bugs/show_bug.cgi?id=203553 * corrected the example for the org.eclipse.cdt.core.templates extension-point * improved the description of extension-point org.eclipse.cdt.core.templateAssociations We didn't add the original template engine design docs to the ISV help as I believe they shouldn't be needed for ISV use of the extension point. Leaving open for comment
Created attachment 90457 [details] ProcessRunner is at org.eclipse.cdt.core.templateengine.process.ProcessRunner
Created attachment 90458 [details] IPagesAfterTemplateSelection is at org.eclipse.cdt.ui.templateengine.IPagesAfterTemplateSelectionProvider
Created attachment 90459 [details] Fixes to projectTemplateEngine docs Hi Andrew, Sorry for the delay in getting back to this bug... There were a few incorrect locations detailed in the templateengine help files. I've also resolved the template engine processes between cdt.core and managedbuilder, and added the processes which weren't listed to Howtodeveloptemplates.html. When editing exampleTemplate.html, I first replaced <br> with <br>\n to make it slightly more human parseable -- so you may want to do that when diffing the old with the new. I think I've fixed most of the outdated location problems -- and hopefully not added any further inaccuracies!
thanks James. I've applied these corrections and improvements to CDT_4_0 and HEAD. Unless you have more enhancements for the template engine docs, I'd like to close this? (Its probably best to have a separate defect for any project model docs).
Thanks for applying these Andrew!
