Updating ddoc to support modern HTML tags

Jakob Ovrum via Digitalmars-d digitalmars-d at puremagic.com
Mon Apr 20 23:39:18 PDT 2015


On Monday, 20 April 2015 at 19:42:43 UTC, Gary Willoughby wrote:
> I've just done a little bit of work on the ddoc documentation 
> and it was brought to my attention that the HTML output of ddoc 
> is actually quite old. Some of the current tags are deprecated. 
> I've raised this as an issue here:
>
> https://issues.dlang.org/show_bug.cgi?id=14473
>
> Before starting on any work however, I thought there should be 
> a discussion on what impact this would have and what tags 
> should be used instead.
>
> Here's a list of the current ddoc symbols (and tag output) that 
> IMHO would need updating:
>
> https://gist.github.com/nomad-software/333cd658ad88090dcb0a
>
> and here are some proposed substitutions:
>
> https://gist.github.com/nomad-software/20d2ab1f7d4c9e55a343
>
> The changes seem quite simple but I'm wondering what knock on 
> effect this would have on anything else? Can you see any 
> problems this might create? Any comments on the new tags used?

It's possible that some of the dlang.org CSS would need to be 
updated too, but I like it. Always irked me to see <b> and such 
everywhere. It's still a long road before we even output correct 
HTML, but this is a nice low-effort (relatively) enhancement.

It would have to be mentioned clearly in the changelog so 
third-party users of DDoc can update their CSS and possibly 
JavaScript (although I don't expect any breakages in practice; 
good practice entails using classes).

> The following files would need updating:
> https://github.com/D-Programming-Language/dmd/blob/master/src/doc.c#L143-L186
> https://github.com/D-Programming-Language/dlang.org/blob/master/ddoc.dd#L687-L720

Also http://dlang.org/ddoc (Section "Predefined Macros")


More information about the Digitalmars-d mailing list