I remembered this thread when I tried to use a link to <a href="http://pre.plt-scheme.org/docs/html/futures/">http://pre.plt-scheme.org/docs/html/futures/</a> and it arrived at <a href="http://pre.racket-lang.org/docs/html/futures/">http://pre.racket-lang.org/docs/html/futures/</a> with a page like this:<br>
<br><br> Page not found<br><br>> (uncaught-exception-handler<br> (*(+(*)(*(+(*)(*)(*)(*)(*))(+(*)(*)(*)(*)(*))(+(*)(*)(*)(*))))(+(*)(*)(*)(*))))<br>uncaught exception: 404<br><br>
<br><br>Is it the 404 page template or really an uncaught exception?<br><br>[]'s<br><br clear="all">Rodolfo Carvalho<br>
<br><br><div class="gmail_quote">On Sat, Jun 9, 2012 at 6:24 PM, Matthew Flatt <span dir="ltr"><<a href="mailto:mflatt@cs.utah.edu" target="_blank">mflatt@cs.utah.edu</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div class="im">At Sat, 09 Jun 2012 16:32:03 -0400, Neil Van Dyke wrote:<br>
> What's the best way to link to the documentation for a symbol in one of<br>
> the Racket manuals?<br>
><br>
> Linking into the latest release public copy of the manuals on<br>
> "<a href="http://doc.racket-lang.org" target="_blank">doc.racket-lang.org</a>", here are three options, none of which seems ideal:<br>
><br>
> 1. This works at the moment, but it's big and ugly, and I don't know<br>
> whether it will still work a few months from now:<br>
><br>
> <a href="http://doc.racket-lang.org/planet/Developing_Packages_for_PLaneT.html?q=can-be-loade" target="_blank">http://doc.racket-lang.org/planet/Developing_Packages_for_PLaneT.html?q=can-be-loade</a><br>
> d-with#%28idx._%28gentag._16._%28lib._planet/planet..scrbl%29%29%29<br>
<br>
</div>As long as the section tag, identifier name, and exporting module name<br>
stay the same, that link is stable (by design, not by accident).<br>
<br>
The section tag looks to be derived from the section title in the above<br>
example. If the section title needs to change for some reason, the old<br>
title can be used for the tag to preserve old references, but that<br>
makes some attention by the document author.<br>
<br>
The original plan included setting up a server to find documentation<br>
for a binding in the same way that DrRacket finds documentation, but I<br>
think we never got to that.<br>
<div class="im"><br>
> 2. This does not jump to "can-be-loaded-with" (the "?q=" query part of<br>
> the URL doesn't seem to be used for anything):<br>
><br>
> <a href="http://doc.racket-lang.org/planet/Developing_Packages_for_PLaneT.html?q=can-be-loade" target="_blank">http://doc.racket-lang.org/planet/Developing_Packages_for_PLaneT.html?q=can-be-loade</a><br>
> d-with<br>
<br>
</div>Right --- doesn't work.<br>
<div class="im"><br>
> 3. The following one works well enough in this particular case, since<br>
> there's only one "can-be-loaded-with", but it's not as good if I want to<br>
> link to something that gives multiple search hits. Nor is it very good<br>
> if I wanted to direct people to a particular discussion, such as in the<br>
> Reference rather than the Guide, or vice versa.<br>
><br>
> <a href="http://doc.racket-lang.org/search/index.html?q=can-be-loaded-with" target="_blank">http://doc.racket-lang.org/search/index.html?q=can-be-loaded-with</a><br>
<br>
</div>Yep.<br>
<div class="im"><br>
> My immediate motivation is for when McFly points users to documentation<br>
> they need to look at, such as if McFly adds a missing problematic<br>
> "can-be-loaded-with" to "info.rkt" (see below). But long-term URLs are<br>
> also good for things like linking to Racket documentation from Web<br>
> sites, printed materials, etc. that might have longevity.<br>
><br>
> ;; TODO: See<br>
> <a href="http://doc.racket-lang.org/search/index.html?q=can-be-loaded-with" target="_blank">http://doc.racket-lang.org/search/index.html?q=can-be-loaded-with</a><br>
> (define can-be-loaded-with 'all)<br>
<br>
</div>So far, we have mostly relied on option 1. The last two Racket blog<br>
posts, for example, include lots of links of that form.<br>
<div class="HOEnZb"><div class="h5"><br>
____________________<br>
Racket Users list:<br>
<a href="http://lists.racket-lang.org/users" target="_blank">http://lists.racket-lang.org/users</a><br>
</div></div></blockquote></div><br>