Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DDoc] Make symbols in Phobos documentation links to their own fragments #19085

Open
dlangBugzillaToGithub opened this issue Jan 8, 2016 · 1 comment

Comments

@dlangBugzillaToGithub
Copy link

Jakob Ovrum (@JakobOvrum) reported this on 2016-01-08T11:15:53Z

Transferred from https://issues.dlang.org/show_bug.cgi?id=15528

Description

That way they'd be easier to share. Their styling could be much like headers in the specification pages.

I'm not sure this is possible in current DDoc. We have DDOC_ANCHOR but it's a "hook"; the doc generator automatically instantiates it for each symbol. The relevant place to override for this is DDOC_PSYMBOL, which only knows the completely unqualified name of the symbol, which is unsuitable for links.
@dlangBugzillaToGithub
Copy link
Author

jakobovrum commented on 2016-01-08T11:17:21Z

(In reply to Jakob Ovrum from comment #0)
> That way they'd be easier to share. Their styling could be much like headers
> in the specification pages.
> 
> I'm not sure this is possible in current DDoc. We have DDOC_ANCHOR but it's
> a "hook"; the doc generator automatically instantiates it for each symbol.
> The relevant place to override for this is DDOC_PSYMBOL, which only knows
> the completely unqualified name of the symbol, which is unsuitable for links.

I was also thinking we could add something to put the fully qualified name (including packages and module) of the symbol in the alt text or something, which might help improving search engine results.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant