Hi Ricardo,
Some feedback/comments:
- we should use css instead of hardcode values in the templatates/html
- I prefer a default font as the one used at http://www.hibernate.org/hib_docs/api/
- links to tables/columns from e.g. the foreign key section would be nice
- Some places schema is spelled Squema and Hibernate Hiberante
- I follow that you are using the same color coding as the hibernate logo, which makes it consistent - but also pretty dull..maybe christian have better suggestion for the color schema ?
keep up the good stuff.
p.s. you dont need to fix all of the above before providing the code so we can get it in cvs. Would like to see what changes/additional code that were needed to write such a template.
/max
On Thu, 21 Apr 2005 17:10:29 +0200, Ricardo Moral <[EMAIL PROTECTED]> wrote:
looks good.
cant wait ,)
/max
So the final structure would be something like (very similar to Javadoc):
/doc /tables table-overview.html /somecatalog/childschema/tablename.html (one per class) /classes class-overview.html /somepackage/childpackage/classname.html (one per class)
Right now I dont have the code on this machine so I can't send you a sample.
I'll send something in a couple of hours.
What I have almost working is the generation of the Table documentation. As soon as I finish that I'll send you the code.
Regards, Ricardo.
On 4/21/05, Max Rydahl Andersen <[EMAIL PROTECTED]> wrote:On Thu, 21 Apr 2005 16:44:25 +0200, Ricardo Moral <[EMAIL PROTECTED]> wrote:
This is one of the things that bugs me to, but until know I haven't needed it.
Please add a jira for it so we can get non-mapping code can call this from
the outside.
But anyhow - you should actually in almost 99% cases be able to get it by
just
calling getSqlType(dialect, null); - or just fake the impl of that mapping.
At least as a work around.
I'm getting very curious for any hint on how the final output looks like ;)
/max
> Max, sorry for the delay but I had some problems with my PC.
>
> I need to show the SQL type on the documentation. I have a reference
> to aColumn instance that has the following method:
>
> public String getSqlType(Dialect dialect, Mapping mapping) throws
> HibernateException
>
> This returns the SQL type used in the Table object to generate Table
> Create statements. I think that's the method I must use to get that
> data but I can't get a Mapping object since that instance is
> encapsulated inside the Configuration and there is no way of getting
> hold of it....
>
> Any ideas?
>
> Best Regards,
> Ricardo.
>
> On 4/13/05, Max Rydahl Andersen <[EMAIL PROTECTED]> wrote:
>>
>> > Hi Max,
>>
>> hi ricardo,
>>
>> > I'm working on the Doc generator,
>>
>> nice!
>> btw. i'm cc'ing this to devel so the other guys can see the progress.
>>
>> > I've been checking out the mapping model (org.hibernate.mapping) and I
>> > have one question:
>> >
>> > In the documentation I want to show how each column is used (property,
>> > collection, etc).
>>
>> Nice! I was hoping you also would cover this one.
>>
>> > On the object model the column has a reference to
>> > the value but the the value doesn't have a reference to the Property
>> > so I can't navigate the object structure from the Column to the
>> > Property (The documentation generation process is driven by the table
>> > list).
>>
>> Yes, column does not know how to navigate "upwards" and that is
>> intentional.
>>
>> >
>> > What I'm going to do is create a set of Maps at the begining of the
>> > process to keep the the Columns as keys and the Properties as values
>> > to use during the generation of the documentation inside the velocity
>> > templates.
>>
>> Yes, I were planning to add this logic too as I also need it some places
>> of the plugin - so feel free to add a method that does this.
>>
>> > I think that one possible reason for this is that you could map the
>> > same column for many objects, is that correct? In this case I'll need
>> > a Map with Columns as Keys and Lists of Properties as values.
>>
>> The same columns can be noted multiple places, but note that columns
>> will not always be the same instance (==), but will have the same name
>> so be sure to use .equals() to do the comparisons/lookups.
>>
>> > What do you think about this?
>>
>> Sounds great ... would reaaallly like to see how far you have gotten ?
>>
>> If you dont like to show code yet, then maybe just a sample output ?
>>
>> /max
>>
>> >
>> > Best Regards,
>> > Ricardo.
>> >
>> >
>> > On 4/13/05, Max Rydahl Andersen <[EMAIL PROTECTED]> wrote:
>> >> Hi guys,
>> >>
>> >> any planned date for 3.0.1 ?
>> >>
>> >> I got some minor additions to the core that I would like to add
>> >> (MetaAttributable).
>> >> And if 3.0.1 is not planned to be released soon (within a week) i'll
>> >> need
>> >> to hold changes
>> >> in the toolset back as otherwise the next tool release will not work
>> >> with
>> >> the latest release of hibernate...
>> >>
>> >> --
>> >> --
>> >> Max Rydahl Andersen
>> >> callto://max.rydahl.andersen
>> >>
>> >> Hibernate
>> >> [EMAIL PROTECTED]
>> >> http://hibernate.org
>> >>
>> >> JBoss Inc
>> >> [EMAIL PROTECTED]
>> >> http://jboss.com
>> >>
>> >> -------------------------------------------------------
>> >> SF email is sponsored by - The IT Product Guide
>> >> Read honest & candid reviews on hundreds of IT Products from real
>> users.
>> >> Discover which products truly live up to the hype. Start reading now.
>> >> http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
>> >> _______________________________________________
>> >> hibernate-devel mailing list
>> >> hibernate-devel@lists.sourceforge.net
>> >> https://lists.sourceforge.net/lists/listinfo/hibernate-devel
>> >>
>>
>> --
>> --
>> Max Rydahl Andersen
>> callto://max.rydahl.andersen
>>
>> Hibernate
>> [EMAIL PROTECTED]
>> http://hibernate.org
>>
>> JBoss Inc
>> [EMAIL PROTECTED]
>> http://jboss.com
>>
-- -- Max Rydahl Andersen callto://max.rydahl.andersen
Hibernate [EMAIL PROTECTED] http://hibernate.org
JBoss Inc [EMAIL PROTECTED] http://jboss.com
-- -- Max Rydahl Andersen callto://max.rydahl.andersen
Hibernate [EMAIL PROTECTED] http://hibernate.org
JBoss Inc [EMAIL PROTECTED] http://jboss.com
------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click _______________________________________________ hibernate-devel mailing list hibernate-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/hibernate-devel
