You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@jackrabbit.apache.org by "Sten R. Sandvik" <sr...@enonic.com> on 2006/08/24 22:46:50 UTC

Nodetype documentation (NTDOC)

Hi all.
 
I recently wrote about a nodetype documentation tool I had developed and used. As my understanding this could be used by alot of people and seems to be missing as a tool in Jackrabbit. I have found it quite useful to be able to visualize the node types in a more structured "human-readable" form. Therefore I developed ntdoc (node type documentation generator) that creates JavaDoc like pages for node types. 
 
I have not yet had time to structure the code so that it is suitable for contribution to Jackrabbit, but will do in the near future. Hopefully by next week. But in the meantime it is avaliable on my blog here: http://www.codewreck.net
 
Cheers!

Re: Nodetype documentation (NTDOC)

Posted by Peeter Piegaze <pe...@day.com>.
Sten,

The output looks nice. This will come in handy for me. I look forward
to the contribution.

Cheers,
Peeter

On 8/24/06, Sten R. Sandvik <sr...@enonic.com> wrote:
> Hi all.
>
> I recently wrote about a nodetype documentation tool I had developed and used. As my understanding this could be used by alot of people and seems to be missing as a tool in Jackrabbit. I have found it quite useful to be able to visualize the node types in a more structured "human-readable" form. Therefore I developed ntdoc (node type documentation generator) that creates JavaDoc like pages for node types.
>
> I have not yet had time to structure the code so that it is suitable for contribution to Jackrabbit, but will do in the near future. Hopefully by next week. But in the meantime it is avaliable on my blog here: http://www.codewreck.net
>
> Cheers!
>
>
>

RE: Nodetype documentation (NTDOC)

Posted by "Sten R. Sandvik" <sr...@enonic.com>.
Yes, it will. But it displays a suitable message if not in .cnd or .xml
format now. The reason that it is not displaying an error for .xml is
that it exists a skeleton implementation of the parser, but it does not
do anything right now. 


-----Original Message-----
From: Piyush Purang [mailto:ppurang@gmail.com] 
Sent: 25. august 2006 14:03
To: dev@jackrabbit.apache.org
Subject: Re: Nodetype documentation (NTDOC)

Hmmm... Agreed should have read it completely... But it would be
helpfull if it were to throw a suitable message informing the user
that the feature isn't supported yet, instead of appearing to do
something with the passed xml file.

Re: Nodetype documentation (NTDOC)

Posted by Piyush Purang <pp...@gmail.com>.
Hmmm... Agreed should have read it completely... But it would be
helpfull if it were to throw a suitable message informing the user
that the feature isn't supported yet, instead of appearing to do
something with the passed xml file.

RE: Nodetype documentation (NTDOC)

Posted by "Sten R. Sandvik" <sr...@enonic.com>.
Old style is not done yet. It will be. Only CND is supported at this
point. Read the blog :-)


-----Original Message-----
From: Piyush Purang [mailto:ppurang@gmail.com] 
Sent: 25. august 2006 10:23
To: dev@jackrabbit.apache.org
Subject: Re: Nodetype documentation (NTDOC)

Hi Sten,

Did you test it on an xml defn file? My attempt didn't work.

java -jar ntdoc.jar -d . -t "whatever" customNodeTypes.xml

[INFO] Parsed 0 node type definitions
[INFO] Producing node type documentation to '.'

All that I can say is that it does find my file (If it didn't it
should be more vocal about it.) but fails to read it properly. And I
can assure you that the file has more than one valid nodeType defns
that jackrabbit has had no problem initializing with.

I tried it with the XML NT defns that come with jackrabbit and that
didn't work either.

Sources would have helped diagnosing the problem further..

Cheers
Piyush

Re: Nodetype documentation (NTDOC)

Posted by Piyush Purang <pp...@gmail.com>.
Hi Sten,

Did you test it on an xml defn file? My attempt didn't work.

java -jar ntdoc.jar -d . -t "whatever" customNodeTypes.xml

[INFO] Parsed 0 node type definitions
[INFO] Producing node type documentation to '.'

All that I can say is that it does find my file (If it didn't it
should be more vocal about it.) but fails to read it properly. And I
can assure you that the file has more than one valid nodeType defns
that jackrabbit has had no problem initializing with.

I tried it with the XML NT defns that come with jackrabbit and that
didn't work either.

Sources would have helped diagnosing the problem further..

Cheers
Piyush