Community
Participate
Working Groups
Requirements: * Create a 'Register TOC' wizard that automatically adds and updates TOC extensions within the project's plug-in manifest files * Add a "Register this TOC" hyperlink to the TOC form page header that summons the 'register TOC' wizard Please see the simple cheat sheet editor for a working example. Please see Bug # 162812 to see the type of work involved.
*** Bug 200260 has been marked as a duplicate of this bug. ***
Created attachment 76954 [details] Register Table of Contents Wizard Enhancement. Creates a "Register Table of Contents" Wizard. The wizard can be used to update TOCs that have already been registered, or to register new TOCs.
Forgot to mention, you won't see a registered TOC in the Help Contents view unless it actually links to content (at least one topic has to have an HREF attribute filled in; see bug 201140).
Comment on attachment 76954 [details] Register Table of Contents Wizard Enhancement. Nice work. However, there has been a change in requirements. Details to follow.
Amendments: * Delete "Category" field -> Do not generate any default content * Delete "Additional directory ..." field -> Do not generate any default content * Remove "Registration Information" group * Keep "This table of contents is a master ..." checkbox -> However, reword label to make less wordy -> Fix Bug: Checkbox should be checked if the extension has already been defined and marked as primary and vice versa. * Add a new label saying something like the following: "This wizard will update or add a TOC extension in the project's plugin.xml" -> Make "plugin.xml" a hyperlink that when clicked opens the appropriate plug-in manifest editor on the "Extensions" page * Provide a help document for this wizard -> e.g. Make accessible when the (?) button is clicked in the bottom left hand corner of the wizard * Note: Use layout spacing rather than blank labels to space fields and labels
Created attachment 77507 [details] Register TOC Wizard and Doc Page Conformed to all of the changes in requirements mentioned above except for the description label and plugin.xml hyperlink, which would open the manifest editor behind the wizard and generally not be pretty. Also added context and a stub documentation page to be filled in later.
Comment on attachment 77507 [details] Register TOC Wizard and Doc Page Thanks Noam.
Patch released to HEAD. Target: 3.4 M2 Changes: * Fixed bug: Missing bundle in 'Require-Bundle' header. 'org.eclipse.help.toc' should be 'org.eclipse.help' plug-in * Fixed bug: Unused label: RegisterTocWizardPage_labelCreate * Fixed bug: On first use, when the primary check box is unchecked, the primary attribute value is blank (uses default value which is false), instead of explicitly setting value to false * Enhancement: Primary TOC checkbox should be checked by default -> Makes contribution visible in Infocenter if user does not know what to expect * Known Bug: If more than one TOC extension is found in the plugin.xml file, the wizard adds the TOC element to the last extension instead of the first extension found -> Register cheat sheet wizard has the same problem * Outstanding Bug: TOC wizard does not read extension and update primary checkbox based on existing values -> Breakage caused by new extension registry -> Same problem with register cheat sheet wizard
I will go ahead and fix things up a bit to make sure it works with extension registry code.
The outstanding bug of being able to read existing extensions points is fixed. Marking bug as fixed.
