[caffeine-hx] r737 committed - Created wiki page through web user interface.

[caffe...@googlecode.com]

Revision: 737
Author: damon...@gmail.com
Date: Sun Aug 5 09:40:23 2012
Log: Created wiki page through web user interface.
http://code.google.com/p/caffeine-hx/source/detail?r=737

Added:
/wiki/ChxDocChanges.wiki

=======================================
--- /dev/null
+++ /wiki/ChxDocChanges.wiki Sun Aug 5 09:40:23 2012
@@ -0,0 +1,33 @@
+#summary One-sentence summary of this page.
+
+= Introduction =
+
+With the release of ChxDoc 1.2, there have been some major changes that
will definitely affect existing templates and the command line.
+
+= Details =
+
+These things will need to be done in order to migrate:
+ * References to _meta_ in templates changed. See [#Template_changes]
+ * _--includeOnly_ and _-f_ do not do filtering. See [#Filtering]
+ * _--templateDir_ switch removed. See [#Specifying_templates]
+ * Switch _-f_ retasked See [#The_-f_switch]
+ * Xml configuration. See [ChxDoc#Configuration]
+ * Switch _--macroFile_ changed to _--macros_
+
+== Template changes ==
+
+If you have a custom template, you must change the _meta_ references to
_webmeta_. This is generally at the top of your .mtt files and has the
three elements _data_, _keywords_ and _stylesheet_. See revision r734 for
diffs to the default templates for examples. The _meta_ tag is now part of
the _docs_ and will display the haxe metadata associated with a class or
class field. See the diff of class.mtt for an example of how to change your
template.
+
+== Filtering ==
+
+Filtering used to be done with the _-f_ and _--includeOnly_ switches. This
did not allow for very fine grained control over what documentation got
created. The new system in version 1.2 works more like a firewall, where
packages are passed through the filter engine, which will either _allow_ or
_deny_ documentation.
+
+The _-f_ and _--includeOnly_ switches have been removed. Use -_-policy_,
_--allow_ and _--deny_. Refer to [ChxDoc#Package_and_Type_filtering]
+
+== Specifying templates ==
+
+_--templateDir_ has been removed. The new switch _--templatesDir__ (note
the s) specifies a base template path, and _--template_ specifies the
template to use. If your old syntax was
__--templateDir=/chxdoc/templates/default__, it would now be
__--templatesDir=/chxdoc/templates --template=default__. The actual path is
found by combining the two, so actually specifying the full path in either
will work. However, beware of default settings you have in your
home .chxdoc file.
+
+== The -f switch ==
+
+On the command line, the haxe generated xml files used to be specified
without a command line switch. This is no longer the case, and must be
specified with _-f_ or _--file_. {{{ chxdoc -o docs flash.xml }}} is now
{{{ chxdoc -o docs -f flash.xml }}}