Bug 18931 – Additional sections for DDoc

Status
NEW
Severity
enhancement
Priority
P4
Component
dmd
Product
D
Version
D2
Platform
All
OS
All
Creation time
2018-06-01T13:22:57Z
Last change time
2024-12-13T18:59:00Z
Assigned to
No Owner
Creator
Jonathan Wilbur
Moved to GitHub: dmd#17862 →

Comments

Comment #0 by jonathan — 2018-06-01T13:22:57Z
DDoc could use some more sections. My ideas are: * Citations * Definitions * Keywords There should also be macros for AUTHOR, which could conditionally include a name, email, location, GPG keys, website, cryptocurrency wallets, etc.
Comment #1 by issues.dlang — 2018-06-02T03:34:12Z
You _can_ make up your own section names, you know. They just all end up using the DDOC macros DDOC_SECTION and DDOC_SECTION_H, whereas the standard ones get their own macros, so if you want to muck around with how they get formatted by redefining the macros for them, all of the non-standard ones get formatted the same. And if there's something specific that you want to do with the author name, then you can always create your own macro for it. That's the sort of thing that really only matters when you want to affect how it's presented or add only pieces of the information and have the macro fill in the standard bits, and those are really going to be dependent on what you want to be displaying with every author name, and I don't think that you're going to get general agreement on what that should be. Phobos mostly just uses the authors name. At most, a few of use use a normal macro for generating a link and make our names be links to our websites, but not even that is very common. Author names aren't even consistently added. Ultimately, you have to look at the git history to see who did what. So, while I can see a helper macro for author names being useful, it sounds to me like the sort of thing that anyone who wants one is going to need to do themselves for their own project, since what it would entail really depends on their project.
Comment #2 by robert.schadek — 2024-12-13T18:59:00Z
THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/dmd/issues/17862 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB