/usr/share/doc/racket/scribble/xref.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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | <!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.8 Cross-Reference Utilities</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="tocviewsublistbottom" style="display: block;" 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="" class="tocviewselflink" 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="tocviewlink" data-pltdoc="x">Extending and Configuring Scribble Output</a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref~3f%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">xref?</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._load-xref%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">load-<wbr></wbr>xref</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-binding-~3edefinition-tag%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">xref-<wbr></wbr>binding-<wbr></wbr>>definition-<wbr></wbr>tag</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-tag-~3epath%2Banchor%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">xref-<wbr></wbr>tag-<wbr></wbr>>path+<span class="mywbr"> </span>anchor</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-tag-~3eindex-entry%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">xref-<wbr></wbr>tag-<wbr></wbr>>index-<wbr></wbr>entry</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-render%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">xref-<wbr></wbr>render</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-transfer-info%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">xref-<wbr></wbr>transfer-<wbr></wbr>info</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-index%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">xref-<wbr></wbr>index</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._entry%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">entry</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._data%2Broot~3f%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">data+<span class="mywbr"> </span>root?</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-data%2Broot%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">make-<wbr></wbr>data+<span class="mywbr"> </span>root</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._data%2Broot%2Bdoc-id~3f%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">data+<span class="mywbr"> </span>root+<span class="mywbr"> </span>doc-<wbr></wbr>id?</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-data%2Broot%2Bdoc-id%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">make-<wbr></wbr>data+<span class="mywbr"> </span>root+<span class="mywbr"> </span>doc-<wbr></wbr>id</span></span></a></td></tr></table></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="docreader.html" title="backward to "6.7 Document Reader"" data-pltdoc="x">← prev</a> <a href="internals.html" title="up to "6 Low-Level Scribble API"" data-pltdoc="x">up</a> <a href="tag.html" title="forward to "6.9 Tag Utilities"" data-pltdoc="x">next →</a></span> </div><h4 x-source-module="(lib "scribblings/scribble/scribble.scrbl")" x-source-pkg="scribble-doc" x-part-tag=""xref"">6.8<tt> </tt><a name="(part._xref)"></a><a name="(mod-path._scribble/xref)"></a>Cross-Reference Utilities</h4><p><div class="SIntrapara"><table cellspacing="0" cellpadding="0" class="defmodule"><tr><td align="left"><span class="hspace"> </span><span class="RktPn">(</span><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><span class="stt"> </span><a href="" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/xref</span></a><span class="RktPn">)</span></td><td align="right"><span class="RpackageSpec"><span class="Smaller"> package:</span> <span class="stt">scribble-lib</span></span></td></tr></table></div><div class="SIntrapara">The <a href="" class="RktModLink" data-pltdoc="x"><span class="RktSym">scribble/xref</span></a> library
provides utilities for querying cross-reference information that was
collected from a document build.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._xref~3f))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref~3f%29%29" class="RktValDef RktValLink" data-pltdoc="x">xref?</a></span></span><span class="hspace"> </span><span class="RktVar">v</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=booleans.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._boolean%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">boolean?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">v</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Returns <span class="RktVal">#t</span> if <span class="RktVar">v</span> is a cross-reference record created
by <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._load-xref%29%29" class="RktValLink" data-pltdoc="x">load-xref</a></span>, <span class="RktVal">#f</span> otherwise.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><table cellspacing="0" cellpadding="0" class="prototype RForeground"><tr><td valign="top"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._load-xref))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._load-xref%29%29" class="RktValDef RktValLink" data-pltdoc="x">load-xref</a></span></span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">sources</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span>[</td><td valign="top"><span class="RktPn">#:demand-source</span><span class="hspace"> </span><span class="RktVar">demand-source</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">#:render%</span><span class="hspace"> </span><span class="RktVar">using-render%</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">#:root</span><span class="hspace"> </span><span class="RktVar">root-path</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">#:doc-id</span><span class="hspace"> </span><span class="RktVar">doc-id-str</span>]<span class="RktPn">)</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">→</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref~3f%29%29" class="RktValLink" data-pltdoc="x">xref?</a></span></td></tr></table></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">sources</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=function-contracts.html%23%2528form._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._-%7E3e%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x"><span class="nobreak">-></span></a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=function-contracts.html%23%2528form._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._-%7E3e%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x"><span class="nobreak">-></span></a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">list?</a></span><span class="RktPn">)</span><span class="RktPn">)</span><span class="RktPn">)</span><span class="RktPn">)</span></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="argcontract"><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">demand-source</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">:</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">(</span><span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._tag~3f%29%29" class="RktValLink" data-pltdoc="x">tag?</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=function-contracts.html%23%2528form._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._-%7E3e%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x"><span class="nobreak">-></span></a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=function-contracts.html%23%2528form._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._-%7E3e%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x"><span class="nobreak">-></span></a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span><span class="RktPn">)</span><span class="hspace"> </span><span class="RktVal">#f</span><span class="RktPn">)</span><span class="RktPn">)</span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">=</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=lambda.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._lambda%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">lambda</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktVar">tag</span><span class="RktPn">)</span><span class="hspace"> </span><span class="RktVal">#f</span><span class="RktPn">)</span></td></tr></table></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="argcontract"><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">using-render%</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">:</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Object_and_Class_Contracts.html%23%2528def._%2528%2528lib._racket%252Fclass..rkt%2529._implementation%7E3f%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">implementation?/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fbase-render..rkt%29._render~3c~25~3e%29%29" class="RktValLink" data-pltdoc="x">render<%></a></span><span class="RktPn">)</span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">=</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">(</span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fhtml-render..rkt%29._render-mixin%29%29" class="RktValLink" data-pltdoc="x">render-mixin</a></span><span class="hspace"> </span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fbase-render..rkt%29._render~25%29%29" class="RktValLink" data-pltdoc="x">render%</a></span><span class="RktPn">)</span></td></tr></table></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">root-path</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="RktPn">)</span><span class="hspace"> </span>=<span class="hspace"> </span><span class="RktVal">#f</span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">doc-id-str</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="RktPn">)</span><span class="hspace"> </span>=<span class="hspace"> </span><span class="RktVal">#f</span></td></tr></table></blockquote></div><div class="SIntrapara">Creates a cross-reference record given a list of functions,
<span class="RktVar">sources</span>.</div></p><p>Let <span class="RktVar">source</span> be a function in <span class="RktVar">sources</span>. The
<span class="RktVar">source</span> function normally returns serialized information,
<span class="RktVar">info</span>, which was formerly obtained from <span class="RktSym"><a href="renderer.html#%28meth._%28%28%28lib._scribble%2Fbase-render..rkt%29._render~3c~25~3e%29._serialize-info%29%29" class="RktValLink" data-pltdoc="x">serialize-info</a></span> in <span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fbase-render..rkt%29._render~3c~25~3e%29%29" class="RktValLink" data-pltdoc="x">render<%></a></span>. The result of <span class="RktVar">source</span> can optionally be
another function, which is in turn responsible for returning a list of
<span class="RktVar">info</span>s. Finally, each <span class="RktVar">info</span> can be either serialized
information, a <span class="RktVal">#f</span> to be ignored, or a value produced by
<span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-data%2Broot%29%29" class="RktValLink" data-pltdoc="x">make-data+root</a></span> or <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-data%2Broot%2Bdoc-id%29%29" class="RktValLink" data-pltdoc="x">make-data+root+doc-id</a></span>, from which
<span class="RktVar">data</span> part is used as serialized information, the
<span class="RktVar">root</span> part overrides <span class="RktVar">root-path</span> for deserialization,
and the <span class="RktVar">doc-id</span> part (if any) overrides
<span class="RktSym">doc-id-string</span> to identify the source document.</p><p>The <span class="RktVar">demand-source</span> function can effectively add a new source
to <span class="RktVar">sources</span> in response to a search for information on the
given tag. The <span class="RktVar">demand-source</span> function returns <span class="RktVal">#f</span>
to indicate that no new sources satisfy the given tag.</p><p>Since the format of serialized information is specific to a rendering
class, the optional <span class="RktVar">using-render%</span> argument accepts the
relevant class. It defaults to HTML rendering, partly because
HTML-format information is usable by other formats (including
Latex/PDF and text).</p><p>If <span class="RktVar">root-path</span> is not <span class="RktVal">#f</span>, then file paths that are
serialized as relative to an instantiation-supplied <span class="RktVar">root-path</span>
are deserialized as relative instead to the given <span class="RktVar">root-path</span>,
but a <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-data%2Broot%29%29" class="RktValLink" data-pltdoc="x">make-data+root</a></span> result for any <span class="RktVar">info</span> supplies
an alternate path for deserialization of the <span class="RktVar">info</span>’s
<span class="RktVar">data</span>.</p><p>If <span class="RktVar">doc-id-str</span> is not <span class="RktVal">#f</span>, it identifies each
cross-reference entry as originating from <span class="RktVar">doc-id-str</span>. This
identification is used when a rendering link to the cross-reference
entry as an external query; see the <span class="RktSym">set-external-tag-path</span>
method of <span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fhtml-render..rkt%29._render-mixin%29%29" class="RktValLink" data-pltdoc="x">render-mixin</a></span>.</p><p>Use <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=raco&rel=xref.html%23%2528def._%2528%2528lib._setup%252Fxref..rkt%2529._load-collections-xref%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">load-collections-xref</a></span> from <a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=raco&rel=xref.html&version=6.7" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">setup/xref</span></a> to
get all cross-reference information for installed documentation.</p><p class="SHistory">Changed in version 1.1 of package <span class="stt">scribble-lib</span>: Added the <span class="RktPn">#:doc-id</span> argument.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><table cellspacing="0" cellpadding="0" class="prototype RForeground"><tr><td valign="top"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._xref-binding-~3edefinition-tag))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-binding-~3edefinition-tag%29%29" class="RktValDef RktValLink" data-pltdoc="x">xref-binding->definition-tag</a></span></span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">xref</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">binding</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">mode</span><span class="RktPn">)</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">→</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._tag~3f%29%29" class="RktValLink" data-pltdoc="x">tag?</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="RktPn">)</span></td></tr></table></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">xref</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref~3f%29%29" class="RktValLink" data-pltdoc="x">xref?</a></span></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="argcontract"><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">binding</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">:</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><table cellspacing="0" cellpadding="0" class="RktBlk"><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=stxops.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fstx..rkt%2529._identifier%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">identifier?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._list%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">list/c</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Module_Names_and_Loading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._module-path%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">module-path?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Module_Names_and_Loading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._module-path-index%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">module-path-index?</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=symbols.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._symbol%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">symbol?</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Module_Names_and_Loading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._module-path-index%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">module-path-index?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=symbols.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._symbol%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">symbol?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Module_Names_and_Loading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._module-path-index%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">module-path-index?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=symbols.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._symbol%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">symbol?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._one-of%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">one-of/c</a></span><span class="hspace"> </span><span class="RktVal">0</span><span class="hspace"> </span><span class="RktVal">1</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=number-types.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._exact-integer%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">exact-integer?</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=number-types.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._exact-integer%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">exact-integer?</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="RktPn">)</span><span class="RktPn">)</span><span class="RktPn">)</span></td></tr></table></td></tr></table></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">mode</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=number-types.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._exact-integer%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">exact-integer?</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="RktPn">)</span></td></tr></table></blockquote></div><div class="SIntrapara">Locates a tag in <span class="RktVar">xref</span> that documents a module export. The
binding is specified in one of several ways, as described below; all
possibilities encode an exporting module and a symbolic name. The name
must be exported from the specified module. Documentation is found
either for the specified module or, if the exported name is
re-exported from other other module, for the other module
(transitively).</div></p><p>The <span class="RktVar">mode</span> argument specifies the relevant phase level for the
binding. The <span class="RktVar">binding</span> is specified in one of four ways:</p><ul><li><p>If <span class="RktVar">binding</span> is an identifier, then
<span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=stxcmp.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._identifier-binding%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">identifier-binding</a></span> is used with <span class="RktVar">mode</span> to
determine the binding.</p></li><li><p>If <span class="RktVar">binding</span> is a two-element list, then the first
element provides the exporting module and the second the
exported name. The <span class="RktVar">mode</span> argument is effectively
ignored.</p></li><li><p>If <span class="RktVar">binding</span> is a seven-element list, then it corresponds
to a result from <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=stxcmp.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._identifier-binding%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">identifier-binding</a></span> using
<span class="RktVar">mode</span>.</p></li><li><p>If <span class="RktVar">binding</span> is a five-element list, then the first
element is as for the two-element-list case, and the remain
elements are as in the last four elements of the seven-element
case.</p></li></ul><p>If a documentation point exists in <span class="RktVar">xref</span>, a tag is returned,
which might be used with <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-tag-~3epath%2Banchor%29%29" class="RktValLink" data-pltdoc="x">xref-tag->path+anchor</a></span> or embedded in
a document rendered via <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-render%29%29" class="RktValLink" data-pltdoc="x">xref-render</a></span>. If no definition point
is found in <span class="RktVar">xref</span>, the result is <span class="RktVal">#f</span>.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><table cellspacing="0" cellpadding="0" class="prototype RForeground"><tr><td valign="top"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._xref-tag-~3epath+anchor))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-tag-~3epath%2Banchor%29%29" class="RktValDef RktValLink" data-pltdoc="x">xref-tag->path+anchor</a></span></span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">xref</span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">tag</span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span>[</td><td valign="top"><span class="RktPn">#:external-root-url</span><span class="hspace"> </span><span class="RktVar">root-url</span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">#:render%</span><span class="hspace"> </span><span class="RktVar">using-render%</span>]<span class="RktPn">)</span></td><td valign="top"><span class="hspace"> </span></td></tr></table></blockquote></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="prototype"><tr><td valign="top"><span class="hspace"> </span></td><td valign="top">→</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><table cellspacing="0" cellpadding="0"><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Manipulating_Paths.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._path%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">path?</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="RktPn">)</span></td></tr></table></td></tr></table></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">xref</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref~3f%29%29" class="RktValLink" data-pltdoc="x">xref?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">tag</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._tag~3f%29%29" class="RktValLink" data-pltdoc="x">tag?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">root-url</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="hspace"> </span><span class="RktVal">#f</span><span class="RktPn">)</span><span class="hspace"> </span>=<span class="hspace"> </span><span class="RktVal">#f</span></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="argcontract"><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">using-render%</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">:</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Object_and_Class_Contracts.html%23%2528def._%2528%2528lib._racket%252Fclass..rkt%2529._implementation%7E3f%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">implementation?/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fbase-render..rkt%29._render~3c~25~3e%29%29" class="RktValLink" data-pltdoc="x">render<%></a></span><span class="RktPn">)</span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">=</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">(</span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fhtml-render..rkt%29._render-mixin%29%29" class="RktValLink" data-pltdoc="x">render-mixin</a></span><span class="hspace"> </span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fbase-render..rkt%29._render~25%29%29" class="RktValLink" data-pltdoc="x">render%</a></span><span class="RktPn">)</span></td></tr></table></td></tr></table></blockquote></div><div class="SIntrapara">Returns a path and anchor string designated by the key <span class="RktVar">tag</span>
according the cross-reference <span class="RktVar">xref</span>. The first result is
<span class="RktVal">#f</span> if no mapping is found for the given tag. The second
result is <span class="RktVal">#f</span> if the first result is <span class="RktVal">#f</span>, and it can
also be <span class="RktVal">#f</span> if the tag refers to a page rather than a specific
point in a page.</div></p><p>If <span class="RktVar">root-url</span> is provided, then references to documentation in
the main installation are redirected to the given URL.</p><p>The optional <span class="RktVar">using-render%</span> argument is as for
<span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._load-xref%29%29" class="RktValLink" data-pltdoc="x">load-xref</a></span>.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._xref-tag-~3eindex-entry))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-tag-~3eindex-entry%29%29" class="RktValDef RktValLink" data-pltdoc="x">xref-tag->index-entry</a></span></span><span class="hspace"> </span><span class="RktVar">xref</span><span class="hspace"> </span><span class="RktVar">tag</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._entry~3f%29%29" class="RktValLink" data-pltdoc="x">entry?</a></span><span class="RktPn">)</span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">xref</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref~3f%29%29" class="RktValLink" data-pltdoc="x">xref?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">tag</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._tag~3f%29%29" class="RktValLink" data-pltdoc="x">tag?</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Extract an <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._entry%29%29" class="RktValLink" data-pltdoc="x">entry</a></span> structure that provides addition information
about the definition (of any) referenced by <span class="RktVar">tag</span>. This
function can be composed with <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-binding-~3edefinition-tag%29%29" class="RktValLink" data-pltdoc="x">xref-binding->definition-tag</a></span> to
obtain information about a binding, such as the library that exports
the binding and its original name.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><table cellspacing="0" cellpadding="0" class="prototype RForeground"><tr><td valign="top"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._xref-render))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-render%29%29" class="RktValDef RktValLink" data-pltdoc="x">xref-render</a></span></span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">xref</span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">doc</span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">dest</span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span>[</td><td valign="top"><span class="RktPn">#:render%</span><span class="hspace"> </span><span class="RktVar">using-render%</span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">#:refer-to-existing-files?</span><span class="hspace"> </span><span class="RktVar">use-existing?</span>]<span class="RktPn">)</span></td><td valign="top"><span class="hspace"> </span></td></tr></table></blockquote></td></tr><tr><td><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=void.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._void%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">void?</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">xref</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref~3f%29%29" class="RktValLink" data-pltdoc="x">xref?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">doc</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._part~3f%29%29" class="RktValLink" data-pltdoc="x">part?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">dest</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._false%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">false/c</a></span><span class="RktPn">)</span></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="argcontract"><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">using-render%</span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">:</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">(</span><span class="RktSym">implemenation?/c</span><span class="hspace"> </span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fbase-render..rkt%29._render~3c~25~3e%29%29" class="RktValLink" data-pltdoc="x">render<%></a></span><span class="RktPn">)</span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top">=</td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktPn">(</span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fhtml-render..rkt%29._render-mixin%29%29" class="RktValLink" data-pltdoc="x">render-mixin</a></span><span class="hspace"> </span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fbase-render..rkt%29._render~25%29%29" class="RktValLink" data-pltdoc="x">render%</a></span><span class="RktPn">)</span></td></tr></table></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">use-existing?</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span><span class="hspace"> </span>=<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=booleans.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._not%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">not</a></span><span class="hspace"> </span><span class="RktVar">dest</span><span class="RktPn">)</span></td></tr></table></blockquote></div><div class="SIntrapara">Renders <span class="RktVar">doc</span> using the cross-reference info in <span class="RktVar">xref</span>
to the destination <span class="RktVar">dest</span>. For example, <span class="RktVar">doc</span> might be a
generated document of search results using link tags described in
<span class="RktVar">xref</span>.</div></p><p>If <span class="RktVar">dest</span> is <span class="RktVal">#f</span>, no file is written, and the result is
an X-expression for the rendered page. Otherwise, the file
<span class="RktVar">dest</span> is written and the result is <a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=guide&rel=void_undefined.html&version=6.7" class="RktModLink Sq" data-pltdoc="x"><span class="nobreak"><span class="RktRes">#<void></span></span></a>.</p><p>The optional <span class="RktVar">using-render%</span> argument is as for
<span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._load-xref%29%29" class="RktValLink" data-pltdoc="x">load-xref</a></span>. It determines the kind of output that is
generated.</p><p>If <span class="RktVar">use-existing?</span> is true, then files referenced during
rendering (such as image files) are referenced from their existing
locations, instead of copying to the directory of <span class="RktVar">dest</span>.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._xref-transfer-info))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-transfer-info%29%29" class="RktValDef RktValLink" data-pltdoc="x">xref-transfer-info</a></span></span><span class="hspace"> </span><span class="RktVar">renderer</span><span class="hspace"> </span><span class="RktVar">ci</span><span class="hspace"> </span><span class="RktVar">xref</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=void.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._void%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">void?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">renderer</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Object_and_Class_Contracts.html%23%2528def._%2528%2528lib._racket%252Fclass..rkt%2529._is-a%7E3f%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">is-a?/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="renderer.html#%28def._%28%28lib._scribble%2Fbase-render..rkt%29._render~3c~25~3e%29%29" class="RktValLink" data-pltdoc="x">render<%></a></span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">ci</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._collect-info~3f%29%29" class="RktValLink" data-pltdoc="x">collect-info?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">xref</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref~3f%29%29" class="RktValLink" data-pltdoc="x">xref?</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Transfers cross-reference information to <span class="RktVar">ci</span>, which is the
initially collected information from <span class="RktVar">renderer</span>.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._xref-index))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref-index%29%29" class="RktValDef RktValLink" data-pltdoc="x">xref-index</a></span></span><span class="hspace"> </span><span class="RktVar">xref</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._entry~3f%29%29" class="RktValLink" data-pltdoc="x">entry?</a></span><span class="RktPn">)</span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">xref</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._xref~3f%29%29" class="RktValLink" data-pltdoc="x">xref?</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Converts indexing information <span class="RktVar">xref</span> into a list of
<span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._entry%29%29" class="RktValLink" data-pltdoc="x">entry</a></span> structures.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>struct</p></div></div><table cellspacing="0" cellpadding="0" class="RForeground"><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=define-struct.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._struct%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">struct</a></span></td><td><span class="hspace"> </span></td><td><a name="(def._((lib._scribble/xref..rkt)._entry-desc))"></a><a name="(def._((lib._scribble/xref..rkt)._entry-tag))"></a><a name="(def._((lib._scribble/xref..rkt)._entry-content))"></a><a name="(def._((lib._scribble/xref..rkt)._entry-words))"></a><a name="(def._((lib._scribble/xref..rkt)._make-entry))"></a><a name="(def._((lib._scribble/xref..rkt)._entry~3f))"></a><a name="(def._((lib._scribble/xref..rkt)._struct~3aentry))"></a><a name="(def._((lib._scribble/xref..rkt)._entry))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._entry%29%29" class="RktValDef RktValLink" data-pltdoc="x">entry</a></span></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym">words</span><span class="stt"> </span><span class="RktSym">content</span><span class="stt"> </span><span class="RktSym">tag</span><span class="stt"> </span><span class="RktSym">desc</span><span class="RktPn">)</span></td></tr></table></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">#:extra-constructor-name</span><span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-entry%29%29" class="RktValLink" data-pltdoc="x">make-entry</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">words</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._and%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">and/c</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="RktPn">)</span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=pairs.html%23%2528def._%2528%2528lib._racket%252Flist..rkt%2529._cons%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">cons?</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">content</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">list?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">tag</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._tag~3f%29%29" class="RktValLink" data-pltdoc="x">tag?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">desc</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Represents a single entry in a Scribble document index.</div></p><p>The <span class="RktSym">words</span> list corresponds to
<span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._index-element-plain-seq%29%29" class="RktValLink" data-pltdoc="x">index-element-plain-seq</a></span>. The <span class="RktSym">content</span> list
corresponds to <span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._index-element-entry-seq%29%29" class="RktValLink" data-pltdoc="x">index-element-entry-seq</a></span>. The <span class="RktSym">desc</span>
value corresponds to <span class="RktSym"><a href="core.html#%28def._%28%28lib._scribble%2Fcore..rkt%29._index-element-desc%29%29" class="RktValLink" data-pltdoc="x">index-element-desc</a></span>. The <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=creatingunits.html%23%2528form._%2528%2528lib._racket%252Funit..rkt%2529._tag%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">tag</a></span> is
the destination for the index link into the main document.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><table cellspacing="0" cellpadding="0" class="together"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._data+root~3f))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._data%2Broot~3f%29%29" class="RktValDef RktValLink" data-pltdoc="x">data+root?</a></span></span><span class="hspace"> </span><span class="RktVar">v</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=booleans.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._boolean%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">boolean?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">v</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></td></tr></table></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="together"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._make-data+root))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-data%2Broot%29%29" class="RktValDef RktValLink" data-pltdoc="x">make-data+root</a></span></span><span class="hspace"> </span><span class="RktVar">data</span><span class="hspace"> </span><span class="RktVar">root</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._data%2Broot~3f%29%29" class="RktValLink" data-pltdoc="x">data+root?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">data</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">root</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktVal">#f</span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="RktPn">)</span></td></tr></table></td></tr></table></blockquote></div><div class="SIntrapara">A value constructed by <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-data%2Broot%29%29" class="RktValLink" data-pltdoc="x">make-data+root</a></span> can be returned by a
source procedure for <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._load-xref%29%29" class="RktValLink" data-pltdoc="x">load-xref</a></span> to specify a path used for
deserialization.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><table cellspacing="0" cellpadding="0" class="together"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._data+root+doc-id~3f))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._data%2Broot%2Bdoc-id~3f%29%29" class="RktValDef RktValLink" data-pltdoc="x">data+root+doc-id?</a></span></span><span class="hspace"> </span><span class="RktVar">v</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=booleans.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._boolean%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">boolean?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">v</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></td></tr></table></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="together"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._scribble/xref..rkt)._make-data+root+doc-id))"></a><span title="Provided from: scribble/xref | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-data%2Broot%2Bdoc-id%29%29" class="RktValDef RktValLink" data-pltdoc="x">make-data+root+doc-id</a></span></span><span class="hspace"> </span><span class="RktVar">data</span><span class="hspace"> </span><span class="RktVar">root</span><span class="hspace"> </span><span class="RktVar">doc-id</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._data%2Broot%2Bdoc-id~3f%29%29" class="RktValLink" data-pltdoc="x">data+root+doc-id?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">data</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">root</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._or%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktVal">#f</span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">doc-id</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span></td></tr></table></td></tr></table></blockquote></div><div class="SIntrapara">Extends <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._make-data%2Broot%2Bdoc-id%29%29" class="RktValLink" data-pltdoc="x">make-data+root+doc-id</a></span> to support an
document-identifying string (see <span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fxref..rkt%29._load-xref%29%29" class="RktValLink" data-pltdoc="x">load-xref</a></span>).</div></p><p class="SHistory">Added in version 1.1 of package <span class="stt">scribble-lib</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="docreader.html" title="backward to "6.7 Document Reader"" data-pltdoc="x">← prev</a> <a href="internals.html" title="up to "6 Low-Level Scribble API"" data-pltdoc="x">up</a> <a href="tag.html" title="forward to "6.9 Tag Utilities"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|