Documenting the EO Model

[Benjamin Steiner]

Hi list,

We are currently designing a quite complex EO Model, and there’s a lot to be 
documented. Does anyone have some advice on how to approach that on a large 
scale or is anyone using some Tools to do it?
I’ve heard of program called “EO Model Doc”, but i don’t know how to get it or 
if it’s even still working.

thanks for any advice
beni
 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Paul Hoadley]

Hi Benjamin,

On 6 Nov 2015, at 7:19 pm, Benjamin Steiner  wrote:

> We are currently designing a quite complex EO Model, and there’s a lot to be 
> documented. Does anyone have some advice on how to approach that on a large 
> scale or is anyone using some Tools to do it?
> I’ve heard of program called “EO Model Doc”, but i don’t know how to get it 
> or if it’s even still working.

Entity Modeler supports adding documentation to an EO Model at all levels: 
model, entity, property. This is stored directly in the model using the 
userInfo dictionary at those levels. Selecting the “Docs” tab for any of those 
objects presents a textarea to edit the content, and an HTML preview:



You can still find EOModelDoc:

https://wiki.wocommunity.org/display/WOL/EOModelDoc 


(You can download a JAR from that page. I’m not sure where the source is these 
days—I’m not seeing it in the Wonder repo. Was it ever available?)

I haven’t used it in a few years, so I can’t say whether it’s still working, 
but it’s certainly produced serviceable output in the past. If you resurrect it 
with any success, please report back to the list. I, for one, have been meaning 
to dig it up from time to time, and would be interested to know its current 
status.


-- 
Paul Hoadley
http://logicsquad.net/

 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Paul Yu]

We do have to thank the guys at Omni for continuing to support that feature.

Paul

> On Nov 6, 2015, at 8:07 AM, Ken Anderson  wrote:
> 
> Omnigraffle will open an EOModel into a beautiful graph.
> 
>> On Nov 6, 2015, at 3:49 AM, Benjamin Steiner  wrote:
>> 
>> Hi list,
>> 
>> We are currently designing a quite complex EO Model, and there’s a lot to be 
>> documented. Does anyone have some advice on how to approach that on a large 
>> scale or is anyone using some Tools to do it?
>> I’ve heard of program called “EO Model Doc”, but i don’t know how to get it 
>> or if it’s even still working.
>> 
>> thanks for any advice
>> beni
>> ___
>> Do not post admin requests to the list. They will be ignored.
>> Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
>> Help/Unsubscribe/Update your Subscription:
>> https://lists.apple.com/mailman/options/webobjects-dev/kenlists%40anderhome.com
>> 
>> This email sent to kenli...@anderhome.com
> 
> ___
> Do not post admin requests to the list. They will be ignored.
> Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
> Help/Unsubscribe/Update your Subscription:
> https://lists.apple.com/mailman/options/webobjects-dev/pyu%40mac.com
> 
> This email sent to p...@mac.com


 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Samuel Pelletier]

Hi Benjamin,

For large model, the only solution I found useful is to create schemas using 
Omni Graffle. I usually create multiple schemas for a single model/project, one 
for each module like finance, operations, CRM, etc... Trying to document more 
than 12-15 entities in a single schema does not lead to effective 
documentation. If an entity is present in multiple schema, I usually define it 
only once and present only it's name some attributes on others where it is 
referenced.

Automated tools do not deal well with complex model with circular and multi 
path between entities. They also tend to produce too detailed diagrams, you 
does not need the FK attributes of the relationship is visible with a line for 
example...

I also usually create my schemas before the EOModel and create the migration 
code from the model.

Samuel

> Le 2015-11-06 à 03:49, Benjamin Steiner  a écrit :
> 
> Hi list,
> 
> We are currently designing a quite complex EO Model, and there’s a lot to be 
> documented. Does anyone have some advice on how to approach that on a large 
> scale or is anyone using some Tools to do it?
> I’ve heard of program called “EO Model Doc”, but i don’t know how to get it 
> or if it’s even still working.
> 
> thanks for any advice
> beni
> ___
> Do not post admin requests to the list. They will be ignored.
> Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
> Help/Unsubscribe/Update your Subscription:
> https://lists.apple.com/mailman/options/webobjects-dev/samuel%40samkar.com
> 
> This email sent to sam...@samkar.com


 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Klaus Berkling]

On Nov 6, 2015, at 12:49 AM, Benjamin Steiner  wrote:

> We are currently designing a quite complex EO Model, and there’s a lot to be 
> documented. Does anyone have some advice on how to approach that on a large 
> scale or is anyone using some Tools to do it?
> I’ve heard of program called “EO Model Doc”, but i don’t know how to get it 
> or if it’s even still working.


I use OmniGraffle too to visualize the schema and the relationships. Attributes 
can be documented in text files, although I try to be self documenting. 


"We keep moving forward, opening new doors, and doing new things, because we're 
curious and curiosity keeps leading us down new paths."
Walt Disney

Klaus Berkling
www.berkling.us | @kiberkli | Photography





 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Klaus Berkling]

On Nov 6, 2015, at 12:49 AM, Benjamin Steiner  wrote:

> We are currently designing a quite complex EO Model, and there’s a lot to be 
> documented. Does anyone have some advice on how to approach that on a large 
> scale or is anyone using some Tools to do it?
> I’ve heard of program called “EO Model Doc”, but i don’t know how to get it 
> or if it’s even still working.


I use OmniGraffle too to visualize the schema and the relationships. Attributes 
can be documented in text files, although I try to be self documenting. 


"We keep moving forward, opening new doors, and doing new things, because we're 
curious and curiosity keeps leading us down new paths."
Walt Disney

Klaus Berkling
www.berkling.us | @kiberkli | Photography





 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Ramsey Gurley]

Not WO related at all, but I recently discovered the DBeaver Eclipse plugin. 
It’s pretty amazing. You can use it to connect to any database with a JDBC. It 
has diagram views so you won’t need something like omnigraffle to see your 
schema and with a DB like postgres, you can document your tables directly in 
the database itself. No need to lock up your documentation in proprietary WO 
formats.

http://www.techrepublic.com/blog/linux-and-open-source/two-features-of-dbeaver-that-every-database-manager-should-know/

You can install it via Help -> Eclipse Marketplace, and then search for DBeaver.

On Nov 6, 2015, at 1:49 AM, Benjamin Steiner  wrote:

> Hi list,
> 
> We are currently designing a quite complex EO Model, and there’s a lot to be 
> documented. Does anyone have some advice on how to approach that on a large 
> scale or is anyone using some Tools to do it?
> I’ve heard of program called “EO Model Doc”, but i don’t know how to get it 
> or if it’s even still working.
> 
> thanks for any advice
> beni
> ___
> Do not post admin requests to the list. They will be ignored.
> Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
> Help/Unsubscribe/Update your Subscription:
> https://lists.apple.com/mailman/options/webobjects-dev/rgurley%40smarthealth.com
> 
> This email sent to rgur...@smarthealth.com


 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Ken Anderson]

I thank them with my $$$ :)

> On Nov 6, 2015, at 8:23 AM, Paul Yu  wrote:
> 
> We do have to thank the guys at Omni for continuing to support that feature.
> 
> Paul
> 
>> On Nov 6, 2015, at 8:07 AM, Ken Anderson  wrote:
>> 
>> Omnigraffle will open an EOModel into a beautiful graph.
>> 
>>> On Nov 6, 2015, at 3:49 AM, Benjamin Steiner  wrote:
>>> 
>>> Hi list,
>>> 
>>> We are currently designing a quite complex EO Model, and there’s a lot to 
>>> be documented. Does anyone have some advice on how to approach that on a 
>>> large scale or is anyone using some Tools to do it?
>>> I’ve heard of program called “EO Model Doc”, but i don’t know how to get it 
>>> or if it’s even still working.
>>> 
>>> thanks for any advice
>>> beni
>>> ___
>>> Do not post admin requests to the list. They will be ignored.
>>> Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
>>> Help/Unsubscribe/Update your Subscription:
>>> https://lists.apple.com/mailman/options/webobjects-dev/kenlists%40anderhome.com
>>> 
>>> This email sent to kenli...@anderhome.com
>> 
>> ___
>> Do not post admin requests to the list. They will be ignored.
>> Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
>> Help/Unsubscribe/Update your Subscription:
>> https://lists.apple.com/mailman/options/webobjects-dev/pyu%40mac.com
>> 
>> This email sent to p...@mac.com
> 

 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Paul Yu]

However, they don’t have to keep that block of code alive.  Although eomodel 
has not change in a thousand years, so they actually don’t have to touch that 
code…
> On Nov 6, 2015, at 8:37 AM, Ken Anderson  wrote:
> 
> I thank them with my $$$ :)
> 
>> On Nov 6, 2015, at 8:23 AM, Paul Yu  wrote:
>> 
>> We do have to thank the guys at Omni for continuing to support that feature.
>> 
>> Paul
>> 
>>> On Nov 6, 2015, at 8:07 AM, Ken Anderson  wrote:
>>> 
>>> Omnigraffle will open an EOModel into a beautiful graph.
>>> 
 On Nov 6, 2015, at 3:49 AM, Benjamin Steiner  wrote:
 
 Hi list,
 
 We are currently designing a quite complex EO Model, and there’s a lot to 
 be documented. Does anyone have some advice on how to approach that on a 
 large scale or is anyone using some Tools to do it?
 I’ve heard of program called “EO Model Doc”, but i don’t know how to get 
 it or if it’s even still working.
 
 thanks for any advice
 beni
 ___
 Do not post admin requests to the list. They will be ignored.
 Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
 Help/Unsubscribe/Update your Subscription:
 https://lists.apple.com/mailman/options/webobjects-dev/kenlists%40anderhome.com
 
 This email sent to kenli...@anderhome.com
>>> 
>>> ___
>>> Do not post admin requests to the list. They will be ignored.
>>> Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
>>> Help/Unsubscribe/Update your Subscription:
>>> https://lists.apple.com/mailman/options/webobjects-dev/pyu%40mac.com
>>> 
>>> This email sent to p...@mac.com
>> 


 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Chuck Hill]

I¹Ve used EOModelDoc. Below are some Ant fragments to get you started.  I
am also attaching a eogen template showing how to drive the documentation
from the EOModel into the classes where JavaDoc and you IDE will pick it
up.  I find that generally more useful.

Chuck










































On 2015-11-06, 12:49 AM,
"webobjects-dev-bounces+chill=gevityinc@lists.apple.com on behalf of
Benjamin Steiner" 
 wrote:

>Hi list,
>
>We are currently designing a quite complex EO Model, and there¹s a lot to
>be documented. Does anyone have some advice on how to approach that on a
>large scale or is anyone using some Tools to do it?
>I¹ve heard of program called ³EO Model Doc², but i don¹t know how to get
>it or if it¹s even still working.
>
>thanks for any advice
>beni
> ___
>Do not post admin requests to the list. They will be ignored.
>Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
>Help/Unsubscribe/Update your Subscription:
>https://lists.apple.com/mailman/options/webobjects-dev/chill%40gevityinc.c
>om
>
>This email sent to ch...@gevityinc.com



HHBaseClass.eotemplate
Description: HHBaseClass.eotemplate
 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documenting the EO Model

[Ken Anderson]

Omnigraffle will open an EOModel into a beautiful graph.

> On Nov 6, 2015, at 3:49 AM, Benjamin Steiner  wrote:
> 
> Hi list,
> 
> We are currently designing a quite complex EO Model, and there’s a lot to be 
> documented. Does anyone have some advice on how to approach that on a large 
> scale or is anyone using some Tools to do it?
> I’ve heard of program called “EO Model Doc”, but i don’t know how to get it 
> or if it’s even still working.
> 
> thanks for any advice
> beni
> ___
> Do not post admin requests to the list. They will be ignored.
> Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
> Help/Unsubscribe/Update your Subscription:
> https://lists.apple.com/mailman/options/webobjects-dev/kenlists%40anderhome.com
> 
> This email sent to kenli...@anderhome.com

 ___
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list  (Webobjects-dev@lists.apple.com)
Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/webobjects-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com