suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update the docs to mention the search-box parameter in the html mixin.

Browse Source
This commit is contained in:
Leif Andersen 2016-06-15 15:20:58 -04:00
parent 0ca977aecd
commit c34a69c623
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
scribble-doc/scribblings/scribble/renderer.scrbl
View File

@ -333,7 +333,20 @@ formatted as Racket code.}}
@defmixin[render-mixin (render<%>) ()]{
Specializes a @racket[render<%>] class for generating HTML output.
@defconstructor/auto-super[([search-box? boolean? #f])]{
Specializes a @racket[render<%>] class for generating
HTML output. The arguments are the same as
@racket[render<%>], except for the addition of
@racket[search-box].
If @racket[search-box?] is @racket[#t] and the document
is created with @racket[scribble/manual], then it will be
rendered with a search box, similar to this page. Note
that the @racket[search-box?] argument does not create
the search page itself. Rather, it passes the search
query to whatever page is located at
@tt{search/index.html}. The query is passed as an HTTP
query string in the @tt{q} field.}
@defmethod[(set-external-tag-path [url string?]) void?]{