Skip to Content

Changes for page EOModelDoc

Last modified by Theodore Petrosky on 2012/02/11 13:36
From version 37.1
edited by Chuck Hill
on 2008/08/01 14:17
Change comment: There is no comment for this version
To version 42.1
edited by Chuck Hill
on 2008/07/31 18:06
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.
... ... @@ -29,7 +29,7 @@
29 29  
30 30  The command line syntax of for EOModelDoc:
31 31  
32 -##java --jar eomodeldoc.jar --output /path/to/output/folder -model /path/to/model.eomodeld]** -modelgroup /path/to/working/dir] -templates /path/to/templates] -entityURLTemplate "http:~/~/domain/path/to/JavaDocs/$entity.classNamePath.html**##
22 +##java --jar eomodeldoc.jar --output /path/to/output/folder -model /path/to/model.eomodeld]** -modelgroup /path/to/working/dir] -templates /path/to/templates] -entityURLTemplate "http:~/~/whatever?$entity.classNamePath}.html**##
33 33  
34 34  |=Parameter|=Usage / Function
35 35  |output|Path to the directory where the output HTML files will be written.
... ... @@ -38,13 +38,6 @@
38 38  |templates|Path to the directory where the Velocity templates are stored. See the [[||anchor="Template Files"]] section below for details on these templates. If this is not specified, the default templates inside the eomodeldoc.jar file will be used.
39 39  |entityURLTemplate|URL to the JavaDocs for the classes in the model. This is used to create links from the EOModel documentation to the JavaDoc documentation. The dots in the classpath are replaced with "/" when the path is generated.
40 40  
41 -=== Notes ===
42 -
43 -* Only ##-output## is required
44 -* Usually only one of ##-modelGroup## or ##-model## is used (i.e. not both at the same time)
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/##
47 -
48 48  === Usage Examples ===
49 49  
50 50  Document one model:
... ... @@ -51,7 +51,7 @@
51 51  
52 52  {{code}}
53 53  
54 -java -jar /path/to/eomodeldoc.jar -model /path/to/model.eomodeld -output /tmp/eomodeldoc
37 +java -jar eomodeldoc.jar -model /path/to/model.eomodeld -output /tmp/eomodeldoc
55 55  
56 56  {{/code}}
57 57  
... ... @@ -60,7 +60,7 @@
60 60  
61 61  {{code}}
62 62  
63 -java -jar /path/to/eomodeldoc.jar -modelgroup /path/to/project -output /tmp/eomodeldoc
46 +java -jar eomodeldoc.jar -modelgroup /path/to/project -output /tmp/eomodeldoc
64 64  
65 65  {{/code}}
66 66  
... ... @@ -68,67 +68,10 @@
68 68  
69 69  {{code}}
70 70  
71 -java -jar /path/to/eomodeldoc.jar -output /tmp/eomodeldoc
54 +java -jar eomodeldoc.jar -output /tmp/eomodeldoc
72 72  
73 73  {{/code}}
74 74  
75 -== Running from Ant ==
76 -
77 -There is no Ant task (yet) for EOModelDoc. You can run it with an ##java## task following this pattern:
78 -
79 -{{code value="xml"}}
80 -
81 -<java jar="/path/to/eomodeldoc.jar"
82 - fork="true"
83 - maxmemory="256m">
84 - <arg value="-output" />
85 - <arg value="/path/to/output/folder" />
86 - <arg value="-modelgroup" />
87 - <arg value="/path/to/working/dir" />
88 - <arg value="-templates" />
89 - <arg value="/path/to/templates" />
90 - <arg value="-entityURLTemplate" />
91 - <arg value="http://whatever?$${entity.classNamePath}.html" />
92 -</java>
93 -
94 -{{/code}}
95 -
96 -{{code value="xml"}}
97 -
98 -<java jar="/path/to/eomodeldoc.jar"
99 - fork="true"
100 - maxmemory="256m">
101 - <arg value="-output" />
102 - <arg value="/path/to/output/folder" />
103 - <arg value="-model" />
104 - <arg value="/path/to/modelA.eomodeld" />
105 - <arg value="-model" />
106 - <arg value="/path/to/modelB.eomodeld" />
107 - <arg value="-model" />
108 - <arg value="/path/to/modelC.eomodeld" />
109 - <arg value="-templates" />
110 - <arg value="/path/to/templates" />
111 - <arg value="-entityURLTemplate" />
112 - <arg value="http://whatever?$${entity.classNamePath}.html" />
113 -</java>
114 -
115 -{{/code}}
116 -
117 -If you include this in the build.xml file in the project, it can be as simple as:
118 -
119 -{{code value="xml"}}
120 -
121 -<java jar="/path/to/eomodeldoc.jar"
122 - fork="true"
123 - maxmemory="256m">
124 - <arg value="-output" />
125 - <arg value="Documentation" />
126 - <arg value="-modelgroup" />
127 - <arg value="." />
128 -</java>
129 -
130 -{{/code}}
131 -
132 132  == Template Files ==
133 133  
134 134  Default templates are included in the eomodeldoc.jar file. You can extract these templates to use as a basis for your own templates with this command:
... ... @@ -139,7 +139,7 @@
139 139  
140 140  {{/code}}
141 141  
142 -See the [[EOGenerator template documentation>>EOGenerator Templates and Additions]] documentation for information on customizing these templates. 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.
68 +Only need to have the templates that are different from the jar?
143 143  
144 144  The templates and their function are:
145 145  
... ... @@ -173,21 +173,4 @@
173 173  
174 174  ----
175 175  
176 -== Alternate Templates ==
177 -
178 -Have some interesting templates to share? Add them as attachements and link them here.
179 -
180 -=== Template Mark I from Chuck ===
181 -
182 -[[Download>>^ChuckHillTemplates.tgz]]
183 -
184 -This is the default template with some useful (to me) changes:
185 -
186 -* individual properties can be toggled open and closed
187 -* non-class hidden by default
188 -* less blank vertical space
189 -* column name moved into details
190 -
191 -----
192 -
193 -[[image:ChuckHillTemplate.png]]
102 +== Running from Ant ==