This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 31923 - Context property sheet needs tooltips
Summary: Context property sheet needs tooltips
Status: VERIFIED FIXED
Alias: None
Product: javaee
Classification: Unclassified
Component: Code (show other bugs)
Version: 3.x
Hardware: All All
: P3 blocker (vote)
Assignee: Milan Kuchtiak
URL: http://ui.netbeans.org/docs/checklist...
Keywords: UI
Depends on:
Blocks:
 
Reported: 2003-03-12 04:17 UTC by Ann Sunhachawee
Modified: 2003-08-18 16:55 UTC (History)
1 user (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ann Sunhachawee 2003-03-12 04:17:52 UTC
Runtime tab.
See properties of Server REgistry->Installed
Servers->Tomcat 4.0-> <Installation node> ->
<host> -> <context>

All the tooltips on the the property sheet are a
repetition of the name itself. Need better tooltips.

Suggested (though please do evaluate them, since
I"m not sure what all of them exactly do.. basing
off the online help)
className - "Java class name of the implementation
to use" [[Note: would like better tooltip for
this. What implementation still is vague to me]]

cookies- "If True, cookies are used for session
identifier communication, else use URL rewriting"

crossContext- "If True, can successfully return a
request dispatcher for other web modules running
on the current virtual host."

debug-  "Level of debugging detail logged. Use
higher numbers for more detailed output."
[[Need to provide the range of debugging if
possible is it a 0-10 or is it arbitrary, i.e.
specifiable by the developer?? Please provide
feedback ]]

docBase- "Absolute or relative path to the web
module's document base"

override- "If False, use DefaultContext settings,
else use  explicit settings in this Context element"

path- "Context path for the current web module."

privileged- "If True, allows the current context
to use container servlets"

reloadable- "If True, reloads the web module if a
change is detected."

useNaming- "If True, enables a JNDI InitialContext
for the current web module"

workDir- "Pathname to a scratch directory for
temporary read-write use by servlets"

wrapperClass- "Java class name of the
org.apache.catalina.Wrapper implementation"

*Note for the future, I'd like to change the names
of these properties in general to make it agree
with IDE L&F (human understandable wording and
Sentence capitalization. This has docs impact tho
Comment 1 _ rkubacki 2003-03-12 08:57:18 UTC
I am not sure about future plans. This uses similiar framework as
depl. descriptor editoing so it can be related to intended changes in
this area.

cookies - 'If True, cookies are used as a session tracking mechanism,
else URL rewriting is used.' see servlet spec chapter 7.

crossContext - IIRC false is default and most common.

reloadable- "If True, the web module reloading (using Tomcat 4
administration functionality)? is enabled."

I expect all hinst should be a sentence (ended with period).
Comment 2 psuk 2003-03-12 16:02:57 UTC
Small change, fix is easy, we need to fix it for NB35.
Changing Target Milestone to 3.5.
Comment 3 Milan Kuchtiak 2003-03-12 16:19:58 UTC
The suggested fix :
==================================================
RCS file:
/cvs/tomcatint/tomcat40/src/org/netbeans/modules/tomcat/tomcat40/nodes/Bundle.properties,v
retrieving revision 1.5
diff -r1.5 Bundle.properties
27a28,44
> 
> HINT_path=The context path of this web module, which is matched
against the beginning of each request URI.
> HINT_docBase=Absolute or relative path to the web module's document
base.
> HINT_contextClassName=Java class name of the
org.apache.catalina.Context implementation.
> HINT_cookies=If True, cookies are used as a session tracking
mechanism, else URL rewriting is used. See servlet spec chapter 7.
> HINT_crossContext=Set to True if you want calls within this
application to ServletContext.getContext() to successfully return a
request dispatcher for other web modules running on the current
virtual host. The default value is False.
> HINT_reloadable=If True, Tomcat automatically reloads the web module
if a change is detected.
> HINT_useNaming=If True, Tomcat enables a JNDI InitialContext for the
current web module.
> HINT_wrapperClass=Java class name of the org.apache.catalina.Wrapper
implementation.
> HINT_override=If False, use the DefaultContext settings, else use
the explicit settings in this Context element.
> HINT_privileged=Setting to True allows this context to use container
servlets.
> HINT_workDir=Pathname to a scratch directory to be provided by this
Context for temporary read-write use by servlets.
> HINT_hostName=The Network name of the current virtual host.
> HINT_appBase=Absolute or relative pathname to the application base
directory.
> HINT_hostClassName=Java class name of the org.apache.catalina.Host
implementation.
> HINT_unpackWARs=If True, Tomcat unpacks deployed WARs as a disk
directory structure.
> HINT_debug=The level of debugging detail logged to the associated
Logger. Higher numbers generate more detailed output. If not
specified, the default value is 0.
\ No newline at end of file
Index: ContextNode.java
===================================================================
RCS file:
/cvs/tomcatint/tomcat40/src/org/netbeans/modules/tomcat/tomcat40/nodes/ContextNode.java,v
retrieving revision 1.18
diff -r1.18 ContextNode.java
121c121
<                "path"  // NOI18N
---
>                NbBundle.getMessage(ContextNode.class, "HINT_path")
141c141
<                "docBase"  // NOI18N
---
>                NbBundle.getMessage(ContextNode.class, "HINT_docBase")
159c159
<                "className" // NOI18N
---
>                NbBundle.getMessage(ContextNode.class,
"HINT_contextClassName")
172c172
<                "cookies" // NOI18N
---
>                NbBundle.getMessage(ContextNode.class, "HINT_cookies")
193c193
<                "crossContext" // NOI18N
---
>                NbBundle.getMessage(ContextNode.class,
"HINT_crossContext")
214c214
<                "reloadable" // NOI18N
---
>                NbBundle.getMessage(ContextNode.class, "HINT_reloadable")
235c235
<                "useNaming" // NOI18N
---
>                NbBundle.getMessage(ContextNode.class, "HINT_useNaming")
256c256
<                "wrapperClass" // NOI18N
---
>                NbBundle.getMessage(ContextNode.class,
"HINT_wrapperClass")
269c269
<                "override" // NOI18N
---
>               NbBundle.getMessage(ContextNode.class, "HINT_override")
290c290
<                "privileged" // NOI18N
---
>                NbBundle.getMessage(ContextNode.class, "HINT_privileged")
311c311
<                "workDir" // NOI18N
---
>                NbBundle.getMessage(ContextNode.class, "HINT_workDir")
331c331
<                "debug" // NOI18N
---
>                NbBundle.getMessage(ContextNode.class, "HINT_debug")
Index: HostNode.java
===================================================================
RCS file:
/cvs/tomcatint/tomcat40/src/org/netbeans/modules/tomcat/tomcat40/nodes/HostNode.java,v
retrieving revision 1.23
diff -r1.23 HostNode.java
347c347
<                "name"  // NOI18N
---
>                NbBundle.getMessage(HostNode.class, "HINT_hostName")
383c383
<                "appBase" // NOI18N
---
>                NbBundle.getMessage(HostNode.class, "HINT_appBase")
418c418
<                "className" // NOI18N
---
>                NbBundle.getMessage(HostNode.class, "HINT_hostClassName")
431c431
<                "unpackWARs" // NOI18N
---
>                NbBundle.getMessage(HostNode.class, "HINT_unpackWARs")
474c474
<                "debug" // NOI18N
---
>                NbBundle.getMessage(HostNode.class, "HINT_debug")
=====================================================
Property names follows the names of the Context attributes from the
server.xml file.
I was not able to find out what is the interval for the debug attribute.

Code reviewers : Ana Sunhachawee, Radim Kubacki
Comment 4 Ann Sunhachawee 2003-03-12 20:09:53 UTC
In general, tooltips should not be sentences ending with a period.
(notice, that most of the tooltips currently are only phrases.. not
complete sentences anyway) This would unnecessarily lengthen the
tooltip and make it harder to read and understand in the 4 seconds it
gets to be up. Looking over my suggestions, I think there are a few
places where i incorrectly included periods, but will address that here.

I notice some changes to the proposed wording, would like to get more
feedback on what the changes are communicating. Just trying to make
the tooltips as short as possible. I think if they need more info,
then they can go to help. 


1. path -  I think folks should know that the context path is matched
against the beginnings of request URI, so i think simply "Context path
of this web module" is enough. 

2. remove periods from all tooltips but debug.

3. cookies - I think "See servlet chapter 7" is overkill for a
tooltip.. if it needs to be mentioned, add a docs issue to get it
mentioned in the help

4.crossContext - way too long to read in 4s. How about "If True,
ServletContext.getContext() can return a
request dispatcher for other web modules running on the current
virtual host"

Don't understand Radim's comment, since the default value i see is True?

5. Remove beginning "The" from host name and debug. 

6. In debug, is "Logger" capitalized for a special reason?
   
7. To respond to Radim's comment on reloadable.. the fact that "using
Tomcat 5 admin functionality" seems something that can be relegated to
help if needed.

BTW Thanks for the clarification that the property names are being
taken from the Context entry in the server.xml. It makes a little more
sense now. We'll have to discuss going forward. 
Comment 5 Milan Kuchtiak 2003-03-13 09:48:20 UTC
Thank you Ann, I will implement your corrections.

By the way, I noticed that most of the Netbeans' ToolTipTexts end with
period!

The crossContext default value is "false" indeed, as Radim said.

The Logger is capitalized because it is related to the <Logger>
element from the server.xml file.

Now am waiting for Radim's code review.

Comment 6 _ rkubacki 2003-03-13 12:45:13 UTC
ad 1. I agree witth shortened wording

ad 2. excerpt from NB UI checklist (see the URL):

# It is not always necessary to write a complete sentence with a
subject and a predicate. Often sentence fragments are sufficient if
the context is clear. However, sentence capitalization and punctuation
should be used.

I don't share your opinion that it is harder for reading if it is
complete sentence with period.

ad 3. Ann is right. I suggested to use quoted sentence. The comment
about servlet spec was only to provide some context if Ann had wanted
to dive deeper into thsi problem.

ad 4. Really long. What about: 'Set to True if the application
requires access to ServletContext of other web modules. The default
value is False.'?

ad 7. Better to use my suggestion without part in parentesis. This
falg only allows to reload app on demand.

Also please add newline to the end of Bundle.properties file.
Comment 7 Milan Kuchtiak 2003-03-13 13:31:33 UTC
Thanks Radim.

I tried to incorporate all your and Ann's comments.
See the changed diff file :

> HINT_path=Context path of this web module.
> HINT_docBase=Absolute or relative path to the web module's document
base.
> HINT_contextClassName=Java class name of the
org.apache.catalina.Context implementation.
> HINT_cookies=If True, cookies are used as a session tracking
mechanism, else URL rewriting is used.
> HINT_crossContext=Set to True if the web module requires to access
the ServletContext of other web modules. The default value is False.
> HINT_reloadable=If True, the web module reloading is enabled.
> HINT_useNaming=If True, Tomcat enables a JNDI InitialContext for the
current web module.
> HINT_wrapperClass=Java class name of the org.apache.catalina.Wrapper
implementation.
> HINT_override=If False, use the DefaultContext settings, else use
the explicit settings in this Context element.
> HINT_privileged=Setting to True allows this context to use container
servlets.
> HINT_workDir=Pathname to a scratch directory to be provided by this
Context for temporary read-write use by servlets.
> HINT_hostName=Network name of the current virtual host.
> HINT_appBase=Absolute or relative pathname to the application base
directory.
> HINT_hostClassName=Java class name of the org.apache.catalina.Host
implementation.
> HINT_unpackWARs=If True, Tomcat unpacks deployed WARs as a disk
directory structure.
> HINT_debug=Level of debugging detail logged to the associated
Logger. Higher numbers generate more detailed output. If not
specified, the default value is 0.
Comment 8 Milan Kuchtiak 2003-03-14 08:25:21 UTC
Fixed in both trunk and NB3.5.

Thanks for code reviews.

Comment 10 Jason Rush 2003-08-18 16:55:16 UTC
Verified in NB 3.5 RC3.