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

“::” in links is replaced with $COLON$COLON, this is too verbose #698

Closed
AlexDaniel opened this issue Jul 14, 2016 · 8 comments
Closed
Labels
big Issue consisting of many subissues

Comments

@AlexDaniel
Copy link
Member

For example: https://docs.perl6.org/type/IO$COLON$COLONSocket$COLON$COLONINET

This makes the link completely unreadable. Maybe we can replace :: with just -? That's what cpan does.

Or, since we are not using windows to host perl.org, maybe we can detect the OS and allow some extra characters?

@gfldex
Copy link
Contributor

gfldex commented Jul 14, 2016

infix:<:> would become infix:<-> (actually it would be /routine/-.html) what would clash with infix:<-> (what is /routine/-.html). If we replace it with something else, we have to use a char that is not used in any operator name.

We may not be hosting on windows but somebody might want to put the files on a usbstick. What still doesn't work because there is WHAT.html and what.html.

@titsuki
Copy link
Member

titsuki commented Jul 14, 2016

If we can use zenkaku character I think this is a little bit more readable than $COLON.

For example

https://docs.perl6.org/type/IO::Socket::INET

@zoffixznet
Copy link
Contributor

zoffixznet commented Jul 14, 2016

This also breaks the symmetry we have that you can visit https://docs.perl6.org/type/TYPENAME and get docs for that type. I frequently do it by hand in the browser, but I see some tools are broken too:

<Frameless> huggable: IO::Path
<huggable> Frameless, File or directory path: https://docs.perl6.org/type/IO::Path

A bit of out-of-box thinking... what if we throw in a web app to serve the docs? That'd make the filenames we generate much more flexible. Or we can generate Rewrite rules in .htaccess to cater sanely-named files from fancy-pants URLs?

@gfldex
Copy link
Contributor

gfldex commented Jul 14, 2016

The Rewrite rule should work nicely. There is a complete list of links under https://docs.perl6.org/links.txt to test against.

@zoffixznet
Copy link
Contributor

I commited a rule that makes https://docs.perl6.org/type/IO::Path URLs work. So the concern I raised above is solved.

Not sure about the OP. The Rewrite doesn't change the generated URLs in the actual document. Not sure if that's a problem.

@AlexDaniel
Copy link
Member Author

@zoffixznet it is. https://docs.perl6.org/type/X$COLON$COLONProc$COLON$COLONAsync looks horrifying.

@coke coke added the big Issue consisting of many subissues label Dec 12, 2016
@tisonkun
Copy link
Member

tisonkun commented Nov 8, 2017

@AlexDaniel Seems like it's fixed

@AlexDaniel
Copy link
Member Author

I don't know what fixed it but you're right.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
big Issue consisting of many subissues
Projects
None yet
Development

No branches or pull requests

6 participants