1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/tasklist.suggestions/javahelp/org/netbeans/modules/tasklist/suggestions/ui/docs/Contents.toc	Wed Nov 30 17:00:00 2005 +0000
     1.3 @@ -0,0 +1,20 @@
     1.4 +<?xml version='1.0' encoding='ISO-8859-1' ?>
     1.5 +<!DOCTYPE toc PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 1.0//EN" "http://java.sun.com/products/javahelp/toc_1_0.dtd">
     1.6 +<!--
     1.7 +                Sun Public License Notice
     1.8 +
     1.9 +The contents of this file are subject to the Sun Public License
    1.10 +Version 1.0 (the "License"). You may not use this file except in
    1.11 +compliance with the License. A copy of the License is available at
    1.12 +http://www.sun.com/
    1.13 +
    1.14 +The Original Code is NetBeans. The Initial Developer of the Original
    1.15 +Code is Sun Microsystems, Inc. Portions Copyright 1997-2001 Sun
    1.16 +Microsystems, Inc. All Rights Reserved.
    1.17 +-->
    1.18 +
    1.19 +<toc version="1.0">
    1.20 +    <tocitem>Suggestions
    1.21 +        <tocitem target="org.netbeans.modules.tasklist.suggestions.HOMEID">Suggestions View</tocitem>
    1.22 +    </tocitem>
    1.23 +</toc>

     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/tasklist.suggestions/javahelp/org/netbeans/modules/tasklist/suggestions/ui/docs/HelpSet.hs	Wed Nov 30 17:00:00 2005 +0000
     2.3 @@ -0,0 +1,34 @@
     2.4 +<?xml version='1.0' encoding='ISO-8859-1' ?>
     2.5 +<!DOCTYPE helpset PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 1.0//EN" "http://java.sun.com/products/javahelp/helpset_1_0.dtd">
     2.6 +<!--
     2.7 +                Sun Public License Notice
     2.8 +
     2.9 +The contents of this file are subject to the Sun Public License
    2.10 +Version 1.0 (the "License"). You may not use this file except in
    2.11 +compliance with the License. A copy of the License is available at
    2.12 +http://www.sun.com/
    2.13 +
    2.14 +The Original Code is NetBeans. The Initial Developer of the Original
    2.15 +Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun
    2.16 +Microsystems, Inc. All Rights Reserved.
    2.17 +-->
    2.18 +
    2.19 +<helpset version="1.0">
    2.20 +  <title>TaskList</title>
    2.21 +  <maps>
    2.22 +     <homeID>org.netbeans.modules.tasklist.suggestions.HOMEID</homeID>
    2.23 +     <mapref location="Map.jhm"/>
    2.24 +  </maps>
    2.25 +  <view>
    2.26 +    <name>TOC</name>
    2.27 +    <label>Contents</label>
    2.28 +    <type>javax.help.TOCView</type>
    2.29 +    <data>Contents.toc</data>
    2.30 +  </view>
    2.31 +  <!--<view>
    2.32 +    <name>Search</name>
    2.33 +    <label>Search</label>
    2.34 +    <type>javax.help.SearchView</type>
    2.35 +    <data engine="com.sun.java.help.search.DefaultSearchEngine">JavaHelpSearch</data>
    2.36 +  </view>-->
    2.37 +</helpset>

     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/tasklist.suggestions/javahelp/org/netbeans/modules/tasklist/suggestions/ui/docs/Map.jhm	Wed Nov 30 17:00:00 2005 +0000
     3.3 @@ -0,0 +1,18 @@
     3.4 +<?xml version='1.0' encoding='ISO-8859-1' ?>
     3.5 +<!DOCTYPE map PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 1.0//EN" "http://java.sun.com/products/javahelp/map_1_0.dtd">
     3.6 +<!--
     3.7 +                Sun Public License Notice
     3.8 +
     3.9 +The contents of this file are subject to the Sun Public License
    3.10 +Version 1.0 (the "License"). You may not use this file except in
    3.11 +compliance with the License. A copy of the License is available at
    3.12 +http://www.sun.com/
    3.13 +
    3.14 +The Original Code is NetBeans. The Initial Developer of the Original
    3.15 +Code is Sun Microsystems, Inc. Portions Copyright 1997-2002 Sun
    3.16 +Microsystems, Inc. All Rights Reserved.
    3.17 +-->
    3.18 +
    3.19 +<map version="1.0">
    3.20 +  <mapID target="org.netbeans.modules.tasklist.suggestions.HOMEID" url="suggestions.html" />
    3.21 +</map>

     4.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.2 +++ b/tasklist.suggestions/javahelp/org/netbeans/modules/tasklist/suggestions/ui/docs/suggestions.html	Wed Nov 30 17:00:00 2005 +0000
     4.3 @@ -0,0 +1,222 @@
     4.4 +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
     4.5 +<html>
     4.6 +<head>
     4.7 +<!--
     4.8 +   -                 Sun Public License Notice
     4.9 +   - 
    4.10 +   - The contents of this file are subject to the Sun Public License
    4.11 +   - Version 1.0 (the "License"). You may not use this file except in
    4.12 +   - compliance with the License. A copy of the License is available at
    4.13 +   - http://www.sun.com/
    4.14 +   - 
    4.15 +   - The Original Code is NetBeans. The Initial Developer of the Original
    4.16 +   - Code is Sun Microsystems, Inc. Portions Copyright 1997-2002 Sun
    4.17 +   - Microsystems, Inc. All Rights Reserved.
    4.18 +  -->
    4.19 +  <title>Suggestions</title>
    4.20 +  <link rel="StyleSheet" href="ide.css" type="text/css">
    4.21 +</head>
    4.22 +<body>
    4.23 +<h2> Suggestions </h2>
    4.24 +The <a href="http://tasklist.netbeans.org"><b>suggestions</b></a>
    4.25 +module, which lists suggestions for your code, such as ideas for how
    4.26 +compiler errors can be fixed, lists unused code, suggests copyrights
    4.27 +whose year ranges need to be updated, etc. <br>
    4.28 +<br>
    4.29 +This feature is still being designed and implemented.
    4.30 +Check out http://tasklist.netbeans.org and the
    4.31 +dev@tasklist.netbeans.org mailing list to get informed
    4.32 +and provide feedback.
    4.33 +<p>The "Suggestions View" shows a list of suggestions generated
    4.34 +by various pieces in the IDE. For example, there is a copyright
    4.35 +checker which makes sure that if there is a copyright string
    4.36 +near the top of the source file, the current year is included,
    4.37 +and if that is not the case, it provides a suggestion that it
    4.38 +is fixed. In many cases, the suggestions can be fixed automatically,
    4.39 +by simply double clicking on the suggestion. </p>
    4.40 +<p>The Suggestions View typically shows suggestions for the
    4.41 +current source file. However, if you select a directory
    4.42 +in the explorer and go to the Tools menu, you can
    4.43 +run the <b>Scan Directory for Suggestions</b> action. This
    4.44 +will recursively process all source files in the directory
    4.45 +and list suggestions for these in a separate view. This
    4.46 +is a convenient way to for example fix the copyright years
    4.47 +on all your source files. Note that you can shift select
    4.48 +all the suggestions and right click to select <b>Fix...</b>,
    4.49 +and now you will iterate through all the suggestions.
    4.50 +</p>
    4.51 +<p>Creating these suggestions often involve a lot of processing.
    4.52 +By default, this processing happens every time you edit a
    4.53 +source file (after a short delay). You can change this such
    4.54 +that suggestion scanning only occurs when you save a file.
    4.55 +You can also simply hide the Suggestions View temporarily if
    4.56 +you want to free up the CPU for something else (such as running
    4.57 +an ant task), since processing only occurs when the Suggestions
    4.58 +View is visible. You can also customize how long the suggestion
    4.59 +scanner should wait after an edit before starting a scan.
    4.60 +You can find these options by selecting "Edit Categories..." in
    4.61 +the context menu in the Suggestions View.
    4.62 +</p>
    4.63 +<p>The following is a list of suggestion providers you might
    4.64 +have available. Modules can add more suggestion providers, so this list
    4.65 +may not be complete.
    4.66 +</p>
    4.67 +<ul>
    4.68 +  <li> Java Compilation Errors. Lists all the java compilation errors
    4.69 +encountered while background-parsing the current source file. It will
    4.70 +also fix suggestions for how the errors can be fixed. For example, it
    4.71 +may suggest that a particular import statement is added, or the
    4.72 +capitalization of an identifier may be changed, or a new method
    4.73 +created. </li>
    4.74 +  <li> Rule Checking. Using the PMD utility, it checks the source file
    4.75 +for violations of rules. This will for example list unused methods,
    4.76 +empty if blocks, etc. </li>
    4.77 +  <li> Javadoc Errors. Lists all methods in the current file that have
    4.78 +errors in their javadoc. The javadoc may be missing, or the parameter
    4.79 +list incomplete, or a @return missing, etc. Allows some of these to be
    4.80 +corrected automatically. </li>
    4.81 +  <li> HTML Errors. Lists errors and warnings in your HTML, XML and JSP
    4.82 +documents, such as missing ALT tags, mismatched tags, etc. Allows the
    4.83 +document to be cleaned up and reformatted automatically. </li>
    4.84 +  <li> Copyright Errors. Lists copyright items where the year or year
    4.85 +range does not include the current year. Allows these to be corrected
    4.86 +automatically. </li>
    4.87 +  <li> Due Tasks. Lists tasks in the user task view that are already
    4.88 +due or will become due in the next 36 hours (e.g. roughly today or
    4.89 +tomorrow). </li>
    4.90 +  <li> Source Tasks. Lists tasks found in the source file, where a task
    4.91 +is an entry in a comment marked by FIXME, TODO or XXX. </li>
    4.92 +</ul>
    4.93 +<p>
    4.94 +</p>
    4.95 +<h3>Fixing a Suggestion</h3>
    4.96 +Some tasks have associated Fix operations. When that is the case,
    4.97 +double clicking on the suggestion will bring up the Fix Confirmation
    4.98 +Dialog. The Fix confirmation dialog varies from suggestion to
    4.99 +suggestion, but typically it provides details describing exactly
   4.100 +what applying Fix is going to change - and gives you a Cancel button
   4.101 +if you change your mind.
   4.102 +<p>You can select multiple suggestions at once (using the Shift key
   4.103 +or the Control key), and then right click and select Fix. This
   4.104 +will apply Fix to each item in the selection list, which provides
   4.105 +you with a quick way to apply a number of suggestions. When multiple
   4.106 +suggestions have been selected, the confirmation dialog includes
   4.107 +a "Fix All" button which bypasses the confirmation step for each
   4.108 +suggestion and simply performs the suggestions quietly. It will
   4.109 +also have a "Skip" button you can use to skip one particular
   4.110 +suggestion and move to the next.
   4.111 +</p>
   4.112 +<p></p>
   4.113 +<h3>Show Source Code</h3>
   4.114 +Whenever a confirmation dialog is shown for a suggestion, its
   4.115 +associated file position is also shown in the editor. If a
   4.116 +suggestion does not have an automatic fix operation, the
   4.117 +default operation on double click is to show the source position.
   4.118 +For suggestions with automatic fix, you can right click and
   4.119 +select "Go To Source" to show the source position for a suggestion.
   4.120 +<h3>Filtering Suggestions</h3>
   4.121 +If you want to limit your focus to suggestions of one particular
   4.122 +category, use the "Show" action in the Suggestions View context menu.
   4.123 +It lists the categories of suggestions, such as "Java Compilation
   4.124 +Errors". When you select one of these, only suggestions in that
   4.125 +category are shown (and more importantly, the other categories are no
   4.126 +longer processed, so your computer doesn't have to work as hard.)
   4.127 +If you want to get back to showing all suggestions, simply select
   4.128 +"All" from the Show menu.
   4.129 +<h3>Disabling Suggestions</h3>
   4.130 +If you are not interested in a particular category of suggestions, such
   4.131 +as
   4.132 +"Copyright Problems", you can disable it. This will make your
   4.133 +suggestions view less cluttered since it only lists suggestions
   4.134 +you are interested in. To disable a category, right click on
   4.135 +a suggestion and select "Disable Category". You can also
   4.136 +show the "Edit Categories..." dialog - and this is what you have
   4.137 +to do if you want to bring back a category you have previously
   4.138 +disabled.
   4.139 +<!-- TODO Show dialog screenshot here -->The "Edit Categories" dialog
   4.140 +lists the available categories
   4.141 +as rows in a table. Additional columns allow you to enable/disable
   4.142 +each category, and for those that are enabled, turn off
   4.143 +confirmation dialogs when the suggestion is performed.
   4.144 +When confirmation is disabled for a category, selecting
   4.145 +"Fix..." on a suggestion will perform the fix without showing
   4.146 +the confirmation dialog.
   4.147 +<p><b>Important</b>: Note that disabling a category applies to
   4.148 +all suggestions of that particular category. For example,
   4.149 +if there is a particular rule suggestion you don't want
   4.150 +to see, such as "unused import", disabling it means that
   4.151 +ALL rule suggestions are disabled, not just this particular
   4.152 +rule. To customize which rules are run, right click
   4.153 +and select "Edit Rules...". </p>
   4.154 +<p>Finally, the dialog allows you to control the scanning behavior
   4.155 +of sourcefile-oriented suggestions. You can choose to have
   4.156 +the suggestion list updated whenever the document is edited,
   4.157 +or just when the document is saved. You can also change the
   4.158 +scanning delay to be more or less aggressive. The scanning
   4.159 +delay is the time interval that the suggestions view will
   4.160 +wait after a file edit or file save before it starts checking
   4.161 +the source for suggestions.
   4.162 +</p>
   4.163 +<h3>Category-specific Help</h3>
   4.164 +<ul>
   4.165 +  <li> The Java Compilation Errors are cued off of the java module's
   4.166 +parser - so it ignores the save-vs-edit behavior.
   4.167 +    <p> This module also depends on the specific English error strings
   4.168 +created by the compiler. If somehow you are running the compiler in a
   4.169 +different locale, this may break the module. This should be fixed by
   4.170 +JSR-199 when that becomes available. </p>
   4.171 +    <p></p>
   4.172 +  </li>
   4.173 +  <li> The Rule Violations suggestions provide automatic fix performers
   4.174 +for unused imports, duplicate imports, and unused fields. Not all
   4.175 +unused fields have automatic fixers, since in some cases doing it
   4.176 +automatically might be risky.
   4.177 +    <p></p>
   4.178 +  </li>
   4.179 +  <li> The Javadoc error does not handle parameter renaming well. In
   4.180 +particular, let's say that you had a method with a single parameter
   4.181 +named "foo", and you documented this with a "@param foo" javadoc tag.
   4.182 +Then you've renamed the parameter to "bar" and forgot to update the
   4.183 +javadoc. The javadoc scanner will not realize that "@param foo" is
   4.184 +referring to parameter "bar", so you will get two errors: no javadoc
   4.185 +for "bar", and javadoc for a nonexistent parameter "foo". When you
   4.186 +autofix this javadoc, it will create a new empty javadoc tag for "bar",
   4.187 +and remove the javadoc tag for "foo", instead of renaming (and
   4.188 +persisting) the existing javadoc.
   4.189 +    <p></p>
   4.190 +  </li>
   4.191 +  <li> The Javadoc error provider will list separate suggestions for
   4.192 +separate problems found in a method's javadoc. However, running Fix on
   4.193 +the suggestion will fix ALL the problems in the javadoc in a single
   4.194 +operation. You cannot fix one individual problem automatically.
   4.195 +    <p></p>
   4.196 +  </li>
   4.197 +  <li> The HTML error provider works on HTML files, XML files and JSP
   4.198 +files. The errors are provided by the "Tidy" utility behind the scenes.
   4.199 +It was mostly written for HTML files so it is not clear how useful the
   4.200 +errors are in XML or JSP files.
   4.201 +    <p> In the context menu, you can find a "Cleanup/Rewrite" action.
   4.202 +When you select this, your entire document will be cleaned up (meaning
   4.203 +wrong tags moved or removed, etc.) and reformatted. By selecting the
   4.204 +Preview button in the dialog, you can get a before-and-after diff of
   4.205 +the changes performed. </p>
   4.206 +    <p> You can run this action on documents that don't have
   4.207 +suggestions as well. Select the given HTML document, and then look in
   4.208 +the Tools menu - the action should be there. </p>
   4.209 +    <p></p>
   4.210 +  </li>
   4.211 +  <li> You can customize the tokens that are used to locate source code
   4.212 +tasks: XXX, TODO, FIXME. Go to the Options dialog and select "Task List
   4.213 +Editor Support"; you will find a setting named "Scan Regular
   4.214 +Expression". This is a regular expression your source comments are
   4.215 +matched against.
   4.216 +    <p> </p>
   4.217 +  </li>
   4.218 +</ul>
   4.219 +If you have any questions or comments, write to
   4.220 +dev@tasklist.netbeans.org .
   4.221 +<hr>Comments &amp; requests to <a
   4.222 + href="mailto:dev@tasklist.netbeans.org"><code>dev@tasklist.netbeans.org</code></a>.
   4.223 +Further information at <a href="http://tasklist.netbeans.org/"><code>http://tasklist.netbeans.org</code></a>.
   4.224 +</body>
   4.225 +</html>

     5.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     5.2 +++ b/tasklist.suggestions/src/org/netbeans/modules/tasklist/suggestions/ui/helpsetref.xml	Wed Nov 30 17:00:00 2005 +0000
     5.3 @@ -0,0 +1,5 @@
     5.4 +<?xml version="1.0"?>
     5.5 +<!DOCTYPE helpsetref PUBLIC
     5.6 +          "-//NetBeans//DTD JavaHelp Help Set Reference 1.0//EN"
     5.7 +          "http://www.netbeans.org/dtds/helpsetref-1_0.dtd">
     5.8 +<helpsetref url="nbdocs:/org/netbeans/modules/tasklist/suggestions/ui/docs/HelpSet.hs"/>

     6.1 --- a/tasklist.suggestions/src/org/netbeans/modules/tasklist/suggestions/ui/suggestions-layer.xml	Wed Nov 30 16:42:15 2005 +0000
     6.2 +++ b/tasklist.suggestions/src/org/netbeans/modules/tasklist/suggestions/ui/suggestions-layer.xml	Wed Nov 30 17:00:00 2005 +0000
     6.3 @@ -28,4 +28,16 @@
     6.4          </folder>
     6.5      </folder>
     6.6  
     6.7 +    <folder name="Services">
     6.8 +        <folder name="JavaHelp">
     6.9 +            <!-- Merge after Core IDE Help: -->
    6.10 +            <attr name="org-netbeans-modules-usersguide-above-regular.txt/org-netbeans-modules-tasklist-suggestions-ui-helpsetref.xml" boolvalue="true"/>
    6.11 +
    6.12 +            <file name="org-netbeans-modules-tasklist-suggestions-ui-helpsetref.xml" url="helpsetref.xml"/>
    6.13 +
    6.14 +            <!-- Merge before 3rd party help: -->
    6.15 +            <attr name="org-netbeans-modules-tasklist-suggestions-ui-helpsetref.xml/org-netbeans-modules-usersguide-below-regular.txt" boolvalue="true"/>
    6.16 +        </folder>    
    6.17 +    </folder>
    6.18 +    
    6.19  </filesystem>