suggestion for improving dcmtk documentation

All other questions regarding DCMTK

Moderator: Moderator Team

Post Reply
Message
Author
boxerab
Posts: 11
Joined: Fri, 2014-02-21, 17:16

suggestion for improving dcmtk documentation

#1 Post by boxerab »

As there are several open source dicom toolkits (dcmtk, gdcm, dcm4che) with different command line conventions, I think it would be very helpful
to have a simple example listed for each dcmtk utility.
I found myself having to google "storescu dcmtk simple example" to start working with the storescu, for example.

Thanks so much,
Aaron

J. Riesmeier
DCMTK Developer
Posts: 2541
Joined: Tue, 2011-05-03, 14:38
Location: Oldenburg, Germany
Contact:

Re: suggestion for improving dcmtk documentation

#2 Post by J. Riesmeier »

I agree and this is what we actually do for all newer command line tools (see "Examples" or "Notes" section in the corresponding man page, e.g. for dcmsend or dcmrecv). There are also more general instructions like in the testing.txt file.

However, our experience is that many users never look into the documentation although it is much better and more comprehensive than many people might think. Even the --help output (syntax usage) is sufficient once you are used to the DCMTK conventions, which are actually described in each man page (see e.g. "Logging", "Command line" and "Environment" sections).

boxerab
Posts: 11
Joined: Fri, 2014-02-21, 17:16

Re: suggestion for improving dcmtk documentation

#3 Post by boxerab »

Thanks, Joerg. So, perhaps just storescu is missing an example.
And yes, other than this little nit-pick, the docs are quite clear and comprehensive..

Aaron

Michael Onken
DCMTK Developer
Posts: 2072
Joined: Fri, 2004-11-05, 13:47
Location: Oldenburg, Germany
Contact:

Re: suggestion for improving dcmtk documentation

#4 Post by Michael Onken »

Hi,

there is also a new DCMTK networking howto that explains how to use dcmqrscp, storescu, echoscu, findscu and movescu together.

Maybe this is also interesting for you.

Best,
Michael

Post Reply

Who is online

Users browsing this forum: Google [Bot] and 1 guest