Community
Participate
Working Groups
Version: 3.3.0 Build id: I20070601-1539 java.fullversion=J2RE 1.5.0 IBM J9 2.3 Windows XP x86-32 j9vmwi3223-20070201 (JIT enabled) J9VM - 20070131_11312_lHdSMR JIT - 20070109_1805ifx1_r8 GC - 200701_09 BootLoader constants: OS=win32, ARCH=x86, WS=win32, NL=en_US Using EPP Java, go to Help --> Help Contents Search for: batch compiler --> no result found (see to be attached screen shot) Base Eclipse 3.3 gives 5 matches (see to be attached screen shot)
Created attachment 74326 [details] [screen shot] EPP - no match
Created attachment 74327 [details] [screen shot] base Eclipse 3.3 - 5 matches
I think this is expected behaviour. EPP Java doesn't include the platform ISV doc.
(In reply to comment #3) OK, now noticed that, compared to base Eclipse 3.3, EPP on-line help is missing the following sections: Platform Plug-in Developer Guide JDT Plug-in Developer Guide 1 - even if missing these 2 chapters, 1 match could at least have been found for my search for the "batch compiler" (as it was returned using base Eclipse): this is the one located is the What's new page of the Java Development User Guide (though agreed, this is not an exact match). 2 - as an end-user, I was assuming that by downloading/installing EPP Java, I would get base Eclipse 3.3 + packaged features. This is not the case, as EPP is missing 2 major sections of the on-line help. 3 - I was also assuming that the JDT plug-in shipped with its on-line help
When I'm understanding EPP Java right, it is intended for users who write Java applications but do NOT target Eclipse. Therefore, they would also not want to extend the JDT by writing plugins for it -- they don't need the extension points reference and the Platform API Reference. So, I do understand why the PDE ISV Docs and the JDT ISV Docs are not packaged. For the batch compiler, it seems this is kind of a grey zone. I could imagine JDT users want to use the batch compiler even if they do not target Eclipse. So perhaps the batch compiler docs should move from the JDT ISV Docs to the JDT User Docs. Regarding your comment (2), you do get base Eclipse (i.e the Framework, aka Platform) plus features. You do NOT get the SDK plus features.
Yes, I think this packaging is intentional. Since EPP Java doesn't include PDE, it can't be used for plugin development, and the plug-in development guides for platform and JDT are not needed. There is a separate "plug-in developers" package for people doing plug-in development. If help search is not finding a match that it should, I suggest moving this bug to Platform User Assistance. Perhaps there is a problem building the help index...
Moving as suggested
Given that this has not been commented on since July, I assume it's wrongly assigned. So I'm changing the summary - old value was: [epp java]: searching help does not find any match and assign it to JDT. My arguing is that since any user can run the Batch Compiler even if just JDT is installed without the PDE or Sources or ISV Docs, its documentation should also be in the JDT User Docs. In other words, you do not need to write a program and link it against the JDT .class files in order to run the batch compiler -- it can be run as a normal user, just the command-line arguments need to be known so they should be in the user docs.
'JDT Plug-in Developer Guide > Programmer's Guide > JDT Core > Compiling Java code' should really be split in two and the 'non-programmatic' items should be moved to the user guide. The following 3 sections should be present in the user guide - Using the batch compiler - Using the ant javac adapter - Excluding warnings using SuppressWarnings I assume if the above 3 sections are available in the user guide, they need not be present in the developer guide, or do they ? Dani, what do you think?
(In reply to comment #9) > 'JDT Plug-in Developer Guide > Programmer's Guide > JDT Core > Compiling Java > code' should really be split in two and the 'non-programmatic' items should be > moved to the user guide. > > The following 3 sections should be present in the user guide > - Using the batch compiler > - Using the ant javac adapter > - Excluding warnings using SuppressWarnings > > I assume if the above 3 sections are available in the user guide, they need not > be present in the developer guide, or do they ? > > Dani, what do you think? I agree with this. And we should add a TOC for 'Compiling Java code' in the ISV doc. The 'Using the batch compiler' entry could then link to the JDT User Doc via <a href="PLUGINS_ROOT/org.eclipse.jdt.doc.user/URL_GOES_HERE">Using the batch compiler</a> Srikanth or Olivier, any objections?
(In reply to comment #10) [...] > Srikanth or Olivier, any objections? Sounds good to me.
Jay, per our discussion, please follow up, Thanks.
(In reply to comment #9) > The following 3 sections should be present in the user guide > - Using the batch compiler > - Using the ant javac adapter > - Excluding warnings using SuppressWarnings Dani, I can't think of a title for a common topic for these sections. Do you have a suggestion? Or should these have their own topics?
I would create a document in the 'Tasks' section and call it 'Compiling Java code' - i.e. same as the current document heading in the ISV plugin.
(In reply to comment #14) > I would create a document in the 'Tasks' section and call it 'Compiling Java > code' - i.e. same as the current document heading in the ISV plugin. +1.
I just noticed we the already have some relevant topic under: Java development user guide > Concepts > Java Builder This page also refers to the "Using the ant javac adapter" section. So, I guess we can just add our sub topics here.
(In reply to comment #16) > I just noticed we the already have some relevant topic under: > Java development user guide > Concepts > Java Builder > > This page also refers to the "Using the ant javac adapter" section. So, I guess > we can just add our sub topics here. 'Compiling Java code' would fit better in 'Tasks'. Of course we have to update the link in Concepts > Java Builder page.
List of SuppressWarnings tokens is also present in 'Java development user guide > Reference > Java Editor'. I guess we should keep one copy of this list and refer to it from other places.
(In reply to comment #18) > List of SuppressWarnings tokens is also present in 'Java development user guide > > Reference > Java Editor'. This one (ref-java-suppresswarnings-tokens.htm) looks outdated anyway. > I guess we should keep one copy of this list and refer to it from other places. Yep.
Created attachment 196443 [details] Proposed Patch Patch contains the changes discussed so far. The changes only contain restructuring and no content changes as such. Perhaps the links from the ISV docs to the user guide can look better. I will see what I can do. Another note: I have put the links on top for better visibility.
Created attachment 196507 [details] Upated patch I have made the links look better in this patch.
Jay, the patch is not good. - Clicking ISV doc > Prog Guide > Compiling Java code gives: An error occured while processing the requested document: org.xml.sax.SAXParseException; lineNumber: 28; columnNumber: 135; The element type "br" must be terminated by the matching end-tag "</br>". Other issues: - Simply adding links (as you tried) without any further explanation (e.g. that it's in the user doc) is not good enough (we normally have such links for pointing to sections inside the same document). - Compiling is more important than formatting ==> switch the entries. - The example code is no longer blue and other styles seem lost too. Please make sure that the formatting, styles and colors are preserved when moving the doc from ISV to User. - The suppressWarnings page needs work: - the title is hard to read - please use the standard title font (style) - the tokens are not visible. Previously it wasn't great either (green color) but now the tokens are no longer separated from the description at all - you now write "Java 5.0 offers the option...". So, it's not working in Java 6 and Java 7? - What's the change in /org.eclipse.jdt.doc.isv/topics_Guide.xml?
Created attachment 196524 [details] tweaked patch (In reply to comment #22) > - Clicking ISV doc > Prog Guide > Compiling Java code gives: > An error occured while processing the requested document: > > org.xml.sax.SAXParseException; lineNumber: 28; columnNumber: 135; The element > type "br" must be terminated by the matching end-tag "</br>". > > Other issues: > - Simply adding links (as you tried) without any further explanation (e.g. that > it's in the user doc) is not good enough (we normally have such links for > pointing to sections inside the same document). > - Compiling is more important than formatting ==> switch the entries. In the attached patch the above issues are fixed, in addition I had restored the green color of the SuppressWarnings tokens and deleted o.e.jdt.doc.user/reference/ref-java-suppresswarnings-tokens.htm. Plus a few small cleanups.
Committed the tweaked patch with some changes: - fixed the title font/style - fixed the wrong <title> in all files (this caused wrong search results) - improved TOC entries - moved link to User doc to the top of ISV's 'Compiling Java code' Jay and Deepak please review the changes directly in HEAD.
Created attachment 196544 [details] Error Changes look good. But I get an error when I navigate to the 'Using the ant javac adapter" page through the link in the Java Builder page. The error message is attached. I will see what is causing the error. I also noticed that we don't have link to the "Exclude Warnings" section from the ISV's Compiling Java Code topic. Is that intentional?
(In reply to comment #25) > Created attachment 196544 [details] > Error > > Changes look good. But I get an error when I navigate to the 'Using the ant > javac adapter" page through the link in the Java Builder page. The error > message is attached. I will see what is causing the error. This is probably because you killed the target workspace before clicking the link. > I also noticed that we don't have link to the "Exclude Warnings" section from > the ISV's Compiling Java Code topic. Is that intentional? Yes.
Verified in I20110525-0800.
Fixed a couple of things - Some styles were still missing - I have copied over missing css styles from the ISV plugin - also deleted an unnecessary file - org.eclipse.jdt.doc.user/tasks/task-compile_java_code.htm Last thing remaining is that the user doc now talks about "Using the static compile(String commandLine, PrintWriter outWriter, PrintWriter errWriter, CompilationProgress progress) method of the class BatchCompiler.". This small part on programmatic usage of the batch compiler needs to be moved back to the ISV plugin. :)
> Last thing remaining is that the user doc now talks about "Using the static > compile(String commandLine, PrintWriter outWriter, PrintWriter errWriter, > CompilationProgress progress) method of the class BatchCompiler.". This small > part on programmatic usage of the batch compiler needs to be moved back to the > ISV plugin. :) Splitting the batch compiler doc again just for that is overkill.
