/usr/share/doc/racket/scribble/plt-manuals.html is in racket-doc 6.1-4.
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 | <!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>4 Scribbling Documentation</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="" class="tocviewselflink" 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="tocviewlink" 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>4 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Scribbling Documentation</a></td></tr></table><div class="tocviewsublistbottom" style="display: block;" id="tocview_1"><table cellspacing="0" cellpadding="0"><tr><td align="right">4.1 </td><td><a href="how-to-doc.html" class="tocviewlink" data-pltdoc="x">Getting Started with Documentation</a></td></tr><tr><td align="right">4.2 </td><td><a href="reference-style.html" class="tocviewlink" data-pltdoc="x">Style Guide</a></td></tr><tr><td align="right">4.3 </td><td><a href="manual.html" class="tocviewlink" data-pltdoc="x">Manual Forms</a></td></tr><tr><td align="right">4.4 </td><td><a href="scheme.html" class="tocviewlink" data-pltdoc="x">Racket</a></td></tr><tr><td align="right">4.5 </td><td><a href="eval.html" class="tocviewlink" data-pltdoc="x">Evaluation and Examples</a></td></tr><tr><td align="right">4.6 </td><td><a href="srcdoc.html" class="tocviewlink" data-pltdoc="x">In-<wbr></wbr>Source Documentation</a></td></tr><tr><td align="right">4.7 </td><td><a href="bnf.html" class="tocviewlink" data-pltdoc="x">BNF Grammars</a></td></tr><tr><td align="right">4.8 </td><td><a href="Compatibility_Libraries.html" class="tocviewlink" data-pltdoc="x">Compatibility Libraries</a></td></tr></table></div></div></div></div><div class="maincolumn"><div class="main"><div class="versionbox"><span class="version">6.1</span></div><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.1", "../");" 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.1");">top</a></span><span class="navright"> <a href="LNCS_Paper_Format.html" title="backward to "3.7 LNCS Paper Format"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Scribble: The Racket Documentation Tool"" data-pltdoc="x">up</a> <a href="how-to-doc.html" title="forward to "4.1 Getting Started with Documentation"" data-pltdoc="x">next →</a></span> </div><h3 x-source-module="(lib "scribblings/scribble/scribble.scrbl")" x-part-tag=""plt-manuals"">4<tt> </tt><a name="(part._plt-manuals)"></a>Scribbling Documentation</h3><p>The <a href="manual.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/manual</span></a> language and associated libraries
provide extensive support for documenting Racket libraries. The
most significant aspect of support for documentation is the way that
source-code bindings are connected to documentation sites through the
module namespace—<wbr></wbr>a connection that is facilitated by the fact that
Scribble documents are themselves modules that reside in the same
namespace. <a href="how-to-doc.html" data-pltdoc="x">Getting Started with Documentation</a> provides an introduction to using
Scribble for documentation, and the remaining sections document the
relevant libraries and APIs in detail.</p><table cellspacing="0" cellpadding="0"><tr><td><p><span class="hspace"> </span><a href="how-to-doc.html" class="toclink" data-pltdoc="x">4.1<span class="hspace"> </span>Getting Started with Documentation</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="how-to-doc.html#%28part._setting-up%29" class="toclink" data-pltdoc="x">4.1.1<span class="hspace"> </span>Setting Up Library Documentation</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="how-to-doc.html#%28part._racket-hyperlinks%29" class="toclink" data-pltdoc="x">4.1.2<span class="hspace"> </span>Racket Typesetting and Hyperlinks</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="how-to-doc.html#%28part._section-hyperlinks%29" class="toclink" data-pltdoc="x">4.1.3<span class="hspace"> </span>Section Hyperlinks</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="how-to-doc.html#%28part._.Defining_.Racket_.Bindings%29" class="toclink" data-pltdoc="x">4.1.4<span class="hspace"> </span>Defining Racket Bindings</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="how-to-doc.html#%28part._.Showing_.Racket_.Examples%29" class="toclink" data-pltdoc="x">4.1.5<span class="hspace"> </span>Showing Racket Examples</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="how-to-doc.html#%28part._.Multi-.Page_.Sections%29" class="toclink" data-pltdoc="x">4.1.6<span class="hspace"> </span>Multi-Page Sections</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="reference-style.html" class="toclink" data-pltdoc="x">4.2<span class="hspace"> </span>Style Guide</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="reference-style.html#%28part._.Prose_and_.Terminology%29" class="toclink" data-pltdoc="x">4.2.1<span class="hspace"> </span>Prose and Terminology</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="reference-style.html#%28part._.Typesetting_.Code%29" class="toclink" data-pltdoc="x">4.2.2<span class="hspace"> </span>Typesetting Code</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="reference-style.html#%28part._.Typesetting_.Prose%29" class="toclink" data-pltdoc="x">4.2.3<span class="hspace"> </span>Typesetting Prose</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="reference-style.html#%28part._.Section_.Titles%29" class="toclink" data-pltdoc="x">4.2.4<span class="hspace"> </span>Section Titles</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="reference-style.html#%28part._.Indexing%29" class="toclink" data-pltdoc="x">4.2.5<span class="hspace"> </span>Indexing</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="reference-style.html#%28part._examples-style%29" class="toclink" data-pltdoc="x">4.2.6<span class="hspace"> </span>Examples</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="manual.html" class="toclink" data-pltdoc="x">4.3<span class="hspace"> </span>Manual Forms</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="scribble_manual_code.html" class="toclink" data-pltdoc="x">4.3.1<span class="hspace"> </span>Typesetting Code</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="scribble_manual_code.html#%28part._all-code%29" class="toclink" data-pltdoc="x">4.3.1.1<span class="hspace"> </span><span class="RktModLink"><span class="RktMod">#lang</span></span>-Specified Code</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="scribble_manual_code.html#%28part._racket-code%29" class="toclink" data-pltdoc="x">4.3.1.2<span class="hspace"> </span>Racket Code</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="scribble_manual_code.html#%28part._.Preserving_.Comments%29" class="toclink" data-pltdoc="x">4.3.1.3<span class="hspace"> </span>Preserving Comments</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="scribble_manual_code.html#%28part._.Code_.Fonts_and_.Styles%29" class="toclink" data-pltdoc="x">4.3.1.4<span class="hspace"> </span>Code Fonts and Styles</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="doc-modules.html" class="toclink" data-pltdoc="x">4.3.2<span class="hspace"> </span>Documenting Modules</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="doc-forms.html" class="toclink" data-pltdoc="x">4.3.3<span class="hspace"> </span>Documenting Forms, Functions, Structure Types, and Values</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="doc-classes.html" class="toclink" data-pltdoc="x">4.3.4<span class="hspace"> </span>Documenting Classes and Interfaces</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="doc-signatures.html" class="toclink" data-pltdoc="x">4.3.5<span class="hspace"> </span>Documenting Signatures</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="doc-strings.html" class="toclink" data-pltdoc="x">4.3.6<span class="hspace"> </span>Various String Forms</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="section-links.html" class="toclink" data-pltdoc="x">4.3.7<span class="hspace"> </span>Links</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="manual-indexing.html" class="toclink" data-pltdoc="x">4.3.8<span class="hspace"> </span>Indexing</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="manual-images.html" class="toclink" data-pltdoc="x">4.3.9<span class="hspace"> </span>Images</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="Bibliography.html" class="toclink" data-pltdoc="x">4.3.10<span class="hspace"> </span>Bibliography</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="Version_History.html" class="toclink" data-pltdoc="x">4.3.11<span class="hspace"> </span>Version History</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="Miscellaneous.html" class="toclink" data-pltdoc="x">4.3.12<span class="hspace"> </span>Miscellaneous</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="index-entries.html" class="toclink" data-pltdoc="x">4.3.13<span class="hspace"> </span>Index-Entry Descriptions</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="manual-render-style.html" class="toclink" data-pltdoc="x">4.3.14<span class="hspace"> </span>Manual Rendering Style</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="scheme.html" class="toclink" data-pltdoc="x">4.4<span class="hspace"> </span>Racket</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="eval.html" class="toclink" data-pltdoc="x">4.5<span class="hspace"> </span>Evaluation and Examples</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="srcdoc.html" class="toclink" data-pltdoc="x">4.6<span class="hspace"> </span>In-Source Documentation</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="srcdoc.html#%28part._.Source_.Annotations_for_.Documentation%29" class="toclink" data-pltdoc="x">4.6.1<span class="hspace"> </span>Source Annotations for Documentation</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="srcdoc.html#%28part._.Extracting_.Documentation_from_.Source%29" class="toclink" data-pltdoc="x">4.6.2<span class="hspace"> </span>Extracting Documentation from Source</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="bnf.html" class="toclink" data-pltdoc="x">4.7<span class="hspace"> </span>BNF Grammars</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="Compatibility_Libraries.html" class="toclink" data-pltdoc="x">4.8<span class="hspace"> </span>Compatibility Libraries</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="Compatibility_Libraries.html#%28part._struct%29" class="toclink" data-pltdoc="x">4.8.1<span class="hspace"> </span>Compatibility Structures And Processing</a></p></td></tr><tr><td><p><span class="hspace"> </span><a href="Compatibility_Libraries.html#%28part._basic%29" class="toclink" data-pltdoc="x">4.8.2<span class="hspace"> </span>Compatibility Basic Functions</a></p></td></tr></table><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.1", "../");" 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.1");">top</a></span><span class="navright"> <a href="LNCS_Paper_Format.html" title="backward to "3.7 LNCS Paper Format"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Scribble: The Racket Documentation Tool"" data-pltdoc="x">up</a> <a href="how-to-doc.html" title="forward to "4.1 Getting Started with Documentation"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|