commit 1ef30a57153c5081f7e06f3f5f68f421430f8af1
parent b2d05d8a2fe0b2146b3cb445e0b08e67fb2c076d
Author: Matthew Flatt <mflatt@racket-lang.org>
Date: Wed, 5 Mar 2014 10:56:03 -0700
scribble/html docs: clarify the effect of 'abs un `url-roots`
original commit: d168e5953d8001d981458e5ebb0ed0b3fc2669b8
Diffstat:
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/html.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/html.scrbl
@@ -454,13 +454,16 @@ for reference. A @racket[#f] value is equivalent to an empty list.
The parameter value is a mapping from path prefixes to URLs (actually,
any string). When two paths have the same prefix, links from one to
the other are relative (unless absolute links are requested); if they
-have different prefixes, the URL will be used instead. The roots of
-all paths are expected to be disjoint (e.g., no @racket["/foo"] and
-@racket["/foo/bar"] roots).
+have different prefixes, the full URL is used. The paths enclosed by
+two root paths must be disjoint (e.g., the list must not include
+both @racket["/colors"] and @racket["/colors/red"], but it can include
+both @racket["/colors/red"] and @racket["/colors/blue"]).
-If an item in the parameter's list includes @racket['abs], then an
-absolute URL is produced for all references to files with the
-corresponding prefix. If an item includes @racket['index], then a
+If an item in the parameter's list includes @racket['abs], then a
+site-local, absolute URL (i.e., a URL that starts with @litchar{/}) is
+produced for references among files within the corresponding prefix.
+
+If an item in the parameter's list includes @racket['index], then a
reference to a directory path is converted to a reference to
@filepath{index.html}, otherwise a reference to @filepath{index.html}
is converted to a directory path.}
