diff options
author | Karl Berry <karl@freefriends.org> | 2020-09-03 21:07:12 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2020-09-03 21:07:12 +0000 |
commit | 2460993119d8ffa82074d9f0c61b828dda39799b (patch) | |
tree | f1341cde2e628d4fc76ee015fc3bf4241c4c9be5 /Master/texmf-dist/doc/latex | |
parent | 24747f42d2ae33e72bd6cb817501a16951912000 (diff) |
docutils (3sep20)
git-svn-id: svn://tug.org/texlive/trunk@56252 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r-- | Master/texmf-dist/doc/latex/docutils/README.md | 69 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/docutils/docutils.sty.html | 831 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/docutils/docutils.sty.txt | 275 |
3 files changed, 1175 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/docutils/README.md b/Master/texmf-dist/doc/latex/docutils/README.md new file mode 100644 index 00000000000..2a0cc3b195d --- /dev/null +++ b/Master/texmf-dist/doc/latex/docutils/README.md @@ -0,0 +1,69 @@ +docutils.sty +============ + +Helper commands and element definitions for Docutils_ LaTeX output. + +:Copyright: © 2020 Günter Milde + +:Licence: Released under the terms of the `2-Clause BSD license`__ + + __ https://opensource.org/licenses/BSD-2-Clause + + +Changelog +--------- + +| 2020-08-28 first public version for Docutils >= 0.17 + +Requirements +------------ + +None. + +Installation +------------ + +If possible, get this package from your distribution using its +installation manager. Alternatively, copy/move/link ``docutils.sty`` +to a place where LaTeX can find it. + +Usage +----- + +The package is intended for use with LaTeX documents generated from +reStructuredText_ sources with Docutils_. + +When generating LaTeX documents, specify this package with the +`"stylesheet"`_ `configuration option`_, e.g. :: + + rst2latex --stylesheet=docutils exampledocument.txt + +The the Docutils `LaTeX writer` will then reference this package +istead of inserting required definitions into the preamble of +generated documents (see the `Docutils LaTeX Writer documentation`_ +for details). + +.. _reStructuredText: https://en.wikipedia.org/wiki/ReStructuredText + +.. _Docutils: https://docutils.sourceforge.io/ + +.. _"stylesheet": + https://docutils.sourceforge.io/docs/user/config.html#stylesheet-latex-writers + +.. _configuration option: + https://docutils.sourceforge.io/docs/user/config.html + +.. _Docutils LaTeX Writer documentation: + https://docutils.sourceforge.io/docs/user/latex.html + +Documentation Generation +------------------------ + +The bidirectional text <-> code converter PyLit_ and Docutils_ +were used to generate the HTML documentation:: + + #> pylit docutils.sty + #> rst2html5 docutils.sty.txt docutils.sty.html + +.. _Pylit: https://repo.or.cz/pylit.git + diff --git a/Master/texmf-dist/doc/latex/docutils/docutils.sty.html b/Master/texmf-dist/doc/latex/docutils/docutils.sty.html new file mode 100644 index 00000000000..e3b59817731 --- /dev/null +++ b/Master/texmf-dist/doc/latex/docutils/docutils.sty.html @@ -0,0 +1,831 @@ +<!DOCTYPE html> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta charset="utf-8"/> +<meta name="generator" content="Docutils 0.17b.dev: http://docutils.sourceforge.net/" /> +<title>docutils.sty</title> +<style type="text/css"> + +/* Minimal style sheet for the HTML output of Docutils. */ +/* */ +/* :Author: Günter Milde, based on html4css1.css by David Goodger */ +/* :Id: $Id$ */ +/* :Copyright: © 2015 Günter Milde. */ +/* :License: Released under the terms of the `2-Clause BSD license`_, */ +/* in short: */ +/* */ +/* Copying and distribution of this file, with or without modification, */ +/* are permitted in any medium without royalty provided the copyright */ +/* notice and this notice are preserved. */ +/* */ +/* This file is offered as-is, without any warranty. */ +/* */ +/* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause */ + +/* This CSS2.1_ stylesheet defines rules for Docutils elements without */ +/* HTML equivalent. It is required to make the document semantic visible. */ +/* */ +/* .. _CSS2.1: http://www.w3.org/TR/CSS2 */ +/* .. _validates: http://jigsaw.w3.org/css-validator/validator$link */ + +/* alignment of text and inline objects inside block objects*/ +.align-left { text-align: left; } +.align-right { text-align: right; } +.align-center { clear: both; text-align: center; } +.align-top { vertical-align: top; } +.align-middle { vertical-align: middle; } +.align-bottom { vertical-align: bottom; } + +/* titles */ +h1.title, p.subtitle { + text-align: center; +} +p.topic-title, +p.sidebar-title, +p.rubric, +p.admonition-title, +p.system-message-title { + font-weight: bold; +} +h1 + p.subtitle, +h1 + p.section-subtitle { + font-size: 1.6em; +} +h2 + p.section-subtitle { + font-size: 1.28em; +} +p.subtitle, +p.section-subtitle, +p.sidebar-subtitle { + font-weight: bold; + margin-top: -0.5em; +} +p.sidebar-title { + font-size: larger; +} +p.rubric { + font-size: larger; + color: maroon; +} +a.toc-backref { + color: black; + text-decoration: none; } + +/* Warnings, Errors */ +div.system-messages h1, +span.problematic, +p.system-message-title { + color: red; +} + +/* inline literals */ +span.docutils.literal { + font-family: monospace; + white-space: pre-wrap; +} +/* do not wraph at hyphens and similar: */ +.literal > span.pre { white-space: nowrap; } + +/* Lists */ + +/* compact and simple lists: no margin between items */ +.simple li, .compact li, +.simple ul, .compact ul, +.simple ol, .compact ol, +.simple > li p, .compact > li p, +dl.simple > dd, dl.compact > dd { + margin-top: 0; + margin-bottom: 0; +} + +/* Table of Contents */ +div.topic.contents { margin: 0.5em 0; } +div.topic.contents ul { + list-style-type: none; + padding-left: 1.5em; +} + +/* Enumerated Lists */ +ol.arabic { list-style: decimal } +ol.loweralpha { list-style: lower-alpha } +ol.upperalpha { list-style: upper-alpha } +ol.lowerroman { list-style: lower-roman } +ol.upperroman { list-style: upper-roman } + +dt span.classifier { font-style: italic } +dt span.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +/* Field Lists and drivatives */ +/* bold field name, content starts on the same line */ +dl.field-list > dt, +dl.option-list > dt, +dl.docinfo > dt, +dl.footnote > dt, +dl.citation > dt { + font-weight: bold; + clear: left; + float: left; + margin: 0; + padding: 0; + padding-right: 0.5em; +} +/* Offset for field content (corresponds to the --field-name-limit option) */ +dl.field-list > dd, +dl.option-list > dd, +dl.docinfo > dd { + margin-left: 9em; /* ca. 14 chars in the test examples */ +} +/* start field-body on a new line after long field names */ +dl.field-list > dd > *:first-child, +dl.option-list > dd > *:first-child +{ + display: inline-block; + width: 100%; + margin: 0; +} +/* field names followed by a colon */ +dl.field-list > dt:after, +dl.docinfo > dt:after { + content: ":"; +} + +/* Bibliographic Fields (docinfo) */ +pre.address { font: inherit; } +dd.authors > p { margin: 0; } + +/* Option Lists */ +dl.option-list { margin-left: 1.5em; } +dl.option-list > dt { font-weight: normal; } +span.option { white-space: nowrap; } + +/* Footnotes and Citations */ +dl.footnote.superscript > dd {margin-left: 1em; } +dl.footnote.brackets > dd {margin-left: 2em; } +dl > dt.label { font-weight: normal; } +a.footnote-reference.brackets:before, +dt.label > span.brackets:before { content: "["; } +a.footnote-reference.brackets:after, +dt.label > span.brackets:after { content: "]"; } +a.footnote-reference.superscript, +dl.footnote.superscript > dt.label { + vertical-align: super; + font-size: smaller; +} +dt.label > span.fn-backref { margin-left: 0.2em; } +dt.label > span.fn-backref > a { font-style: italic; } + +/* Line Blocks */ +div.line-block { display: block; } +div.line-block div.line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 40px; +} + +/* Figures, Images, and Tables */ +.figure.align-left, +figure.align-left, +img.align-left, +object.align-left, +table.align-left { + margin-right: auto; +} +.figure.align-center, +figure.align-center, +img.align-center, +object.align-center, +table.align-center { + margin-left: auto; + margin-right: auto; +} +.figure.align-right, +figure.align-right, +img.align-right, +object.align-right, +table.align-right { + margin-left: auto; +} +img.align-center, img.align-right, +object.align-center, object.align-right { + display: block; +} +/* reset inner alignment in figures and tables */ +.figure.align-left, .figure.align-right, +figure.align-left, figure.align-right, +table.align-left, table.align-center, table.align-right { + text-align: inherit; +} + +/* Sidebar */ +aside.sidebar { + width: 30%; + max-width: 26em; + float: right; + clear: right; +} + +/* Text Blocks */ +blockquote, +div.topic, +div.admonition, +div.system-message, +pre.literal-block, +pre.doctest-block, +pre.math, +pre.code { + margin-left: 1.5em; + margin-right: 1.5em; +} +pre.code .ln { color: gray; } /* line numbers */ + +/* Tables */ +table { border-collapse: collapse; } +td, th { + border-style: solid; + border-color: silver; + padding: 0 1ex; + border-width: thin; +} +td > p:first-child, th > p:first-child { margin-top: 0; } +td > p, th > p { margin-bottom: 0; } + +table > caption { + text-align: left; + margin-bottom: 0.25em +} + +table.borderless td, table.borderless th { + border: 0; + padding: 0; + padding-right: 0.5em /* separate table cells */ +} + +/* Document Header and Footer */ +header { border-bottom: 1px solid black; } +footer { border-top: 1px solid black; } + +/* new HTML5 block elements: set display for older browsers */ +header, section, footer, aside, nav, main, article, figure { + display: block; +} + +</style> +<style type="text/css"> + +/* CSS31_ style sheet for the output of Docutils HTML writers. */ +/* Rules for easy reading and pre-defined style variants. */ +/* */ +/* :Author: Günter Milde, based on html4css1.css by David Goodger */ +/* :Id: $Id$ */ +/* :Copyright: © 2015 Günter Milde. */ +/* :License: Released under the terms of the `2-Clause BSD license`_, */ +/* in short: */ +/* */ +/* Copying and distribution of this file, with or without modification, */ +/* are permitted in any medium without royalty provided the copyright */ +/* notice and this notice are preserved. */ +/* */ +/* This file is offered as-is, without any warranty. */ +/* */ +/* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause */ +/* .. _CSS3: http://www.w3.org/TR/CSS3 */ + + +/* Document Structure */ +/* ****************** */ + +/* "page layout" */ +body { + margin: 0; + background-color: #dbdbdb; +} +div.document, +main { + line-height:1.3; + counter-reset: table figure; + /* avoid long lines --> better reading */ + /* optimum is 45…75 characters/line <http://webtypography.net/2.1.2> */ + /* OTOH: lines should not be too short because of missing hyphenation, */ + max-width: 50em; + padding: 1px 2%; /* 1px on top avoids grey bar above title (mozilla) */ + margin: auto; + background-color: white; +} + +/* Sections */ + +/* Transitions */ + +hr.docutils { + width: 80%; + margin-top: 1em; + margin-bottom: 1em; + clear: both; +} + +/* Paragraphs */ +/* ========== */ + +/* vertical space (parskip) */ +p, ol, ul, dl, li, dd, +div.line-block, +div.topic, +table { + margin-top: 0.5em; + margin-bottom: 0.5em; +} +p:first-child { margin-top: 0; } +/* (:last-child is new in CSS 3) */ +p:last-child { margin-bottom: 0; } + +h1, h2, h3, h4, h5, h6, +dl > dd { + margin-bottom: 0.5em; +} + +/* Lists */ +/* ===== */ + +/* Separate list entries in compound lists */ +dl > dd, ol > li, + +/* Definition Lists */ +/* Indent lists nested in definition lists */ +/* (:only-child is new in CSS 3) */ +dd > ul:only-child, dd > ol:only-child { padding-left: 1em; } + +/* Description Lists */ +/* styled like in most dictionaries, encyclopedias etc. */ +dl.description > dt { + font-weight: bold; + clear: left; + float: left; + margin: 0; + padding: 0; + padding-right: 0.5em; +} + +/* Field Lists */ + +/* example for custom field-name width */ +dl.field-list.narrow > dd { + margin-left: 5em; +} +/* run-in: start field-body on same line after long field names */ +dl.field-list.run-in > dd p { + display: block; +} + +/* Bibliographic Fields */ + +/* generally, bibliographic fields use special definition list dl.docinfo */ +/* but dedication and abstract are placed into "topic" divs */ +div.abstract p.topic-title { + text-align: center; +} +div.dedication { + margin: 2em 5em; + text-align: center; + font-style: italic; +} +div.dedication p.topic-title { + font-style: normal; +} + +/* Citations */ +dl.citation dt.label { + font-weight: bold; +} +span.fn-backref { + font-weight: normal; +} + +/* Text Blocks */ +/* =========== */ + +/* Literal Blocks */ + +pre.literal-block, +pre.doctest-block, +pre.math, +pre.code { + font-family: monospace; +} + +/* Block Quotes */ + +blockquote > table, +div.topic > table { + margin-top: 0; + margin-bottom: 0; +} +blockquote p.attribution, +div.topic p.attribution { + text-align: right; + margin-left: 20%; +} + +/* Tables */ +/* ====== */ + +/* th { vertical-align: bottom; } */ + +table tr { text-align: left; } + +/* "booktabs" style (no vertical lines) */ +table.booktabs { + border: 0; + border-top: 2px solid; + border-bottom: 2px solid; + border-collapse: collapse; +} +table.booktabs * { + border: 0; +} +table.booktabs th { + border-bottom: thin solid; +} + +/* numbered tables (counter defined in div.document) */ +table.numbered > caption:before { + counter-increment: table; + content: "Table " counter(table) ": "; + font-weight: bold; +} + +/* Explicit Markup Blocks */ +/* ====================== */ + +/* Footnotes and Citations */ +/* ----------------------- */ + +/* line on the left */ +dl.footnote { + padding-left: 1ex; + border-left: solid; + border-left-width: thin; +} + +/* Directives */ +/* ---------- */ + +/* Body Elements */ +/* ~~~~~~~~~~~~~ */ + +/* Images and Figures */ + +/* let content flow to the side of aligned images and figures */ +.figure.align-left, +figure.align-left, +img.align-left, +object.align-left { + display: block; + clear: left; + float: left; + margin-right: 1em; +} +.figure.align-right, +figure.align-right, +img.align-right, +object.align-right { + display: block; + clear: right; + float: right; + margin-left: 1em; +} +/* Stop floating sidebars, images and figures at section level 1,2,3 */ +h1, h2, h3 { clear: both; } + +/* Numbered figures */ +figure.numbered > figcaption > p:before { + counter-increment: figure; + content: "Figure " counter(figure) ": "; + font-weight: bold; +} + + +/* Admonitions and System Messages */ + +div.admonition, +div.system-message, +aside.sidebar { + border: medium outset; + margin: 1em 1.5em; + padding: 0.5em 1em; +} + +div.caution p.admonition-title, +div.attention p.admonition-title, +div.danger p.admonition-title, +div.error p.admonition-title, +div.warning p.admonition-title, +div.error { + color: red; +} + + +/* Sidebar */ + +/* Move right. In a layout with fixed margins, */ +/* it can be moved into the margin. */ +div.sidebar, +aside.sidebar { + width: 30%; + max-width: 26em; + margin-left: 1em; + margin-right: -2%; + background-color: #ffffee; +} + +/* Code */ + +pre.code { padding: 0.7ex } +pre.code, code { background-color: #eeeeee } +pre.code .ln { color: gray; } /* line numbers */ +/* basic highlighting: for a complete scheme, see */ +/* http://docutils.sourceforge.net/sandbox/stylesheets/ */ +pre.code .comment, code .comment { color: #5C6576 } +pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } +pre.code .literal.string, code .literal.string { color: #0C5404 } +pre.code .name.builtin, code .name.builtin { color: #352B84 } +pre.code .deleted, code .deleted { background-color: #DEB0A1} +pre.code .inserted, code .inserted { background-color: #A3D289} + +/* Math */ +/* styled separately (see math.css for math-output=HTML) */ + +/* Epigraph */ +/* Highlights */ +/* Pull-Quote */ +/* Compound Paragraph */ +/* Container */ + +/* Document Header and Footer */ + +footer, header { + font-size: smaller; + clear: both; + padding: 0.5em 2%; + background-color: #ebebee; + border: none; +} + +/* Inline Markup */ +/* ============= */ + +/* Emphasis */ +/* em */ +/* Strong Emphasis */ +/* strong */ +/* Interpreted Text */ +/* span.interpreted */ +/* Title Reference */ +/* cite */ + +/* Inline Literals */ +/* possible values: normal, nowrap, pre, pre-wrap, pre-line */ +/* span.docutils.literal { white-space: pre-wrap; } */ + +/* Hyperlink References */ +a { text-decoration: none; } + +/* External Targets */ +/* span.target.external */ +/* Internal Targets */ +/* span.target.internal */ +/* Footnote References */ +/* a.footnote-reference */ +/* Citation References */ +/* a.citation-reference */ + +</style> +</head> +<body> +<main id="docutils-sty"> +<h1 class="title">docutils.sty</h1> + +<!-- %% docutils.sty: macros for Docutils LaTeX output. +%% +%% Copyright © 2020 Günter Milde +%% Released under the terms of the `2-Clause BSD license`, in short: +%% +%% Copying and distribution of this file, with or without modification, +%% are permitted in any medium without royalty provided the copyright +%% notice and this notice are preserved. +%% This file is offered as-is, without any warranty. --> +<p>Helper commands and element definitions for <a class="reference external" href="https://docutils.sourceforge.io/">Docutils</a> LaTeX output.</p> +<dl class="field-list simple"> +<dt>Copyright</dt> +<dd><p>© 2020 Günter Milde</p> +</dd> +<dt>Licence</dt> +<dd><p>Released under the terms of the <a class="reference external" href="https://opensource.org/licenses/BSD-2-Clause">2-Clause BSD license</a></p> +</dd> +</dl> +<section id="changelog"> +<h2>Changelog</h2> +<div class="line-block"> +<div class="line">2020-08-28 first public version for Docutils >= 0.17</div> +</div> +</section> +<section id="requirements"> +<h2>Requirements</h2> +<p>None.</p> +</section> +<section id="installation"> +<h2>Installation</h2> +<p>If possible, get this package from your distribution using its +installation manager. Alternatively, copy/move/link <span class="docutils literal">docutils.sty</span> +to a place where LaTeX can find it.</p> +</section> +<section id="usage"> +<h2>Usage</h2> +<p>The package is intended for use with LaTeX documents generated from +<a class="reference external" href="https://en.wikipedia.org/wiki/ReStructuredText">reStructuredText</a> sources with <a class="reference external" href="https://docutils.sourceforge.io/">Docutils</a>.</p> +<p>When generating LaTeX documents, specify this package with the +<a class="reference external" href="https://docutils.sourceforge.io/docs/user/config.html#stylesheet-latex-writers">“stylesheet”</a> <a class="reference external" href="https://docutils.sourceforge.io/docs/user/config.html">configuration option</a>, e.g.</p> +<pre class="literal-block">rst2latex --stylesheet=docutils exampledocument.txt</pre> +<p>The the Docutils <cite>LaTeX writer</cite> will then reference this package +istead of inserting required definitions into the preamble of +generated documents (see the <a class="reference external" href="https://docutils.sourceforge.io/docs/user/latex.html">Docutils LaTeX Writer documentation</a> +for details).</p> +</section> +<section id="documentation-generation"> +<h2>Documentation Generation</h2> +<p>The bidirectional text <-> code converter <a class="reference external" href="https://repo.or.cz/pylit.git">PyLit</a> and <a class="reference external" href="https://docutils.sourceforge.io/">Docutils</a> +were used to generate the HTML documentation:</p> +<pre class="literal-block">#> pylit docutils.sty +#> rst2html5 docutils.sty.txt docutils.sty.html</pre> +</section> +<section id="implementation"> +<h2>Implementation</h2> +<section id="identification"> +<h3>Identification</h3> +<pre class="literal-block">\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{docutils} + [2020/08/28 macros for Docutils LaTeX output]</pre> +</section> +<section id="helpers"> +<h3>Helpers</h3> +<p>duclass:</p> +<pre class="literal-block">% class handling for environments (block-level elements) +% \begin{DUclass}{spam} tries \DUCLASSspam and +% \end{DUclass}{spam} tries \endDUCLASSspam +\ifx\DUclass\undefined % poor man's "provideenvironment" + \newenvironment{DUclass}[1]% + {% "#1" does not work in end-part of environment. + \def\DocutilsClassFunctionName{DUCLASS#1} + \csname \DocutilsClassFunctionName \endcsname}% + {\csname end\DocutilsClassFunctionName \endcsname}% +\fi</pre> +<p>providelength:</p> +<pre class="literal-block">% Provide a length variable and set default, if it is new +\providecommand*{\DUprovidelength}[2]{ + \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{} +}</pre> +</section> +<section id="configuration-defaults"> +<h3>Configuration defaults</h3> +<p>See the <a class="reference external" href="https://docutils.sourceforge.io/docs/user/latex.html">Docutils LaTeX Writer documentation</a> for details.</p> +<p>abstract:</p> +<pre class="literal-block">\providecommand*{\DUCLASSabstract}{ + \renewcommand{\DUtitle}[1]{\centerline{\textbf{##1}}} +}</pre> +<p>dedication:</p> +<pre class="literal-block">% special topic for dedications +\providecommand*{\DUCLASSdedication}{% + \renewenvironment{quote}{\begin{center}}{\end{center}}% +}</pre> +<p>TODO: add em to set dedication text in italics?</p> +<p>docinfo:</p> +<pre class="literal-block">% width of docinfo table +\DUprovidelength{\DUdocinfowidth}{0.9\linewidth}</pre> +<p>error:</p> +<pre class="literal-block">\providecommand*{\DUCLASSerror}{\color{red}}</pre> +<p>highlight_rules:</p> +<pre class="literal-block">% basic code highlight: +\providecommand*\DUrolecomment[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}} +\providecommand*\DUroledeleted[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}} +\providecommand*\DUrolekeyword[1]{\textbf{#1}} +\providecommand*\DUrolestring[1]{\textit{#1}}</pre> +</section> +<section id="elements"> +<h3>Elements</h3> +<p>Definitions for unknown or to-be-configured Docutils elements.</p> +<p>admonition:</p> +<pre class="literal-block">% admonition environment (specially marked topic) +\ifx\DUadmonition\undefined % poor man's "provideenvironment" + \newbox{\DUadmonitionbox} + \newenvironment{DUadmonition}% + {\begin{center} + \begin{lrbox}{\DUadmonitionbox} + \begin{minipage}{0.9\linewidth} + }% + { \end{minipage} + \end{lrbox} + \fbox{\usebox{\DUadmonitionbox}} + \end{center} + } +\fi</pre> +<p>fieldlist:</p> +<pre class="literal-block">% field list environment (for separate configuration of `field lists`) +\ifthenelse{\isundefined{\DUfieldlist}}{ + \newenvironment{DUfieldlist}% + {\quote\description} + {\enddescription\endquote} +}{}</pre> +<p>footnotes:</p> +<pre class="literal-block">% numerical or symbol footnotes with hyperlinks and backlinks +\providecommand*{\DUfootnotemark}[3]{% + \raisebox{1em}{\hypertarget{#1}{}}% + \hyperlink{#2}{\textsuperscript{#3}}% +} +\providecommand{\DUfootnotetext}[4]{% + \begingroup% + \renewcommand{\thefootnote}{% + \protect\raisebox{1em}{\protect\hypertarget{#1}{}}% + \protect\hyperlink{#2}{#3}}% + \footnotetext{#4}% + \endgroup% +}</pre> +<p>inline:</p> +<pre class="literal-block">% custom inline roles: \DUrole{#1}{#2} tries \DUrole#1{#2} +\providecommand*{\DUrole}[2]{% + \ifcsname DUrole#1\endcsname% + \csname DUrole#1\endcsname{#2}% + \else% + #2% + \fi% +}</pre> +<p>legend:</p> +<pre class="literal-block">% legend environment (in figures and formal tables) +\ifthenelse{\isundefined{\DUlegend}}{ + \newenvironment{DUlegend}{\small}{} +}{}</pre> +<p>lineblock:</p> +<pre class="literal-block">% line block environment +\DUprovidelength{\DUlineblockindent}{2.5em} +\ifthenelse{\isundefined{\DUlineblock}}{ + \newenvironment{DUlineblock}[1]{% + \list{}{\setlength{\partopsep}{\parskip} + \addtolength{\partopsep}{\baselineskip} + \setlength{\topsep}{0pt} + \setlength{\itemsep}{0.15\baselineskip} + \setlength{\parsep}{0pt} + \setlength{\leftmargin}{#1}} + \raggedright + } + {\endlist} +}{}</pre> +<p>optionlist:</p> +<pre class="literal-block">% list of command line options +\providecommand*{\DUoptionlistlabel}[1]{\bfseries #1 \hfill} +\DUprovidelength{\DUoptionlistindent}{3cm} +\ifthenelse{\isundefined{\DUoptionlist}}{ + \newenvironment{DUoptionlist}{% + \list{}{\setlength{\labelwidth}{\DUoptionlistindent} + \setlength{\rightmargin}{1cm} + \setlength{\leftmargin}{\rightmargin} + \addtolength{\leftmargin}{\labelwidth} + \addtolength{\leftmargin}{\labelsep} + \renewcommand{\makelabel}{\DUoptionlistlabel}} + } + {\endlist} +}{}</pre> +<p>rubric:</p> +<pre class="literal-block">% informal heading +\providecommand*{\DUrubric}[1]{\subsubsection*{\emph{#1}}}</pre> +<p>sidebar:</p> +<pre class="literal-block">% text outside the main text flow +\providecommand{\DUsidebar}[1]{% + \begin{center} + \colorbox[gray]{0.80}{\parbox{0.9\linewidth}{#1}} + \end{center} +}</pre> +<p>title:</p> +<pre class="literal-block">% title for topics, admonitions, unsupported section levels, and sidebar +\providecommand*{\DUtitle}[1]{\subsubsection*{#1}}</pre> +<p>subtitle:</p> +<pre class="literal-block">% subtitle (for sidebar) +\providecommand*{\DUsubtitle}[1]{\par\emph{#1}\smallskip}</pre> +<p>documentsubtitle:</p> +<pre class="literal-block">% subtitle (in document title) +\providecommand*{\DUdocumentsubtitle}[1]{{\large #1}}</pre> +<p>titlereference:</p> +<pre class="literal-block">% titlereference standard role +\providecommand*{\DUroletitlereference}[1]{\textsl{#1}}</pre> +<p>transition:</p> +<pre class="literal-block">% transition (break / fancybreak / anonymous section) +\providecommand*{\DUtransition}{% + \hspace*{\fill}\hrulefill\hspace*{\fill} + \vskip 0.5\baselineskip +}</pre> +</section> +</section> +</main> +</body> +</html> diff --git a/Master/texmf-dist/doc/latex/docutils/docutils.sty.txt b/Master/texmf-dist/doc/latex/docutils/docutils.sty.txt new file mode 100644 index 00000000000..7cdb670743a --- /dev/null +++ b/Master/texmf-dist/doc/latex/docutils/docutils.sty.txt @@ -0,0 +1,275 @@ +docutils.sty +************ +Style file for docutils LaTeX output +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:Copyright: © 2020 Günter Milde +:Licence: Released under the terms of the `2-Clause BSD license`_, in short: + + Copying and distribution of this file, with or without modification, + are permitted in any medium without royalty provided the copyright + notice and this notice are preserved. + This file is offered as-is, without any warranty. + + .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause + + +:Abstract: + Helper commands and element definitions for Docutils_ LaTeX output. + +:Changelog: + .. class:: borderless + + ====== ========== ========================================================= + 0.1 2020-08-28 initial version + ====== ========== ========================================================= + +Installation +============ + +Copy/Move/Link ``docutils.sty`` to a suitable place in the “TeX Directory +Structure” (TDS_) and run ``texhash``, or place it in the current working +directory (e.g. for testing). + +Usage +===== + +When generating LaTeX documents from reStructuredText sources, +specify this package with the `"stylesheet"`_ configuration_ option, e.g. +``rst2latex --stylesheet=docutils``. +Alternatively, the Docutils `LaTeX writer` will extract required definitions +and insert them into the preamble of generated documents +(see `Docutils LaTeX Writer`_ for details). + + +Implementation +============== + +:: + + \NeedsTeXFormat{LaTeX2e} + \ProvidesPackage{docutils} + [2020/08/28 v0.1 macros for Docutils LaTeX output] + + +Helpers +------- + +duclass:: + + % class handling for environments (block-level elements) + % \begin{DUclass}{spam} tries \DUCLASSspam and + % \end{DUclass}{spam} tries \endDUCLASSspam + \ifx\DUclass\undefined % poor man's "provideenvironment" + \newenvironment{DUclass}[1]% + {% "#1" does not work in end-part of environment. + \def\DocutilsClassFunctionName{DUCLASS#1} + \csname \DocutilsClassFunctionName \endcsname}% + {\csname end\DocutilsClassFunctionName \endcsname}% + \fi + +providelength:: + + % Provide a length variable and set default, if it is new + \providecommand*{\DUprovidelength}[2]{ + \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{} + } + + +Configuration defaults +---------------------- + +See `Docutils LaTeX Writer`_ for details. + +abstract:: + + \providecommand*{\DUCLASSabstract}{ + \renewcommand{\DUtitle}[1]{\centerline{\textbf{##1}}} + } + +dedication:: + + % special topic for dedications + \providecommand*{\DUCLASSdedication}{% + \renewenvironment{quote}{\begin{center}}{\end{center}}% + } + +TODO: add \em to set dedication text in italics? + +docinfo:: + + % width of docinfo table + \DUprovidelength{\DUdocinfowidth}{0.9\linewidth} + +error:: + + \providecommand*{\DUCLASSerror}{\color{red}} + +highlight_rules:: + + % basic code highlight: + \providecommand*\DUrolecomment[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}} + \providecommand*\DUroledeleted[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}} + \providecommand*\DUrolekeyword[1]{\textbf{#1}} + \providecommand*\DUrolestring[1]{\textit{#1}} + +Elements +-------- + +Definitions for unknown or to-be-configured Docutils elements +and roles (inline elements). + +admonition:: + + % admonition environment (specially marked topic) + \ifx\DUadmonition\undefined % poor man's "provideenvironment" + \newbox{\DUadmonitionbox} + \newenvironment{DUadmonition}% + {\begin{center} + \begin{lrbox}{\DUadmonitionbox} + \begin{minipage}{0.9\linewidth} + }% + { \end{minipage} + \end{lrbox} + \fbox{\usebox{\DUadmonitionbox}} + \end{center} + } + \fi + +fieldlist:: + + % field list environment (for separate configuration of `field lists`) + \ifthenelse{\isundefined{\DUfieldlist}}{ + \newenvironment{DUfieldlist}% + {\quote\description} + {\enddescription\endquote} + }{} + +footnotes:: + + % numerical or symbol footnotes with hyperlinks and backlinks + \providecommand*{\DUfootnotemark}[3]{% + \raisebox{1em}{\hypertarget{#1}{}}% + \hyperlink{#2}{\textsuperscript{#3}}% + } + \providecommand{\DUfootnotetext}[4]{% + \begingroup% + \renewcommand{\thefootnote}{% + \protect\raisebox{1em}{\protect\hypertarget{#1}{}}% + \protect\hyperlink{#2}{#3}}% + \footnotetext{#4}% + \endgroup% + } + +inline:: + + % custom inline roles: \DUrole{#1}{#2} tries \DUrole#1{#2} + \providecommand*{\DUrole}[2]{% + \ifcsname DUrole#1\endcsname% + \csname DUrole#1\endcsname{#2}% + \else% + #2% + \fi% + } + +legend:: + + % legend environment (in figures and formal tables) + \ifthenelse{\isundefined{\DUlegend}}{ + \newenvironment{DUlegend}{\small}{} + }{} + +lineblock:: + + % line block environment + \DUprovidelength{\DUlineblockindent}{2.5em} + \ifthenelse{\isundefined{\DUlineblock}}{ + \newenvironment{DUlineblock}[1]{% + \list{}{\setlength{\partopsep}{\parskip} + \addtolength{\partopsep}{\baselineskip} + \setlength{\topsep}{0pt} + \setlength{\itemsep}{0.15\baselineskip} + \setlength{\parsep}{0pt} + \setlength{\leftmargin}{#1}} + \raggedright + } + {\endlist} + }{} + +optionlist:: + + % list of command line options + \providecommand*{\DUoptionlistlabel}[1]{\bfseries #1 \hfill} + \DUprovidelength{\DUoptionlistindent}{3cm} + \ifthenelse{\isundefined{\DUoptionlist}}{ + \newenvironment{DUoptionlist}{% + \list{}{\setlength{\labelwidth}{\DUoptionlistindent} + \setlength{\rightmargin}{1cm} + \setlength{\leftmargin}{\rightmargin} + \addtolength{\leftmargin}{\labelwidth} + \addtolength{\leftmargin}{\labelsep} + \renewcommand{\makelabel}{\DUoptionlistlabel}} + } + {\endlist} + }{} + +rubric:: + + % informal heading + \providecommand*{\DUrubric}[1]{\subsubsection*{\emph{#1}}} + +sidebar:: + + % text outside the main text flow + \providecommand{\DUsidebar}[1]{% + \begin{center} + \colorbox[gray]{0.80}{\parbox{0.9\linewidth}{#1}} + \end{center} + } + +title:: + + % title for topics, admonitions, unsupported section levels, and sidebar + \providecommand*{\DUtitle}[1]{\subsubsection*{#1}} + +subtitle:: + + % subtitle (for sidebar) + \providecommand*{\DUsubtitle}[1]{\par\emph{#1}\smallskip} + +documentsubtitle:: + + % subtitle (in document title) + \providecommand*{\DUdocumentsubtitle}[1]{{\large #1}} + +titlereference:: + + % titlereference standard role + \providecommand*{\DUroletitlereference}[1]{\textsl{#1}} + +transition:: + + % transition (break / fancybreak / anonymous section) + \providecommand*{\DUtransition}{% + \hspace*{\fill}\hrulefill\hspace*{\fill} + \vskip 0.5\baselineskip + } + +References +========== + +.. [Docutils] https://docutils.sourceforge.io/ + +.. _Docutils Document Tree: + https://docutils.sourceforge.io/docs/ref/doctree.html + +.. _Docutils LaTeX Writer: + https://docutils.sourceforge.io/docs/user/latex.html + +.. _Configuration: + https://docutils.sourceforge.io/docs/user/config.html + +.. _"stylesheet": + https://docutils.sourceforge.io/docs/user/config.html#stylesheet-latex-writers + +.. _TDS: http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tds |