dtddoc-develop — DTDDoc list oriented for development, bug reports, improvement discussion,...

Re: [Dtddoc-develop] Switching between frames and no frames

[<her...@fr...>]

good idea : done !
see http://dtddoc.sourceforge.net/example.html

Herv=E9

Le jeudi 31 ao=FBt 2006 04:59, Wendy Smoak a =E9crit :
> I often want to link directly to a particular attribute, such as:
>
> http://struts.apache.org/struts-sandbox/tiles/tiles-core/dtddoc/org/apach=
e/
>tiles/resources/tiles-config_1_2.dtd.html#description
>
> Once I do that, there's no way to get back to the framed presentation.
>
> I suggest adding 'Frames' and 'No Frames' links to the top of the
> page, similar to the ones available on Javadoc:
>
> http://struts.apache.org/struts-sandbox/tiles/tiles-core/apidocs/org/apac=
he
>/tiles/taglib/package-summary.html
>
> Even if the 'Frames' link just went back to the main framed index
> page, and not directly to the item you were viewing, that would be
> okay.
>
> Thanks,

[Dtddoc-develop] Switching between frames and no frames

[Wendy S. <ws...@gm...>]

I often want to link directly to a particular attribute, such as:

http://struts.apache.org/struts-sandbox/tiles/tiles-core/dtddoc/org/apache/tiles/resources/tiles-config_1_2.dtd.html#description

Once I do that, there's no way to get back to the framed presentation.

I suggest adding 'Frames' and 'No Frames' links to the top of the
page, similar to the ones available on Javadoc:

http://struts.apache.org/struts-sandbox/tiles/tiles-core/apidocs/org/apache/tiles/taglib/package-summary.html

Even if the 'Frames' link just went back to the main framed index
page, and not directly to the item you were viewing, that would be
okay.

Thanks,
-- 
Wendy

Re: [Dtddoc-develop] DTDDoc Maven2 plugin

[Wendy S. <ws...@gm...>]

On 8/30/06, Herv=E9 BOUTEMY <her...@fr...> wrote:

> I fixed the immediate problem : now the plugin won't die.
...
> Is it ok for you ?

Yes.  With plugin config in the struts-parent pom, I get dtddoc
generated in each module that contains dtds, and no problems at the
project root or in other modules.

> But I couldn't figure out how JXR and javadoc plugin generate the main pa=
ge,
> referencing modules' reports : for the moment, DTDDoc report does not app=
ear
> in the main page. If you know how to make better, I'm interested in any
> pointers...

Sorry, I haven't done any plugin development, so I don't know. :(
The taglibdoc plugin seems most similar to yours, maybe you can find a
hint there.

Thanks,
--=20
Wendy

Re: [Dtddoc-develop] DTDDoc font size

[Wendy S. <ws...@gm...>]

On 8/30/06, Herv=E9 BOUTEMY <her...@fr...> wrote:

> To investigate new values and share together our impressions, I've put on=
line
> a font-size demo : http://dtddoc.sourceforge.net/tmp/font-size/size.html
> After the actual value, I added 2 proposals with simple changes in
> DTDDocStyle.css.
>
> Now I need help from DTDDoc users : what do you think of these proposals =
? Do
> you have other DTDDocStyle.css to propose ?

Of the three (actual, small, medium) I prefer the 'small' one.

The current default is too small, IMO.

--=20
Wendy

[Dtddoc-develop] DTDDoc font size

[<her...@fr...>]

What should be DTDDoc's default font size ? Is it actually too small ?
Such a question is a matter of taste + OS + browser + screen size + ...

To investigate new values and share together our impressions, I've put onli=
ne=20
a font-size demo : http://dtddoc.sourceforge.net/tmp/font-size/size.html
After the actual value, I added 2 proposals with simple changes in=20
DTDDocStyle.css.

Now I need help from DTDDoc users : what do you think of these proposals ? =
Do=20
you have other DTDDocStyle.css to propose ?

Thanks in advance for your feed-back.

Herv=E9

Re: [Dtddoc-develop] DTDDoc Maven2 plugin

[<her...@fr...>]

Le mercredi 30 ao=FBt 2006 08:08, Wendy Smoak a =E9crit :
> On 8/29/06, Wendy Smoak <ws...@gm...> wrote:
> > It works fine in Tiles 2.
Thank you for your test : such a configuration was exactly what was expecte=
d.

>
> ... and then I added it to the struts-parent pom, to see if it would
> aggregate the DTDs for both struts-config and tiles-config or just
> generate them underneath their respective modules.
huh, multi-module and aggregation : this one was not expected at all.

>
> Instead, it died. :( The stack trace is below.  It's complaining
> because there is no src/main/resources under
>   http://svn.apache.org/repos/asf/struts/struts1/trunk
>
> I added a profile to the struts-parent pom with the repositories and
> <reporting> plugin config.  If you want to try it, check out the svn
> URL above, then execute:
>
> $ mvn site -P dtddoc
>
> Let me know if you need more info!  Here's the stack trace:

Thank you Wendy for this precise report : I could reproduce the problem, an=
d=20
better understand what is expected with multi-modules.
I fixed the immediate problem : now the plugin won't die.
But I couldn't figure out how JXR and javadoc plugin generate the main page=
,=20
referencing modules' reports : for the moment, DTDDoc report does not appea=
r=20
in the main page. If you know how to make better, I'm interested in any=20
pointers...

Is it ok for you ?


Herv=E9

Re: [Dtddoc-develop] DTDDoc Maven2 plugin

[Wendy S. <ws...@gm...>]

On 8/29/06, Wendy Smoak <ws...@gm...> wrote:

> It works fine in Tiles 2.

... and then I added it to the struts-parent pom, to see if it would
aggregate the DTDs for both struts-config and tiles-config or just
generate them underneath their respective modules.

Instead, it died. :( The stack trace is below.  It's complaining
because there is no src/main/resources under
  http://svn.apache.org/repos/asf/struts/struts1/trunk

I added a profile to the struts-parent pom with the repositories and
<reporting> plugin config.  If you want to try it, check out the svn
URL above, then execute:

$ mvn site -P dtddoc

Let me know if you need more info!  Here's the stack trace:

[ERROR] FATAL ERROR
[INFO] ------------------------------------------------------------------------
[INFO] basedir e:\svn\struts\current\struts1\src\main\resources does not exist
[INFO] ------------------------------------------------------------------------
[INFO] Trace
java.lang.IllegalStateException: basedir e:\svn\struts\current\struts1\src\main\
resources does not exist
        at org.codehaus.plexus.util.DirectoryScanner.scan(DirectoryScanner.java:
542)
        at org.codehaus.plexus.util.FileUtils.getFileNames(FileUtils.java:1402)
        at org.codehaus.plexus.util.FileUtils.getFileNames(FileUtils.java:1368)
        at org.codehaus.plexus.util.FileUtils.getFiles(FileUtils.java:1340)
        at net.sf.dtddoc.maven2.DTDDocReport.executeReport(DTDDocReport.java:146
)
        at net.sf.dtddoc.maven2.DTDDocReport.generate(DTDDocReport.java:128)
        at org.apache.maven.plugins.site.SiteMojo.generateReportsPages(SiteMojo.
java:802)
        at org.apache.maven.plugins.site.SiteMojo.execute(SiteMojo.java:301)
        at org.apache.maven.plugin.DefaultPluginManager.executeMojo(DefaultPlugi
nManager.java:412)
        at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoals(Defa
ultLifecycleExecutor.java:534)
        at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoalWithLi
fecycle(DefaultLifecycleExecutor.java:475)
        at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoal(Defau
ltLifecycleExecutor.java:454)
        at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoalAndHan
dleFailures(DefaultLifecycleExecutor.java:306)
        at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeTaskSegmen
ts(DefaultLifecycleExecutor.java:273)
        at org.apache.maven.lifecycle.DefaultLifecycleExecutor.execute(DefaultLi
fecycleExecutor.java:140)
        at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:322)
        at org.apache.maven.DefaultMaven.execute(DefaultMaven.java:115)
        at org.apache.maven.cli.MavenCli.main(MavenCli.java:256)
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.
java:39)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAcces
sorImpl.java:25)
        at java.lang.reflect.Method.invoke(Method.java:585)
        at org.codehaus.classworlds.Launcher.launchEnhanced(Launcher.java:315)
        at org.codehaus.classworlds.Launcher.launch(Launcher.java:255)
        at org.codehaus.classworlds.Launcher.mainWithExitCode(Launcher.java:430)

        at org.codehaus.classworlds.Launcher.main(Launcher.java:375)
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 17 seconds
[INFO] Finished at: Tue Aug 29 22:50:59 MST 2006
[INFO] Final Memory: 20M/37M
[INFO] ------------------------------------------------------------------------

-- 
Wendy Smoak

Re: [Dtddoc-develop] DTDDoc Maven2 plugin

[Wendy S. <ws...@gm...>]

On 8/28/06, Herv=E9 BOUTEMY <her...@fr...> wrote:

> A new version of the plugin is available : as suggested by Wendy,
> includes/excludes is supported, and the default sourceDirectory is now
> src/main/resources
>
> see http://dtddoc.sourceforge.net/maven2/dtddoc-mojo.html
>
> It would be nice if somebody could try it and confirm it works as expecte=
d
> before I release a final version on ibiblio central repository and announ=
ce
> it on ann...@ma...

It works fine in Tiles 2.  I removed the <configuration> section and
it picked up the two DTDs from src/main/resources, then I added an
<exclusion> for one of them, and it generated DTDDoc for only the
remaining one.

Thanks!

--=20
Wendy Smoak

[Dtddoc-develop] DTDDoc Maven2 plugin

[<her...@fr...>]

A new version of the plugin is available : as suggested by Wendy,=20
includes/excludes is supported, and the default sourceDirectory is now=20
src/main/resources

see http://dtddoc.sourceforge.net/maven2/dtddoc-mojo.html

It would be nice if somebody could try it and confirm it works as expected=
=20
before I release a final version on ibiblio central repository and announce=
=20
it on ann...@ma...

thx

Herv=E9

Re: [Dtddoc-develop] Where are we ?

[<her...@fr...>]

Le Samedi 5 Ao=FBt 2006 03:51, Wendy Smoak a =E9crit :
> A few questions/comments:
>
> How significantly will we have to change the dtds?  I need to go look
> at your docs again, but I was under the impression we would need to
> change the dtd comments to be more Javadoc-like.
My test was here only to show you that you'd get a first result without=20
changing *anything* to the DTDs : it's like javadoc, at the first level, yo=
u=20
give it your sources without knowing that this tool exists, and it gives yo=
u=20
an intersting first result.
Now, if you want to take advantage of DTDDoc's enhancements to documentatio=
n,=20
yes : just add "@attr" tags for evey attribute in existing comments. Other=
=20
less important tags are there : see http://dtddoc.sf.net/documentation.html.

>
> I think the sourceDirectory should default to src/main/resources and
> find any DTD anywhere under it.  For example, taglib-maven-plugin [1]
> (which generates TLDDoc) defaults to src/main/resources/META-INF and
> any subdirectory.
yes, thanks for the suggestiion : I'll do that.

> Wish: It should support aggregation, so that if there are dtds
> scattered across different modules in the build, it can create one
> dtddoc set at the top level of the website.
for this one, I'll need more time : Maven's multi-module is a strange beast=
 to=20
me. I think I'll add it to a TODO list instead of waiting its resolution=20
before getting a 0.1 version.

>
> Wish: It should also support the notion of <includes>/<excludes> in
> case there are some dtds present in the filesystem that we do not want
> to build dtddoc for.
for this one, it's the major point I knew I had to include before releasing=
=20
0.1.

>
> The default font seems very small, is it easy to change?
Yes, it's in the CSS : for the moment, it is 11px. Perhaps we should just=20
remove the entry... If you have any suggestion, don't hesitate.

>
> Thanks again!  I'm going to add the config to the Tiles 2 project
> which is in the Struts Sandbox.  That gives us a bit more freedom to
> play without affecting a release.
great

>
> [1] http://maven-taglib.sourceforge.net/m2/taglibdoc-mojo.html

regards,

Herv=E9

Re: [Dtddoc-develop] Where are we ?

[Wendy S. <ws...@gm...>]

On 7/29/06, Herv=E9 BOUTEMY <her...@fr...> wrote:

> I made 2 simple tests to see what using DTDDoc for Struts could look like=
 :
...
> Is it what you were waiting for ? Or did you imagine another way of
> integrating DTDDoc ?

Sorry for the delay -- my 'todo list' is miles long.  It looks great--
I had been trying to find the time to do exactly what you did to try
it out. :)

A few questions/comments:

How significantly will we have to change the dtds?  I need to go look
at your docs again, but I was under the impression we would need to
change the dtd comments to be more Javadoc-like.

I think the sourceDirectory should default to src/main/resources and
find any DTD anywhere under it.  For example, taglib-maven-plugin [1]
(which generates TLDDoc) defaults to src/main/resources/META-INF and
any subdirectory.

Although sourceDirectory is marked as optional in the docs, there is
no default value listed, and I didn't get any output until I told it
   <sourceDirectory>src/main/resources</sourceDirectory>
See above, that's what it should default to. :)

Wish: It should support aggregation, so that if there are dtds
scattered across different modules in the build, it can create one
dtddoc set at the top level of the website.

Wish: It should also support the notion of <includes>/<excludes> in
case there are some dtds present in the filesystem that we do not want
to build dtddoc for.

The default font seems very small, is it easy to change?

Thanks again!  I'm going to add the config to the Tiles 2 project
which is in the Struts Sandbox.  That gives us a bit more freedom to
play without affecting a release.

[1] http://maven-taglib.sourceforge.net/m2/taglibdoc-mojo.html

--=20
Wendy

[Dtddoc-develop] Removing useless presentation

[Stefan C. <sch...@sk...>]

Hi,


You actually did some (Davide Griffiths in June 2005, see m-l  
archive) work on removing some of the presentation stuff in DTDDoc.  
As I'm a new daddy, I missed your post in this mailing list. But now  
we've got some more time so would you be so kind as to show us what  
you've done ?

cheers,

stF

Re: [Dtddoc-develop] Where are we ?

[<her...@fr...>]

Hi Wendy,

=46YI, DTDDoc is now in the public repository on ibiblio :=20
http://www.ibiblio.org/maven2/net/sf/dtddoc/DTDDoc/0.0.11/

=46or the moment, maven-dtddoc-plugin is not released : a snapshot is avail=
able=20
in http://dtddoc.sourceforge.net/maven2/


I made 2 simple tests to see what using DTDDoc for Struts could look like :

1. add current maven-dtddoc-plugin snapshot in struts2-core pom.xml, after=
=20
dependencies. The result is there :=20
http://dtddoc.sourceforge.net/tmp/struts2-core/maven-reports.html
(corresponding pom is there : http://dtddoc.sourceforge.net/tmp/pom.xml)


2. I took every DTD in http://struts.apache.org/dtds/ and used DTDDoc 0.0.1=
1=20
ant task to generate the doc. The result is there :
http://dtddoc.sourceforge.net/tmp/dtds/


Is it what you were waiting for ? Or did you imagine another way of=20
integrating DTDDoc ?


Herv=E9

Le Lundi 24 Juillet 2006 07:02, Wendy Smoak a =E9crit :
> On 7/23/06, Herv=E9 BOUTEMY <her...@fr...> wrote:
> > Nothing important has changed, because the tool works great and I had no
> > new feature to add, just minor enhancements.
> > I started to work on Maven 1 plugin and Maven 2 plugin, but nothing is
> > finished yet : is there really a user need ?
>
> Hi there!  Yes, I'd like to use DTDDoc as part of Struts' Maven 2
> build, so that DTD documentation could be part of the generated
> website.
>
> We're using LiveDTD right now.  I chose it because neither LiveDTD nor
> DTDDoc had a Maven 2 plugin, and LiveDTD worked with the existing dtd
> while (as I understand it) the comments would need to be modified to
> work with DTDDoc.  The dtds are here: http://struts.apache.org/dtds/
>
> If you put DTDDoc in the public repository on ibiblio, release a Maven
> 2 plugin and announce it on the Maven user list, you're likely to pick
> up at least a couple of new users. ;)
>
> Thanks!

Re: [Dtddoc-develop] Where are we ?

[Stefan C. <sch...@sk...>]

I cut some pieces of the previous mail...

>> If you put DTDDoc in the public repository on ibiblio, release a =20
>> Maven
>> 2 plugin and announce it on the Maven user list, you're likely to =20
>> pick
>> up at least a couple of new users. ;)
>>
>> Thanks!
>
> ok, ok, I'll work again on it :)

Hey hey hey, open source is a drug :) I'll make the logging part.

Let me insist again : if we want DTDDoc to be used in a project such =20
as struts, I will make sure the quality is "built in".

>
> I opened JIRA MAVENUPLOAD-1011 and MAVENUPLOAD-1012 to have DTDDoc =20
> itself on
> ibiblio

I'll look at that.

>
> then I published a snapshot dtddoc-maven-plugin on
> http://dtddoc.sourceforge.net/maven2/, with its dependencies.

I'll look at this during the week-end most probably.

>
> If your can try it and give me your impressions, that would help me.
> To be able to use the temporary dtddoc repository , you'll need to =20
> add it in
> your setting.xml :

This is beyond me for the moment. I'll check with some friends down =20
here to understand that !

stF

>   <profiles>
>     <profile>
>     <activation><activeByDefault>true</activeByDefault></activation>
>     <repositories>
>       <repository>
>         <id>dtddoc</id>
>         <url>http://dtddoc.sf.net/maven2</url>
>       </repository>
>     </repositories>
>     <pluginRepositories>
>       <pluginRepository>
>         <id>dtddoc</id>
>         <url>http://dtddoc.sf.net/maven2</url>
>       </pluginRepository>
>     </pluginRepositories>
>   </profile>
>   </profiles>
>
> regards
>
> Herv=E9

Re: [Dtddoc-develop] Correct form of doc comments?

[Stefan C. <sch...@sk...>]

>> To me, "<!---" is a bug in Netbeans.
>> Now, if you think it would be useful to distinguish normal DTD =20
>> comment from
>> DTDDoc comments (just like javadoc doesn't render basic comments), =20=

>> perhaps we
>> can add it to DTDDoc's feature list, as an Ant task option
>
> Whatever you think best, I guess.  I didn't find it unexpected for =20
> the doc comments to be different to the ordinary ones since that's =20
> what I was used to from javadoc.  On the other hand, if you don't =20
> want to change it I can just as easily raise a bug report with =20
> Netbeans.

Dunno exactly if a bug submission to NetBean would solve anything... =20
I guess we're more agile.

>
>> (name to find : if
>> you have an idea of a meaningful name...).
>
> Hmm...  docCommentDelimiters=3D"true", perhaps?

docCommentDelimiter=3D"triple-hyphen" or "none"

I suggest this because "true" makes sense only if you know the =20
meaning behind "docCommentDelimiter". IMHO, my suggestion is more =20
readable for someone who doesn't RTFM...

Does this make sense ?

stF



>
>
> Andrew.
>
>>
>> Herv=E9
>>
>> Le Vendredi 14 Juillet 2006 11:56, Andrew Stevens a =E9crit :
>> > I stumbled across DTDDoc because a DTD I generated in Netbeans =20
>> (from an
>> > existing XML document) contained a whole load of comments which =20
>> read
>> > <!--- Put your DTDDoc comment here. -->
>> > by each element or attribute declaration.  Nice tool :-)
>> >
>> > However, I noticed that the generated docs all have a leading =20
>> "-", which I
>> > assume is because the comments Netbeans generated use =20
>> "<!---" (in the same
>> > way that javadoc comments use "/**" rather than just "/*") and =20
>> DTDDoc is
>> > expecting just "<!--".  So I'm wondering whether this has always =20=

>> been the
>> > case, or the Netbeans module is simply doing it wrong, or if =20
>> I've found the
>> > wrong tool and there's another DTDDoc that expects the other form?
>> >
>> >
>> > Andrew.
>
>
>
> ----------------------------------------------------------------------=20=

> ---
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to =20
> share your
> opinions on IT & business topics through brief surveys -- and earn =20
> cash
> http://www.techsay.com/default.php?=20
> page=3Djoin.php&p=3Dsourceforge&CID=3DDEVDEV____________________________=
____=20
> _______________
> Dtddoc-develop mailing list
> Dtd...@li...
> https://lists.sourceforge.net/lists/listinfo/dtddoc-develop

Re: [Dtddoc-develop] Where are we ?

[Stefan C. <sch...@sk...>]

> Nothing important has changed, because the tool works great and I  
> had no new
> feature to add, just minor enhancements.

okay.

> I started to work on Maven 1 plugin and Maven 2 plugin, but nothing is
> finished yet : is there really a user need ?

Look at the mail of Wendy Smoak !

Now, as another step toward Maven "pluginification", I started to  
replace all the "println" from the code by an appropriate logging  
mechanism. I'll try to abstract the Ant, Maven and command line into  
something close to the usual logging stuff; actually the very minimum  
to get those three environments to work. I also bring several  
improvements on the overall "error reporting" (usual stuff : who's  
raising exceptions, who's catching them)

Next, I think we'll have to develop a Maven plugin but I've no  
experience with Maven. From what I've seen of the API I can develop  
but since I don't have any experience with Maven, I can hardly make  
sure my code is actually "maven" compliant. A code review would be  
much appreciated here (or better, someone else does it :))

Besides, it's very funny to look at code that one has written a year  
ago ! The comments are rather good so far but the testing side is  
completely missing. So it's a 50% success. If I have enough time,  
I'll address that as well...

stF

Re: [Dtddoc-develop] Where are we ?

[<her...@fr...>]

Le Lundi 24 Juillet 2006 07:02, Wendy Smoak a =E9crit :
> On 7/23/06, Herv=E9 BOUTEMY <her...@fr...> wrote:
> > Nothing important has changed, because the tool works great and I had no
> > new feature to add, just minor enhancements.
> > I started to work on Maven 1 plugin and Maven 2 plugin, but nothing is
> > finished yet : is there really a user need ?
>
> Hi there!  Yes, I'd like to use DTDDoc as part of Struts' Maven 2
> build, so that DTD documentation could be part of the generated
> website.
>
> We're using LiveDTD right now.  I chose it because neither LiveDTD nor
> DTDDoc had a Maven 2 plugin, and LiveDTD worked with the existing dtd
> while (as I understand it) the comments would need to be modified to
> work with DTDDoc.  The dtds are here: http://struts.apache.org/dtds/
>
> If you put DTDDoc in the public repository on ibiblio, release a Maven
> 2 plugin and announce it on the Maven user list, you're likely to pick
> up at least a couple of new users. ;)
>
> Thanks!

ok, ok, I'll work again on it :)

I opened JIRA MAVENUPLOAD-1011 and MAVENUPLOAD-1012 to have DTDDoc itself o=
n=20
ibiblio

then I published a snapshot dtddoc-maven-plugin on=20
http://dtddoc.sourceforge.net/maven2/, with its dependencies.

If your can try it and give me your impressions, that would help me.
To be able to use the temporary dtddoc repository , you'll need to add it i=
n=20
your setting.xml :
  <profiles>
    <profile>
    <activation><activeByDefault>true</activeByDefault></activation>
    <repositories>
      <repository>
        <id>dtddoc</id>
        <url>http://dtddoc.sf.net/maven2</url>
      </repository>
    </repositories>
    <pluginRepositories>
      <pluginRepository>
        <id>dtddoc</id>
        <url>http://dtddoc.sf.net/maven2</url>
      </pluginRepository>
    </pluginRepositories>
  </profile>
  </profiles>

regards

Herv=E9

Re: [Dtddoc-develop] Correct form of doc comments?

[Andrew S. <at...@ho...>]

>From: Hervé BOUTEMY <her...@fr...>
>Date: Sun, 16 Jul 2006 12:50:46 +0200
>
>Hi Andrew,
>
>I personnaly don't know af another tool named DTDDoc.
>
>I had a look at CVS's history : it was so at the initial revision, on May 
>25
>2002 :
>http://dtddoc.cvs.sourceforge.net/dtddoc/DTDDoc/example/common_figure.dtd?hideattic=0&revision=1.1&view=markup
>
>I think the idea was that even before DTDDoc existed, people were smart 
>enough
>to comment their DTDs : raw information was here, waiting for DTDDoc to
>publish it ! :)
>That's only later that @xxx conventions "à la javadoc" were added : asking 
>for
>an extra "-" like the extra "*" from javadoc would have lead to loose all
>these free comments.
>
>To me, "<!---" is a bug in Netbeans.
>Now, if you think it would be useful to distinguish normal DTD comment from
>DTDDoc comments (just like javadoc doesn't render basic comments), perhaps 
>we
>can add it to DTDDoc's feature list, as an Ant task option

Whatever you think best, I guess.  I didn't find it unexpected for the doc 
comments to be different to the ordinary ones since that's what I was used 
to from javadoc.  On the other hand, if you don't want to change it I can 
just as easily raise a bug report with Netbeans.

>(name to find : if
>you have an idea of a meaningful name...).

Hmm...  docCommentDelimiters="true", perhaps?


Andrew.

>
>Hervé
>
>Le Vendredi 14 Juillet 2006 11:56, Andrew Stevens a écrit :
> > I stumbled across DTDDoc because a DTD I generated in Netbeans (from an
> > existing XML document) contained a whole load of comments which read
> > <!--- Put your DTDDoc comment here. -->
> > by each element or attribute declaration.  Nice tool :-)
> >
> > However, I noticed that the generated docs all have a leading "-", which 
>I
> > assume is because the comments Netbeans generated use "<!---" (in the 
>same
> > way that javadoc comments use "/**" rather than just "/*") and DTDDoc is
> > expecting just "<!--".  So I'm wondering whether this has always been 
>the
> > case, or the Netbeans module is simply doing it wrong, or if I've found 
>the
> > wrong tool and there's another DTDDoc that expects the other form?
> >
> >
> > Andrew.

Re: [Dtddoc-develop] Where are we ?

[Wendy S. <ws...@gm...>]

On 7/23/06, Herv=E9 BOUTEMY <her...@fr...> wrote:

> Nothing important has changed, because the tool works great and I had no =
new
> feature to add, just minor enhancements.
> I started to work on Maven 1 plugin and Maven 2 plugin, but nothing is
> finished yet : is there really a user need ?

Hi there!  Yes, I'd like to use DTDDoc as part of Struts' Maven 2
build, so that DTD documentation could be part of the generated
website.

We're using LiveDTD right now.  I chose it because neither LiveDTD nor
DTDDoc had a Maven 2 plugin, and LiveDTD worked with the existing dtd
while (as I understand it) the comments would need to be modified to
work with DTDDoc.  The dtds are here: http://struts.apache.org/dtds/

If you put DTDDoc in the public repository on ibiblio, release a Maven
2 plugin and announce it on the Maven user list, you're likely to pick
up at least a couple of new users. ;)

Thanks!
--=20
Wendy Smoak
Struts | MyFaces | Shale

Re: [Dtddoc-develop] Where are we ?

[<her...@fr...>]

Hi Stephan,

You can look at StatCVS report, generated with Maven :
http://dtddoc.sourceforge.net/mavendoc/statcvs/author_hboutemy.html

Nothing important has changed, because the tool works great and I had no ne=
w=20
feature to add, just minor enhancements.
I started to work on Maven 1 plugin and Maven 2 plugin, but nothing is=20
finished yet : is there really a user need ?

Welcome back to the project.

Herv=E9

Le Samedi 22 Juillet 2006 21:39, Stefan Champailler a =E9crit :
> (Herv=E9, this one is for you)
>
> Well, you may find this quite funny but could someone tell me what's
> been going on on the CVS version of DTDDoc so far ? I've just
> downloaded the whole thing (guess it's been a year or so since I've
> hacked this thing) and I wonder what's new.
>
> Looks like my baby's now flying on its own...
>
> So Herv=E9 ? What the hell did you add in there ? :)
>
> Now, why am I all of a sudden looking inside the beast again ?
> Because it may be possible that DTDDoc would be used by the Strut
> project to document. Therefore I think I can put more junk in the
> trunk so that there's another version that would please the strut
> team (now call me a slave :))
>
> (and besides, I do have some spare time now since 1) I've got 2 hours
> of train everyday to get to and back from my job and 2) I've got a
> brand new iBook G4 to use there)
>
>
> stF
> -------------------------------------------------------------------------
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to share
> your opinions on IT & business topics through brief surveys -- and earn
> cash
> http://www.techsay.com/default.php?page=3Djoin.php&p=3Dsourceforge&CID=3D=
DEVDEV
> _______________________________________________
> Dtddoc-develop mailing list
> Dtd...@li...
> https://lists.sourceforge.net/lists/listinfo/dtddoc-develop

[Dtddoc-develop] Where are we ?

[Stefan C. <sch...@sk...>]

(Herv=E9, this one is for you)

Well, you may find this quite funny but could someone tell me what's =20
been going on on the CVS version of DTDDoc so far ? I've just =20
downloaded the whole thing (guess it's been a year or so since I've =20
hacked this thing) and I wonder what's new.

Looks like my baby's now flying on its own...

So Herv=E9 ? What the hell did you add in there ? :)

Now, why am I all of a sudden looking inside the beast again ? =20
Because it may be possible that DTDDoc would be used by the Strut =20
project to document. Therefore I think I can put more junk in the =20
trunk so that there's another version that would please the strut =20
team (now call me a slave :))

(and besides, I do have some spare time now since 1) I've got 2 hours =20=

of train everyday to get to and back from my job and 2) I've got a =20
brand new iBook G4 to use there)


stF=

Re: [Dtddoc-develop] Correct form of doc comments?

[Stefan C. <sch...@sk...>]

Hi Andrew,

> I stumbled across DTDDoc because a DTD I generated in Netbeans =20
> (from an
> existing XML document) contained a whole load of comments which read
> <!--- Put your DTDDoc comment here. -->
> by each element or attribute declaration.  Nice tool :-)
>
> However, I noticed that the generated docs all have a leading "-", =20
> which I
> assume is because the comments Netbeans generated use "<!---" (in =20
> the same
> way that javadoc comments use "/**" rather than just "/*") and =20
> DTDDoc is
> expecting just "<!--".  So I'm wondering whether this has always =20
> been the
> case, or the Netbeans module is simply doing it wrong, or if I've =20
> found the
> wrong tool and there's another DTDDoc that expects the other form?

I don't think netbeans does it wrong (although I've never used that =20
tool). As far as I'm concerned, when I designed DTDDoc I just decided =20=

to have regular comments used. But now, I do realise that this is an =20
issue. Indeed one cannot mix non DTDDoc comments with DTDDoc comments.

Hmmmm... Well, I'll look into it if I get a chance but this is going =20
to take some time because well, my "real life" is just =20
waaaaaaaaaaaaaaaaay too busy nowadays. And moreover I've now moved to =20=

MacOSX so i have to set up my development environment again. I'll =20
keep you informed.

Now we can think about the correct way of doing that. One could say =20
that DTDDoc should understand only triple "-" or only double "-". =20
That's maybe the best to do as it retains backwards compatibility =20
(with DTDDoc). It wouldn't be much work to do.

And of course, we should make it an Ant option (and a command line =20
option) as Herv=E9 puts it.

Anyway, thank you for passing by.

stF

Re: [Dtddoc-develop] Correct form of doc comments?

[Stefan C. <sch...@sk...>]

Le 16-juil.-06 =E0 12:50, Herv=E9 BOUTEMY a =E9crit :

> Hi Andrew,
>
> I personnaly don't know af another tool named DTDDoc.

There are some, just google.

>
> I had a look at CVS's history : it was so at the initial revision, =20
> on May 25
> 2002 :

Damn it's already 4 years old !

>
> I think the idea was that even before DTDDoc existed, people were =20
> smart enough
> to comment their DTDs : raw information was here, waiting for =20
> DTDDoc to
> publish it ! :)

So I conclude I was a smart guy :)

> That's only later that @xxx conventions "=E0 la javadoc" were added : =20=

> asking for
> an extra "-" like the extra "*" from javadoc would have lead to =20
> loose all
> these free comments.

Not sure I get it.

>
> To me, "<!---" is a bug in Netbeans.

I'd say a design decision.

> Now, if you think it would be useful to distinguish normal DTD =20
> comment from
> DTDDoc comments (just like javadoc doesn't render basic comments), =20
> perhaps we
> can add it to DTDDoc's feature list, as an Ant task option (name to =20=

> find : if
> you have an idea of a meaningful name...).

I definitely consider this suggestion worth the effort.

>
> Herv=E9
>
> Le Vendredi 14 Juillet 2006 11:56, Andrew Stevens a =E9crit :
>> I stumbled across DTDDoc because a DTD I generated in Netbeans =20
>> (from an
>> existing XML document) contained a whole load of comments which read
>> <!--- Put your DTDDoc comment here. -->
>> by each element or attribute declaration.  Nice tool :-)
>>
>> However, I noticed that the generated docs all have a leading "-", =20=

>> which I
>> assume is because the comments Netbeans generated use "<!---" (in =20
>> the same
>> way that javadoc comments use "/**" rather than just "/*") and =20
>> DTDDoc is
>> expecting just "<!--".  So I'm wondering whether this has always =20
>> been the
>> case, or the Netbeans module is simply doing it wrong, or if I've =20
>> found the
>> wrong tool and there's another DTDDoc that expects the other form?
>>
>>
>> Andrew.

Re: [Dtddoc-develop] Correct form of doc comments?

[<her...@fr...>]

Hi Andrew,

I personnaly don't know af another tool named DTDDoc.

I had a look at CVS's history : it was so at the initial revision, on May 2=
5=20
2002 :
http://dtddoc.cvs.sourceforge.net/dtddoc/DTDDoc/example/common_figure.dtd?h=
ideattic=3D0&revision=3D1.1&view=3Dmarkup

I think the idea was that even before DTDDoc existed, people were smart eno=
ugh=20
to comment their DTDs : raw information was here, waiting for DTDDoc to=20
publish it ! :)
That's only later that @xxx conventions "=E0 la javadoc" were added : askin=
g for=20
an extra "-" like the extra "*" from javadoc would have lead to loose all=20
these free comments.


To me, "<!---" is a bug in Netbeans.
Now, if you think it would be useful to distinguish normal DTD comment from=
=20
DTDDoc comments (just like javadoc doesn't render basic comments), perhaps =
we=20
can add it to DTDDoc's feature list, as an Ant task option (name to find : =
if=20
you have an idea of a meaningful name...).

Herv=E9

Le Vendredi 14 Juillet 2006 11:56, Andrew Stevens a =E9crit :
> I stumbled across DTDDoc because a DTD I generated in Netbeans (from an
> existing XML document) contained a whole load of comments which read
> <!--- Put your DTDDoc comment here. -->
> by each element or attribute declaration.  Nice tool :-)
>
> However, I noticed that the generated docs all have a leading "-", which I
> assume is because the comments Netbeans generated use "<!---" (in the same
> way that javadoc comments use "/**" rather than just "/*") and DTDDoc is
> expecting just "<!--".  So I'm wondering whether this has always been the
> case, or the Netbeans module is simply doing it wrong, or if I've found t=
he
> wrong tool and there's another DTDDoc that expects the other form?
>
>
> Andrew.
>
>
>
>
> -------------------------------------------------------------------------
> Using Tomcat but need to do more? Need to support web services, security?
> Get stuff done quickly with pre-integrated technology to make your job
> easier Download IBM WebSphere Application Server v.1.0.1 based on Apache
> Geronimo
> http://sel.as-us.falkag.net/sel?cmd=3Dlnk&kid=3D120709&bid=3D263057&dat=
=3D121642
> _______________________________________________
> Dtddoc-develop mailing list
> Dtd...@li...
> https://lists.sourceforge.net/lists/listinfo/dtddoc-develop

[Dtddoc-develop] Correct form of doc comments?

[Andrew S. <at...@ho...>]

I stumbled across DTDDoc because a DTD I generated in Netbeans (from an 
existing XML document) contained a whole load of comments which read
<!--- Put your DTDDoc comment here. -->
by each element or attribute declaration.  Nice tool :-)

However, I noticed that the generated docs all have a leading "-", which I 
assume is because the comments Netbeans generated use "<!---" (in the same 
way that javadoc comments use "/**" rather than just "/*") and DTDDoc is 
expecting just "<!--".  So I'm wondering whether this has always been the 
case, or the Netbeans module is simply doing it wrong, or if I've found the 
wrong tool and there's another DTDDoc that expects the other form?


Andrew.