Wiki source code of EOModelDoc
Version 25.1 by Chuck Hill on 2008/07/31 16:33
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | == Overview == | ||
| 2 | |||
| 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. | ||
| 4 | |||
| 5 | On the WOLips side, from version 3.3.x, [[Entity Modeler>>Using Entity Modeler]] has a Documentation tab on all of the elements of a model that lets you record HTML documentation for your model, entities, attributes, etc. There is even an HTML preview. You can then run eomodeldoc to produce documentation much like javadoc for your model. | ||
| 6 | |||
| 7 | == Future Plans == | ||
| 8 | |||
| 9 | From Mike Schrag: //There's not a nice build process for this one either, yet, because it includes all of the eclipse dependencies in the single jar. Eventually I'll make this nicer and include it actually inside of Eclipse. There are also modifications to the ERNeutralLook coming soon that will display popup help for you models based on the model documentation.// | ||
| 10 | |||
| 11 | == Download and Example Output == | ||
| 12 | |||
| 13 | [[Download EOModelDoc jar>>http://webobjects.mdimension.com/wolips/eomodeldoc.jar]] | ||
| 14 | |||
| 15 | This is an example of the current state of eomodeldoc (the default templates are not done, but it will give you an idea of what it can do). The templates are all Velocity-based, and you can override them with custom versions. This was run in the BugTracker project folder. This model does not have documentation added to it with the new Entity Modeler yet, so it looks a little more bare than it would if it was documented properly. I'll probably document it just to have a full example to show. | ||
| 16 | [[View Example Output>>http://webobjects.mdimension.com/wolips/eomodeldoc_example/]] | ||
| 17 | |||
| 18 | == Usage == | ||
| 19 | |||
| 20 | The command line syntax of for EOModelDoc: | ||
| 21 | |||
| 22 | ##eomodeldoc --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 | Still working on all the model loaders, but you should be able to do | ||
| 25 | |||
| 26 | java --jar eomodeldoc.jar --model /path/to/model.eomodeld --output /tmp/ | ||
| 27 | eomodeldoc | ||
| 28 | (will load all the models in the modelgroup based on your eclipse or | ||
| 29 | IDEA project files ..... allegedly ... still working the kinks out on | ||
| 30 | this) | ||
| 31 | or | ||
| 32 | |||
| 33 | java --jar eomodeldoc.jar --modelgroup /path/to/project --output /tmp/ | ||
| 34 | eomodeldoc | ||
| 35 | (i haven't tried that one yet) | ||
| 36 | |||
| 37 | or | ||
| 38 | |||
| 39 | java --jar eomodeldoc.jar --output /tmp/eomodeldoc | ||
| 40 | from inside your project | ||
| 41 | |||
| 42 | == Template Files == | ||
| 43 | |||
| 44 | 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: | ||
| 45 | |||
| 46 | {{code}} | ||
| 47 | |||
| 48 | unzip /path/to/eomodeldoc.jar *.vm -x "*/*" | ||
| 49 | |||
| 50 | {{/code}} | ||
| 51 | |||
| 52 | The templates and their function are: | ||
| 53 | |||
| 54 | |=Template Name|=Usage / Function | ||
| 55 | |entityContent.html.vm| | ||
| 56 | |eomodeldoc.css.vm| | ||
| 57 | |eomodeldoc.js.vm| | ||
| 58 | |index.html.vm| | ||
| 59 | |indexContent.html.vm| | ||
| 60 | |indexModels.html.vm| | ||
| 61 | |indexOverview.html.vm| | ||
| 62 | |modelContent.html.vm| | | ||
| 63 | |modelOverview.html.vm| | ||
| 64 | |prototype.js.vm| | ||
| 65 | |storedProcedureContent.html.vm| |