Skip to content

Commit c34a69c

Browse files
committed
Update the docs to mention the search-box parameter in the html mixin.
1 parent 0ca977a commit c34a69c

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

scribble-doc/scribblings/scribble/renderer.scrbl

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,20 @@ formatted as Racket code.}}
333333

334334
@defmixin[render-mixin (render<%>) ()]{
335335

336-
Specializes a @racket[render<%>] class for generating HTML output.
336+
@defconstructor/auto-super[([search-box? boolean? #f])]{
337+
Specializes a @racket[render<%>] class for generating
338+
HTML output. The arguments are the same as
339+
@racket[render<%>], except for the addition of
340+
@racket[search-box].
341+
342+
If @racket[search-box?] is @racket[#t] and the document
343+
is created with @racket[scribble/manual], then it will be
344+
rendered with a search box, similar to this page. Note
345+
that the @racket[search-box?] argument does not create
346+
the search page itself. Rather, it passes the search
347+
query to whatever page is located at
348+
@tt{search/index.html}. The query is passed as an HTTP
349+
query string in the @tt{q} field.}
337350

338351
@defmethod[(set-external-tag-path [url string?]) void?]{
339352

0 commit comments

Comments
 (0)