Handler Names

We look to name handler carefully. This helps us both understand the code, and find code we created earlier.

We use a combination of CamelCase and underscore ("_") based prefixes to structure how we organise handlers.

> **Note:** Wiki causes problesm with how we name handlers as the underscore character is stripped out from the page-slug unecessarily.

# Flat Name Space Our aim is to create a flat name-space as far as this is humanely possible

# Short Handler Key Handlers that are not private, should have a unique name based on their Short Hkey as this is how the Livecode engine also referes to them.

# Handler Prefix Handlers are organised in libraries with the public handlers grouped using a prefix that should be meaningful and is often named the same as the library they are part of.

Underscore prefixes are stripped out in page-slugs. We consider therefore a handler name without the "_" character to be the same as the full handler even though Livecode would distinguish them. The rule that acheives this result is to avoid handler names that do not have prefixes.

# Wiki fixes naming Problems in naming can be caught out through documenting the handlers in wiki - where it becoes obvious when tow handler names clash.

# No Hyphens We don't (yet) use "-" of "." in out handler names. Spaces are turned into hyphens in page-slugs.

# Examples

However this is ugly, and we prefer to document these handlers simply using the handler name. This forces us to distinguish public handlers by name alone.

> Note: we can add brackets to function names as they are stripped out in the wiki-links slug.