| Server IP : 82.148.16.210 / Your IP : 216.73.217.46 Web Server : nginx/1.29.5 System : Linux mail.sarafai.ru 6.1.0-43-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.162-1 (2026-02-08) x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /proc/thread-self/root/usr/share/doc/python3-docutils/docs/ref/rst/ |
Upload File : |
<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> <title>reStructuredText Standard Definition Files</title> <meta name="author" content="David Goodger" /> <meta name="date" content="2022-04-02" /> <meta name="copyright" content="This document has been placed in the public domain." /> <link rel="stylesheet" href="../../../css/html4css1.css" type="text/css" /> </head> <body> <div class="header"> <a class="reference external" href="https://docutils.sourceforge.io">Docutils</a> | <a class="reference external" href="../../index.html">Overview</a> | <a class="reference external" href="../../index.html#project-fundamentals">About</a> | <a class="reference external" href="../../index.html#user">Users</a> | <a class="reference external" href="../../index.html#ref">Reference</a> | <a class="reference external" href="../../index.html#howto">Developers</a> <hr class="header"/> </div> <div class="document" id="restructuredtext-standard-definition-files"> <h1 class="title">reStructuredText Standard Definition Files</h1> <table class="docinfo" frame="void" rules="none"> <col class="docinfo-name" /> <col class="docinfo-content" /> <tbody valign="top"> <tr><th class="docinfo-name">Author:</th> <td>David Goodger</td></tr> <tr><th class="docinfo-name">Contact:</th> <td><a class="first last reference external" href="mailto:docutils-develop@lists.sourceforge.net">docutils-develop@lists.sourceforge.net</a></td></tr> <tr><th class="docinfo-name">Revision:</th> <td>9051</td></tr> <tr><th class="docinfo-name">Date:</th> <td>2022-04-02</td></tr> <tr><th class="docinfo-name">Copyright:</th> <td>This document has been placed in the public domain.</td></tr> </tbody> </table> <!-- Minimal menu bar for inclusion in documentation sources in ``docutils/docs/*/`` sub-sub-diretories. Attention: this is not a standalone document. --> <div class="contents topic" id="contents"> <p class="topic-title">Contents</p> <ul class="simple"> <li><a class="reference internal" href="#substitution-definitions" id="toc-entry-1">Substitution Definitions</a><ul> <li><a class="reference internal" href="#character-entity-sets" id="toc-entry-2">Character Entity Sets</a></li> </ul> </li> <li><a class="reference internal" href="#s5-html-definitions" id="toc-entry-3">S5/HTML Definitions</a></li> </ul> </div> <p>This document describes standard definition files, such as sets of substitution definitions and interpreted text roles, that can be included in reStructuredText documents. The <a class="reference external" href="directives.html#include">"include" directive</a> has a special syntax for these standard definition files, angle brackets around the file name:</p> <pre class="literal-block"> .. include:: <filename.txt> </pre> <p>The individual data files are stored with the Docutils source code in the "docutils" package, in the <tt class="docutils literal">docutils/parsers/rst/include</tt> directory.</p> <div class="section" id="substitution-definitions"> <h1><a class="toc-backref" href="#toc-entry-1">Substitution Definitions</a></h1> <p>Many of the standard definition files contain sets of <a class="reference external" href="restructuredtext.html#substitution-definitions">substitution definitions</a>, which can be used in documents via <a class="reference external" href="restructuredtext.html#substitution-references">substitution references</a>. For example, the copyright symbol is defined in <tt class="docutils literal">isonum.txt</tt> as "copy":</p> <pre class="literal-block"> .. include:: <isonum.txt> Copyright |copy| 2003 by John Q. Public, all rights reserved. </pre> <p>Individual substitution definitions can also be copied from definition files and pasted into documents. This has two advantages: it removes dependencies, and it saves processing of unused definitions. However, multiple substitution definitions add clutter to the document.</p> <p>Substitution references require separation from the surrounding text with whitespace or punctuation. To use a substitution without intervening whitespace, you can use the disappearing-whitespace escape sequence, backslash-space:</p> <pre class="literal-block"> .. include:: isonum.txt Copyright |copy| 2003, BogusMegaCorp\ |trade|. </pre> <p>Custom substitution definitions may use the <a class="reference external" href="directives.html#unicode">"unicode" directive</a>. Whitespace is ignored and removed, effectively sqeezing together the text:</p> <pre class="literal-block"> .. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN .. |BogusMegaCorp (TM)| unicode:: BogusMegaCorp U+2122 .. with trademark sign Copyright |copy| 2003, |BogusMegaCorp (TM)|. </pre> <p>In addition, the "ltrim", "rtrim", and "trim" options may be used with the "unicode" directive to automatically trim spaces from the left, right, or both sides (respectively) of substitution references:</p> <pre class="literal-block"> .. |---| unicode:: U+02014 .. em dash :trim: </pre> <div class="section" id="character-entity-sets"> <h2><a class="toc-backref" href="#toc-entry-2">Character Entity Sets</a></h2> <p>The following files contain substitution definitions corresponding to XML character entity sets, from the following standards: ISO 8879 & ISO 9573-13 (combined), MathML, and XHTML1. They were generated by the <tt class="docutils literal">tools/dev/unicode2rstsubs.py</tt> program from the input file <a class="reference external" href="https://www.w3.org/2003/entities/xml/">unicode.xml</a>, which is maintained as part of the MathML 2 Recommentation XML source.</p> <table border="1" class="docutils"> <colgroup> <col width="28%" /> <col width="72%" /> </colgroup> <thead valign="bottom"> <tr><th class="head">Entity Set File</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isoamsa.txt">isoamsa.txt</a></td> <td>Added Mathematical Symbols: Arrows</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isoamsb.txt">isoamsb.txt</a></td> <td>Added Mathematical Symbols: Binary Operators</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isoamsc.txt">isoamsc.txt</a></td> <td>Added Mathematical Symbols: Delimiters</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isoamsn.txt">isoamsn.txt</a></td> <td>Added Mathematical Symbols: Negated Relations</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isoamso.txt">isoamso.txt</a></td> <td>Added Mathematical Symbols: Ordinary</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isoamsr.txt">isoamsr.txt</a></td> <td>Added Mathematical Symbols: Relations</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isobox.txt">isobox.txt</a></td> <td>Box and Line Drawing</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isocyr1.txt">isocyr1.txt</a></td> <td>Russian Cyrillic</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isocyr2.txt">isocyr2.txt</a></td> <td>Non-Russian Cyrillic</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isodia.txt">isodia.txt</a></td> <td>Diacritical Marks</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isogrk1.txt">isogrk1.txt</a></td> <td>Greek Letters</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isogrk2.txt">isogrk2.txt</a></td> <td>Monotoniko Greek</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isogrk3.txt">isogrk3.txt</a></td> <td>Greek Symbols</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isogrk4.txt">isogrk4.txt</a> <a class="footnote-reference" href="#footnote-1" id="footnote-reference-1">[1]</a></td> <td>Alternative Greek Symbols</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isolat1.txt">isolat1.txt</a></td> <td>Added Latin 1</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isolat2.txt">isolat2.txt</a></td> <td>Added Latin 2</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isomfrk.txt">isomfrk.txt</a> <a class="footnote-reference" href="#footnote-1" id="footnote-reference-2">[1]</a></td> <td>Mathematical Fraktur</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isomopf.txt">isomopf.txt</a> <a class="footnote-reference" href="#footnote-1" id="footnote-reference-3">[1]</a></td> <td>Mathematical Openface (Double-struck)</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isomscr.txt">isomscr.txt</a> <a class="footnote-reference" href="#footnote-1" id="footnote-reference-4">[1]</a></td> <td>Mathematical Script</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isonum.txt">isonum.txt</a></td> <td>Numeric and Special Graphic</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isopub.txt">isopub.txt</a></td> <td>Publishing</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/isotech.txt">isotech.txt</a></td> <td>General Technical</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/mmlalias.txt">mmlalias.txt</a></td> <td>MathML aliases for entities from other sets</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/mmlextra.txt">mmlextra.txt</a> <a class="footnote-reference" href="#footnote-1" id="footnote-reference-5">[1]</a></td> <td>Extra names added by MathML</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/xhtml1-lat1.txt">xhtml1-lat1.txt</a></td> <td>XHTML Latin 1</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/xhtml1-special.txt">xhtml1-special.txt</a></td> <td>XHTML Special Characters</td> </tr> <tr><td><a class="reference external" href="../../../docutils/parsers/rst/include/xhtml1-symbol.txt">xhtml1-symbol.txt</a></td> <td>XHTML Mathematical, Greek and Symbolic Characters</td> </tr> </tbody> </table> <table class="docutils footnote" frame="void" id="footnote-1" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label">[1]</td><td><em>(<a class="fn-backref" href="#footnote-reference-1">1</a>, <a class="fn-backref" href="#footnote-reference-2">2</a>, <a class="fn-backref" href="#footnote-reference-3">3</a>, <a class="fn-backref" href="#footnote-reference-4">4</a>, <a class="fn-backref" href="#footnote-reference-5">5</a>)</em> There are <tt class="docutils literal"><span class="pre">*-wide.txt</span></tt> variants for each of these character entity set files, containing characters outside of the Unicode basic multilingual plane or BMP (wide-Unicode; code points greater than U+FFFF). Most pre-built Python distributions are "narrow" and do not support wide-Unicode characters. Python <em>can</em> be built with wide-Unicode support though; consult the Python build instructions for details.</td></tr> </tbody> </table> <p>For example, the copyright symbol is defined as the XML character entity <tt class="docutils literal">&copy;</tt>. The equivalent reStructuredText substitution reference (defined in both <tt class="docutils literal">isonum.txt</tt> and <tt class="docutils literal"><span class="pre">xhtml1-lat1.txt</span></tt>) is <tt class="docutils literal">|copy|</tt>.</p> </div> </div> <div class="section" id="s5-html-definitions"> <h1><a class="toc-backref" href="#toc-entry-3">S5/HTML Definitions</a></h1> <p>The "<a class="reference external" href="../../../docutils/parsers/rst/include/s5defs.txt">s5defs.txt</a>" standard definition file contains interpreted text roles (classes) and other definitions for documents destined to become <a class="reference external" href="../../user/slide-shows.html">S5/HTML slide shows</a>.</p> <!-- Local Variables: mode: indented-text indent-tabs-mode: nil sentence-end-double-space: t fill-column: 70 End: --> </div> </div> </body> </html>