commit d51825b95e9ff296a48d9c90b65305ca2557120e parent 798155c4f9b70d0e07208c9fa0159df078a2f351 Author: ben <benjaminlgreenman@gmail.com> Date: Mon, 25 Jan 2016 11:51:31 -0500 example usage of 'other-doc' Diffstat:
| M | scribble-doc/scribblings/scribble/base.scrbl | | | 13 | ++++++++++++- |
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/scribble-doc/scribblings/scribble/base.scrbl b/scribble-doc/scribblings/scribble/base.scrbl @@ -677,7 +677,18 @@ If @racket[indirect] is not @racket[#f], then the link's resolution in HTML can be delayed, like @racket[seclink] with @racket[#:indirect? #t]. The @racket[indirect] content is prefixed with ``the'' and suffixed with ``documentation'' to generate the rendered text of the -link.} +link. For example: + +@verbatim[#:indent 2]|{ + @other-doc['(lib "parsack/parsack/parsack.scrbl") + #:indirect "Parsec implementation in Racket"] +}| + +renders as a hyperlink with the text: + +@verbatim[#:indent 2]|{ + the Parsec implementation in Racket documentation +}|} @defproc[(elemtag [t (or/c tag? string?)] [pre-content pre-content?] ...) element?]{