dtddocumentor DtdAnalyzer

[Brian Wong]

Hi,

 

Recently, I downloaded DtdAnalyzer-0.3 for DTD documentation purpose. I have following the instruction to put comments on my DTD file, run dtddocumentor.bat. dtddocumentor generated HTMLs for my DTD generated, however, there is no comments generated.

 

Then I try dtdanalyzer command, I can see the dtdanalyzer generate an XML file with my comments inside. Is it a bug in dtddocumentor ? Or I miss something when I run dtddocumentor? I follow the example from http://ncbitools.github.com/DtdAnalyzer/ to run dtddocumentor. Can anyone give me some suggestion on how to generate HTML documentation for DTD using dtddocumentor ? thanks

 

Brian

 

 

[Maloney, Christopher (NIH/NLM/NCBI) [C]]

Hi, Brian,

It's hard to say what's going wrong without actually seeing the DTD files that you're trying to use.  Could you zip them up and send them?  If you don’t want to send them to the list, just send them to my direct email.

 

Chris Maloney

NIH/NLM/NCBI (Contractor)

Building 45, 5AN.24D-22

301-594-2842

--
You received this message because you are subscribed to the Google Groups "DtdAnalyzer" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dtdanalyzer...@googlegroups.com.
To post to this group, send email to dtdan...@googlegroups.com.
Visit this group at http://groups.google.com/group/dtdanalyzer?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[Maloney, Christopher (NIH/NLM/NCBI) [C]]

Did you figure this out on your own?  If not, and you still want help, just let us know more details so we can try to reproduce the problem.

 

Chris Maloney

NIH/NLM/NCBI (Contractor)

Building 45, 5AN.24D-22

301-594-2842

 

From: Brian Wong [mailto:wong...@gmail.com]
Sent: Tuesday, January 29, 2013 6:27 PM
To: dtdan...@googlegroups.com
Subject: dtddocumentor DtdAnalyzer

 

Hi,

--

[Brian Wong]

Dear Chris,

 

I have been busy with other projects this morning and does not have time to reply on your question, sorry about that.

 

The DTD I have been working on is confidental at the moment and I cannot send the DTD to you, however, I have created a DTD example that has the same problem as the one i am working on, Attached is the DTD + the doc folder created by dtddocumentor.

 

The following is the information on my machine:

 

1) Windows XP SP1

2) DtdAnalyzer-0.3

 

Let me know if you need further information

 

Thanks for helping.

 

Regards,

 

-Brian

[Maloney, Christopher (NIH/NLM/NCBI) [C]]

Hi, Brian,

 

You found a bug.  Bare text (not enclosed in elements) is not getting copied properly by the documentor stylesheet.  I fixed it here:  https://github.com/NCBITools/DtdAnalyzer/commit/7460144791135c99884d0dd4a73b9330d7c5782c.

 

If you want this fix, you could clone and build the repository yourself (it should be easy if you have the JDK installed somewhere) or else wait for our next release.

 

Otherwise, a simple work-around is to always make sure the documentation is wrapped in an HTML element.  Instead of

    <!-- ~~ <act>

    ACT

    ~~ -->

 

Use this:

    <!-- ~~ <act>

    <p>ACT</p>

    ~~ -->

 

Or something similar.

 

Or use Markdown – we usually have markdown turned on, and that’s why we never noticed this before.

[Brian Wong]

Dear Chris,

 

I will try it later. No wonder I cannot have comments all even I follow extactly in the banana example. Thanks for helping.

 

Regards,

 

-Brian

[Maloney, Christopher (NIH/NLM/NCBI) [C]]

Markdown used to be the default, but we changed it, thinking not everyone would have (or would want to install) the Markdown processor pandoc on their systems.  So the examples *used* to work out-of-the-box.  Since changing the default, the documentation and examples are lagging behind a bit.

 

 

Chris Maloney

NIH/NLM/NCBI (Contractor)

Building 45, 5AN.24D-22

301-594-2842

 

--