From d325e037820542d52a508e2174b34ba873e97827 Mon Sep 17 00:00:00 2001 From: Jay McCarthy Date: Tue, 5 Sep 2017 09:42:29 +0100 Subject: [PATCH] Redirect users attention to local vs global documentation search distinction --- pkgs/racket-index/scribblings/main/config.rkt | 9 ++++++++- pkgs/racket-index/scribblings/main/private/search.js | 3 +++ pkgs/racket-index/scribblings/main/search.scrbl | 11 ++++++++++- 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/pkgs/racket-index/scribblings/main/config.rkt b/pkgs/racket-index/scribblings/main/config.rkt index 267561ac60..e4eac8aeea 100644 --- a/pkgs/racket-index/scribblings/main/config.rkt +++ b/pkgs/racket-index/scribblings/main/config.rkt @@ -6,6 +6,13 @@ (define bug-url "http://bugs.racket-lang.org/") +(define rendering-global-manuals? (and (getenv "PLT_PKG_BUILD_SERVICE") #t)) +(define search-manuals-label + (format "Search ~a Manuals" + (if rendering-global-manuals? + "Global" + "Local"))) + ;; Link definitions: (id-sym title root-sym/#f-for-url subpath/url), ;; or a `---' for a spacer; the root-sym can be `plt' for standard ;; pages, or `user' for pages that have an installation and a @@ -14,7 +21,7 @@ ;; where the corresponding document is generated, this is a hack.) (define links `((start "Racket Documentation" user "index.html") - (search "Search Manuals" user "search/index.html") + (search ,search-manuals-label user "search/index.html") --- (license "License" plt "license/index.html") (acks "Acknowledgements" plt "acks/index.html") diff --git a/pkgs/racket-index/scribblings/main/private/search.js b/pkgs/racket-index/scribblings/main/private/search.js index 7443f1b13b..f8df143543 100644 --- a/pkgs/racket-index/scribblings/main/private/search.js +++ b/pkgs/racket-index/scribblings/main/private/search.js @@ -774,6 +774,9 @@ function UpdateResults() { (first_search_result+results_num < search_results.length) ? "black" : "#e0e0e0"; saved_status = false; + + document.getElementById("redo_search_global").innerHTML = + "Click here to repeat your search globally."; } function HandleKeyEvent(event) { diff --git a/pkgs/racket-index/scribblings/main/search.scrbl b/pkgs/racket-index/scribblings/main/search.scrbl index 6492018cd2..6498e75bc4 100644 --- a/pkgs/racket-index/scribblings/main/search.scrbl +++ b/pkgs/racket-index/scribblings/main/search.scrbl @@ -1,6 +1,15 @@ #lang scribble/doc -@(require "private/utils.rkt" "private/make-search.rkt") +@(require scribble/base + scribble/core + scribble/html-properties + "private/utils.rkt" + "private/make-search.rkt" + "config.rkt") @main-page['search #t] +@(if rendering-global-manuals? + @para{You are searching all available Racket packages, including those that you may not have installed locally. Therefore, you may need to install a package to use the results shown below. @hyperlink["http://docs.racket-lang.org/pkg/getting-started.html"]{Getting Started with Packages} guides you through this process. If you want to re-run your search with local results only, press F1 in DrRacket or run @tt{raco docs} on the command line.} + @para{You are searching only your locally installed Racket packages. More results may be available by using the @hyperlink["http://docs.racket-lang.org/search/"]{global search} that inspects all available packages. @elem[#:style (style #f (list (attributes (list (cons 'id "redo_search_global")))))]{You may wish to repeat your search globally.}}) + @make-search[#f]