/usr/share/doc/racket/scribble/config-style.html is in racket-doc 6.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>6.11.2 Configuring Output</title><link rel="stylesheet" type="text/css" href="../scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="../racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../doc-site.css" title="default"/><script type="text/javascript" src="../scribble-common.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../doc-site.js"></script><script type="text/javascript" src="../local-redirect/local-redirect.js"></script><script type="text/javascript" src="../local-redirect/local-user-redirect.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="doc-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">►</a></td><td></td><td><a href="index.html" class="tocviewlink" data-pltdoc="x">Scribble:<span class="mywbr"> </span> The Racket Documentation Tool</a></td></tr></table></div><div class="tocviewsublisttop" style="display: none;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="getting-started.html" class="tocviewlink" data-pltdoc="x">Getting Started</a></td></tr><tr><td align="right">2 </td><td><a href="reader.html" class="tocviewlink" data-pltdoc="x">@ Syntax</a></td></tr><tr><td align="right">3 </td><td><a href="generic-prose.html" class="tocviewlink" data-pltdoc="x">High-<wbr></wbr>Level Scribble API</a></td></tr><tr><td align="right">4 </td><td><a href="plt-manuals.html" class="tocviewlink" data-pltdoc="x">Scribbling Documentation</a></td></tr><tr><td align="right">5 </td><td><a href="lp.html" class="tocviewlink" data-pltdoc="x">Literate Programming</a></td></tr><tr><td align="right">6 </td><td><a href="internals.html" class="tocviewselflink" data-pltdoc="x">Low-<wbr></wbr>Level Scribble API</a></td></tr><tr><td align="right">7 </td><td><a href="running.html" class="tocviewlink" data-pltdoc="x">Running <span class="stt">scribble</span></a></td></tr><tr><td align="right"></td><td><a href="doc-index.html" class="tocviewlink" data-pltdoc="x">Index</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_1");">►</a></td><td>6 </td><td><a href="internals.html" class="tocviewlink" data-pltdoc="x">Low-<wbr></wbr>Level Scribble API</a></td></tr></table><div class="tocviewsublist" style="display: none;" id="tocview_1"><table cellspacing="0" cellpadding="0"><tr><td align="right">6.1 </td><td><a href="layers.html" class="tocviewlink" data-pltdoc="x">Scribble Layers</a></td></tr><tr><td align="right">6.2 </td><td><a href="reader-internals.html" class="tocviewlink" data-pltdoc="x">@ Reader Internals</a></td></tr><tr><td align="right">6.3 </td><td><a href="core.html" class="tocviewlink" data-pltdoc="x">Structures And Processing</a></td></tr><tr><td align="right">6.4 </td><td><a href="renderer.html" class="tocviewlink" data-pltdoc="x">Renderers</a></td></tr><tr><td align="right">6.5 </td><td><a href="decode.html" class="tocviewlink" data-pltdoc="x">Decoding Text</a></td></tr><tr><td align="right">6.6 </td><td><a href="doclang.html" class="tocviewlink" data-pltdoc="x">Document Language</a></td></tr><tr><td align="right">6.7 </td><td><a href="docreader.html" class="tocviewlink" data-pltdoc="x">Document Reader</a></td></tr><tr><td align="right">6.8 </td><td><a href="xref.html" class="tocviewlink" data-pltdoc="x">Cross-<wbr></wbr>Reference Utilities</a></td></tr><tr><td align="right">6.9 </td><td><a href="tag.html" class="tocviewlink" data-pltdoc="x">Tag Utilities</a></td></tr><tr><td align="right">6.10 </td><td><a href="blueboxes.html" class="tocviewlink" data-pltdoc="x">Blue Boxes Utilities</a></td></tr><tr><td align="right">6.11 </td><td><a href="config.html" class="tocviewselflink" data-pltdoc="x">Extending and Configuring Scribble Output</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_2");">▼</a></td><td>6.11 </td><td><a href="config.html" class="tocviewlink" data-pltdoc="x">Extending and Configuring Scribble Output</a></td></tr></table><div class="tocviewsublistbottom" style="display: block;" id="tocview_2"><table cellspacing="0" cellpadding="0"><tr><td align="right">6.11.1 </td><td><a href="extra-style.html" class="tocviewlink" data-pltdoc="x">Implementing Styles</a></td></tr><tr><td align="right">6.11.2 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Configuring Output</a></td></tr><tr><td align="right">6.11.3 </td><td><a href="builtin-css.html" class="tocviewlink" data-pltdoc="x">Base CSS Style Classes</a></td></tr><tr><td align="right">6.11.4 </td><td><a href="manual-css.html" class="tocviewlink" data-pltdoc="x">Manual CSS Style Classes</a></td></tr><tr><td align="right">6.11.5 </td><td><a href="builtin-latex.html" class="tocviewlink" data-pltdoc="x">Base Latex Macros</a></td></tr><tr><td align="right">6.11.6 </td><td><a href="latex-prefix.html" class="tocviewlink" data-pltdoc="x">Latex Prefix Support</a></td></tr></table></div></div></div></div><div class="maincolumn"><div class="main"><div class="navsettop"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.7", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">top</a></span><span class="navright"> <a href="extra-style.html" title="backward to "6.11.1 Implementing Styles"" data-pltdoc="x">← prev</a> <a href="config.html" title="up to "6.11 Extending and Configuring Scribble Output"" data-pltdoc="x">up</a> <a href="builtin-css.html" title="forward to "6.11.3 Base CSS Style Classes"" data-pltdoc="x">next →</a></span> </div><h5 x-source-module="(lib "scribblings/scribble/scribble.scrbl")" x-source-pkg="scribble-doc" x-part-tag=""config-style"">6.11.2<tt> </tt><a name="(part._config-style)"></a>Configuring Output</h5><p>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
<span class="stt">raco setup</span> 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
<a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=index.html&version=6.7" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">racket/base</span></a> styles.</p><p>Two kinds of files implement the two kinds of configuration:</p><ul><li><p>A <a name="(tech._prefix._file)"></a><span style="font-style: italic">prefix file</span> determines the <span class="stt">DOCTYPE</span> line for
HTML output or the <span class="stt">\documentclass</span> configuration (and
perhaps some addition package uses or other configurations) for
Latex output.</p><p>The default prefix files are <span class="stt">"scribble-prefix.html"</span>
and <span class="stt">"scribble-prefix.tex"</span> in the <span class="stt">"scribble"</span>
collection.</p></li><li><p>A <a name="(tech._style._file)"></a><span style="font-style: italic">style file</span> refines the implementation of styles
used in the document—<wbr></wbr>typically just the “built-in” styles
used by <a href="base.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/base</span></a>.</p><p>The default style files, <span class="stt">"scribble-style.css"</span> and
<span class="stt">"scribble-style.tex"</span> in the <span class="stt">"scribble"</span>
collection, change no style implementations.</p></li></ul><p>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.</p><p>When rendering a document through the <span class="stt">scribble</span> command-line
tool, use flags to select a prefix file, style file, and additional
accompanying files:</p><ul><li><p>Select the prefix file using the <a name="(idx._(gentag._18._(lib._scribblings/scribble/scribble..scrbl)))"></a><span class="nobreak"><span class="stt">--prefix</span></span>
flag. (Selecting the prefix file also cancels the default list
of accompanying files, if any.)</p></li><li><p>Replace the style file using the <a name="(idx._(gentag._19._(lib._scribblings/scribble/scribble..scrbl)))"></a><span class="nobreak"><span class="stt">--style</span></span>
flag. Add additional style definitions and re-definitions using
the <a name="(idx._(gentag._20._(lib._scribblings/scribble/scribble..scrbl)))"></a><span class="nobreak"><span class="stt">++style</span></span> flag.</p></li><li><p>Add additional accompanying files with <a name="(idx._(gentag._21._(lib._scribblings/scribble/scribble..scrbl)))"></a><span class="nobreak"><span class="stt">++extra</span></span>.</p></li></ul><p>When using the <span class="stt">scribble</span> command-line utility, a document can
declare its default style, prefix, and extra files through a
<span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fhtml-properties..rkt%29._html-defaults%29%29" class="RktValLink" data-pltdoc="x">html-defaults</a></span> and/or <span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Flatex-properties..rkt%29._latex-defaults%29%29" class="RktValLink" data-pltdoc="x">latex-defaults</a></span>
<a href="core.html#%28tech._style._property%29" class="techoutside" data-pltdoc="x"><span class="techinside">style property</span></a>. In particular, when using the <span class="stt">scribble</span>
command-line tool to generate Latex or PDF a document whose main part
is implemented with <a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=guide&rel=Module_Syntax.html%23%2528part._hash-lang%2529&version=6.7" class="RktModLink Sq" data-pltdoc="x"><span class="RktMod">#lang</span></a><span class="stt"> </span><a href="manual.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/manual</span></a>, the result has the standard
Racket manual configuration, because <a href="manual.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/manual</span></a>
associates a <span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Flatex-properties..rkt%29._latex-defaults%29%29" class="RktValLink" data-pltdoc="x">latex-defaults</a></span> <a href="core.html#%28tech._style._property%29" class="techoutside" data-pltdoc="x"><span class="techinside">style property</span></a> with the exported
document. The <a href="SIGPLAN_Paper_Format.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/sigplan</span></a> language similarly
associates a default configuration with an exported document. As
libraries imported with <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">require</a></span>, however,
<a href="manual.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/manual</span></a> and <a href="SIGPLAN_Paper_Format.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/sigplan</span></a>
simply implement new styles in a composable way.</p><p>Whether or not a document has a default prefix- and style-file
configuration through a <a href="core.html#%28tech._style._property%29" class="techoutside" data-pltdoc="x"><span class="techinside">style property</span></a>, the defaults can be
overridden using <span class="stt">scribble</span> command-line flags. Furthermore,
languages like <a href="manual.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/manual</span></a> and
<a href="SIGPLAN_Paper_Format.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/sigplan</span></a> add a <span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fhtml-properties..rkt%29._html-defaults%29%29" class="RktValLink" data-pltdoc="x">html-defaults</a></span> and/or
<span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Flatex-properties..rkt%29._latex-defaults%29%29" class="RktValLink" data-pltdoc="x">latex-defaults</a></span> <a href="core.html#%28tech._style._property%29" class="techoutside" data-pltdoc="x"><span class="techinside">style property</span></a> to a main-document part only if
it does not already have such a property added through the
<span class="RktPn">#:style</span> argument of <span class="RktSym"><a href="base.html#%28def._%28%28lib._scribble%2Fbase..rkt%29._title%29%29" class="RktValLink" data-pltdoc="x">title</a></span>.</p><div class="navsetbottom"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.7", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">top</a></span><span class="navright"> <a href="extra-style.html" title="backward to "6.11.1 Implementing Styles"" data-pltdoc="x">← prev</a> <a href="config.html" title="up to "6.11 Extending and Configuring Scribble Output"" data-pltdoc="x">up</a> <a href="builtin-css.html" title="forward to "6.11.3 Base CSS Style Classes"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|