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

Every page starting with ? points to index. #2270

Closed
jjatria opened this issue Aug 16, 2018 · 4 comments
Closed

Every page starting with ? points to index. #2270

jjatria opened this issue Aug 16, 2018 · 4 comments
Labels
big Issue consisting of many subissues bug Error of some kind, from a typo to errors in the examples. external Depends on another ticket (likely in another repo) meta RFCs, general discussion, writing style, repository organization, etc.

Comments

@jjatria
Copy link
Contributor

jjatria commented Aug 16, 2018

The problem

When browsing the index for routines, the ??? routine links to the same page as ?? !!, which does not appear to actually include any information about what ??? might do. In fact, the ??? string does not appear in the linked page.

Suggestions

These should either link to different pages, or, if they are different flavours of the same, the code example should be expanded to show both cases.

@JJ JJ added docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section labels Aug 17, 2018
@JJ
Copy link
Contributor

JJ commented Aug 20, 2018

In fact, that should point to this page. And both point to the "index" page, which has nothing to do with it...

@JJ JJ changed the title No difference in the documentation for ??? and ?? !! Every page starting with ? points to index. Aug 20, 2018
@JJ JJ added search meta RFCs, general discussion, writing style, repository organization, etc. labels Aug 20, 2018
@JJ
Copy link
Contributor

JJ commented Aug 20, 2018

I think it's a problem in the generation of the index. ? is simply the start of the query section of an URL; anything starting with that points to index.html, which curiously enough we do have in our set of pages. It would return a 404 otherwise.
I'll see what can be done about this. Thanks for the report.

@JJ
Copy link
Contributor

JJ commented Aug 20, 2018

There are also problems with .?. The . is eliminated and also points to index.

@JJ JJ added the bug Error of some kind, from a typo to errors in the examples. label Aug 20, 2018
@JJ
Copy link
Contributor

JJ commented Aug 24, 2018

Finally, I'm closing the PR (thanks to @Altai-man for reviewing it) that kinda patched (or maybe not) this problem.
This problem is related to how indexes (indices, whatever) are generated. The problem is that, for no reason, they are generated on the fly as POD6 and then put it back as HTML. This involves some back-and-forthing of MIME-encoded URLs, in whose steps some stuff is lost.
I think the main intention of this is to generate indices in the same template that the rest of the site. And this pass through pod6 is needed because the template is embedded in the pod-to-html code, as indicated in Raku/Pod-To-HTML#35
So.
I think the best approach is to be able to generate HTML pages directly without the bridge. And in order to to that we need to separate the template from the code, and then use that template to generate pages needed here (or simply create our own template). Then, we can refactor htmlify.p6 #1823 to use this.
So this becomes officially big, and also external. And it's the kind of issue we need to keep having. Thanks, @jjatria for reporting it.

@JJ JJ added external Depends on another ticket (likely in another repo) big Issue consisting of many subissues and removed docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section labels Aug 24, 2018
@JJ JJ closed this as completed in e9f3a9d Sep 1, 2019
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 bug Error of some kind, from a typo to errors in the examples. external Depends on another ticket (likely in another repo) meta RFCs, general discussion, writing style, repository organization, etc.
Projects
None yet
Development

No branches or pull requests

3 participants
@JJ @jjatria and others