8.9 World

6.0.1.6

8.9 World

package: pollen

A set of global values and parameters that are used throughout the Pollen system. If you don’t like the defaults I’ve picked, change them.

All identifiers are exported with the prefix world:, and are so documented below.

value
world:default-port : integer? = 8080

parameter
(world:current-server-port) → integer?
(world:current-server-port port) → void?
port : integer?
= world:default-port

A parameter that sets the HTTP port for the project server. Initialized to world:default-port, which defaults to 8080.

value
world:main-pollen-export : symbol? = 'doc
value
world:meta-pollen-export : symbol? = 'metas

The two exports from a compiled Pollen source file.

value
world:project-require : string? = "project-require.rkt"

File implicitly required into every Pollen source file from its directory.

parameter
(world:check-project-requires-in-render?) → boolean?
(world:check-project-requires-in-render? check?) → void?
check? : boolean?
= #t

A parameter that determines whether the world:project-require file is checked for changes on every pass through render. (Can be faster to turn this off if you don’t need it.) Initialized to #t.

value
world:server-extras-dir : string? = "server-extras"

Name of directory where server support files live.

parameter
(world:current-server-extras-path) → path?
(world:current-server-extras-path dir) → void?
dir : path?
= #f

A parameter that reports the path to the directory of support files for the project server. Initialized to #f, but set to a proper value when the server runs.

value
world:preproc-source-ext : symbol? = 'pp
value
world:markup-source-ext : symbol? = 'pm
value
world:markdown-source-ext : symbol? = 'pmd
value
world:null-source-ext : symbol? = 'p
value
world:pagetree-source-ext : symbol? = 'ptree
value
world:template-source-ext : symbol? = 'pt
value
world:scribble-source-ext : symbol? = 'scrbl

File extensions for Pollen source files.

value
world:decodable-extensions : (listof symbol?)
= (list world:markup-source-ext world:pagetree-source-ext)

File extensions that are eligible for decoding.

value
world:mode-auto : symbol? = 'auto
value
world:mode-preproc : symbol? = 'pre
value
world:mode-markup : symbol? = 'markup
value
world:mode-markdown : symbol? = 'markdown
value
world:mode-pagetree : symbol? = 'ptree

Mode indicators for the Pollen reader and parser.

value
world:default-pagetree : string? = "index.ptree"

Pagetree that Pollen dashboard loads by default in each directory.

value
world:pagetree-root-node : symbol? = '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.

value
world:command-marker : char? = #\◊

The magic character that indicates a Pollen command, function, or variable.

value
world:default-template-prefix : string? = "template"

Prefix of the default template.

value
world:fallback-template : string? = "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).

value
world:template-meta-key : symbol? = 'template

Meta key used to store a template name for that particular source file.

value
world:newline : string? = "\n"
value
world:linebreak-separator : string? = world:newline
value
world:paragraph-separator : string? = "\n\n"

Default separators used in decoding.

value
world:dashboard-css : string? = "poldash.css"

CSS file used for the dashboard.

value
world:paths-excluded-from-dashboard : (listof path?)
= (map string->path (list "poldash.css" "compiled"))

Paths not shown in the Pollen dashboard.

← prev up next →

1	Installation
2	Quick tour
3	Backstory
4	System overview
5	Using raco pollen
6	File formats
7	◊ command overview
8	Module reference
9	Acknowledgments
10	License & source code
	Index

8.1	Cache
8.2	Decode
8.3	File
8.4	Pagetree
8.5	Render
8.6	Template
8.7	Tag
8.8	Top
8.9	World