Skip to Content

Changes for page EOModelDoc

Last modified by Theodore Petrosky on 2012/02/11 13:36
From version 34.1
edited by Chuck Hill
on 2008/07/31 20:54
Change comment: There is no comment for this version
To version 27.1
edited by Chuck Hill
on 2008/08/01 14:38
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,3 +1,13 @@
1 +== Contents ==
2 +
3 +[[||anchor="Overview"]]
4 +[[||anchor="Future Plans"]]
5 +[[||anchor="Download and Example Output"]]
6 +[[||anchor="Usage"]]
7 +[[||anchor="Running from Ant"]]
8 +[[||anchor="Template Files"]]
9 +[[||anchor="Alternate Templates"]]
10 +
1 1  == Overview ==
2 2  
3 3  EOModelDoc is a command line tool to generate HTML documentation of a set of EOModels. It is a replacement for [[EOReporter>>http://www.rubicode.com/Software/EOReporter/]] (which will not work on Leopard and newer releases of OS X). EOModelDoc was funded by the Apple iTunes Store and released to the community.
... ... @@ -33,7 +33,7 @@
33 33  * Only ##-output## is required
34 34  * Usually only one of ##-modelGroup## or ##-model## is used (i.e. not both at the same time)
35 35  * The ##-templates## path only needs to point the the templates that you have changed. If any templates are not found on that path, the defaults from the jar are used.
36 -* For ##-entityURLTemplate## the ##http:~/~/domain/path/to/JavaDocs/## the path to the index.html file that JavaDoc generates. It will be something like ##http:~/~/developer.apple.com/documentation/MacOSXServer/Reference/WO54_Reference/##
46 +* For ##-entityURLTemplate## the ##http:~/~/domain/path/to/JavaDocs/## the path to the index.html file that JavaDoc generates. It will be something like ##http:~/~/developer.apple.com/documentation/MacOSXServer/Reference/WO54_Reference/##. If the EOModelDocs and JavaDocs are on the same server, you can use absolute or relative paths instead of a full URL:##http:~/~/developer.apple.com/documentation/MacOSXServer/Reference/WO54_Reference/##
37 37  
38 38  === Usage Examples ===
39 39  
... ... @@ -64,6 +64,8 @@
64 64  
65 65  == Running from Ant ==
66 66  
77 +**Note**: do not put this jar on your classpath! Chaos and Other Bad Things may ensue.
78 +
67 67  There is no Ant task (yet) for EOModelDoc. You can run it with an ##java## task following this pattern:
68 68  
69 69  {{code value="xml"}}
... ... @@ -162,3 +162,22 @@
162 162  
163 163  
164 164  ----
177 +
178 +== Alternate Templates ==
179 +
180 +Have some interesting templates to share? Add them as attachements and link them here.
181 +
182 +=== Template Mark I from Chuck ===
183 +
184 +[[Download>>^ChuckHillTemplates.tgz]]
185 +
186 +This is the default template with some useful (to me) changes:
187 +
188 +* individual properties can be toggled open and closed
189 +* non-class hidden by default
190 +* less blank vertical space
191 +* column name moved into details
192 +
193 +----
194 +
195 +[[image:ChuckHillTemplate.png]]