Prepare CodeBlock directive for inclusion in the Docutils core.

Rename directive and class from "code-block" to "code". Fix fallback if pygments not found. Use class-based interface. Add "number-lines" option. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@6488 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
author: milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> 2010-11-30 11:59:33 +0000
committer: milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> 2010-11-30 11:59:33 +0000
commit: c5880303ec69f984827af77f08cf3d9a54f83cd2 (patch)
tree: 8730121b4af5e5ae5a3d01f5f8b3027b394aeef6 /sandbox/code-block-directive/docs
parent: 976cec43efc64e68a9e2a1fc27135a11b27938aa (diff)
download: docutils-c5880303ec69f984827af77f08cf3d9a54f83cd2.tar.gz
4 files changed, 76 insertions, 189 deletions
diff --git a/sandbox/code-block-directive/docs/myfunction.py.htm b/sandbox/code-block-directive/docs/myfunction.py.htm
index 62f7ae00f..617f4b671 100644
--- a/sandbox/code-block-directive/docs/myfunction.py.htm
+++ b/sandbox/code-block-directive/docs/myfunction.py.htm
@@ -3,124 +3,30 @@
 <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.6: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.8: http://docutils.sourceforge.net/" />
 <title></title>
-<style type="text/css">
-
-/* Stylesheet for pygments enhanced reStructured Text */
-/* ================================================== */
-
-/* :Author:    Guenter Milde */
-/* :Copyright: 2007 G. Milde */
-/*             This stylesheet is released under the GPL v. 2 or later */
-
-/* This stylesheet provides syntax highlight for documents generated with a */
-/* pygments_ enhanced reStructured Text -> html converter. */
-
-/* Import the default docutils style sheet */
-/* --------------------------------------- */
-/* :: */
-
-@import url("/stylesheets/html4css1.css");         
-
-/* Indent the code block */
-/* --------------------- */
-
-/* Content copied from the `html4css1.css` rule for literal blocks. */
-/* Selector adapted to the output of Pygments_. :: */
-
-div.highlight {
-  margin-left: 2em ;
-  margin-right: 2em ;
-  background-color: #eeeeee
-  }
-
-
-/* Colour code blocks */
-/* ------------------ */
-
-/* Pygments_ has an option to generate stylesheets for html and latex. */
-/* The following code is generated with the command */
-/* `pygmentize -S default -f html > pygments-default.css`:: */
-
-.c { color: #008800; font-style: italic } /* Comment */
-.err { border: 1px solid #FF0000 } /* Error */
-.k { color: #AA22FF; font-weight: bold } /* Keyword */
-.o { color: #666666 } /* Operator */
-.cm { color: #008800; font-style: italic } /* Comment.Multiline */
-.cp { color: #008800 } /* Comment.Preproc */
-.c1 { color: #008800; font-style: italic } /* Comment.Single */
-.gd { color: #A00000 } /* Generic.Deleted */
-.ge { font-style: italic } /* Generic.Emph */
-.gr { color: #FF0000 } /* Generic.Error */
-.gh { color: #000080; font-weight: bold } /* Generic.Heading */
-.gi { color: #00A000 } /* Generic.Inserted */
-.go { color: #808080 } /* Generic.Output */
-.gp { color: #000080; font-weight: bold } /* Generic.Prompt */
-.gs { font-weight: bold } /* Generic.Strong */
-.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
-.gt { color: #0040D0 } /* Generic.Traceback */
-.kc { color: #AA22FF; font-weight: bold } /* Keyword.Constant */
-.kd { color: #AA22FF; font-weight: bold } /* Keyword.Declaration */
-.kp { color: #AA22FF } /* Keyword.Pseudo */
-.kr { color: #AA22FF; font-weight: bold } /* Keyword.Reserved */
-.kt { color: #AA22FF; font-weight: bold } /* Keyword.Type */
-.m { color: #666666 } /* Literal.Number */
-.s { color: #BB4444 } /* Literal.String */
-.na { color: #BB4444 } /* Name.Attribute */
-.nb { color: #AA22FF } /* Name.Builtin */
-.nc { color: #0000FF } /* Name.Class */
-.no { color: #880000 } /* Name.Constant */
-.nd { color: #AA22FF } /* Name.Decorator */
-.ni { color: #999999; font-weight: bold } /* Name.Entity */
-.ne { color: #D2413A; font-weight: bold } /* Name.Exception */
-.nf { color: #00A000 } /* Name.Function */
-.nl { color: #A0A000 } /* Name.Label */
-.nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
-.nt { color: #008000; font-weight: bold } /* Name.Tag */
-.nv { color: #B8860B } /* Name.Variable */
-.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
-.mf { color: #666666 } /* Literal.Number.Float */
-.mh { color: #666666 } /* Literal.Number.Hex */
-.mi { color: #666666 } /* Literal.Number.Integer */
-.mo { color: #666666 } /* Literal.Number.Oct */
-.sb { color: #BB4444 } /* Literal.String.Backtick */
-.sc { color: #BB4444 } /* Literal.String.Char */
-.sd { color: #BB4444; font-style: italic } /* Literal.String.Doc */
-.s2 { color: #BB4444 } /* Literal.String.Double */
-.se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
-.sh { color: #BB4444 } /* Literal.String.Heredoc */
-.si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
-.sx { color: #008000 } /* Literal.String.Other */
-.sr { color: #BB6688 } /* Literal.String.Regex */
-.s1 { color: #BB4444 } /* Literal.String.Single */
-.ss { color: #B8860B } /* Literal.String.Symbol */
-.bp { color: #AA22FF } /* Name.Builtin.Pseudo */
-.vc { color: #B8860B } /* Name.Variable.Class */
-.vg { color: #B8860B } /* Name.Variable.Global */
-.vi { color: #B8860B } /* Name.Variable.Instance */
-.il { color: #666666 } /* Literal.Number.Integer.Long */
-
-/* .. _pygments:  http://pygments.org/ */
-
-</style>
+<link rel="stylesheet" href="../data/pygments-default.css" type="text/css" />
 </head>
 <body>
 <div class="document">
 
 
-<p>This is a test of the new code-block directive:</p>
+<p>This is a test of the new &quot;code&quot; directive:</p>
 <!-- Translate this document to HTML with a pygments enhanced frontend, e.g.
 
 ../rst2html-highlight - -stylesheet=../data/pygments-default.css
 
 ../rst2latex-highlight - -stylesheet=../data/pygments-docutileroles.sty -->
-<pre class="code-block python literal-block">
-<span class="k">def</span> <span class="nf">my_function</span><span class="p">():</span>
-    <span class="s">&quot;just a test&quot;</span>
-    <span class="k">print</span> <span class="mf">8</span><span class="o">/</span><span class="mf">2</span>
-
+<pre class="code python silly literal-block">
+<span class="ln">1 </span><span class="k">def</span> <span class="nf">my_function</span><span class="p">():</span>
+<span class="ln">2 </span>    <span class="sd">&quot;&quot;&quot;Test the lexer.
+</span><span class="ln">3 </span><span class="sd">
+</span><span class="ln">4 </span><span class="sd">    just a test&quot;&quot;&quot;</span>
+<span class="ln">5 </span>
+<span class="ln">6 </span>    <span class="c"># and now for something completely different</span>
+<span class="ln">7 </span>    <span class="k">print</span> <span class="mi">8</span><span class="o">/</span><span class="mi">2</span>
 </pre>
+<p>The end.</p>
 </div>
 </body>
 </html>
diff --git a/sandbox/code-block-directive/docs/myfunction.py.pdf b/sandbox/code-block-directive/docs/myfunction.py.pdf
index 05fba74ea..b6624d223 100644
--- a/sandbox/code-block-directive/docs/myfunction.py.pdf
+++ b/sandbox/code-block-directive/docs/myfunction.py.pdf
diff --git a/sandbox/code-block-directive/docs/myfunction.py.tex b/sandbox/code-block-directive/docs/myfunction.py.tex
index 6d5ddd5dd..c72da4eac 100644
--- a/sandbox/code-block-directive/docs/myfunction.py.tex
+++ b/sandbox/code-block-directive/docs/myfunction.py.tex
@@ -1,93 +1,66 @@
-\documentclass[10pt,a4paper,english]{scrartcl}
-\usepackage{babel}
-\usepackage[T1]{fontenc}
-\usepackage{shortvrb}
-\usepackage{ucs}
-\usepackage[utf8x]{inputenc}
-\usepackage{tabularx}
-\usepackage{longtable}
-\usepackage{booktabs}
-\setlength{\extrarowheight}{2pt}
-\usepackage{amsmath}
-\usepackage{graphicx}
-\usepackage{color}
-\usepackage{multirow}
-\usepackage{ifthen}
-\typearea{12}
+\documentclass[a4paper]{article}
 % generated by Docutils <http://docutils.sourceforge.net/>
-\newlength{\admonitionwidth}
-\setlength{\admonitionwidth}{0.9\textwidth}
-\newlength{\docinfowidth}
-\setlength{\docinfowidth}{0.9\textwidth}
-\newlength{\locallinewidth}
-\newcommand{\optionlistlabel}[1]{\bf #1 \hfill}
-\newenvironment{optionlist}[1]
-{\begin{list}{}
-  {\setlength{\labelwidth}{#1}
-   \setlength{\rightmargin}{1cm}
-   \setlength{\leftmargin}{\rightmargin}
-   \addtolength{\leftmargin}{\labelwidth}
-   \addtolength{\leftmargin}{\labelsep}
-   \renewcommand{\makelabel}{\optionlistlabel}}
-}{\end{list}}
-\newlength{\lineblockindentation}
-\setlength{\lineblockindentation}{2.5em}
-\newenvironment{lineblock}[1]
-{\begin{list}{}
-  {\setlength{\partopsep}{\parskip}
-   \addtolength{\partopsep}{\baselineskip}
-   \topsep0pt\itemsep0.15\baselineskip\parsep0pt
-   \leftmargin#1}
- \raggedright}
-{\end{list}}
-% begin: floats for footnotes tweaking.
-\setlength{\floatsep}{0.5em}
-\setlength{\textfloatsep}{\fill}
-\addtolength{\textfloatsep}{3em}
-\renewcommand{\textfraction}{0.5}
-\renewcommand{\topfraction}{0.5}
-\renewcommand{\bottomfraction}{0.5}
-\setcounter{totalnumber}{50}
-\setcounter{topnumber}{50}
-\setcounter{bottomnumber}{50}
-% end floats for footnotes
-% some commands, that could be overwritten in the style file.
-\newcommand{\rubric}[1]{\subsection*{~\hfill {\it #1} \hfill ~}}
-\newcommand{\titlereference}[1]{\textsl{#1}}
-% end of "some commands"
-% user specified packages and stylesheets:
+\usepackage{fixltx2e} % LaTeX patches, \textsubscript
+\usepackage{cmap} % fix search and cut-and-paste in Acrobat
+\usepackage{ifthen}
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\setcounter{secnumdepth}{0}
+
+%%% Custom LaTeX preamble
+% suppress the (LaTeX-added) References section heading
+\AtBeginDocument{\renewcommand{\refname}{\vspace{-1em}}}
+\newlength{\DUlineblockindent}
+\setlength{\DUlineblockindent}{1em}
+
+%%% User specified packages and stylesheets
 \usepackage{../data/pygments-docutilsroles}
-\ifthenelse{\isundefined{\hypersetup}}{
-\usepackage[colorlinks=true,linkcolor=blue,urlcolor=blue]{hyperref}
-}{}
-% Custom roles: 
-% \DUrole{NAME}{content} calls \docutilsroleNAME if it exists
-\providecommand{\DUrole}[2]{%
-  \ifcsname docutilsrole#1\endcsname%
-    \csname docutilsrole#1\endcsname{#2}%
-  \else%
-    #2%
+
+%%% Fallback definitions for Docutils-specific commands
+
+% inline markup (custom roles)
+% \DUrole{#1}{#2} tries \DUrole#1{#2}
+\providecommand*{\DUrole}[2]{%
+  \ifcsname DUrole#1\endcsname%
+    \csname DUrole#1\endcsname{#2}%
+  \else% backwards compatibility: try \docutilsrole#1{#2}
+    \ifcsname docutilsrole#1\endcsname%
+      \csname docutilsrole#1\endcsname{#2}%
+    \else%
+      #2%
+    \fi%
   \fi%
 }
-\title{}
-\author{}
-\date{}
-\raggedbottom
+
+% hyperlinks:
+\ifthenelse{\isundefined{\hypersetup}}{
+  \usepackage[colorlinks=true,linkcolor=blue,urlcolor=blue,citecolor=black]{hyperref}
+  \urlstyle{same} % normal text font (alternatives: tt, rm, sf)
+}{}
+
+
+%%% Body
 \begin{document}
 
-\setlength{\locallinewidth}{\linewidth}
+This is a test of the new ``code'' directive:
 
-This is a test of the new code-block directive:
 % Translate this document to HTML with a pygments enhanced frontend, e.g.
 % 
-% rst2html-highlight --stylesheet=../data/pygments-default.css --link-stylesheet
+% ../rst2html-highlight --stylesheet=../data/pygments-default.css
 % 
-% rst2latex-highlight --stylesheet=../data/pygments-docutileroles.sty 
+% ../rst2latex-highlight --stylesheet=../data/pygments-docutilsroles.sty
+%
 \begin{quote}{\ttfamily \raggedright \noindent
-\DUrole{k}{def}~\DUrole{nf}{my{\_}function}\DUrole{p}{():}~\\
-~~~~\DUrole{s}{"just~a~test"}~\\
-~~~~\DUrole{k}{print}~\DUrole{mf}{8}\DUrole{o}{/}\DUrole{mf}{2}~\\
+\DUrole{ln}{~7~}\DUrole{k}{def}~\DUrole{nf}{my\_function}\DUrole{p}{():}~\\
+\DUrole{ln}{~8~}~~~~\DUrole{sd}{"{}"{}"Test~the~lexer.\\
+}\DUrole{ln}{~9~}\DUrole{sd}{~\\
+}\DUrole{ln}{10~}\DUrole{sd}{~~~~just~a~test"{}"{}"}~\\
+\DUrole{ln}{11~}~\\
+\DUrole{ln}{12~}~~~~\DUrole{c}{\#~and~now~for~something~completely~different}~\\
+\DUrole{ln}{13~}~~~~\DUrole{k}{print}~\DUrole{mi}{8}\DUrole{o}{/}\DUrole{mi}{2}
+}
+\end{quote}
 
-}\end{quote}
+The end.
 
 \end{document}
diff --git a/sandbox/code-block-directive/docs/myfunction.py.txt b/sandbox/code-block-directive/docs/myfunction.py.txt
index 783e5b0b6..b9727e96f 100644
--- a/sandbox/code-block-directive/docs/myfunction.py.txt
+++ b/sandbox/code-block-directive/docs/myfunction.py.txt
@@ -1,13 +1,21 @@
-This is a test of the new code-block directive:
+This is a test of the new "code" directive:
 
 .. Translate this document to HTML with a pygments enhanced frontend, e.g.
 
     ../rst2html-highlight --stylesheet=../data/pygments-default.css
 
-    ../rst2latex-highlight --stylesheet=../data/pygments-docutileroles.sty
+    ../rst2latex-highlight --stylesheet=../data/pygments-docutilsroles.sty
 
-.. code-block:: python
+.. code:: python
+  :class: silly
+  :number-lines: 7
 
   def my_function():
-      "just a test"
+      """Test the lexer.
+
+      just a test"""
+
+      # and now for something completely different
       print 8/2
+
+The end.
author	milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>	2010-11-30 11:59:33 +0000
committer	milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>	2010-11-30 11:59:33 +0000
commit	c5880303ec69f984827af77f08cf3d9a54f83cd2 (patch)
tree	8730121b4af5e5ae5a3d01f5f8b3027b394aeef6 /sandbox/code-block-directive/docs
parent	976cec43efc64e68a9e2a1fc27135a11b27938aa (diff)
download	docutils-c5880303ec69f984827af77f08cf3d9a54f83cd2.tar.gz