1
0
Fork 0
cl-sites/guile.html_node/texinfo-html.html

105 lines
5.5 KiB
HTML
Raw Normal View History

2024-12-17 12:49:28 +01:00
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual documents Guile version 3.0.10.
Copyright (C) 1996-1997, 2000-2005, 2009-2023 Free Software Foundation,
Inc.
Copyright (C) 2021 Maxime Devos
Copyright (C) 2024 Tomas Volf
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License." -->
<title>texinfo html (Guile Reference Manual)</title>
<meta name="description" content="texinfo html (Guile Reference Manual)">
<meta name="keywords" content="texinfo html (Guile Reference Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content=".texi2any-real">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Texinfo-Processing.html" rel="up" title="Texinfo Processing">
<link href="texinfo-indexing.html" rel="next" title="texinfo indexing">
<link href="texinfo-docbook.html" rel="prev" title="texinfo docbook">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css">
</head>
<body lang="en">
<div class="subsection-level-extent" id="texinfo-html">
<div class="nav-panel">
<p>
Next: <a href="texinfo-indexing.html" accesskey="n" rel="next">(texinfo indexing)</a>, Previous: <a href="texinfo-docbook.html" accesskey="p" rel="prev">(texinfo docbook)</a>, Up: <a href="Texinfo-Processing.html" accesskey="u" rel="up">Texinfo Processing</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="g_t_0028texinfo-html_0029"><span>7.22.3 (texinfo html)<a class="copiable-link" href="#g_t_0028texinfo-html_0029"> &para;</a></span></h4>
<ul class="mini-toc">
<li><a href="#Overview-7" accesskey="1">Overview</a></li>
<li><a href="#Usage-7" accesskey="2">Usage</a></li>
</ul>
<div class="subsubsection-level-extent" id="Overview-7">
<h4 class="subsubsection"><span>7.22.3.1 Overview<a class="copiable-link" href="#Overview-7"> &para;</a></span></h4>
<p>This module implements transformation from <code class="code">stexi</code> to HTML. Note
that the output of <code class="code">stexi-&gt;shtml</code> is actually SXML with the HTML
vocabulary. This means that the output can be further processed, and
that it must eventually be serialized by <code class="code">sxml-&gt;xml</code>.
See <a class="xref" href="Reading-and-Writing-XML.html">Reading and Writing XML</a>.
</p>
<p>References (i.e., the <code class="code">@ref</code> family of commands) are resolved by a
<em class="dfn">ref-resolver</em>. See <a class="xref" href="#texinfo-html-add_002dref_002dresolver_0021">add-ref-resolver!</a>.
</p>
</div>
<div class="subsubsection-level-extent" id="Usage-7">
<h4 class="subsubsection"><span>7.22.3.2 Usage<a class="copiable-link" href="#Usage-7"> &para;</a></span></h4>
<a class="anchor" id="texinfo-html-add_002dref_002dresolver_0021"></a><dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-add_002dref_002dresolver_0021"><span class="category-def">Function: </span><span><strong class="def-name">add-ref-resolver!</strong> <var class="def-var-arguments">proc</var><a class="copiable-link" href="#index-add_002dref_002dresolver_0021"> &para;</a></span></dt>
<dd><p>Add <var class="var">proc</var> to the head of the list of ref-resolvers. <var class="var">proc</var> will
be expected to take the name of a node and the name of a manual and
return the URL of the referent, or <code class="code">#f</code> to pass control to the next
ref-resolver in the list.
</p>
<p>The default ref-resolver will return the concatenation of the manual
name, <code class="code">#</code>, and the node name.
</p>
</dd></dl>
<a class="anchor" id="texinfo-html-stexi_002d_003eshtml"></a><dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-stexi_002d_003eshtml"><span class="category-def">Function: </span><span><strong class="def-name">stexi-&gt;shtml</strong> <var class="def-var-arguments">tree</var><a class="copiable-link" href="#index-stexi_002d_003eshtml"> &para;</a></span></dt>
<dd><p>Transform the stexi <var class="var">tree</var> into shtml, resolving references via
ref-resolvers. See the module commentary for more details.
</p>
</dd></dl>
<a class="anchor" id="texinfo-html-urlify"></a><dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-urlify"><span class="category-def">Function: </span><span><strong class="def-name">urlify</strong> <var class="def-var-arguments">str</var><a class="copiable-link" href="#index-urlify"> &para;</a></span></dt>
</dl>
</div>
</div>
</body>
</html>