Skip to content

Commit b7f361e

Browse files
committed
update for 'long-key index entry configuration
1 parent 3cc4644 commit b7f361e

File tree

4 files changed

+16
-6
lines changed

4 files changed

+16
-6
lines changed

scribble-doc/scribblings/scribble/base.scrbl

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
(syntax-rules ()
1010
[(_ id result/c x ...)
1111
(defproc (id [#:tag tag (or/c #f string? (listof string?)) #f]
12-
[#:tag-prefix tag-prefix (or/c #f string? module-path?) #f]
12+
[#:tag-prefix tag-prefix (or/c #f string? module-path? hash?) #f]
1313
[#:style style (or/c style? #f string? symbol? (listof symbol?)) #f]
1414
[pre-content pre-content?] (... ...+))
1515
result/c
@@ -63,7 +63,7 @@ have @racketmodname[scribble/manual]).
6363
@section{Document Structure}
6464

6565
@defproc[(title [#:tag tag (or/c #f string? (listof string?)) #f]
66-
[#:tag-prefix tag-prefix (or/c #f string? module-path?) #f]
66+
[#:tag-prefix tag-prefix (or/c #f string? module-path? hash?) #f]
6767
[#:style style (or/c style? #f string? symbol? (listof symbol?)) #f]
6868
[#:version vers (or/c string? #f) #f]
6969
[#:date date (or/c string? #f) #f]
@@ -88,7 +88,10 @@ multi-page HTML output.
8888
The @racket[tag-prefix] argument is propagated to the generated
8989
structure (see @secref["tags"]). If @racket[tag-prefix] is a module
9090
path, it is converted to a string using
91-
@racket[module-path-prefix->string].
91+
@racket[module-path-prefix->string]. Similarly, if @racket[tag-prefix]
92+
is a hash table with @racket['tag-prefix] mapped to a module path,
93+
then it is replaced with a hash table where @racket['tag-prefix] is
94+
mapped to a string.
9295

9396
The @racket[vers] argument is propagated to the @racket[title-decl]
9497
structure. Use @racket[""] as @racket[vers] to suppress version

scribble-doc/scribblings/scribble/manual.scrbl

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2349,6 +2349,7 @@ exhaustive, because new modules can re-export the binding).}
23492349
[(method-name) symbol?]
23502350
[(constructor?) boolean?]
23512351
[(class-tag) tag?]
2352+
[(long-key) string?]
23522353
[else any/c])]
23532354
#:immutable #t))])]{
23542355

@@ -2375,12 +2376,17 @@ Some additional keys are well-known:
23752376
in the case of a method or constructor index entry, where the
23762377
@racket[name] field has the class name in both cases.}
23772378

2379+
@item{@racket['long-key]: An alternative string for searches to match.
2380+
This string is useful when the name that is normally used to refer to
2381+
a binding has an extra prefix that is added on import, for example.}
2382+
23782383
]
23792384

23802385
The @racket[exported-index-desc*] struct is preferable over
23812386
other index entry descriptions below.
23822387

2383-
@history[#:added "1.53"]}
2388+
@history[#:added "1.53"
2389+
#:changed "1.59" @elem{Added @racket['long-key].}]}
23842390

23852391
@defstruct[(form-index-desc exported-index-desc) ()]{
23862392

scribble-lib/info.rkt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
(define pkg-authors '(mflatt eli))
2323

24-
(define version "1.58")
24+
(define version "1.59")
2525

2626
(define license
2727
'((Apache-2.0 OR MIT)

scribble-lib/scribble/manual-struct.rkt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@
3636
[(method-name) symbol?]
3737
[(display-from-libs) (listof content?)]
3838
[(constructor?) boolean?]
39-
[(class-tag) tag?])])]
39+
[(class-tag) tag?]
40+
[(long-key) string?])])]
4041
[(method-index-desc exported-index-desc) ([method-name symbol?]
4142
[class-tag tag?])]
4243
[(constructor-index-desc exported-index-desc) ([class-tag tag?])]

0 commit comments

Comments
 (0)