srfi-template.html

<!DOCTYPE html>
<html lang="en">
<!--
SPDX-FileCopyrightText: [year] [copyright holder]
SPDX-License-Identifier: MIT
-->
  <head>
    <meta charset="utf-8">
    <title>SRFI ###: ???title???</title>
    <link href="/favicon.png" rel="icon" sizes="192x192" type="image/png">
    <link rel="stylesheet" href="https://srfi.schemers.org/srfi.css" type="text/css">
    <meta name="viewport" content="width=device-width, initial-scale=1"></head>
  <body>
    <h1><a href="https://srfi.schemers.org/"><img class="srfi-logo" src="https://srfi.schemers.org/srfi-logo.svg" alt="SRFI surfboard logo" /></a>###: ???title???</h1>

<p>by ???author(s)???</p>

<h2 id="status">Status</h2>

<p style="color: red;">For editor's use only.  Please do not edit this section.</p>

<p>??? the draft/final/withdrawn status of the SRFI, information on how
to subscribe to its mailing list, and important dates in its history.
The editor will add this section.</p>

<h2 id="abstract">Abstract</h2>

<p>??? abstract, preferably shorter than 200 words.  Please outline the
need for, and design of, the proposal.</p>

<h2 id="issues">Issues</h2>

<p>??? Optional section that may point out things to be resolved.  This
will not appear in the final SRFI.</p>

<h2 id="rationale">Rationale</h2>

<p>??? detailed rationale.  This should be 200-500 words long.  Please
explain why the proposal should be incorporated as a standard feature
in Scheme implementations.  List related standards and SRFIs,
including dependencies, conflicts, and replacements.  If there are
other standards which this proposal will replace or with which it will
compete, please explain why the present proposal is a substantial
improvement.</p>

<h2 id="specification">Specification</h2>

<p>??? detailed specification.  This should be detailed enough that a
conforming implementation could be completely created from this
description.</p>

<p>Please include examples.  They make it much easier for readers to
understand your proposal.</p>

<p>Please follow the linguistic conventions described in the <a
href="/srfi-faq.html#conventions">FAQ</a>.  In particular, please
follow the conventions about the use of the terms <dfn>must,</dfn> <dfn>must not,</dfn>
<dfn>required,</dfn> <dfn>shall,</dfn> <dfn>shall not,</dfn> <dfn>should,</dfn> <dfn>should not,</dfn>
<dfn>recommended,</dfn> <dfn>may,</dfn> and <dfn>optional</dfn> defined by <a
href="https://www.ietf.org/rfc/rfc2119.html">RFC 2119</a>.  This
convention has been adopted by R7RS Small, too, in section 1.3.2
(<a href="https://small.r7rs.org/attachment/r7rs.pdf">PDF</a>).</p>

<p>Also by convention, the phrase <dfn>it is an error to <em>X</em></dfn> is used in
Scheme documents to mean that <em>X</em> is not allowed, but to leave
it up to the implementer to decide what to do in response.
Implementations may signal an error, assign some new meaning to
<em>X</em>, or fail catastrophically.</p>

<h2 id="implementation">Implementation</h2>

<p>??? explanation of how it meets the sample implementation
requirement (see <a href="srfi-process.html">process</a>), and the
code, if possible, or a link to it</p>

<p>We use the phrase <dfn>sample implementation</dfn> instead of
<dfn>reference implementation</dfn> because the latter implies that
the implementation itself is the source of truth, whereas for SRFIs,
the document is normative.</p>

<a href="srfi-minus-???-sample.scm">Source for the sample implementation.</a>

<h2 id="acknowledgements">Acknowledgements</h2>

<p>??? credit where it is due.  For example, please consider
acknowledging people on the SRFI mailing list who have contributed to
the discussion.</p>

<h2 id="copyright">Copyright</h2>
<p>&copy; 202? ???author(s)???.</p>

<p>
  Permission is hereby granted, free of charge, to any person
  obtaining a copy of this software and associated documentation files
  (the "Software"), to deal in the Software without restriction,
  including without limitation the rights to use, copy, modify, merge,
  publish, distribute, sublicense, and/or sell copies of the Software,
  and to permit persons to whom the Software is furnished to do so,
  subject to the following conditions:</p>

<p>
  The above copyright notice and this permission notice (including the
  next paragraph) shall be included in all copies or substantial
  portions of the Software.</p>

<p>
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.</p>

  <hr>
  <address>Editor: <a href="mailto:srfi-editors+at+srfi+dot+schemers+dot+org">Arthur A. Gleckler</a></address></body></html>