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

doc: example include-section for scribble/lp2

Browse Source
This commit is contained in:
Ben Greenman 2017-11-29 23:14:12 -05:00
parent 05037353bd
commit ed0e87d54d
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
scribble-doc/scribblings/scribble/lp.scrbl
View File

@ -69,6 +69,15 @@ a @racket[doc] submodule that is expanded (so that the content is
effectively re-expanded). The @racketidfont{doc} submodule is declared effectively re-expanded). The @racketidfont{doc} submodule is declared
with @racket[module*]. with @racket[module*].
To include a @racketmodname[scribble/lp2] document named
@filepath{file.scrbl} into another Scribble document,
import the @racketidfont{doc} submodule:
@codeblock[#:keep-lang-line? #false]|{
#lang scribble/manual
@include-section[(submod "file.scrbl" doc)]
}|
@history[#:added "1.8" @history[#:added "1.8"
#:changed "1.17" @elem{Declared the @racketidfont{doc} submodule with #:changed "1.17" @elem{Declared the @racketidfont{doc} submodule with
@racket[module*] instead of @racket[module].}] @racket[module*] instead of @racket[module].}]
@ -127,8 +136,8 @@ used.
@defmodule[scribble/lp-include]{The @defmodule[scribble/lp-include]{The
@racketmodname[scribble/lp-include] library is normally used within a @racketmodname[scribble/lp-include] library is normally used within a
Scribble document---that is, a module that starts with something like Scribble document---that is, a module that starts with something like
@racket[#, @hash-lang[] @racketmodname[scribble/base]] or @racket[#, @hash-lang[] @hash-lang[] @racketmodname[scribble/base] or @hash-lang[] @racketmodname[scribble/manual],
@racketmodname[scribble/manual]], instead of @racket[#, @hash-lang[] @racketmodname[racket]].} instead of @hash-lang[] @racketmodname[racket].}
@defform[(lp-include filename)]{ @defform[(lp-include filename)]{
Includes the source of @racket[filename] as the typeset version of the literate Includes the source of @racket[filename] as the typeset version of the literate