655 lines
28 KiB
Racket
655 lines
28 KiB
Racket
#lang scribble/doc
|
|
@(require scribble/manual scribble/core scribble/decode
|
|
scribble/html-properties scribble/latex-properties
|
|
"utils.rkt"
|
|
(for-label racket/base
|
|
scribble/latex-prefix))
|
|
|
|
@(define (fake-title . str) (apply bold str))
|
|
|
|
@(define (css s) (tt s))
|
|
@(define spacer @hspace[1])
|
|
@(define baseline (style #f '(baseline)))
|
|
@(define-syntax-rule (css-table [name desc] ...)
|
|
(tabular
|
|
#:style (style #f (list (table-columns (list baseline baseline baseline baseline))))
|
|
(list (list spacer name spacer @smaller[desc]) ...)))
|
|
|
|
@; ------------------------------------------------------------
|
|
|
|
@title[#:tag "config" #:style 'toc]{Extending and Configuring Scribble Output}
|
|
|
|
Sometimes, Scribble's primitives and built-in styles are insufficient
|
|
to produce the output that you need. The cases in which you need to
|
|
extend or configure Scribble fall into two groups:
|
|
|
|
@itemize[
|
|
|
|
@item{You may need to drop into the back-end ``language'' of CSS or
|
|
Latex to create a specific output effect. For this kind of
|
|
extension, you will mostly likely attach a
|
|
@racket[css-addition] or @racket[tex-addition] @tech{style property}
|
|
to style, where the addition implements the style name. This
|
|
kind of extension is described in @secref["extra-style"].}
|
|
|
|
@item{You may need to produce a document whose page layout is
|
|
different from the Racket documentation style. For that
|
|
kind of configuration, you can run the @exec{scribble} command-line
|
|
tool and supply flags like @DFlag{prefix} or @DPFlag{style}, or
|
|
you can associate a @racket[html-defaults] or
|
|
@racket[latex-defaults] @tech{style property} to the main document's
|
|
style. This kind of configuration is described in
|
|
@secref["config-style"].}
|
|
|
|
]
|
|
|
|
@local-table-of-contents[]
|
|
|
|
@; ------------------------------------------------------------
|
|
|
|
@section[#:tag "extra-style"
|
|
#:style (make-style #f (list (make-css-addition "inbox.css")
|
|
(make-tex-addition "inbox.tex")))
|
|
]{Implementing Styles}
|
|
|
|
When a string is used as a style in an @racket[element],
|
|
a @racket[multiarg-element], @racket[paragraph], @racket[table],
|
|
@racket[itemization], @racket[nested-flow], or
|
|
@racket[compound-paragraph], it corresponds to a CSS class for HTML
|
|
output or a Latex macro/environment for Latex output. In Latex output,
|
|
the string is used as a command name for a @racket[paragraph]
|
|
and an environment name for a @racket[table], @racket[itemization],
|
|
@racket[nested-flow], or @racket[compound-paragraph]; if the style has
|
|
a @racket['command] @tech{style property} for a @racket[nested-flow] or
|
|
@racket[compound-paragraph], then the style name is used as a command
|
|
instead of an environment; and if the style has
|
|
a @racket['multicommand] @tech{style property} for a @racket[nested-flow],
|
|
then the style name is used as a command with multiple arguments.
|
|
In addition, for an itemization, the style
|
|
string is suffixed with @racket["Item"] and used as a CSS class or Latex
|
|
macro name to use for the itemization's items (in place of @ltx{item}
|
|
in the case of Latex).
|
|
|
|
To add a mapping from your own style name to a CSS configuration, add
|
|
a @racket[css-addition] structure instance to a style's @tech{style property}
|
|
list. To map a style name to a Latex macro or environment, add a
|
|
@racket[tex-addition] structure instance. A @racket[css-addition] or
|
|
@racket[tex-addition] is normally associated with the style whose name
|
|
is implemented by the adition, but it can also be added to the style
|
|
for an enclosing part.
|
|
|
|
Scribble includes a number of predefined styles that are used by the
|
|
exports of @racket[scribble/base]. You can use them or redefine
|
|
them. The styles are specified by @filepath{scribble.css} and
|
|
@filepath{scribble.tex} in the @filepath{scribble} collection.
|
|
|
|
The styles used by @racketmodname[scribble/manual] are implemented by
|
|
@filepath{racket.css} and @filepath{racket.tex} in the
|
|
@filepath{scribble} collection. Other libraries, such as
|
|
@racketmodname[scriblib/autobib], similarly implement styles through files
|
|
that are associated by @racket[css-addition] and @racket[tex-addition]
|
|
@tech{style properties}.
|
|
|
|
To avoid collisions with future additions to Scribble, start your
|
|
style name with an uppercase letter that is not @litchar{S}. An
|
|
uppercase letter helps to avoid collisions with macros defined by
|
|
Latex packages, and future styles needed by @racketmodname[scribble/base] and
|
|
@racketmodname[scribble/manual] will start with @litchar{S}.
|
|
|
|
For example, a Scribble document
|
|
|
|
@verbatim[#:indent 2]|{
|
|
#lang scribble/manual
|
|
@(require scribble/core
|
|
scribble/html-properties
|
|
scribble/latex-properties)
|
|
|
|
@(define inbox-style
|
|
(make-style "InBox"
|
|
(list (make-css-addition "inbox.css")
|
|
(make-tex-addition "inbox.tex"))))
|
|
|
|
@title{Quantum Pet}
|
|
|
|
Do not open: @elem[#:style inbox-style]{Cat}
|
|
}|
|
|
|
|
combined with an @filepath{inbox.css} that contains
|
|
|
|
@verbatim[#:indent 2]|{
|
|
.InBox {
|
|
padding: 0.2em;
|
|
border: 1px solid #000000;
|
|
}
|
|
}|
|
|
|
|
and an @filepath{inbox.tex} that contains
|
|
|
|
@verbatim[#:indent 2]|{
|
|
\newcommand{\InBox}[1]{\fbox{#1}}
|
|
}|
|
|
|
|
generates
|
|
|
|
@nested[#:style 'inset]{
|
|
@fake-title{Quantum Pet}
|
|
|
|
Do not open: @elem[#:style "InBox"]{Cat}
|
|
}
|
|
|
|
@index["HTML Tags and Attributes"]{
|
|
Scribble documents can also embed specific html tags and
|
|
attributes.} For example, this Scribble document:
|
|
@codeblock|{
|
|
#lang scribble/base
|
|
|
|
@(require scribble/core
|
|
scribble/html-properties)
|
|
|
|
@(define external-image
|
|
(elem
|
|
#:style
|
|
(style #f
|
|
(list (alt-tag "img")
|
|
(attributes
|
|
'((src . "http://racket-lang.org/icon.png")))))))
|
|
|
|
@external-image
|
|
}|
|
|
|
|
renders as the the Racket logo at the url
|
|
@url{http://racket-lang.org/logo.png}
|
|
when producing html.
|
|
|
|
@; ------------------------------------------------------------
|
|
|
|
@section[#:tag "config-style"]{Configuring Output}
|
|
|
|
The implementation of styles used by libraries depends to some degree
|
|
on separately configurable parameters, and configuration is also
|
|
possible by replacing style implementations. Latex output is more
|
|
configurable in the former way, since a document class determines a
|
|
set of page-layout and font properties that are used by other
|
|
commands. The style-replacement kind of configuration corresponds to
|
|
re-defining Latex macros or overriding CSS class attributes. When
|
|
@exec{raco setup} builds PDF documentation, it uses both kinds of
|
|
configuration to produce a standard layout for Racket manuals;
|
|
that is, it selects a particular page layout, and it replaces some
|
|
@racketmodname[racket/base] styles.
|
|
|
|
Two kinds of files implement the two kinds of configuration:
|
|
|
|
@itemize[
|
|
|
|
@item{A @deftech{prefix file} determines the @tt{DOCTYPE} line for
|
|
HTML output or the @ltx{documentclass} configuration (and
|
|
perhaps some addition package uses or other configurations) for
|
|
Latex output.
|
|
|
|
The default prefix files are @filepath{scribble-prefix.html}
|
|
and @filepath{scribble-prefix.tex} in the @filepath{scribble}
|
|
collection.}
|
|
|
|
@item{A @deftech{style file} refines the implementation of styles
|
|
used in the document---typically just the ``built-in'' styles
|
|
used by @racketmodname[scribble/base].
|
|
|
|
The default style files, @filepath{scribble-style.css} and
|
|
@filepath{scribble-style.tex} in the @filepath{scribble}
|
|
collection, change no style implementations.}
|
|
|
|
]
|
|
|
|
For a given configuration of output, typically a particular prefix
|
|
file works with a particular style file. Some prefix or style files
|
|
may be more reusable. For now, reading the default files is the best
|
|
way to understand how they interact. A prefix and/or style file may
|
|
also require extra accomanying files; for example, a prefix file for
|
|
Latex mode may require a corresponding Latex class file. The default
|
|
prefix and style files require no extra files.
|
|
|
|
When rendering a document through the @exec{scribble} command-line
|
|
tool, use flags to select a prefix file, style file, and additional
|
|
accompanying files:
|
|
|
|
@itemize[
|
|
|
|
@item{Select the prefix file using the @as-index{@DFlag{prefix}}
|
|
flag. (Selecting the prefix file also cancels the default list
|
|
of accompanying files, if any.)}
|
|
|
|
@item{Replace the style file using the @as-index{@DFlag{style}}
|
|
flag. Add additional style definitions and re-definitions using
|
|
the @as-index{@DPFlag{style}} flag.}
|
|
|
|
@item{Add additional accompanying files with @as-index{@DPFlag{extra}}.}
|
|
|
|
]
|
|
|
|
When using the @exec{scribble} command-line utility, a document can
|
|
declare its default style, prefix, and extra files through a
|
|
@racket[html-defaults] and/or @racket[latex-defaults]
|
|
@tech{style property}. In particular, when using the @exec{scribble}
|
|
command-line tool to generate Latex or PDF a document whose main part
|
|
is implemented with @racket[#, @hash-lang[] #,
|
|
@racketmodname[scribble/manual]], the result has the standard
|
|
Racket manual configuration, because @racketmodname[scribble/manual]
|
|
associates a @racket[latex-defaults] @tech{style property} with the exported
|
|
document. The @racketmodname[scribble/sigplan] language similarly
|
|
associates a default configuration with an exported document. As
|
|
libraries imported with @racket[require], however,
|
|
@racketmodname[scribble/manual] and @racketmodname[scribble/sigplan]
|
|
simply implement new styles in a composable way.
|
|
|
|
Whether or not a document has a default prefix- and style-file
|
|
configuration through a @tech{style property}, the defaults can be
|
|
overridden using @exec{scribble} command-line flags. Furthermore,
|
|
languages like @racketmodname[scribble/manual] and
|
|
@racketmodname[scribble/sigplan] add a @racket[html-defaults] and/or
|
|
@racket[latex-defaults] @tech{style property} to a main-document part only if
|
|
it does not already have such a property added through the
|
|
@racket[#:style] argument of @racket[title].
|
|
|
|
@; ------------------------------------------------------------
|
|
|
|
@section[#:tag "builtin-css"]{Base CSS Style Classes}
|
|
|
|
The following renderings of @elem[#:style (style #f (list
|
|
(link-resource "demo.scrbl")))]{@filepath{demo.scrbl}} demonstrate all
|
|
of the CSS style classes used by @racketmodname[scribble/base] forms and
|
|
functions:
|
|
|
|
@itemlist[
|
|
|
|
@item{@other-doc['(lib "scribblings/scribble/demo-s1.scrbl")] shows
|
|
the default style in a single-page rendering without a search
|
|
box.}
|
|
|
|
@item{@other-doc['(lib "scribblings/scribble/demo-m1.scrbl")] shows
|
|
the default style in a multi-page rendering without a search
|
|
box.}
|
|
|
|
@item{@other-doc['(lib "scribblings/scribble/demo-s2.scrbl")] shows
|
|
the current manual style's adjustments in a single-page
|
|
rendering with a search box.}
|
|
|
|
@item{@other-doc['(lib "scribblings/scribble/demo-m2.scrbl")] shows
|
|
the current manual style's adjustments in a multi-page
|
|
rendering with a search box.}
|
|
|
|
]
|
|
|
|
The style classes:
|
|
|
|
@(css-table
|
|
[@css{maincolumn} @elem{Outer wrapper for all content in the main column.}]
|
|
[@css{main} @elem{Inner wrapper for all content in the main column, including navigation bars.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{refpara} @elem{Outer wrapper for right-hand @racket[margin-note] notes.}]
|
|
[@css{refparaleft} @elem{Outer wrapper for left-hand @racket[margin-note] notes.}]
|
|
[@css{refelem} @elem{Outer wrapper for right @racket[margin-note*] notes.}]
|
|
[@css{refelemleft} @elem{Outer wrapper for left-hand @racket[margin-note*] notes.}]
|
|
[@css{refcolumn} @elem{Middle wrapper for right-hand @racket[margin-note] and @racket[margin-note*] notes.}]
|
|
[@css{refcolumnleft} @elem{Middle wrapper for left-hand @racket[margin-note] and @racket[margin-note*] notes.}]
|
|
[@css{refcontent} @elem{Inner wrapper for @racket[margin-note] and @racket[margin-note*] notes.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{tocset} @elem{Groups table-of-contents panels: main and ``on this page.''}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{tocview} @elem{Wraps the main (multi-page mode) or only (single-page mode) table-of-contents panel.}]
|
|
[@css{tocviewlist} @elem{A hierarchical layer of content in a main table-of-contents panel.}]
|
|
[@css{tocviewlisttopspace} @elem{With @css{tocviewlist} for the first layer.}]
|
|
[@css{tocviewtoggle} @elem{The always-visible name of a layer.}]
|
|
[@css{tocviewtitle} @elem{With @css{tocviewtoggle} for the first layer.}]
|
|
[@css{tocviewsublist} @elem{An item in a layer that has multiple items and more items before and after.}]
|
|
[@css{tocviewsublistonly} @elem{An item in a single-item layer.}]
|
|
[@css{tocviewsublisttop} @elem{The first item in a multi-item layer.}]
|
|
[@css{tocviewsublistbottom} @elem{The last item in a multi-item layer.}]
|
|
[@css{tocviewlink} @elem{Inner wrapper for an item in a layer when linked to a different page.}]
|
|
[@css{tocviewselflink} @elem{Inner wrapper for every item in a layer when linked to the same page.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{tocsub} @elem{Wraps the ``on this page'' (multi-page mode only) table-of-contents panel.}]
|
|
[@css{tocsubtitle} @elem{Wraps the words ``on this page''.}]
|
|
[@css{tocsublist} @elem{Inner table for the ``on this page'' panel.}]
|
|
[@css{tocsublinknumber} @elem{Number for an entry in an ``on this page'' panel.}]
|
|
[@css{tocsubseclink} @elem{Title for a @emph{section} entry in an ``on this page'' panel.}]
|
|
[@css{tocsubnonseclink} @elem{Title for a @emph{non-section} entry in an ``on this page'' panel
|
|
that has some section links.}]
|
|
[@css{tocsublink} @elem{Title for a @emph{non-section} entry in an ``on this page'' panel
|
|
that has no section links.}]
|
|
|
|
[@css{toctoplink} @elem{Top-level entry in an inline (not the panel) table of contents.}]
|
|
[@css{toclink} @elem{Nested entry in an inline (not the panel) table of contents.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{versionbox} @elem{Outer wrapper for version}]
|
|
[@css{version} @elem{Inner wrapper for version in the case of search box and/or navigation.}]
|
|
[@css{versionNoNav} @elem{Inner wrapper for version in the acse of no search box and navigation.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{SAuthorListBox} @elem{Outer wrapper for the author list.}]
|
|
[@css{SAuthorList} @elem{Inner wrapper for the author list.}]
|
|
[@css{author} @elem{Wrapper for an individual author.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{navsettop} @elem{Wraps the top navigation bar (in multi-page mode or when a search bar is present).}]
|
|
[@css{navsetbottom} @elem{Wraps the bottom navigation bar (in multi-page mode or when a search bar is present).}]
|
|
[@css{navleft} @elem{Wraps left-side elements within a navigation bar.}]
|
|
[@css{navright} @elem{Wraps right-side elements within a navigation bar.}]
|
|
[@css{nonavigation} @elem{Disabled links within a navigation bar.}]
|
|
[@css{searchform} @elem{Outer wrapper for a search box within the top navigation bar.}]
|
|
[@css{searchbox} @elem{Inner wrapper for a search box within the top navigation bar.}]
|
|
[@css{nosearchform} @elem{Takes the place of an absent search box within the top navigation bar.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{SSubSubSubSection} @elem{Deeply nested subsection (below @tt{<h5>}).}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{SIntrapara} @elem{Used with @tt{<div>} instead of @tt{<p>} for a paragraph
|
|
within a @racket[compound-paragraph].}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{SubFlow} @elem{For a @racket[nested-flow] with no style name: no inset.}]
|
|
[@css{SCodeFlow} @elem{For a @racket[nested-flow] with the @racket['code-inset] style name:
|
|
inset suitable for code.}]
|
|
[@css{SVInsetFlow} @elem{For a @racket[nested-flow] with the @racket['vertical-inset] style name:
|
|
add space before and after suitable for code.}]
|
|
[@css{SCentered} @elem{For a @racket[nested-flow] created by @racket[centered]: horizontally
|
|
centered.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{boxed} @elem{For a @racket[table] with the @racket['boxed] style name: as a definition box.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{compact} @elem{For an @racket[itemlist] with the @racket['compact] style name.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{techoutside} @elem{Outer wrapper for a technical-term reference.}]
|
|
[@css{techinside} @elem{Inner wrapper for a technical-term reference.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{indexlink} @elem{For an entry in the index.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{stt} @elem{Fixed-width text.}]
|
|
[@css{sroman} @elem{Serif text.}]
|
|
[@css{ssanserif} @elem{Sans serif text.}]
|
|
[@css{slant} @elem{Oblique (as opposed to italic) text.}]
|
|
[@css{Smaller} @elem{Smaller text (as created by @racket[smaller]).}]
|
|
[@css{Larger} @elem{Smaller text (as created by @racket[larger]).}]
|
|
[@css{hspace} @elem{For whitespace produced by @racket[hspace].}]
|
|
[@css{nobreak} @elem{Disable link breaks.}]
|
|
[@css{badlink} @elem{Broken cross-reference.}]
|
|
[@css{plainlink} @elem{Hyperlink without an underline.}])
|
|
|
|
In addition, the @css{SIEHidden} style class is built in to all
|
|
Scribble HTML output to hide an element on Internet Explorer 6.
|
|
|
|
@; ------------------------------------------------------------
|
|
|
|
@section[#:tag "manual-css"]{Manual CSS Style Classes}
|
|
|
|
The following renderings of @elem[#:style (style #f (list
|
|
(link-resource "demo-manual.scrbl")))]{@filepath{demo-manual.scrbl}}
|
|
demonstrate all of the CSS style classes used by
|
|
@racketmodname[scribble/manual] forms and functions in addition to the
|
|
@seclink["builtin-css"]{base style classes}.
|
|
|
|
@itemlist[
|
|
|
|
@item{@other-doc['(lib "scribblings/scribble/demo-manual-s1.scrbl")] shows
|
|
the original style in a single-page rendering without a search
|
|
box.}
|
|
|
|
@item{@other-doc['(lib "scribblings/scribble/demo-manual-m1.scrbl")] shows
|
|
the original style in a multi-page rendering without a search
|
|
box.}
|
|
|
|
@item{@other-doc['(lib "scribblings/scribble/demo-manual-s2.scrbl")] shows
|
|
the current manual style's adjustments in a single-page
|
|
rendering with a search box.}
|
|
|
|
@item{@other-doc['(lib "scribblings/scribble/demo-manual-m2.scrbl")] shows
|
|
the current manual style's adjustments in a multi-page
|
|
rendering with a search box.}
|
|
|
|
]
|
|
|
|
The style classes:
|
|
|
|
@(css-table
|
|
[@css{RktSym} @elem{Identifiers with no @racket[for-label] binding.}]
|
|
[@css{RktValLink} @elem{Identifier with @racket[for-label] binding to a variable definition.}]
|
|
[@css{RktValDef} @elem{Definition site of a variable, normally combined with @css{RktValLink}.}]
|
|
[@css{RktStxLink} @elem{Identifier with @racket[for-label] binding to a syntactic-form definition.}]
|
|
[@css{RktStxDef} @elem{Definition site of a syntactic form, normally combined with @css{RktStxLink}.}]
|
|
[@css{RktSymDef} @elem{Definition site of an identifier without binding (normally a mistake), combined with @css{RktSym}.}]
|
|
[@css{RktVar} @elem{Local variable or meta-variable.}]
|
|
[@css{RktRes} @elem{REPL result.}]
|
|
[@css{RktOut} @elem{Output written to the current output port.}]
|
|
[@css{RktErr} @elem{Output written to the current error port.}]
|
|
[@css{RktCmt} @elem{A comment in Racket code.}]
|
|
[@css{RktVal} @elem{A literal value in Racket code.}]
|
|
[@css{RktPn} @elem{Parentheses, keywords, and similar delimiters in Racket code.}]
|
|
[@css{RktRdr} @elem{Reader shorthands in Racket code, except for commas.}]
|
|
[@css{RktMeta} @elem{An unquoting comma in Racket code.}]
|
|
[@css{highlighted} @elem{Hilighlted code (via @racket[code:highlight] in @racket[racketblock], for example).}]
|
|
[@css{RktIn} @elem{Foreground for literal characters written with @racket[litchar].}]
|
|
[@css{RktInBG} @elem{Background for literal characters written with @racket[litchar].}]
|
|
[@css{RktModLink} @elem{A module name linked to the module's definition.}]
|
|
[@css{RktMod} @elem{A module name (normally @css{RktModLink}, instead).}]
|
|
[@css{RktKw} @elem{A ``keyword;'' not normally used.}]
|
|
[@css{RktOpt} @elem{Brackets for optional arguments (in function definitions).}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{RktBlk} @elem{Wrapper for multi-linke Racket code blocks.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{defmodule} @elem{Module definition block.}]
|
|
[@css{RpackageSpec} @elem{Package specification within a module-definition block.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{RBoxed} @elem{Definition block; always combined with @css{boxed}.}]
|
|
[@css{together} @elem{Table within a @racket[together] grouping.}]
|
|
[@css{RBackgroundLabel} @elem{Wrapper for ``procedure,'' ``syntax,'' etc., backing in a definition box.}]
|
|
[@css{RBackgroundLabelInner} @elem{Wrapper within @css{RBackgroundLabel}.}]
|
|
[@css{RForeground} @elem{Wrapper for element to appear over a @css{RBackgroundLabel}.}]
|
|
[@css{prototype} @elem{Wrapper for a multi-line procedure-definition prototype.}]
|
|
[@css{argcontract} @elem{Wrapper for a multi-line argument contract and default value.}]
|
|
[@css{specgrammar} @elem{Wrapper for a grammar with a syntactic-form definition box.}]
|
|
[@css{inherited} @elem{Wrapper for a margin ``inherited methods'' table.}]
|
|
[@css{inheritedlbl} @elem{Wrapper for ``Inherited methods:'' and ``from'' labels.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{leftindent} @elem{Left-indented block, such as form @racket[specsubform].}]
|
|
[@css{insetpara} @elem{Inset block.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{Rfilebox} @elem{Wrapper for a file box (via @racket[filebox]),}]
|
|
[@css{Rfiletitle} @elem{Outer wrapper for a file box title.}]
|
|
[@css{Rfilename} @elem{Inner wrapper for a file box title.}]
|
|
[@css{Rfilecontent} @elem{Wrapper for file box content.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{SHistory} @elem{Wrapper for @racket[history] paragraphs.}]
|
|
|
|
[@spacer @spacer]
|
|
|
|
[@css{RBibliography} @elem{Wrapper for a @racket[bibliography] section.}])
|
|
|
|
@; ------------------------------------------------------------
|
|
|
|
@section[#:tag "builtin-latex"]{Base Latex Macros}
|
|
|
|
The @filepath{scribble.tex} Latex configuration includes several
|
|
macros and environments that you can redefine to adjust the output
|
|
style:
|
|
|
|
@itemlist[
|
|
|
|
@item{@ltxd[0]{preDoc} --- called before the document content; the
|
|
default does nothing, while the @racketmodname[scribble/manual]
|
|
configuration enabled @ltx{sloppy}.}
|
|
|
|
@item{@ltxd[0]{postDoc} --- called after the document content; the
|
|
default does nothing.}
|
|
|
|
@item{@ltxd[0]{sectionNewpage} --- called before each top-level
|
|
section starts; the default does nothing, while the
|
|
@racketmodname[scribble/manual] configuration uses
|
|
@ltx{newpage} to start each chapter on a new page.}
|
|
|
|
@item{@ltxd[3]{SecRefLocal} --- the first argument is a Latex label,
|
|
the second argument is a section number, and the third argument
|
|
is a section title. This macro is used by @racket[secref] to
|
|
reference a section (other than a document or top-level section
|
|
within a document) that has a number and that is local to the
|
|
current document. The default expands to @ltx{SecRef}, passing
|
|
along just the second and third arguments (so that the label is
|
|
ignored).}
|
|
|
|
@item{@ltxd[2]{SecRef} --- like @ltx{SecRefLocal}, but used when the
|
|
referenced section is in a different document, so that no label
|
|
is available. The default shows ``section'' followed by the
|
|
section number (ignoring the title). The
|
|
@racketmodname[scribble/manual] redefinition of this macro
|
|
shows ``§'', the section number, and the title in quotes.}
|
|
|
|
@item{@ltxd[3]{ChapRefLocal} and @ltxd[2]{ChapRef} --- like
|
|
@ltx{SecRefLocal} and @ltx{SecRef}, but for a top-level section
|
|
within a document. The default implementation defers to
|
|
@ltx{SecRefLocal} or @ltx{SecRef}.}
|
|
|
|
@item{@ltxd[3]{PartRefLocal} and @ltxd[2]{PartRef} --- like
|
|
@ltx{SecRefLocal} and @ltx{SecRef}, but for a top-level section
|
|
within a document whose part has the @racket['grouper] style
|
|
property. The default @ltx{PartRef} shows ``part'' followed by
|
|
the section number (ignoring the title).}
|
|
|
|
@item{@ltxd[3]{BookRefLocal} and @ltxd[2]{BookRef} --- like
|
|
@ltx{SecRefLocal} and @ltx{SecRef}, but for a document (as
|
|
opposed to a section within the document). The default
|
|
@ltx{BookRef} implementation shows the title in italic.}
|
|
|
|
@item{@ltxd[3]{SecRefLocalUC} and @ltxd[2]{SecRefUC} --- like
|
|
@ltx{SecRefLocal} and @ltx{SecRef}, but for @racket[Secref].
|
|
The default @ltx{SecRefUC} shows ``Section'' followed by the
|
|
section number.}
|
|
|
|
@item{@ltxd[3]{ChapRefLocalUC} and @ltxd[2]{ChapRefUC} --- like
|
|
@ltx{ChapRefLocal} and @ltx{ChapRef}, but for
|
|
@racket[Secref]. The default @ltx{ChapRefUC}implementation
|
|
defers to @ltx{SecRefUC}.}
|
|
|
|
@item{@ltxd[3]{PartRefLocalUC} and @ltxd[2]{PartRefUC} --- like
|
|
@ltx{PartRefLocal} and @ltx{PartRef}, but for @racket[Secref].
|
|
The default @ltx{PartRefUC} shows ``Part'' followed by the
|
|
section number.}
|
|
|
|
@item{@ltxd[3]{BookRefLocalUC} and @ltxd[2]{BookRefUC} --- like
|
|
@ltx{BookRefLocal} and @ltx{BookRef}, but for @racket[Secref].
|
|
The default @ltx{BookRefUC} defers to @ltx{BookRef}.}
|
|
|
|
@item{@ltxd[2]{SecRefLocalUN}, @ltxd[1]{SecRefUCUN},
|
|
@ltxd[2]{SecRefLocalUCUN}, @ltxd[1]{SecRefUN},
|
|
@ltxd[2]{PartRefLocalUN}, @ltxd[1]{PartRefUN},
|
|
@ltxd[2]{PartRefLocalUCUN}, @ltxd[1]{PartRefUCUN},
|
|
@ltxd[2]{BookRefLocalUN}, @ltxd[1]{BookRefUN},
|
|
@ltxd[2]{BookRefLocalUCUN}, @ltxd[1]{BookRefUCUN},
|
|
@ltxd[2]{ChapRefLocalUN}, @ltxd[1]{ChapRefUN},
|
|
@ltxd[2]{ChapRefLocalUCUN}, and @ltxd[1]{ChapRefUCUN} --- like
|
|
@ltx{SecRefLocal}, etc., but in the case that a
|
|
section/part/chapter number is unavailable. The default
|
|
implementation of @ltx{BookRefUN} uses @ltx{BookRef} with an
|
|
empty first argument. The default @ltx{SecRefLocalUN} expands
|
|
to its second argument in quotes followed by ``on page'' as a
|
|
@ltx{pageref} using the first argument, while the default
|
|
@ltx{SecRefUN} expands to its only argument in quotes. The
|
|
default @ltx{PartRef} and @ltx{ChapRef} variants expand to the
|
|
corresponding @ltx{SecRef} variant.}
|
|
|
|
@item{@ltxd[2]{Ssection}, @ltxd[2]{Ssubsection},
|
|
@ltxd[2]{Ssubsubsection}, @ltxd[2]{Ssubsubsubsection},
|
|
@ltxd[2]{Ssubsubsubsubsection} --- for a top-level section, a
|
|
second-level section, etc., where the last variant is used for
|
|
all sections that are deeper than four levels. The first
|
|
argument corresponds to the optional argument to
|
|
@ltx{section}, which is used for the table of contents.}
|
|
|
|
@item{@ltxd[1]{Ssectionstar}, @ltxd[1]{Ssubsectionstar},
|
|
@ltxd[1]{Ssubsubsectionstar}, @ltxd[1]{Ssubsubsubsectionstar},
|
|
@ltxd[1]{Ssubsubsubsubsectionstar} --- like @ltx{Ssection},
|
|
etc., but for unnumbered sections that are omitted from the
|
|
table of contents.}
|
|
|
|
@item{@ltxd[2]{Ssectionstarx}, @ltxd[1]{Ssubsectionstarx},
|
|
@ltxd[2]{Ssubsubsectionstarx},
|
|
@ltxd[2]{Ssubsubsubsectionstarx},
|
|
@ltxd[2]{Ssubsubsubsubsectionstarx} --- like @ltx{Ssection},
|
|
etc., but for unnumbered sections (that nevertheless appear in
|
|
the table of contents).}
|
|
|
|
@item{@ltxd[0]{Sincsection}, @ltxd[0]{Sincsubsection},
|
|
@ltxd[0]{Sincsubsubsection}, @ltxd[0]{Sincsubsubsubsection},
|
|
@ltxd[0]{Sincsubsubsubsubsection} --- increments the section
|
|
counter.}
|
|
|
|
@item{@ltxd[2]{Spart}, @ltxd[1]{Spartstar}, @ltxd[2]{Spartstarx},
|
|
@ltxd[0]{Sincpart} --- like the section commands, but used for
|
|
in place of @ltxd[2]{Ssection}, @ltxd[1]{Ssectionstar}, @|etc|
|
|
for a part with the @racket['grouper] style property.}
|
|
|
|
@item{@ltxe{SInsetFlow} environment --- for a @racket[nested-flow]
|
|
with the @racket['inset] style name.}
|
|
|
|
@item{@ltxe{SCodeFlow} environment --- for a @racket[nested-flow]
|
|
with the @racket['code-inset] style name.}
|
|
|
|
@item{@ltxe{SVInsetFlow} environment --- for a @racket[nested-flow]
|
|
with the @racket['vertical-inset] style name.}
|
|
|
|
@item{@ltxd[1]{SCodeBox}, @ltxd[1]{SVInsetBox} --- for a
|
|
@racket[nested-flow] with the @racket['code-inset] or
|
|
@racket['vertical-inset] style name, respectively, and as the
|
|
content of a table cell. The content is installed into a TeX
|
|
box using @tt{\setbox1}.}
|
|
|
|
]
|
|
|
|
@; ------------------------------------------------------------
|
|
|
|
@section[#:tag "latex-prefix"]{Latex Prefix Support}
|
|
|
|
@defmodule[scribble/latex-prefix]{Provides a string that is useful for
|
|
constructing a Latex document prefix.}
|
|
|
|
@defthing[unicode-encoding-packages string?]{
|
|
|
|
A string containing Latex code that is useful after a
|
|
@tt{\documentclass} declaration to make Latex work with Unicode
|
|
characters.}
|