admin@glassfish.java.net

Re: Please review: changes to asadmin help man page

From: Paul Davies <Paul-Martin.Davies_at_Sun.COM>
Date: Thu, 31 May 2007 16:19:29 -0700

Hi,

> The doc team can and should create variables (text entities) for the
> profile names so they can be changed everywhere at once. But we may not
> be able to do this before Beta 3.

I wonder if Kedar's preference for keeping profile names out of the man pages is
to allow for the possibility of users defining their own custom profiles in the
future. As June points out, instability in the profile names can be handled by
the use of SGML text entities ("declare once, reference everywhere").

Perhaps Kedar's concern would be addressed by wording such as:

        This [command | option | operand | whatever] requires the
        &cluster-profile-name; profile, the &enterprise-profile-name;
        profile, or a custom profile that supports management of
        standalone instances and instance clusters.


&cluster-profile-name; and &enterprise-profile-name; are SGML text entity
references that would be replaced with the actual names of the profiles.

As Kedar suggested, perhaps we can discuss this question further at the Admin
I-Team Meeting on Monday.

Regards,
-- 
Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
http://blogs.sun.com/techscribe/