PDA

View Full Version : M.C. Escher's clever Glossary definitions


tmart
03-27-2008, 11:28 AM
I am pretty sure that I have an understanding of these terms from hearing them in context, but I'd like to know for sure. The circular definitions in the Glossary can send consumers on a wild-goose chase and their correction would go a long way toward making the glossary and other docs that use these terms more digestible.

The cross-reference (I assume this is what "x." means) entries really provide no value other than perhaps as placeholders for future elaboration because there is no means by which we can "contrast" the cross-referenced entry with the base entry on the topic. These are excerpts from the current AppLogic glossary... note that in the set below, "class boundary" is the only term that is actually given a definition that moves in the direction of explaining either "boundary" or "interior" - but only really does so with "boundary" in the context of a class boundary.

application boundary
the class boundary of the application as an appliance class (the predefined singleton class main). See also class boundary and interior.
...

boundary
x. See also class boundary and application boundary. Contrast with interior.
...

class
A class is a definition of an appliance, consisting of boundary and volumes, that can be used to create appliance instances. See also catalog class and singleton class. Contrast with instance.
...

catalog class
x. See also class. Contrast with singleton class.
...

class boundary
all attributes of a class visible from outside. The class boundary of AppLogic appliances includes the class name, terminals, volumes, resources and properties. Both simple appliances and assemblies have boundaries. See also application boundary. Contrast with interior.
...

interior
x. Contrast with boundary.
...

singleton, singleton class
x. See also class. Contrast with catalog class.


Additionally, I know that it is difficult to do this and requires extensive ongoing versioned commitment, but as a suggestion- it would be helpful for the glossary to be kept in sync with the AppLogic docs. Example: component is not listed in the glossary... yet there is a whole set of "component" commands on the console. It would also help us to make sure that we have a common language on forums and when chatting with the very patient support folks.

Thanks!

barmijo
03-27-2008, 02:55 PM
Thanks for pointing this out. We make an effort not to create circular references, but it does happen from time to time. I'll have someone take a look at this and correct it.

PeterNic
04-04-2008, 08:01 PM
tmart,

Sorry - the "x" means "todo". The glossary is unfinished and got published under the assumption that it will be better to have it even in this form than not (at least to create links between terms, which is what the "see also" does). We will be fixing and expanding it (this originally was in a wiki, so we could use anyone's help -- now we have to do it all by ourselves :).

Component is equal to appliance; in most cases "component" is used only in the CLI commands to refer to a running instance of an appliance (since there was no good way to abbreviate appliance and application differently). However, the terms "component" and "appliance" are fully interchangeable. Escher will be proud!

Thanks for taking us to task on the glossary.

Regards,
-- Peter