Skip to Content

Changes for page EOModelDoc

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

Summary

Details

Page properties
Content
... ... @@ -1,13 +11,3 @@
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 -
11 11  == Overview ==
12 12  
13 13  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.
... ... @@ -43,7 +43,7 @@
43 43  * Only ##-output## is required
44 44  * Usually only one of ##-modelGroup## or ##-model## is used (i.e. not both at the same time)
45 45  * 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.
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/##
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/##
47 47  
48 48  === Usage Examples ===
49 49  
... ... @@ -74,8 +74,6 @@
74 74  
75 75  == Running from Ant ==
76 76  
77 -**Note**: do not put this jar on your classpath! Chaos and Other Bad Things may ensue.
78 -
79 79  There is no Ant task (yet) for EOModelDoc. You can run it with an ##java## task following this pattern:
80 80  
81 81  {{code value="xml"}}
... ... @@ -174,22 +174,3 @@
174 174  
175 175  
176 176  ----
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]]