Changes for page EOModelDoc

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -19,7 +19,7 @@
19	19
20	20	The command line syntax of for EOModelDoc:
21	21
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:~/~/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**##
23	23
24	24	|=Parameter|=Usage / Function
25	25	|output|Path to the directory where the output HTML files will be written.
...	...	@@ -28,13 +28,6 @@
28	28	|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.
29	29	|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.
30	30
31		-=== Notes ===
32		-
33		-* Only ##-output## is required
34		-* Usually only one of ##-modelGroup## or ##-model## is used (i.e. not both at the same time)
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/##
37		-
38	38	=== Usage Examples ===
39	39
40	40	Document one model:
...	...	@@ -41,7 +41,7 @@
41	41
42	42	{{code}}
43	43
44		-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
45	45
46	46	{{/code}}
47	47
...	...	@@ -50,7 +50,7 @@
50	50
51	51	{{code}}
52	52
53		-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
54	54
55	55	{{/code}}
56	56
...	...	@@ -58,7 +58,7 @@
58	58
59	59	{{code}}
60	60
61		-java -jar /path/to/eomodeldoc.jar -output /tmp/eomodeldoc
	54	+java -jar eomodeldoc.jar -output /tmp/eomodeldoc
62	62
63	63	{{/code}}
64	64
...	...	@@ -68,11 +68,13 @@
68	68
69	69	{{code value="xml"}}
70	70
71		-<java jar="/path/to/eomodeldoc.jar"
72		- fork="true"
73		- maxmemory="256m">
	64	+<java jar="dist/test.jar"
	65	+ fork="true"
	66	+ maxmemory="256m">
74	74	<arg value="-output" />
75	75	<arg value="/path/to/output/folder" />
	69	+ <arg value="-model" />
	70	+ <arg value="/path/to/model.eomodeld" />
76	76	<arg value="-modelgroup" />
77	77	<arg value="/path/to/working/dir" />
78	78	<arg value="-templates" />
...	...	@@ -83,42 +83,6 @@
83	83
84	84	{{/code}}
85	85
86		-{{code value="xml"}}
87		-
88		-<java jar="/path/to/eomodeldoc.jar"
89		- fork="true"
90		- maxmemory="256m">
91		- <arg value="-output" />
92		- <arg value="/path/to/output/folder" />
93		- <arg value="-model" />
94		- <arg value="/path/to/modelA.eomodeld" />
95		- <arg value="-model" />
96		- <arg value="/path/to/modelB.eomodeld" />
97		- <arg value="-model" />
98		- <arg value="/path/to/modelC.eomodeld" />
99		- <arg value="-templates" />
100		- <arg value="/path/to/templates" />
101		- <arg value="-entityURLTemplate" />
102		- <arg value="http://whatever?$${entity.classNamePath}.html" />
103		-</java>
104		-
105		-{{/code}}
106		-
107		-If you include this in the build.xml file in the project, it can be as simple as:
108		-
109		-{{code value="xml"}}
110		-
111		-<java jar="/path/to/eomodeldoc.jar"
112		- fork="true"
113		- maxmemory="256m">
114		- <arg value="-output" />
115		- <arg value="Documentation" />
116		- <arg value="-modelgroup" />
117		- <arg value="." />
118		-</java>
119		-
120		-{{/code}}
121		-
122	122	== Template Files ==
123	123
124	124	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:
...	...	@@ -129,7 +129,7 @@
129	129
130	130	{{/code}}
131	131
132		-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.
	91	+See the [[EOGenerator template documentation>>EOGenerator Templates and Additions]] documentation for information on customizing these templates. Only need to have the templates that are different from the jar?
133	133
134	134	The templates and their function are:
135	135