From 8bd17d345f2585adf981363de997f03664d447e0 Mon Sep 17 00:00:00 2001 From: Matthew Butterick Date: Fri, 17 Jul 2015 10:23:18 -0700 Subject: [PATCH] add xref to docs re changing command character (closes #73) --- scribblings/command.scrbl | 4 ++-- scribblings/world.scrbl | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/scribblings/command.scrbl b/scribblings/command.scrbl index 687c5cb..a08ebaf 100644 --- a/scribblings/command.scrbl +++ b/scribblings/command.scrbl @@ -19,7 +19,7 @@ Pollen uses a special character — the @italic{lozenge}, which looks like this: @section{The lozenge glyph (◊)} -I chose the lozenge as the command marker because a) it appears in almost every font, b) it's barely used in ordinary typesetting, c) it's not used in any programming language that I know of, and d) its shape and color allow it to stand out easily in code without being distracting. +I chose the lozenge as the command character because a) it appears in almost every font, b) it's barely used in ordinary typesetting, c) it's not used in any programming language that I know of, and d) its shape and color allow it to stand out easily in code without being distracting. Here's how you type it: @@ -29,7 +29,7 @@ Here's how you type it: @bold{Ubuntu}: ctrl + shift + U, then 25CA -Still, if you don't want to use the lozenge as your command marker, you can use something else. Set Pollen's @racket[world:command-marker] value to whatever character you want. +Still, if you don't want to use the lozenge as your command character, you can set Pollen's @racket[world:command-char] value to whatever character you want (see also @seclink["settable-values"]). @margin-note{Scribble uses the @"@" sign as a delimiter. It's not a bad choice if you only work with Racket files. But as you use Pollen to work on other kinds of text-based files that commonly contain @"@" signs — HTML pages especially — it gets cumbersome. So I changed it.} diff --git a/scribblings/world.scrbl b/scribblings/world.scrbl index 14e9d86..98f1dc0 100644 --- a/scribblings/world.scrbl +++ b/scribblings/world.scrbl @@ -32,7 +32,7 @@ A parameter that determines whether the @racket[world:directory-require] file is -@section{Settable values} +@section[#:tag "settable-values"]{Settable values} These values can be changed by overriding them in your @racket["directory-require.rkt"] source file. Within this file, @seclink["submodules" #:doc '(lib "scribblings/guide/guide.scrbl")]{create a submodule} called @racket[config]. Then within this submodule, use @racket[define] to make a variable with the same name as the one in @racket[pollen/world], but without the @racket[world:] prefix. Assign it whatever value you like. Repeat as needed. When Pollen runs, these definitions will supersede those in @racket[pollen/world].