remove #:value from docs

pull/9/head
Matthew Butterick 11 years ago
parent a82a04d7fc
commit d47755937e

@ -11,8 +11,7 @@
The slowest part of a @racket[render] is parsing and decoding the source file. Often, previewing a single source file necessarily means decoding others (for instance templates, or other source files that are linked into the main source file). But usually, only one source file is changing at a time. Therefore, Pollen stores copies of the exports of source files — namely, whatever is stored in @code[(format "~a" world:main-pollen-export)] and @code[(format "~a" world:meta-pollen-export)] — in the cache so they can be reused.
@defparam[current-cache hash hash?
#:value (make-cache)]{A parameter that refers to the current cache. It is initialized with @racket[make-cache].
@defparam[current-cache hash hash?]{A parameter that refers to the current cache. It is initialized with @racket[make-cache].
The cache is a hash table that uses the complete path of a source file as its keys. The value associated with each of these keys is a subcache — another hash table with keys @racket['doc], @racket['metas] (for storing the exports of the source file) and @racket['mod-time] (for storing the modification time, provided by @racket[file-or-directory-modify-seconds]).}

@ -168,8 +168,7 @@ The @racket[_tags-to-exclude] argument is useful if you're decoding source that'
Because it's convenient, Pollen categorizes tagged X-expressions into two categories: @italic{block} and @italic{inline}. Why is it convenient? When using @racket[decode], you often want to treat the two categories differently. Not that you have to. But this is how you can.
@defparam[project-block-tags block-tags (listof txexpr-tag?)
#:value (listof symbol?)]{
@defparam[project-block-tags block-tags (listof txexpr-tag?)]{
A parameter that defines the set of tags that @racket[decode] will treat as blocks. This parameter is initialized with the HTML block tags, namely:
@code[(format "~a" html:block-tags)]}

@ -88,8 +88,7 @@ Convert @racket[_v] to a pagenode.
@section{Navigation}
@defparam[current-pagetree pagetree pagetree?
#:value #f]{
@defparam[current-pagetree pagetree pagetree?]{
A parameter that defines the default pagetree used by pagetree navigation functions (e.g., @racket[parent-pagenode], @racket[chidren], et al.) if another is not explicitly specified. Initialized to @racket[#f].}

@ -14,86 +14,97 @@ A set of global values and parameters that are used throughout the Pollen system
All identifiers are exported with the prefix @racket[world:], and are so documented below.
@defthing[world:default-port integer? #:value 8080]
@defparam[world:current-server-port port integer?
#:value world:default-port]{
@defthing[world:default-port integer?]
@defparam[world:current-server-port port integer?]{
A parameter that sets the HTTP port for the project server. Initialized to @racket[world:default-port], which defaults to 8080.}
@deftogether[(
@defthing[world:main-pollen-export symbol? #:value 'doc]
@defthing[world:meta-pollen-export symbol? #:value 'metas]
@defthing[world:main-pollen-export symbol?]
@defthing[world:meta-pollen-export symbol?]
)]
The two exports from a compiled Pollen source file.
The two exports from a compiled Pollen source file. Initialized to @racket['doc] and @racket['metas], respectively.
@(defthing world:project-require string? #:value "project-require.rkt")
File implicitly required into every Pollen source file from its directory.
@(defthing world:project-require string?)
File implicitly required into every Pollen source file from its directory. Initialized to @racket["project-require.rkt"].
@defparam[world:check-project-requires-in-render? check? boolean?
#:value #t]{
@defparam[world:check-project-requires-in-render? check? boolean?]{
A parameter that determines whether the @racket[world:project-require] file is checked for changes on every pass through @racket[render]. (Can be faster to turn this off if you don't need it.) Initialized to @racket[#t].}
@defthing[world:server-extras-dir string? #:value "server-extras"]
Name of directory where server support files live.
@defthing[world:server-extras-dir string?]
Name of directory where server support files live. Initialized to @racket["server-extras"].
@defparam[world:current-server-extras-path dir path?
#:value #f]{
@defparam[world:current-server-extras-path dir path?]{
A parameter that reports the path to the directory of support files for the project server. Initialized to @racket[#f], but set to a proper value when the server runs.}
@deftogether[(
@defthing[world:preproc-source-ext symbol? #:value 'pp]
@defthing[world:markup-source-ext symbol? #:value 'pm]
@defthing[world:markdown-source-ext symbol? #:value 'pmd]
@defthing[world:null-source-ext symbol? #:value 'p]
@defthing[world:pagetree-source-ext symbol? #:value 'ptree]
@defthing[world:template-source-ext symbol? #:value 'pt]
@defthing[world:scribble-source-ext symbol? #:value 'scrbl]
@defthing[world:preproc-source-ext symbol?]
@defthing[world:markup-source-ext symbol?]
@defthing[world:markdown-source-ext symbol?]
@defthing[world:null-source-ext symbol?]
@defthing[world:pagetree-source-ext symbol?]
@defthing[world:template-source-ext symbol?]
@defthing[world:scribble-source-ext symbol?]
)]
File extensions for Pollen source files.
File extensions for Pollen source files, initialized to the following values:
@racket[world:preproc-source-ext] = @code[(format "~a" world:preproc-source-ext)]
@(linebreak)@racket[world:markup-source-ext] = @code[(format "~a" world:markup-source-ext)]
@(linebreak)@racket[world:markdown-source-ext] = @code[(format "~a" world:markdown-source-ext)]
@(linebreak)@racket[world:null-source-ext] = @code[(format "~a" world:null-source-ext)]
@(linebreak)@racket[world:pagetree-source-ext] = @code[(format "~a" world:pagetree-source-ext)]
@(linebreak)@racket[world:template-source-ext] = @code[(format "~a" world:template-source-ext)]
@(linebreak)@racket[world:scribble-source-ext] = @code[(format "~a" world:scribble-source-ext)]
@defthing[world:decodable-extensions (listof symbol?) #:value (list world:markup-source-ext world:pagetree-source-ext)]
@defthing[world:decodable-extensions (listof symbol?)]
File extensions that are eligible for decoding.
@deftogether[(
@(defthing world:mode-auto symbol? #:value 'auto)
@(defthing world:mode-preproc symbol? #:value 'pre)
@(defthing world:mode-markup symbol? #:value 'markup)
@(defthing world:mode-markdown symbol? #:value 'markdown)
@(defthing world:mode-pagetree symbol? #:value 'ptree)
@(defthing world:mode-auto symbol?)
@(defthing world:mode-preproc symbol?)
@(defthing world:mode-markup symbol?)
@(defthing world:mode-markdown symbol?)
@(defthing world:mode-pagetree symbol?)
)]
Mode indicators for the Pollen reader and parser.
Mode indicators for the Pollen reader and parser. Initialized to the following values:
@racket[world:mode-auto] = @code[(format "~a" world:mode-auto)]
@(linebreak)@racket[world:mode-preproc] = @code[(format "~a" world:mode-preproc)]
@(linebreak)@racket[world:mode-markup] = @code[(format "~a" world:mode-markup)]
@(linebreak)@racket[world:mode-markdown] = @code[(format "~a" world:mode-markdown)]
@(linebreak)@racket[world:mode-pagetree] = @code[(format "~a" world:mode-pagetree)]
@defthing[world:default-pagetree string? #:value "index.ptree"]
Pagetree that Pollen dashboard loads by default in each directory.
@defthing[world:default-pagetree string?]
Pagetree that Pollen dashboard loads by default in each directory. Initialized to @racket["index.ptree"].
@defthing[world:pagetree-root-node symbol? #:value 'pagetree-root]
Name of the root node in a decoded pagetree. It's ignored by the code, so its only role is to clue you in that you're looking at something that came out of the pagetree decoder.
@defthing[world:pagetree-root-node symbol?]
Name of the root node in a decoded pagetree. It's ignored by the code, so its only role is to clue you in that you're looking at something that came out of the pagetree decoder. Initialized to @racket['pagetree-root].
@defthing[world:command-marker char? #:value #\◊]
The magic character that indicates a Pollen command, function, or variable.
@defthing[world:command-marker char?]
The magic character that indicates a Pollen command, function, or variable. Initialized to @racket[#\◊].
@defthing[world:default-template-prefix string? #:value "template"]
Prefix of the default template.
@defthing[world:default-template-prefix string?]
Prefix of the default template. Initialized to @racket["template"].
@defthing[world:fallback-template string? #:value "fallback.html.pt"]
Name of the fallback template (i.e., the template used to render a Pollen markup file when no other template can be found).
@defthing[world:fallback-template string?]
Name of the fallback template (i.e., the template used to render a Pollen markup file when no other template can be found). Initialized to @racket["fallback.html.pt"].
@defthing[world:template-meta-key symbol? #:value 'template]
Meta key used to store a template name for that particular source file.
@defthing[world:template-meta-key symbol?]
Meta key used to store a template name for that particular source file. Initialized to @racket['template].
@deftogether[(
@(defthing world:newline string? #:value "\n")
@(defthing world:linebreak-separator string? #:value world:newline)
@(defthing world:paragraph-separator string? #:value "\n\n")
@(defthing world:newline string?)
@(defthing world:linebreak-separator string?)
@(defthing world:paragraph-separator string?)
)]
Default separators used in decoding.
Default separators used in decoding. The first two are initialized to @racket["\n"]; the third to @racket["\n\n"].
@(defthing world:dashboard-css string? #:value "poldash.css")
CSS file used for the dashboard.
@(defthing world:dashboard-css string?)
CSS file used for the dashboard. Initialized to @racket["poldash.css"].
@(defthing world:paths-excluded-from-dashboard (listof path?) #:value (map string->path (list "poldash.css" "compiled")))
@(defthing world:paths-excluded-from-dashboard (listof path?))
Paths not shown in the Pollen dashboard.

Loading…
Cancel
Save