First pass at customization doc.

Troy Melhase · Troy Melhase · commit cbd934ac2fcd · 2012-02-05T15:40:29.000-05:00
diff --git a/doc/customization.md b/doc/customization.md
@@ -1,5 +1,69 @@
 ## java2python Customization
 
-### Basic
+The java2python compiler defers a significant amount of its processing to
+handlers defined within configuration files.  These configuration files,
+directories, and modules are supplied to the `j2py` script on the command
+line. See the [usage][] page for instructions on specifying additional configs.
 
-### Advanced
+The default configuration module is `java2python.config.default`.  Refer to [the source
+of that module][1] for its values and additional descriptions.
+
+### A Note About Some of the Names:  Prologue, Base, Head, and Epilogue
+
+When a config point has `Prologue` in its name, it means that the item will be
+responsible for generating code before the output.  For example, method
+prologue handlers generate decorators, while module prologue handlers generate
+the shebang line.
+
+When a config point has `Base` in the name, it means that the item will be
+responsible for generating the base classes of a class, enum, or interface.
+
+
+A config point with `Head` in the name means that the item will be responsible
+for generating code for the section between the declaration and the body of the
+item.  For example:
+
+    class X(object):
+        """ this is a comment generated by classHeadHandlers """
+
+Finally, when a config point contains `Epilogue`, it means that the item will
+be responsible for generating code after the body of the item.  The only
+recognized epilogue config point is `moduleEpilogueHandlers`, which generates a
+main script stanza if necessary.
+
+### Customization Points
+
+* indentPrefix
+* commentPrefix
+* expressionVariableNamingHandler
+
+* modulePrologueHandlers
+* moduleEpilogueHandlers
+* moduleOutputHandlers
+* modulePackageDeclarationHandler
+* moduleImportDeclarationHandler
+* moduleOutputSubs
+
+
+* classHeadHandlers
+* classBaseHandlers
+* classPostWalkHandlers
+
+* interfaceBaseHandlers
+* interfaceHeadHandlers
+
+* enumHeadHandlers
+* enumValueHandler
+
+
+* methodParamHandlers
+* methodLockFunctionName
+* methodHeadHandlers
+* methodPrologueHandlers
+
+* astTransforms
+* typeSubs
+
+
+[usage]: https://github.com/natural/java2python/tree/master/doc/usage.md
+[1]: https://github.com/natural/java2python/blob/master/java2python/config/default.py
