Changes for page EOModelDoc

Summary

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

Details

Page properties

Content

...	...	@@ -17,69 +17,25 @@
17	17
18	18	== Usage ==
19	19
20		-The command line syntax of for EOModelDoc:
	20	+Still working on all the model loaders, but you should be able to do
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:~/~/whatever?$entity.classNamePath}.html**##
23		-
24		-|=Parameter|=Usage / Function
25		-|output|Path to the directory where the output HTML files will be written.
26		-|model|Path to one model to generate documentation for. This parameter can be used multiple times, once for each model.
27		-|modelgroup|The path to an Eclipse or IDEA project. All models listed in the project will be documented. This defaults to the current working directory.
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		-|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		-
31		-=== Usage Examples ===
32		-
33		-Document one model:
34		-
35		-{{code}}
36		-
37		-java -jar eomodeldoc.jar -model /path/to/model.eomodeld -output /tmp/eomodeldoc
38		-
39		-{{/code}}
40		-
	22	+java --jar eomodeldoc.jar --model /path/to/model.eomodeld --output /tmp/
	23	+eomodeldoc
	24	+(will load all the models in the modelgroup based on your eclipse or
	25	+IDEA project files ..... allegedly ... still working the kinks out on
	26	+this)
	27	+or
41	41
42		-Document all models based on the Eclipse or IDEA project definition:
	29	+java --jar eomodeldoc.jar --modelgroup /path/to/project --output /tmp/
	30	+eomodeldoc
	31	+(i haven't tried that one yet)
	32	+
	33	+or
	34	+
	35	+java --jar eomodeldoc.jar --output /tmp/eomodeldoc
	36	+from inside your project
43	43
44		-{{code}}
45		-
46		-java -jar eomodeldoc.jar -modelgroup /path/to/project -output /tmp/eomodeldoc
47		-
48		-{{/code}}
49		-
50		-Document all models based on the Eclipse/IDEA project definition (when current working directory is the top level of the project):
51		-
52		-{{code}}
53		-
54		-java -jar eomodeldoc.jar -output /tmp/eomodeldoc
55		-
56		-{{/code}}
57		-
58		-== Template Files ==
59		-
60		-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:
61		-
62		-{{code}}
63		-
64		-unzip /path/to/eomodeldoc.jar *.vm -x "*/*"
65		-
66		-{{/code}}
67		-
68		-Only need to have the templates that are different from the jar?
69		-
70		-The templates and their function are:
71		-
72		-|=Template Name|=Usage / Function
73		-|indexModels.html.vm|Left pane index of all models.
74		-|indexOverview.html.vm|Left pane index of the contents of all models (e.g. list of entities and stored procedures).
75		-|modelOverview.html.vm|Left pane index of the contents of one model (e.g. list of entities and stored procedures).
76		-|indexContent.html.vm|Main frame description of each model and contents of each model (e.g. list of entities and stored procedures).
77		-|modelContent.html.vm|Main frame contents of one model (list of entities and stored procedures).|
78		-|entityContent.html.vm|Main frame contents for one Entity
79		-|storedProcedureContent.html.vm|Main frame contents for one stored procedure.
80		-|index.html.vm|Top level index.html file defining frameset. You probably won't need to modify this.
81		-|prototype.js.vm|[[Prototype>>http://www.prototypejs.org/learn]] JavaScript file so that the generated documentation can use Ajax whizziness. You probably won't need to modify this.
82		-|eomodeldoc.css.vm|CSS file that controls what the generate output looks like.
83		-|eomodeldoc.js.vm|JavaScript file that cleans up the display. You probably won't need to modify this.
84		-
85		-== Running from Ant ==
	38	+Tthe usage syntax of the eomodeldoc.jar:
	39	+
	40	+[[mbp:~~]] th% java --jar eomodeldoc.jar
	41	+eomodeldoc --output /path/to/output/folder [[-model pathtomodel.eomodeld]]** [[-modelgroup pathtoworkingdir]] [[-templates pathtotemplates]] [-entityURLTemplate "http:~/~/whatever?${{entity.classNamePath}}{{/entity.classNamePath}}.html **