The new version of Ddoc should be flexible enough that people can write config.ddoc files to cause it to generate XHTML, style sheet based HTML, or XML output.

I'd love to see what people can come up with, so it can be incorporated as part of the D distribution.

There's also room for wild/creative files to do things like render D documentation in Star Trek fonts, etc!

www.digitalmars.com/d/ddoc.html

"Walter Bright" <newshound@digitalmars.com> wrote in message news:dh4s2m$vhb$2@digitaldaemon.com...
> The new version of Ddoc should be flexible enough that people can write
> config.ddoc files to cause it to generate XHTML, style sheet based HTML,
> or
> XML output.
>
> I'd love to see what people can come up with, so it can be incorporated as part of the D distribution.
>
> There's also room for wild/creative files to do things like render D documentation in Star Trek fonts, etc!
>
> www.digitalmars.com/d/ddoc.html

Awesome, totally awesome.  This will make documentation so much easier for my project, especially since now it can be set up to ouput custom-formatted docs.

However, there seems to be one major problem.  Specifying a ddoc file on the commandline or setting it as the DDOCFILE in sc.ini crashes DMD.  I'm not entirely sure if there's some special format I'm supposed to use, though, as I just copied the contents of the "Predefined Macros" section of the DDoc docs into a file.  Are there certain macros I shouldn't be overloading, or is there some special format I should use for the ddoc files?

"Jarrett Billingsley" <kb3ctd2@yahoo.com> wrote in message news:dh54r1$16mp$1@digitaldaemon.com...

Figured I might as well post the file, in case you want to test.

Thanks for implementing these changes.  Now, the documentation output is considerably more flexible.

First, I have a few minor comments I found while making an XHTML config.ddoc:

If there's no newline at the end of config.ddoc, garbage is output at
the end of the file.
There are no spaces after the commas in parameter lists, which looks
strange (and there's a space before the comma too.)  Perhaps this is my
fault?
It'd be very nice if there were a way to run the output automatically
through another program (I'm thinking tidy, which cleans up/formats
HTML) but I suppose that'd be cruft.

Attached is a config.ddoc file which should (afaict) always generate
valid XHTML 1.0 Transitional (and 1.0 Strict, and 1.1, for that matter.)
  It should also look fine in all commonly used browsers (Netscape 6+,
IE 4+, Opera 6+, Safari, etc.)

-[Unknown]


> The new version of Ddoc should be flexible enough that people can write config.ddoc files to cause it to generate XHTML, style sheet based HTML, or XML output.

You need a newline at the end of the file, at least as far as I can tell.

-[Unknown]


> "Jarrett Billingsley" <kb3ctd2@yahoo.com> wrote in message news:dh54r1$16mp$1@digitaldaemon.com...
> 
> Figured I might as well post the file, in case you want to test. 
> 
> 

I think the problem is the file must end in a \n.

"Walter Bright" <newshound@digitalmars.com> wrote in message news:dh5b30$1bvr$1@digitaldaemon.com...
>
> I think the problem is the file must end in a \n.

That's it.  Though you might want to fix that ;)

Found a new bug though.  If you try to put an embedded code section in a Params section with at least one parameter before it, such as

 Params:
  args = The list of arguments passed to the program on the command line or
    by the OS.  The first argument is always the name of the program.

 -----------
 void
 -----------

The compiler crashes with an assertion error at line 1306 of doc.c.  There is no crash if the code block is in any other kind of section or if it comes before the parameters.

Lastly, what is the DDOC_KEYWORD style for?  It doesn't seem to be applied to any keywords, even in embedded code blocks.  Is it just there for future expansion?

"Jarrett Billingsley" <kb3ctd2@yahoo.com> wrote in message news:dh6ij4$2d0b$1@digitaldaemon.com...
> Lastly, what is the DDOC_KEYWORD style for?  It doesn't seem to be applied to any keywords, even in embedded code blocks.  Is it just there for
future
> expansion?

Right now, it only applies to null, true and false.

Walter Bright wrote:
> The new version of Ddoc should be flexible enough that people can write
> config.ddoc files to cause it to generate XHTML, style sheet based HTML, or
> XML output.
> 
> I'd love to see what people can come up with, so it can be incorporated as
> part of the D distribution.
> 
> There's also room for wild/creative files to do things like render D
> documentation in Star Trek fonts, etc!
> 
> www.digitalmars.com/d/ddoc.html

If there is someone interested in making PDF documentation, i could use my XML/XSLT experience from the ddocwiki (http://www.quit-clan.de/docwiki/) to create XML output plus some stylesheet for XML-FO. Generating XML would be useful anyways, we could even compile CHMs from it...

I'm asking because it wouldn't be worth the effort if nobody will use it...

"Markus Dangl" <danglm@in.tum.de> wrote in message news:dh6th2$2kvo$1@digitaldaemon.com...
> If there is someone interested in making PDF documentation, i could use my XML/XSLT experience from the ddocwiki (http://www.quit-clan.de/docwiki/) to create XML output plus some stylesheet for XML-FO. Generating XML would be useful anyways, we could even compile CHMs from it...
>
> I'm asking because it wouldn't be worth the effort if nobody will use
it...

I think it's worth doing. I want to include files in the D distribution so people can create XHTML, XML, CHM, RTF, PDF, Latex, Postscript, etc. with Ddoc. I generally subscribe to "build it, and they will come!"

Also, I want to know if there are any technical obstacles preventing this from working, so Ddoc can be fixed. The only way to find that out is to try it.