|
|
Version 1.6 Febuary 5, 2004
This is a preliminary draft that is a work in progress. It needs to be reviewed by the editors as well as the Help Style Team. In addition, it does not contain common terms required by the compiler collection, application servers, and web server helpsets. It also needs to be reviewed by CDP writers, JETS team members, and internal third-party writers.
This automobile lists the known index groups that can potentially be used by more than one helpset. purpose of this list is to define common indexing terminology to help promote a coordinated and cohesive merged index.
Please review this list and identify the entries that apply to the technology about which you write. When indexing your topics, use the applicable terms from this list whenever possible.
The entries in black are the entries that pertain to the core developer product as well as other helpsets. The entries in red pertain to helpsets outside of the core product.
This is a living document. Please contact the merged index tiger team via the MITT@Sun.Com alias if you have questions, if you wish to request additions, deletions, or changes, or if you are having problems using the list.
If you want to be notified about updates to this list and to the guidelines, subscribe to the MITT-interest@Sun.Com list using the Net Admin tool (alias will be available 10/31/03).
For example, the "files" group has a "See also" subentry:
+ files - (See also entry for specific file type) Because it has a "See also" entry, you can put generic (across file type) entries under files, as shown below.+ files - (See also entry for specific file type) - backing up by extension - comparing - copying ...In the following example, the group has a "See" entry. You cannot add any other subentries to this group.
Wrong API (application programming interface) documentation (See Javadoc documentation) generating with javadoc creating comments for
-.-
.java files, See Java applications, source files
.properties files, See properties files
.tld, See TLD (tag library descriptor) files
.xml, See XML (extensible markup language)
-A-
abbreviations, Source Editor
(See Source Editor, abbreviation shortcuts)
access objects
(See also DAO)
Ant
scripts [dp scripts, Ant]
(note: there is an entry for compilation settings, Ant)
API (application programming interface) documentation, See Javadoc documentation
applets [dp clients]
application controller patterns, See patterns, controller
application servers
default server, setting
nodes in Runtime window
server instances
(See also Sun ONE Application Server 7)
(See also Sun ONE Application Server 8)
(See also Sun ONE Web Server)
(See also Tomcat Web Server)
(See also web servers)
application assembler, See J2EE Application Assembler
applications, See entry for specific application type
archive files, See entry for specific archive file type
assembling, See entry for object to be assembled
auditing, See logging
authentication, See entry for specific component
-B-
beans, Java [dp JavaBeans]
(see also entry for specific bean type) (this should be put in by EJB help, not usersguide)
breakpoints
Java [dp Java applications, debugging, breakpoints]
JSP [dp JSP (JavaServerPages, debugging]
servlet [dp servlets, debugging]
building programs
(See Ant)
(See compiling)
bundles, resource, See properties files
browsers, See web browsers
Note: if we add any other types of browsers, this has to change.
business logic
business methods
home
-C-
call stack
cascading style sheets , See CSS (cascading style sheets)
CCI (common client interfaces)
[dp common client interfaces]
CDC (connected device configuration) [dp connected device configuration]
class files
class path
Note: make CLASSPATH variable a secondary entry here
CLDC (connected limited device configuration)
checking
xml documents
jsps
etc.
clients
(See applets)
(See web clients)
(See rich clients)
(See thin clients)
code
(See source code)
code completion [dp "parser database"]
command beans
common client interfaces ,See CCI (common client interfaces) [dp common client interfaces]
compilation settings
Ant
compiler types
Examples of entries:
defining
removing
internal
jikes
compiler types
(See compilation settings)
compiling
Java classes
JSP files
EJB components
MIDlets
MIDlet suites
component interface [dp interfaces]
components
(See entry for specific component type)
components, GUI
Concurrent Versioning System
(See CVS)
configuration files
configuring IDE
(See also entry for object to be configured)
connected device configuration, See CDC (connected device configuration
connected limited device configuration, See CLDC (connected limited device configuration
connector architecture, J2EE [dp J2EE connector architecture]
connection factory references [dp references]
connector modules [dp modules]
connectors
debugger to application [dp debugging, connecting to a running application]
EIS [dp "EIS (enterprise information systems)", "legacy applications"]
J2EE [dp]
server host
container-managed relationships
(See also persistence)
containers, AWT and Swing
containers
(See entry for specific component)
contexts, web module server
(See web applications, contexts, server)
contextual menus
(See menus, contextual)
(See GUI forms, menus)
controller patterns
(See patterns, controller)
cookies
create methods
Note: this is not about creating methods, it is for
holding secondary entries such as:
about
BMP entity bean, throw requirements for
CMP entity bean, throw requirements for
entity bean, defining for
Filesystems node
session bean
stateful session bean
creating, See entry for object to be created
CSS (cascading style sheets) [dp "cascading style sheets"]
CVS (Concurrent Versioning System) [dp concurrent versioning system]
(See also VCS)
merging [dp merging, cvs]]
-D-
DAO (data access objects)
data integration (need to figure this one out
(See DAO)
(See CCI)
(See connector architecture, J2EE)
(See JDBC)
document object model
(See DOM)
debugger settings
debugger types
debugging
connecting to a running application [dp connectors, debugger to application]
Java applications [dp Java applications, debugging]
Java variables [dp variables, debugging Java]
JSP files [dp JSP (JavaServer Pages), debugging]
threads
MIDlets
sessions [dp sessions, debugging]
servlets [dp servlets, debugging]
web modules [dp web modules, debugging]
web services
deleting, See entry for object to be deleted
deploying
Note: suggestions for secondary entries
J2EE applications
web modules
web services
etc.
deployment descriptors
application
application client
XML [dp XML deployment descriptors]
EJB
resource adapter
web services
web module [dp web modules, deployment descriptors]
deployment tools
device emulator registry
device emulators [dp emulators, device]
distributing components, See packaging entry for specific component
directories, See filesystems
doclets
documentation, API, See Javadoc documentation
document type definition, See DTD (document type definition) files
DOM (document object models) [dp data object models]
DTD (document type definition) files [dp document type definition]
-E-
EAR (enterprise application archive) files [dp]
editing
(See also Source Editor)
DTD
Java
JSP
jumplists [dp Source Editor, jumplists]
macros [dp Source Editor, macros]
tag library
XML
editor, See editing
EIS (enterprise information systems) [dp connectors, EIS]
connectors, See connectors, EIS
resource authentication
EJB (enterprise Java bean) applications, See EJB modules
EJB components
compiling [dp compiling, EJB components]
testing [dp testing, EJB components]
EJB containers
EJB JAR files, See JAR (Java archive) files, EJB
EJB modules [dp modules]
EJBQL (EJB query language)
expressions [dp expressions, EJBQL]
EJB queries, See queries, EJB
EJB references [dp references]
EJB remote interfaces [dp]
EJB servers
EJB tier [db]
EL (expression language), JSP
emulators, device, See device emulators
encoding [dp "UTF (universal Transformation Format)", "unicode"]
enterprise beans
enterprise information systems, See EIS (enterprise information systems)
entity beans
entity catalogs, See XML catalogs
environment entries
error pages
event handlers
exceptions
Java
executing programs
(See running)
executor settings
(See runtime settings)
execution types
(See also runtime settings)
expressions, EJBQL
(See EJB QL (query language), expressions)
Extensible Markup Language
(See XML)
executing programs , See running
executor settings, See runtime settings
execution types, See also runtime settings
expressions, EJBQL, See EJB QL (query language), expressions
-F-
facade patterns, See patterns, facade
file extensions
files [dp objects], See also entry for specific file type
filesystems [dp directories]
searching [dp "finding files", "searching filesystems"]
Filesystems nodes, See nodes, Filesystems window
Filesystems window
filter patterns, See patterns, filter
Filter toolbar <note we have 2 filter toolbars, one in tasks module
and debugger module, be careful to differentiate
filters
breakpoint
HTTP request
JAR content
JMS message
query
WAR content
web service business
finding files, See filesystems, searching
formatting code
Java
XML
CC
others?
Form Editor [dp editor]
forms, GUI, See GUI forms
front controller patterns, See patterns, controller
-G-
generated code, modifying
generating, See entry for object being generated
GUI forms [dp form, GUI]
containers
menus [dp contextual menus]
testing [dp testing, GUI forms]
-H-
heap size
help viewer
home business methods, See business methods, home
home interfaces [dp "interfaces", "local home interfaces"]
HTML (hypertext markup language) files
debugging
HTTP monitor [dp monitoring, HTTP requests]
-I-
I18N, See internationlization(I18N)
icons, node, See nodes, Filesystems window
icons, EJB
IDE modules [dp modules]
updating [dp updating IDE modules]
identity, security [dp security identity, EJB]
IDL (interface definition language) [dp Java IDL]
importing
example subentries:
IDE projects
WAR files
MIDlets and MIDlet suites
included EJB
indentation engines
information systems, enterprise, See EIS (enterprise information systems)
instances, server, See entry for specific server
interfaces, Java
interfaces, common client, See CCI (common client interfaces)
interfaces, component , See component interfaces
interface, home, See home interfaces
interfaces, local home, See local home interfaces
internationalization (I18N)
(See also source code)
(See also locales)
-J-
J2EE (Java 2 Platform, Enterprise Edition)
J2EE Application Assembler [dp J2EE Application Assembler]
J2EE applications
deploying
upgrading J2EE version of [dp upgrading version, J2EE]
J2EE clients , See J2EE applications
J2EE connector architecture, See connector architecture, J2EE
J2EE connectors, , See connectors, J2EE
J2EE design patterns
(See also Sun ONE Application Framework)
J2EE modules [[dp modules]
J2EE transaction management
[dp "JTA (Java Transaction API)", Java Transaction API]
J2ME (Java 2 Micro Edition)
J2ME Wireless Toolkit [dp wireless]
JAD (Java application descriptor) files <= From ME
[dp Java application descriptor files]
JAR (Java archive) files [dp Java archive files]
(See also libraries)
EJB
manifests [dp manifests, JAR]
tag libraries, See tag libraries
JATO, See Sun ONE Application Framework
Java API for XML Processing, See JAXP (Java API for XML Processing)
Java application descriptor files, See JAD (Java application descriptor) files
Java applications
compiling
(See compiling, Java applications)
debugging
(See debugging, Java applications)
method permissions [dp "method permissions, Java", "permissions, EJB method"]
methods
running
(See running, Java applications)
variables
source files [dp "Java source files", ".java files"]
Java archive files , See JAR (Java archive) files
Java clients, See entry for specific type of client
Java database connectivity, See JDBC (Java database connectivity)
Java Developer Kit, See JDK (Java Developer Kit)
Java IDL, See IDL (interface definition language)
Java libraries, See libraries, Java
Java Message Services, See JMS (Java Message Services)
Java Naming and Directory Interface , See JNDI (Java Naming and Directory Interface)
Java Platform Debugger Architecture, See JDPA (Java Platform Debugger Architecture)
Java Server Faces, See JSF (Java Server Faces)
Java source files, See Java applications, source files
Java Transaction API, See J2EE transaction management
JavaBeans, See beans, Java
javac compiler
Javadoc documentation
[dp "API (application programming interface) documentation",
"documentation, API]
JavaServer Pages, See JSP (JavaServer Pages)
JAXP (Java API for XML Processing) [dp Java API for XML Processing]
JDK (Java Developer Kit) [dp Java Developer Kit]
JDBC (Java database connectivity) [dp Java applications, database connectivity]
JDPA (Java Platform Debugger Architecture) [dp Java Platform Debugger Architecture]
JMS (Java Message Services) [dp Java Message Services]
JNDI (Java Naming and Directory Interfaces) [dp Java Naming and Directory Interface ]
JSF (Java Server Faces) [dp Java Server Faces]
JSP (JavaServer Pages) [dp JavaServer Pages]
(See also EL (expression language), JSP)
breakpoints, See breakpoints, JSP
debugging, See debugging, JSP
scripting [dp scripting, JSP]
scriptlets [dp scriptlets, JSP]
tags [dp tags, JSP]
tag files [dp tag files]
tag handlers
tag libraries [dp tag libraries]
upgrading, See web modules, upgrading JSP/Servlet version
JTA (Java Transaction API), See J2EE transaction management
jump lists, Source Editor [dp Source Editor, jumplists]
-K-
keyboard commands, See keyboard shortcuts
keyboard shortcuts [dp "keyboard commands", "shortcuts"]
KVM (K virtual machine)
-L-
legacy applications , See EIS (enterprise information systems)
libraries
Java [dp Java libraries]
tag, JSP, See tag libraries
listeners
servlet event
localization
localization strings
locales
local home interfaces [dp "interfaces", "home interfaces"]
logging [dp auditing]
logical nodes, See nodes, Filesystems window
-M-
macros [dp Source Editor, macros]
manifests, JAR, See JAR (Java archive) files, manifests
MDI (multiple document interfaces) [dp MDI (multiple document interfaces)]
memory errors
memory usage
menus, IDE
(See also GUI forms, menus)
(See also keyboard shortcuts)
menus, GUI
merging, CVS, See CVS (concurrent version systems), merging
message-driven beans
messages
asychronous
compiler
messaging
asynchronous
HTTP-based
metadata
method permissions, Java [dp Java applications, method permissions]
middle tier, See tier, middle
MIDlets
MIDlet suites
MIDP (Mobile Information Device Profiles)
[dp Mobile Information Device Profiles]
MIDP applications
Mobile Information Device Profiles, See MIDP (Mobile Information Device Profiles)
model view controller architecture, See MVC (model view controller) architecture
modules, connector, See connector modules
modules, EJB, See EJB modules)
modules, IDE, See IDE modules
modules, J2EE, See J2EE modules
modules, reource adapter, See resource adapter modules)
modules, web, See web modules
monitoring
HTTP requests, See HTTP monitor
network traffic, See network traffic, monitoring
multiple document interfaces, See MDI (multiple document interfaces)
MVC (model view controller) architecture
[dp model view controller architecture]
-N-
network traffic, monitoring
[dp monitoring, network traffic]
nodes, Filesystems window [dp logical nodes]
-O-
objects, See files
opening, See entry for object to be opened
Options window
output directory
Output window
-P-
packages
EJB
Java
packaging, See specific component or application to be packaged
PAR (portal archive) files
Palette window
parser database, See code completion
patterns
controller [dp controller patterns]
facade [dp facad patterns]
filter [dp filter patterns]
session facade [dp session facade patterns]
performance tuning [dp tuning]
Examples of subentries:
application client modules
JAR files
web modules
MIDP applications
permissions
file
EJB method [dp Java applications, method permissions]
persistence [dp container-managed relationships]
BMP (bean-managed pesistence)
CMP (container-managed persistence)
persistent data
portal archive files, See PAR (portal archive) files
portlets
PRC files <= ME; don't know what PRC stands for
primary key classes, EJB
primary keys, EJB
profiling, See entry specific application type to be profiled
projects
EJB
MIDP
settings [dp project settings]
web module
web services
properties files
[dp ".properties files", "resource bundles", "bundles, resource"]
property sheets
Just generic stuff here.
Not a list of all property sheets
PVCS (Polytron Version Control System)
(See also VCS)
-Q-
queries
EJB
(See also EJBQL (query language))
SQL [dp SQL queries]
-R-
RAR (resource adapter archive) files [dp resource adapter archive]
RDBMS (relational database management systems) [dp relational database management systems]
references connection factory, See connection factory references
references, EJB, See EJB references
relational database management systems, See RDBMS (relational database management systems)
remote interfaces, EJB, See EJB remote interfaces
remote method invocation, See RMI (remote method invocation)
remote clients
remote method invocation, See RMI (remote method invocation)
resource adapter archive, See RAR (resource adapter archive) files
resource adapter modules [dp modules]
resource bundles, See properties files
rich clients
roles, security, See security roles
RMI (remote method invocation) [dp remote method invocation]
running
applets
Java programs
web modules [dp web modules, running]
runtime settings
execution types
Runtime window
-S-
sample applications
SAX (Simple API for XML)
scanning XML documents
schemas, XML, See XML schemas
scripts, Ant, See Ant, scripts
scripting, JSP, See JSP, scripting
scriptlets, JSP, See JSP, scriptlets
searching filesystems
security
EIS
EJB
web module
secure socket layer, See SSL (secure socket layer)
security descriptor files
security identity, EJB [dp identity, security]
security roles [dp roles, security]
EJB
J2EE
web module
select methods, EJB
servers, installed
(See also application servers)
(See also web servers)
servlets
debugging (is this correct?)
(See breakpoints)
(See debugging)
upgrading
(See web modules, upgrading JSP/Servlet version)
session beans
session beans
stateful [dp stateful session beans]
stateless [dp stateless session beans]
session data
web module
MIDlet
session facade patterns, See patterns, session facade
sessions, debugging [dp debugging sessions]
settings
IDE
shortcuts, See keyboard shortcuts
skins, emulator
source code [dp code]
Source Editor
(See also editing)
abbreviations [dp abbreviations, Source Editor]
Java
jsp
jumplists [dp jumplists, editing]
macros [dp macros]
SQL queries [dp queries, SQL]
SSL (secure socket layer) [dp secure socket layer]
stateful session beans, See session beans, stateful
stateless session beans, See session beans, stateless
states
bean
HTTP session
stepping through programs
Java
JSP
style sheets
(See also CSS)
setting, in HTML
setting, in Javadoc
Sun ONE Application Framework [dp JATO]
Sun ONE Web Server
syntax <= with sub entries for JSP, EJB QL, etc???
-T-
tag files [dp JSP (JavaServer Pages), tag files]
tag libraries [dp "JSP (JavaServer Pages), tag libraries", "libraries, tag, JSP"]
JAR files [dp JAR (Java archive) files, tag libraries
tag library descriptors, See TLD (tag library descriptor) files
tags, JSP, See JSP, tags
templates
testing
GUI forms [dp GUI forms, testing]
EJB components [dp EJB components, testing]
web modules [dp web applictions, testing]
portlets
thin clients
threads [dp debugging, threads]
Java, debugging
C++, debugging (etc.)
tier
client
EJB, See EJB tier
middle [dp middle tier]
web [dp web tier]
TLD (tag library descriptor) files [dp .tld]
Tomcat servlet container
toolbars
(See also entry for specific toolbar)
GUI forms
(See GUI forms, toolbars)
IDE
Just generics here, such as hiding, moving
trace options, wireless [dp wireless]
transaction management, See J2EE transaction management
tuning , See performance tuning
-U-
unicode , See encoding
Update Center
updating IDE modules [dp IDE modules, updating]
upgrading version
J2EE, See J2EE modules, upgrading J2EE version of
JSP/Servlet, See web modules, upgrading JSP/Servlet version
URI (uniform resource identifier)
web module
URL (uniform resource locator)
web module
user-defined attributes, MIDlet suite <= ME, needs qualifier
UTF (universal Transformation Format), See encoding
-V-
validating
Examples of subentries:
enterprise bean
XML documents
DTD documents
variables, debugging Java
version control systems
(See VCS)
VCS (version control system) [dp version control system]
(See also CVS)
(See also PVCS)
(See also Visual Source Safe)
Visual Source Safe
(See also VCS)
-W-
WAR (web archive) files [dp web archive files]
watching
Java variables
JSP variables and expressions
web archive files, See WAR (web archive) files
web browsers [dp browsers]
WEB-INF
web clients [dp "clients", "web modules, clients"]
web components, See web modules
web containers
web module
web modules [dp web components]
clients [dp web clients]
contexts, server [dp contexts, web module server]]
debugging, See debugging, web modules
DTD (deployment descriptor) [dp deployment descriptors, web module]
modules [dp modules]
running [dp running, web modules]
testing [dp testing, web modules]
upgrading JSP/Servlet version
[dp "JSP (JavaServer Pages), upgrading", "upgrading version, JSP/Servlet"]
URI, See URI (uniform resource identifier), web module
URL, See URL (uniform resource locator), web module
web pages, See HTML files
web servers
(See also Tomcat Servlet Container)
(See also Sun ONE Web Server)
web services
deployment descriptors
web tier [dp tier, web]
web.xml files , See web modules, deployment descriptors
windows, IDE
(See also entry for specific window)
Generic stuff like docking and not a list of the
windows in the IDE, such as Component Inspector
wireless, See J2ME Wireless Toolkit
wireless trace options, See trace options, wireless
-X-
XML (extensible markup language) [dp ".xml", "scanning XML documents"]
XML catalogs
XML deployment descriptors [dp deployment descriptors, XML]
XML schemas [dp schemas, XML]
XSL (extensible stylesheet language) [dp extensible markup language]