[doconce] push by h...@simula.no - New --html_output= option. Fixed typo in doc: scale arg in FIGURE. on 2013-07-13 07:17 GMT

[doc...@googlecode.com]

Revision: b6c9bf7af898
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Jul 13 00:16:44 2013
Log: New --html_output= option. Fixed typo in doc: scale arg in FIGURE.
http://code.google.com/p/doconce/source/detail?r=b6c9bf7af898

Modified:
/bin/doconce
/doc/demos/manual/html/_sources/manual.txt
/doc/demos/manual/html/manual.html
/doc/demos/manual/html/searchindex.js
/doc/demos/manual/manual.cwiki
/doc/demos/manual/manual.do.txt
/doc/demos/manual/manual.epytext
/doc/demos/manual/manual.gwiki
/doc/demos/manual/manual.html
/doc/demos/manual/manual.md
/doc/demos/manual/manual.mwiki
/doc/demos/manual/manual.p.tex
/doc/demos/manual/manual.pdf
/doc/demos/manual/manual.rst
/doc/demos/manual/manual.rst.html
/doc/demos/manual/manual.rst.pdf
/doc/demos/manual/manual.rst.tex
/doc/demos/manual/manual.sphinx.rst
/doc/demos/manual/manual.tex
/doc/demos/manual/manual.txt
/doc/demos/manual/manual.xml
/doc/demos/manual/manual_pdflatex.pdf
/doc/demos/quickref/html/.buildinfo
/doc/demos/quickref/html/_sources/quickref.txt
/doc/demos/quickref/html/_static/pygments.css
/doc/demos/quickref/html/_static/searchtools.js
/doc/demos/quickref/html/genindex.html
/doc/demos/quickref/html/index.html
/doc/demos/quickref/html/quickref.html
/doc/demos/quickref/html/search.html
/doc/demos/quickref/html/searchindex.js
/doc/demos/quickref/quickref.cwiki
/doc/demos/quickref/quickref.do.txt
/doc/demos/quickref/quickref.epytext
/doc/demos/quickref/quickref.gwiki
/doc/demos/quickref/quickref.html
/doc/demos/quickref/quickref.md
/doc/demos/quickref/quickref.mwiki
/doc/demos/quickref/quickref.p.tex
/doc/demos/quickref/quickref.pdf
/doc/demos/quickref/quickref.rst
/doc/demos/quickref/quickref.rst.html
/doc/demos/quickref/quickref.rst.pdf
/doc/demos/quickref/quickref.rst.tex
/doc/demos/quickref/quickref.st
/doc/demos/quickref/quickref.tex
/doc/demos/quickref/quickref.txt
/doc/demos/quickref/quickref.xml
/doc/demos/tutorial/html/.buildinfo
/doc/demos/tutorial/html/_sources/tutorial.txt
/doc/demos/tutorial/html/_static/pygments.css
/doc/demos/tutorial/html/_static/searchtools.js
/doc/demos/tutorial/html/genindex.html
/doc/demos/tutorial/html/index.html
/doc/demos/tutorial/html/search.html
/doc/demos/tutorial/html/searchindex.js
/doc/demos/tutorial/html/tutorial.html
/doc/demos/tutorial/tutorial.cwiki
/doc/demos/tutorial/tutorial.do.txt
/doc/demos/tutorial/tutorial.epytext
/doc/demos/tutorial/tutorial.gwiki
/doc/demos/tutorial/tutorial.html
/doc/demos/tutorial/tutorial.md
/doc/demos/tutorial/tutorial.mwiki
/doc/demos/tutorial/tutorial.p.tex
/doc/demos/tutorial/tutorial.pdf
/doc/demos/tutorial/tutorial.rst
/doc/demos/tutorial/tutorial.rst.html
/doc/demos/tutorial/tutorial.rst.pdf
/doc/demos/tutorial/tutorial.rst.tex
/doc/demos/tutorial/tutorial.sphinx.pdf
/doc/demos/tutorial/tutorial.sphinx.rst
/doc/demos/tutorial/tutorial.st
/doc/demos/tutorial/tutorial.tex
/doc/demos/tutorial/tutorial.txt
/doc/demos/tutorial/tutorial.xml
/doc/manual/manual.do.txt
/doc/quickref/quickref.do.txt
/doc/tutorial/doconce2anything.do.txt
/doc/tutorial/tutorial.do.txt
/lib/doconce/doconce.py
/lib/doconce/doconce_config_default.py
/lib/doconce/misc.py

=======================================
--- /bin/doconce Wed May 29 13:21:03 2013
+++ /bin/doconce Sat Jul 13 00:16:44 2013
@@ -77,7 +77,7 @@
print 'Could not import doconce from directory\n', os.getcwd()
sys.exit(1)

- doconce.doconce.main()
+ doconce.doconce.format_driver()



=======================================
--- /doc/demos/manual/html/_sources/manual.txt Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/html/_sources/manual.txt Sat Jul 13 00:16:44 2013
@@ -5,7 +5,7 @@
===================

:Author: Hans Petter Langtangen
-:Date: Jun 28, 2013
+:Date: Jul 13, 2013

.. lines beginning with # are doconce comment lines

@@ -763,6 +763,9 @@
HTML
----

+Basics
+~~~~~~
+
Making an HTML version of a Doconce file ``mydoc.do.txt``
is performed by

@@ -772,6 +775,23 @@

The resulting file ``mydoc.html`` can be loaded into any web browser for
viewing.

+Typesetting of Code
+~~~~~~~~~~~~~~~~~~~
+
+If the Pygments package (including the ``pygmentize`` program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument ``--no_pygments_html``
+turns off the use of Pygments and makes code blocks appear with
+plain (``pre``) HTML tags. The option ``--pygments_html_linenos`` turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by ``--pygments_html_style=style``, where ``style``
+can be ``default``, ``emacs``, ``perldoc``, and other valid names for
+Pygments styles.
+
+
+HTML Styles
+~~~~~~~~~~~
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -794,22 +814,15 @@
links to the CSS stylesheet in ``filename``. Several stylesheets can
be specified: ``--ccs=file1.css,file2.css,file3.css``.

+HTML templates
+~~~~~~~~~~~~~~
+
Templates are HTML files with "slots" ``%(main)s`` for the main body
of text, ``%(title)s`` for the title, and ``%(date)s`` for the date.
Doconce comes with a few templates. The usage of templates is
described in a `separate document
<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>`_. That
document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the ``pygmentize`` program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument ``--no_pygments_html``
-turns off the use of Pygments and makes code blocks appear with
-plain (``pre``) HTML tags. The option ``--pygments_html_linenos`` turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by ``--pygments_html_style=style``, where ``style``
-can be ``default``, ``emacs``, ``perldoc``, and other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": "
`<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>`_" on
this topic. The template file must contain
valid HTML code and can have three "slots": ``%(title)s`` for a title,
@@ -835,6 +848,40 @@
that are used if the document contains ``!split`` commands for splitting
it into many pages.

+The HTML File Collection
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+``.basename_html_file_collection``, where ``basename`` is the filestem of
+the Doconce file (i.e., the Doconce source is in ``basename.do.txt``).
+
+Filenames
+~~~~~~~~~
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the ``--html_output=basename`` option, where ``basename`` is the
+filestem of the associated HTML files. The
+``.basename_html_file_collection`` file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: ``mydoc_bloodish.html``, ``mydoc_solarized``, and
+``mydoc_vagrant``.
+
+
+.. code-block:: console
+
+ Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+ Terminal> doconce split_html mydoc_bloodish.html
+ Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+ Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant
--pygments_html_style=default \
+
--html_template=templates/my_adapted_vagrant_template.html
+ Terminal> doconce split_html mydoc_vagrant.html
+

Blog Posts
----------
@@ -995,9 +1042,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option ``--latex_printed`` makes some adjustments for documents
+An option ``-DDEVICE=paper`` makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, ``-DDEVICE=screen``, creates a PDF file for reading
+on a screen where links are clickable.

*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,

@@ -1047,6 +1096,9 @@
``multimedia`` (for Beamer-style ``\movie`` command),
or ``href-run`` (for the plain `\h:ref:`run:file`` command)

+ * ``MOVIE_CONTROLS`` adds buttons for starting/stopping movies if the
+ ``media9`` package is used.
+
* ``PREAMBLE`` to turn the LaTeX preamble on or off (i.e., complete
document
or document to be included elsewhere - and note that
the preamble is only included
@@ -1063,13 +1115,6 @@

* ``LINENUMBERS`` for inclusion of line numbers in the text.

- * ``AMON`` for setting the type of admonitions: ``"colors"`` for colored
- boxes with icons, ``"graybox1"`` for gray frame boxes with rounded
- corners (default), ``"graybox2"`` for narrower square gray frame boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or ``"paragraph"`` for simple, plain paragraph headings and ordinary
text
-
* ``COLORED_TABLE_ROWS`` for coloring every other table rows (set this
variable to ``gray`` or ``blue``)

@@ -1115,9 +1160,17 @@
begin and end for blocks inside ``!bc fpro`` and ``!ec``). Specifying
``envir=ans:nt`` means that all other environments are typeset with the
``anslistings.sty`` package, e.g., ``!bc cppcod`` will then result in
-``\begin{c++}``. If no environments like ``sys``, ``fpro``, or the common
-``envir`` are defined on the command line, the plain ``\begin{verbatim}``
-and ``\end{verbatim}`` used.
+``\begin{c++}``. A predefined shortcut as in ``shcod=Verbatim-0.85``
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+``shcod=Verbatim-indent`` implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+``\begin{Verbatim}`` instruction using the syntax illustrated for
+the ``sys`` environments above.
+
+If no environments like ``sys``, ``fpro``, or the common
+``envir`` are defined on the command line, the plain ``\begin{Verbatim}``
+and ``\end{Verbatim}`` instructions are used.


*Step 2b (optional).* Edit the ``mydoc.tex`` file to your needs.
@@ -1836,6 +1889,7 @@

Here are some examples:

+
.. code-block:: text


@@ -1846,11 +1900,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is
written).

- ========= Example on a Chapter Heading =========
-
- Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1885,7 +1934,7 @@
.. code-block:: text


- FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+ FIGURE:[filename, height=400 width=600 frac=0.8] caption


The filename can be without extension, and Doconce will search for an
@@ -1894,16 +1943,28 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's ``convert`` utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats ``html``, ``rst``, ``sphinx``, while
+the frac specification is used for ``latex`` and ``pdflatex`` to specify
+the width of the image as a fraction of the text width.

-Note also that, like for ``TITLE:`` and ``AUTHOR:`` lines, all information
-related to a figure line *must be written on the same line*. Introducing
-newlines in a long caption will destroy the formatting (only the
-part of the caption appearing on the same line as ``FIGURE:`` will be
-included in the formatted caption).
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+
+.. warning::
+ Note the comma
+ between the filename and the figure size specifications and
+ that there should be no space around the = sign. This syntax must
+ be strictly followed.
+
+ Note also that, like for ``TITLE:`` and ``AUTHOR:`` lines, all
information
+ related to a figure line *must be written on the same line*.
Introducing
+ newlines in a long caption will destroy the formatting (only the
+ part of the caption appearing on the same line as ``FIGURE:`` will be
+ included in the formatted caption).


.. _fig:viz:
@@ -2003,12 +2064,27 @@

MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420
height=315]

- MOVIE: [http://vimeo.com/55562330, width=500 height=278]
Computational fluid dynamics movie.
+ MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.

Note that there must be a blank line after every ``MOVIE:`` command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

+.. raw:: html
+
+ <iframe width="420" height="315"
src="http://www.youtube.com/embed/sI2uCHH3qIM" frameborder="0"
allowfullscreen></iframe>
+
+
+
+.. raw:: html
+
+ <iframe width="500" height="278"
src="http://player.vimeo.com/video/55562330" frameborder="0"
allowfullscreen></iframe>
+
+ <em>CFD.</em>
+
+
+
+
Copying Computer Code from Source Files
---------------------------------------

=======================================
--- /doc/demos/manual/html/manual.html Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/html/manual.html Sat Jul 13 00:16:44 2013
@@ -56,7 +56,7 @@
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Author:</th><td
class="field-body">Hans Petter Langtangen</td>
</tr>
-<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body">Jun 28, 2013</td>
+<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body">Jul 13, 2013</td>
</tr>
</tbody>
</table>
@@ -643,12 +643,29 @@
</div>
<div class="section" id="html">
<h2>HTML<a class="headerlink" href="#html" title="Permalink to this
headline">¶</a></h2>
+<div class="section" id="basics">
+<h3>Basics<a class="headerlink" href="#basics" title="Permalink to this
headline">¶</a></h3>
<p>Making an HTML version of a Doconce file <tt class="docutils
literal"><span class="pre">mydoc.do.txt</span></tt>
is performed by</p>
<div class="highlight-console"><div class="highlight"><pre><span
class="go">Terminal&gt; doconce format html mydoc</span>
</pre></div>
</div>
<p>The resulting file <tt class="docutils literal"><span
class="pre">mydoc.html</span></tt> can be loaded into any web browser for
viewing.</p>
+</div>
+<div class="section" id="typesetting-of-code">
+<h3>Typesetting of Code<a class="headerlink" href="#typesetting-of-code"
title="Permalink to this headline">¶</a></h3>
+<p>If the Pygments package (including the <tt class="docutils
literal"><span class="pre">pygmentize</span></tt> program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument <tt class="docutils
literal"><span class="pre">--no_pygments_html</span></tt>
+turns off the use of Pygments and makes code blocks appear with
+plain (<tt class="docutils literal"><span class="pre">pre</span></tt>)
HTML tags. The option <tt class="docutils literal"><span
class="pre">--pygments_html_linenos</span></tt> turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by <tt class="docutils literal"><span
class="pre">--pygments_html_style=style</span></tt>, where <tt
class="docutils literal"><span class="pre">style</span></tt>
+can be <tt class="docutils literal"><span class="pre">default</span></tt>,
<tt class="docutils literal"><span class="pre">emacs</span></tt>, <tt
class="docutils literal"><span class="pre">perldoc</span></tt>, and other
valid names for
+Pygments styles.</p>
+</div>
+<div class="section" id="html-styles">
+<h3>HTML Styles<a class="headerlink" href="#html-styles" title="Permalink
to this headline">¶</a></h3>
<p>The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.</p>
@@ -668,20 +685,14 @@
Doconce write the built-in style to that file. Otherwise the HTML
links to the CSS stylesheet in <tt class="docutils literal"><span
class="pre">filename</span></tt>. Several stylesheets can
be specified: <tt class="docutils literal"><span
class="pre">--ccs=file1.css,file2.css,file3.css</span></tt>.</p>
+</div>
+<div class="section" id="html-templates">
+<h3>HTML templates<a class="headerlink" href="#html-templates"
title="Permalink to this headline">¶</a></h3>
<p>Templates are HTML files with &#8220;slots&#8221; <tt class="docutils
literal"><span class="pre">%(main)s</span></tt> for the main body
of text, <tt class="docutils literal"><span
class="pre">%(title)s</span></tt> for the title, and <tt class="docutils
literal"><span class="pre">%(date)s</span></tt> for the date.
Doconce comes with a few templates. The usage of templates is
described in a <a class="reference external"
href="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html">separate
document</a>. That document describes how you your Doconce-generated
HTML file can have any specified layout.</p>
-<p>If the Pygments package (including the <tt class="docutils
literal"><span class="pre">pygmentize</span></tt> program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument <tt class="docutils
literal"><span class="pre">--no_pygments_html</span></tt>
-turns off the use of Pygments and makes code blocks appear with
-plain (<tt class="docutils literal"><span class="pre">pre</span></tt>)
HTML tags. The option <tt class="docutils literal"><span
class="pre">--pygments_html_linenos</span></tt> turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by <tt class="docutils literal"><span
class="pre">--pygments_html_style=style</span></tt>, where <tt
class="docutils literal"><span class="pre">style</span></tt>
-can be <tt class="docutils literal"><span class="pre">default</span></tt>,
<tt class="docutils literal"><span class="pre">emacs</span></tt>, <tt
class="docutils literal"><span class="pre">perldoc</span></tt>, and other
valid names for
-Pygments styles.</p>
<p>The HTML file can be embedded in a template with your own tailored
design, see a &#8220;tutorial&#8221;: &#8221; <a class="reference
external"
href="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html">https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html</a>&#8221;
on this topic. The template file must contain
valid HTML code and can have three &#8220;slots&#8221;: <tt
class="docutils literal"><span class="pre">%(title)s</span></tt> for a
title,
@@ -705,6 +716,37 @@
that are used if the document contains <tt class="docutils literal"><span
class="pre">!split</span></tt> commands for splitting
it into many pages.</p>
</div>
+<div class="section" id="the-html-file-collection">
+<h3>The HTML File Collection<a class="headerlink"
href="#the-html-file-collection" title="Permalink to this
headline">¶</a></h3>
+<p>There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+<tt class="docutils literal"><span
class="pre">.basename_html_file_collection</span></tt>, where <tt
class="docutils literal"><span class="pre">basename</span></tt> is the
filestem of
+the Doconce file (i.e., the Doconce source is in <tt class="docutils
literal"><span class="pre">basename.do.txt</span></tt>).</p>
+</div>
+<div class="section" id="filenames">
+<h3>Filenames<a class="headerlink" href="#filenames" title="Permalink to
this headline">¶</a></h3>
+<p>An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the <tt class="docutils literal"><span
class="pre">--html_output=basename</span></tt> option, where <tt
class="docutils literal"><span class="pre">basename</span></tt> is the
+filestem of the associated HTML files. The
+<tt class="docutils literal"><span
class="pre">.basename_html_file_collection</span></tt> file lists all the
needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: <tt class="docutils literal"><span
class="pre">mydoc_bloodish.html</span></tt>, <tt class="docutils
literal"><span class="pre">mydoc_solarized</span></tt>, and
+<tt class="docutils literal"><span
class="pre">mydoc_vagrant</span></tt>.</p>
+<div class="highlight-console"><div class="highlight"><pre><span
class="go">Terminal&gt; doconce format html mydoc --html_style=bloodish
\</span>
+<span class="go"> --html_output=mydoc_bloodish</span>
+<span class="go">Terminal&gt; doconce split_html mydoc_bloodish.html</span>
+<span class="go">Terminal&gt; doconce format html mydoc
--html_style=solarized \</span>
+<span class="go"> --html_output=mydoc_solarized
--pygments_html=perldoc \</span>
+<span class="go"> --html_admon=apricot</span>
+<span class="go">Terminal&gt; doconce format html mydoc
--html_style=vagrant \</span>
+<span class="go"> --html_output=mydoc_vagrant
--pygments_html_style=default \</span>
+<span class="go">
--html_template=templates/my_adapted_vagrant_template.html</span>
+<span class="go">Terminal&gt; doconce split_html mydoc_vagrant.html</span>
+</pre></div>
+</div>
+</div>
+</div>
<div class="section" id="blog-posts">
<h2>Blog Posts<a class="headerlink" href="#blog-posts" title="Permalink to
this headline">¶</a></h2>
<p>Doconce can be used for writing blog posts provided the blog site
accepts
@@ -827,9 +869,11 @@
<tt class="docutils literal"><span
class="pre">newcommands_replace.tex</span></tt> (see the section <a
class="reference internal" href="#newcommands"><em>Macros
(Newcommands)</em></a>).
If these files are present, they are included in the LaTeX document
so that your commands are defined.</p>
-<p>An option <tt class="docutils literal"><span
class="pre">--latex_printed</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">-DDEVICE=paper</span></tt> makes some adjustments for documents
aimed at being printed. For example, links to web resources are
-associated with a footnote listing the complete web address (URL).</p>
+associated with a footnote listing the complete web address (URL).
+The default, <tt class="docutils literal"><span
class="pre">-DDEVICE=screen</span></tt>, creates a PDF file for reading
+on a screen where links are clickable.</p>
<p><em>Step 2.</em> Run <tt class="docutils literal"><span
class="pre">ptex2tex</span></tt> (if you have it) to make a standard LaTeX
file,</p>
<div class="highlight-console"><div class="highlight"><pre><span
class="go">Terminal&gt; ptex2tex mydoc</span>
</pre></div>
@@ -865,6 +909,8 @@
while other values are <tt class="docutils literal"><span
class="pre">movie15</span></tt> (<tt class="docutils literal"><span
class="pre">\includemovie</span></tt> command),
<tt class="docutils literal"><span class="pre">multimedia</span></tt> (for
Beamer-style <tt class="docutils literal"><span
class="pre">\movie</span></tt> command),
or <tt class="docutils literal"><span class="pre">href-run</span></tt>
(for the plain <cite>h:ref:`run:file`</cite> command)</li>
+<li><tt class="docutils literal"><span
class="pre">MOVIE_CONTROLS</span></tt> adds buttons for starting/stopping
movies if the
+<tt class="docutils literal"><span class="pre">media9</span></tt> package
is used.</li>
<li><tt class="docutils literal"><span class="pre">PREAMBLE</span></tt> to
turn the LaTeX preamble on or off (i.e., complete document
or document to be included elsewhere - and note that
the preamble is only included
@@ -877,12 +923,6 @@
macro has only effect if inline comments are used (name, colon,
and comment inside brackets).</li>
<li><tt class="docutils literal"><span class="pre">LINENUMBERS</span></tt>
for inclusion of line numbers in the text.</li>
-<li><tt class="docutils literal"><span class="pre">AMON</span></tt> for
setting the type of admonitions: <tt class="docutils literal"><span
class="pre">&quot;colors&quot;</span></tt> for colored
-boxes with icons, <tt class="docutils literal"><span
class="pre">&quot;graybox1&quot;</span></tt> for gray frame boxes with
rounded
-corners (default), <tt class="docutils literal"><span
class="pre">&quot;graybox2&quot;</span></tt> for narrower square gray frame
boxes
-(except for summary, which for A4 format is small and with wrapped
-text around if it does not contain verbatim code),
-or <tt class="docutils literal"><span
class="pre">&quot;paragraph&quot;</span></tt> for simple, plain paragraph
headings and ordinary text</li>
<li><tt class="docutils literal"><span
class="pre">COLORED_TABLE_ROWS</span></tt> for coloring every other table
rows (set this
variable to <tt class="docutils literal"><span
class="pre">gray</span></tt> or <tt class="docutils literal"><span
class="pre">blue</span></tt>)</li>
<li><tt class="docutils literal"><span
class="pre">BLUE_SECTION_HEADINGS</span></tt> for blue section and
subsection headings</li>
@@ -923,9 +963,16 @@
begin and end for blocks inside <tt class="docutils literal"><span
class="pre">!bc</span> <span class="pre">fpro</span></tt> and <tt
class="docutils literal"><span class="pre">!ec</span></tt>). Specifying
<tt class="docutils literal"><span class="pre">envir=ans:nt</span></tt>
means that all other environments are typeset with the
<tt class="docutils literal"><span class="pre">anslistings.sty</span></tt>
package, e.g., <tt class="docutils literal"><span class="pre">!bc</span>
<span class="pre">cppcod</span></tt> will then result in
-<tt class="docutils literal"><span class="pre">\begin{c++}</span></tt>. If
no environments like <tt class="docutils literal"><span
class="pre">sys</span></tt>, <tt class="docutils literal"><span
class="pre">fpro</span></tt>, or the common
-<tt class="docutils literal"><span class="pre">envir</span></tt> are
defined on the command line, the plain <tt class="docutils literal"><span
class="pre">\begin{verbatim}</span></tt>
-and <tt class="docutils literal"><span
class="pre">\end{verbatim}</span></tt> used.</p>
+<tt class="docutils literal"><span class="pre">\begin{c++}</span></tt>. A
predefined shortcut as in <tt class="docutils literal"><span
class="pre">shcod=Verbatim-0.85</span></tt>
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+<tt class="docutils literal"><span
class="pre">shcod=Verbatim-indent</span></tt> implies indentation of the
verbatim text.
+Alternatively, one can provide all desired parameters
+<tt class="docutils literal"><span
class="pre">\begin{Verbatim}</span></tt> instruction using the syntax
illustrated for
+the <tt class="docutils literal"><span class="pre">sys</span></tt>
environments above.</p>
+<p>If no environments like <tt class="docutils literal"><span
class="pre">sys</span></tt>, <tt class="docutils literal"><span
class="pre">fpro</span></tt>, or the common
+<tt class="docutils literal"><span class="pre">envir</span></tt> are
defined on the command line, the plain <tt class="docutils literal"><span
class="pre">\begin{Verbatim}</span></tt>
+and <tt class="docutils literal"><span
class="pre">\end{Verbatim}</span></tt> instructions are used.</p>
<p><em>Step 2b (optional).</em> Edit the <tt class="docutils
literal"><span class="pre">mydoc.tex</span></tt> file to your needs.
For example, you may want to substitute <tt class="docutils literal"><span
class="pre">section</span></tt> by <tt class="docutils literal"><span
class="pre">section*</span></tt> to
avoid numbering of sections, you may want to insert linebreaks
@@ -1491,11 +1538,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1519,7 +1561,7 @@
<div class="section" id="figures">
<h2>Figures<a class="headerlink" href="#figures" title="Permalink to this
headline">¶</a></h2>
<p>Figures are recognized by the special line syntax</p>
-<div class="highlight-text"><div class="highlight"><pre>FIGURE:[filename,
height=xxx width=yyy scale=zzz] possible caption
+<div class="highlight-text"><div class="highlight"><pre>FIGURE:[filename,
height=400 width=600 frac=0.8] caption
</pre></div>
</div>
<p>The filename can be without extension, and Doconce will search for an
@@ -1527,15 +1569,26 @@
say <tt class="docutils literal"><span class="pre">.eps</span></tt> when
requesting an HTML format, Doconce tries to find another
file, and if not, the given file is converted to a proper format
(using ImageMagick&#8217;s <tt class="docutils literal"><span
class="pre">convert</span></tt> utility).</p>
-<p>The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.</p>
-<p>Note also that, like for <tt class="docutils literal"><span
class="pre">TITLE:</span></tt> and <tt class="docutils literal"><span
class="pre">AUTHOR:</span></tt> lines, all information
+<p>The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats <tt class="docutils literal"><span
class="pre">html</span></tt>, <tt class="docutils literal"><span
class="pre">rst</span></tt>, <tt class="docutils literal"><span
class="pre">sphinx</span></tt>, while
+the frac specification is used for <tt class="docutils literal"><span
class="pre">latex</span></tt> and <tt class="docutils literal"><span
class="pre">pdflatex</span></tt> to specify
+the width of the image as a fraction of the text width.</p>
+<p>The figure caption is optional. If omitted, the figure appears
&#8220;inline&#8221;
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p>Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.</p>
+<p class="last">Note also that, like for <tt class="docutils
literal"><span class="pre">TITLE:</span></tt> and <tt class="docutils
literal"><span class="pre">AUTHOR:</span></tt> lines, all information
related to a figure line <em>must be written on the same line</em>.
Introducing
newlines in a long caption will destroy the formatting (only the
part of the caption appearing on the same line as <tt class="docutils
literal"><span class="pre">FIGURE:</span></tt> will be
included in the formatted caption).</p>
+</div>
<div class="figure" id="fig-viz">
<img alt="_images/streamtubes.png" src="_images/streamtubes.png"
style="width: 400px;" />
<p class="caption"><em>Streamtube visualization of a fluid flow</em></p>
@@ -1593,13 +1646,15 @@
<p>A typical <tt class="docutils literal"><span
class="pre">MOVIE</span></tt> command with a YouTube movie is then</p>
<div class="highlight-text"><div class="highlight"><pre>MOVIE:
[http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
</pre></div>
</div>
<p>Note that there must be a blank line after every <tt class="docutils
literal"><span class="pre">MOVIE:</span></tt> command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.</p>
-</div>
+<iframe width="420" height="315"
src="http://www.youtube.com/embed/sI2uCHH3qIM" frameborder="0"
allowfullscreen></iframe><iframe width="500" height="278"
src="http://player.vimeo.com/video/55562330" frameborder="0"
allowfullscreen></iframe>
+
+<em>CFD.</em></div>
<div class="section" id="copying-computer-code-from-source-files">
<h2>Copying Computer Code from Source Files<a class="headerlink"
href="#copying-computer-code-from-source-files" title="Permalink to this
headline">¶</a></h2>
<p>Another type of special lines starts with <tt class="docutils
literal"><span class="pre">&#64;&#64;&#64;CODE</span></tt> and enables
copying
@@ -3907,7 +3962,15 @@
<li><a class="reference internal"
href="#removal-of-inline-comments">Removal of inline comments</a></li>
<li><a class="reference internal" href="#notes">Notes</a></li>
<li><a class="reference internal" href="#demo-of-different-formats">Demo
of different formats</a></li>
-<li><a class="reference internal" href="#html">HTML</a></li>
+<li><a class="reference internal" href="#html">HTML</a><ul>
+<li><a class="reference internal" href="#basics">Basics</a></li>
+<li><a class="reference internal" href="#typesetting-of-code">Typesetting
of Code</a></li>
+<li><a class="reference internal" href="#html-styles">HTML Styles</a></li>
+<li><a class="reference internal" href="#html-templates">HTML
templates</a></li>
+<li><a class="reference internal" href="#the-html-file-collection">The
HTML File Collection</a></li>
+<li><a class="reference internal" href="#filenames">Filenames</a></li>
+</ul>
+</li>
<li><a class="reference internal" href="#blog-posts">Blog Posts</a></li>
<li><a class="reference internal" href="#pandoc-and-markdown">Pandoc and
Markdown</a></li>
<li><a class="reference internal" href="#latex">LaTeX</a></li>
=======================================
--- /doc/demos/manual/html/searchindex.js Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/html/searchindex.js Sat Jul 13 00:16:44 2013
@@ -1,1 +1,1 @@
-Search.setIndex({objects:{},terms:{mydoc2:1,linebreak:1,yellow:1,four:1,fig2:1,fig3:1,fig1:1,consider:1,spellcheck:1,ecollin:1,usepackag:1,matlab:1,under:1,preprocess:[0,1],yourdoc:1,everi:1,wrapper_tech:1,"void":1,rise:1,theorem_count:1,affect:1,pygments_html_lineno:1,disturb:1,upload:1,vector:1,math:1,darkgrai:1,relsiz:1,dirnam:1,direct:1,consequ:1,second:1,esol:1,blue:1,mpeg:1,extra_sect:1,"new":1,net:1,never:1,here:1,"const":1,python_an:1,interpret:1,forum:1,ptex2tex:1,precis:1,loop:1,studi:1,brought:1,unix:1,org:1,outro:1,txt:1,shcod:1,describ:1,would:1,includemovi:1,doconc:[0,1],call:1,typo:1,recommend:1,calc:1,type:1,pdfcrop:1,relat:1,footerbgcolor:1,notic:1,warn:1,mwk:1,rootdir:1,si2uchh3qim:1,automake_sphinx:1,must:1,springer:1,word:1,setup:1,work:1,split_rst:1,root:1,overrid:1,give:1,da6pap:1,somefil:1,caution:1,want:1,attract:1,end:1,quot:1,ordinari:1,vagrant:1,how:1,answer:1,perspect:1,updat:1,recogn:1,after:1,befor:1,wrong:1,demonstr:1,basicstrap:1,attempt:1,pdfnup:1,bootstrap:1,mwiki:1,neglect:1,myeq1:1,maintain:1,environ:[0,1],eblock:1,enter:1,order:1,srclib:1,deck:1,over:1,becaus:1,jpeg:1,keyboard:1,flexibl:1,vari:1,myfil:1,fit:1,setspac:1,better:1,offic:1,fig:1,comprehens:1,html_style:1,easier:1,miiton:1,them:1,var1:1,thei:1,safe:1,"break":1,yourself:1,choic:1,sphinxext:1,each:1,debug:[0,1],side:1,mean:1,pdflatex:[0,1],laboratori:1,logg:1,extract:1,goe:1,content:[0,1],rewrit:1,fairli:1,sphinx_dir:1,reader:1,forth:1,linear:1,navig:1,situat:1,standard:1,acrobat:1,reformul:1,bwarn:1,argument:[0,1],filter:1,iso:1,examples_as_exercis:1,onto:1,no_pygments_html:1,"__theorem":1,rang:1,html_theme_opt:1,render:1,independ:1,biomed:1,restrict:1,instruct:1,alreadi:1,"__abstract":1,primari:1,top:1,sometim:1,mercuri:1,underlin:1,master:1,too:1,similarli:1,toc:1,consol:1,tool:1,xkeyval:1,somewhat:1,knob:1,simula:1,solvin:1,charcter:1,past:1,target:1,keyword:1,provid:1,tree:1,usepack:1,project:[0,1],doonc:1,"5mm":1,admonit:[0,1],fashion:1,dvar1:1,modern:1,raw:1,pylon:1,seen:1,mint:1,minu:1,minted_cpp:1,latter:1,even:1,though:1,pdiff:1,ebook:1,regular:1,letter:1,choos:1,style_vagr:1,tradit:1,don:1,doc:1,flow:1,doe:1,dummi:1,abbrev:1,declar:1,unchang:1,winther:1,random:1,pygments_html_styl:1,syntax:1,mediawiki:1,indentend:1,theme_dir:1,involv:1,layout:1,explain:1,configur:1,theme:1,rich:1,shoutwiki:1,agni:1,watch:1,fluid:1,encourg:1,cloud_spthem:1,makeindex:1,report:1,keyword2:1,keyword1:1,youtub:1,briefer:1,emb:1,"public":1,ban:1,respond:1,kolmogorov:1,pdftool:1,result:1,fail:1,best:1,awar:1,databas:1,wikipedia:1,figur:[0,1],simplest:1,awai:1,approach:1,accord:1,slides_beam:1,extend:1,extens:1,lazi:1,preprocessor:1,extent:1,toler:1,han:1,howev:1,subitem:1,cod:1,docbook:1,seri:1,com:1,mardal:1,dbook:1,height:1,stylefil:1,documentstyl:1,path:1,diff:1,guid:1,assum:1,summar:1,duplic:1,union:1,numpi:1,three:1,been:1,much:1,sphinxdir:1,basic:[0,1],futur:1,quickli:1,life:1,deeper:1,spit:1,xxy:1,xxx:1,anywher:1,els:1,emploi:1,ugli:1,ident:1,subentri:1,gnu:1,servic:1,properti:1,sourceforg:1,aim:1,dept:1,aid:1,anchor:1,pyramid:1,coher:1,conv:1,a6pap:1,conf:1,sever:1,mako:[0,1],disabl:1,perform:1,suggest:1,make:1,complex:1,split:[0,1],texinfo:1,complet:1,a2p:1,slides_html:1,mytext:1,hand:1,bibliograph:1,norwegian:1,pngmath_dvipng_arg:1,tune:1,moondist:1,redefin:1,kept:1,undesir:1,thi:1,endif:1,everyth:1,giftran:1,left:1,identifi:1,just:1,rst2odt:1,xelatex:[0,1],human:1,ifdef:1,kdiff3:1,yet:1,languag:[0,1],easi:1,mix:1,interfer:1,fortran:1,cp2texmf:1,save:1,explanatori:1,gave:1,mayb:1,boldfac:1,fromto:1,background:1,shadow:1,wrapfig:1,measur:1,amon:1,specif:1,arbitrari:1,manual:[0,1],docutil:1,www:1,right:1,old:1,intern:1,toctre:1,successfulli:1,total:1,collect:1,univ:1,core:1,plu:1,bold:1,fancyvrb:1,repositori:1,post:[0,1],chapter:1,slightli:1,surround:1,unfortun:1,algn:1,"__proof":1,produc:1,ppa:1,"float":1,encod:1,fancybox:1,down:1,wrap:1,accordingli:1,git:1,perldoc:1,suffici:1,support:1,transform:1,why:1,avail:1,width:1,wordpress:1,editor:1,analysi:1,head:1,satisfactorili:1,form:1,offer:1,solar:1,"true":1,rerun:1,featur:[0,1],classic:1,request:1,"abstract":1,ephas:1,postscript:1,exist:1,check:1,assembl:1,somenam:1,tkdiff:1,eremark:1,when:1,test:1,diffpack:1,matur:1,notif:1,intend:1,asterisk:1,consid:1,occasion:1,stoke:1,bitbucket:1,longer:1,bullet:1,phone:1,ignor:1,maxdepth:1,time:1,beamer:[0,1],nxn:1,concept:1,particular:1,row:1,middl:1,depend:[0,1],unnumb:1,flask:1,texmf:1,proj:1,sourc:[0,1],xpro:1,brows:1,seemingli:1,level:1,did:1,relbarbgcolor:1,iter:1,item:1,preprocesor:1,combine_imag:1,team:1,quick:[0,1],sidebarlinkcolor:1,round:1,dir:1,sign:1,dmath:1,appear:1,anywai:1,current:1,rst2xml:1,meld:1,xml:1,autogener:1,gener:[0,1],disclaim:[0,1],modif:1,address:1,locat:1,along:1,box:1,shift:1,trial:1,behav:1,myvar:1,slidecel:1,extra:1,tweak:[0,1],modul:[0,1],ipi:1,prefer:1,backtick:1,visibl:1,instal:[0,1],should:1,regex:1,dvipdf:1,univers:1,helvetica:1,todai:1,subvers:1,stylesheet:1,criteria:1,checkout:1,share:1,newcommand:[0,1],visual:1,appendix:1,indic:[0,1],examin:1,easiest:1,dhelvetica:1,slogan:1,uniqu:1,impel:1,can:1,cal:1,purpos:1,ehint:1,claim:1,encapsul:1,bloodish:1,backslash:1,topic:1,abort:1,occur:1,alwai:1,differenti:1,multipl:1,oslo:1,no_abort:1,write:[0,1],pure:1,tile:1,ispel:1,map:1,clone:1,codetermin:1,mac:1,mai:1,underscor:1,data:1,man:1,mdframe:1,favorit:1,inform:1,"switch":1,cannot:1,combin:1,ssh:1,epydoc:1,boldface_:1,"_part0000_mydoc":1,equip:1,still:1,mainli:1,dynam:1,entiti:1,group:1,passag:1,platform:1,window:1,doconce_head:1,main:1,non:1,recal:1,matcher:1,initi:1,half:1,now:1,discuss:1,nor:1,name:1,config:1,separ:1,mydoc_html_file_collect:1,admon:1,compil:1,f2f2f2:1,replac:1,individu:1,continu:1,backport:1,year:1,happen:1,reportlab:1,space:1,bnotic:1,sespecif:1,formula:1,md2html:1,correct:1,headlin:1,fontsiz:1,mako_strict_undefin:1,institut:1,care:1,"__a":1,wai:1,modest:1,thing:1,place:1,view:1,nicknam:1,imposs:1,frequent:1,first:1,origin:1,directli:1,carri:1,onc:1,arrai:1,bluish:1,lsb_releas:1,fast:1,open:1,predefin:1,size:1,given:1,xunicod:1,sheet:1,convent:1,gif:1,white:1,conveni:1,cite:1,forthcom:1,especi:1,copi:[0,1],bsubex:1,specifi:1,"short":1,enclos:1,than:1,png:1,wide:1,instanc:1,posit:1,zsh:1,browser:1,pre:1,unoconv:1,sai:1,nicer:1,pro:1,svnroot:1,ani:1,dash:1,zumbusch:1,mislead:1,engin:1,squar:1,destroi:1,moreov:1,note:[0,1],myeq2:1,take:1,includegraph:1,begin:1,sure:1,normal:1,track:1,fix_bibtex4publish:1,pair:1,icon:1,latex:[0,1],later:1,typeset:[0,1],preambl:1,main_myproj:1,viscou:1,show:1,scitool:1,bright:1,corner:1,unfinish:1,slot:1,onli:1,activ:1,analyz:1,microtyp:1,overwritten:1,variou:1,get:1,xcod:1,tailor:1,springer_collect:1,requir:1,reveal:1,tikz:1,cppcod:1,seldom:1,rst2pdf:1,paper:1,next1:1,where:1,summari:1,wiki:[0,1],"_sever":1,detect:1,xetex:1,label:1,enough:1,between:1,"import":1,inputenc:1,parent:1,screen:1,come:1,tug:1,img:1,tutori:1,mani:1,fix:1,among:1,acceler:1,color:1,overview:[0,1],inspir:1,period:1,pop:1,colon:1,typic:1,ultim:1,segfault:1,mark:1,structuredtext:1,encapusl:1,emphas:1,resolut:1,f90:1,f95:1,impati:1,former:1,those:1,"case":1,thesi:1,invok:1,advantag:1,ctrl:1,henc:1,destin:1,eras:1,ascii:[0,1],pdftk:1,develop:1,author:1,media:1,same:1,html:[0,1],document:[0,1],equat:1,nest:1,assist:1,extern:1,mycount:1,appropri:1,inconsist:1,macro:[0,1],markup:[0,1],ccq:1,sreen:1,without:1,kaar:1,venu:1,execut:1,documentclass:1,rest:[0,1],without_solut:1,flavor:1,hint:1,except:1,littl:1,blog:[0,1],treatment:1,exercis:[0,1],real:1,around:1,read:1,swig:1,nonnest:1,dark:1,grid:1,envir:1,world:1,mydict:1,whitespac:1,cdot:1,inted:1,integ:1,either:1,"_static":1,output:[0,1],fulfil:1,thpack:1,palatino:1,shadowbox:1,constitut:1,definit:1,legal:1,moon:1,subproblem:1,exit:1,refer:[0,1],power:1,inspect:1,tables2csv:1,fulli:1,regexp:1,src:1,split_html:1,stand:1,act:1,mytempl:1,dtodonot:1,myroutin:1,fundamental1:1,pagebreak:1,yyi:1,your:1,wikibook:1,log:1,her:1,area:1,haskel:1,start:1,lot:1,verbatim:[0,1],bundl:1,jun:1,streamtub:1,diffus:1,blueish:1,untag:1,pull:1,possibl:1,"default":1,plaympeg:1,creol:1,externaldocu:1,xcolor:1,creat:1,certain:1,strongli:1,intro:1,decreas:1,file:[0,1],again:1,googl:1,valid:1,you:1,condens:1,sequenc:1,symbol:1,langtangen_et_al_2002:1,sidebartextcolor:1,includemedia:1,exerinfo:1,tmp_mako__filenam:1,unbalanc:1,backward:1,directori:1,descript:[0,1],lbrack:1,potenti:1,cpp:1,escap:1,all:1,forget:1,illustr:1,dollar:1,"___sec2":1,follow:1,alt:1,external_movie_view:1,iconv:1,articl:1,program:[0,1],introduc:1,straightforward:1,fals:1,helvet:1,util:1,"1px":1,verb:1,mechan:1,texconv:1,veri:1,strang:1,unalt:1,nileshbans:1,list:[0,1],adjust:1,plain:[0,1],small:1,dxelatex:1,tex:[0,1],design:1,pass:1,further:1,what:[0,1],sub:1,section:1,netpbm:1,delet:1,version:1,method:1,full:1,hash:1,verbatim_text:1,misspel:1,sophist:1,behaviour:1,trunk:1,strong:1,modifi:1,valu:[0,1],search:[0,1],newlin:1,prior:1,amount:1,pick:1,action:1,narrow:1,via:1,depart:1,rightsidebar:1,filenam:1,href:1,html_theme:1,proceed:1,two:1,formul:1,taken:1,more:1,diamond:1,desir:1,ital:1,dnote:1,flag:1,stick:1,aris:1,known:1,shkumagai:1,none:1,valuabl:1,outlin:1,histori:1,paragraph:1,learn:1,rst2html:1,def:1,uncom:1,inline_tag_begin:1,dexternal_movie_view:1,accept:1,phrase:1,string:1,cours:1,csh:1,divid:1,rather:1,anoth:1,spreadsheet:1,snippet:1,csv:1,simpl:1,css:1,agogo:1,resourc:1,referenc:[0,1],variant:1,"_text":1,fignam:1,wave:1,associ:1,github:1,md2latex:1,footer:[0,1],confus:1,caus:1,testdoc:1,egg:1,help:1,devhelp:1,soon:1,scientist:1,through:1,myarr:1,paramet:1,style:1,roemer:1,ptext2tex:1,amsfont:1,gwiki:[0,1],might:1,fool:1,recip:1,good:1,"return":[0,1],sentenc:1,sphinxfix_localurl:1,petter:1,parenthesi:1,epsfig:1,troubleshoot:[0,1],easili:1,achiev:1,fpro:1,found:1,dir2:1,dir1:1,maketitl:1,sidebarbgcolor:1,hard:1,idea:[0,1],procedur:1,realli:1,heavi:1,beyond:1,"_part":1,publish:1,research:1,footnot:1,lineno:1,print:1,subsubsect:1,my_fil:1,advanc:1,pub:1,ref4:1,reason:1,base:1,put:1,teach:1,bash:1,launch:1,veloc:1,script:1,dpalatino:1,caption:1,perhap:1,fcod:1,ubuntuforum:1,major:1,feel:1,famou:1,misc:1,number:1,unovonv:1,smaller:[0,1],done:1,construct:1,blank:1,miss:[0,1],fanci:1,differ:[0,1],pandoc:[0,1],without_answ:1,cpp_an:1,interact:1,least:1,latexdiff:1,statement:1,cfg:1,illeg:1,scheme:1,evinc:1,option:1,part:1,pars:[0,1],myclass:1,kind:1,ffmpeg:1,whenev:1,remov:[0,1],bibliographystyl:1,horizont:1,reus:1,store:1,sty:1,cleaner:1,comput:[0,1],packag:1,anslist:1,built:1,self:1,also:1,institution2:1,institution3:1,institution1:1,distribut:1,csv2tabl:1,previou:1,reach:1,most:1,plai:1,exer:1,destruct:1,ext:1,clean:1,microsoft:1,think:1,sublist:1,diffpdf:1,session:1,particularli:1,font:1,fine:1,find:1,auctex:1,impact:1,mwlib:1,mjolnir:1,writer:1,solut:1,templat:1,smtplib:1,remedi:1,express:1,nativ:1,libreoffic:1,eq1:1,common:1,set:1,dump:1,creator:1,see:1,sed:1,close:1,someth:1,mybibtexfil:1,no_preprocess:1,subdir:1,experi:1,birkenfeld:1,altern:1,impressj:1,imagemagick:1,numer:1,javascript:1,subexercis:1,ipython:1,water:1,last:1,delimit:1,hyperlink:1,alon:1,"_part0001_mydoc":1,context:1,forgotten:1,pdf:1,whole:1,load:1,markdown:[0,1],simpli:1,point:1,header:[0,1],pycod:1,linux:1,mistak:1,throughout:1,becom:1,java:1,devic:1,due:1,empti:1,newcommands_replac:1,eart2moon_sol:1,strategi:1,invis:1,imag:1,remark:1,epytext:1,understand:1,demand:1,look:1,bluish2:1,formatt:[0,1],"while":1,smart:1,abov:1,error:1,subsitut:1,vlinux:1,pack:1,subsect:1,propag:1,html_admon:1,readi:1,itself:1,rid:1,minim:1,shorter:1,archiv:1,myslid:1,esubex:1,alert:1,user:1,cwiki:1,recent:1,lower:1,task:1,entri:1,elev:1,propos:1,explan:1,langtangen:1,restructuredtext:[0,1],shortcut:1,informat:1,theorem:[0,1],input:1,subroutin:1,format:[0,1],big:1,bib:1,backquot:1,table2:1,table3:1,semi:1,brace:1,xxdiff:1,resolv:1,"_part0002_mydoc":1,popular:1,ignorn:1,encount:1,sketch:1,often:1,simplifi:1,creation:1,some:1,back:1,understood:1,scale:1,montag:1,per:1,substitut:1,mathemat:[0,1],larg:1,retro:1,prog:1,object:1,run:1,zzz:1,newcommand_replac:1,step:[0,1],qthelp:1,idx:1,materi:1,idl:1,incompress:1,langtangen_2003a:1,block:[0,1],file3:1,file2:1,file1:1,doubl:1,emphasi:1,file4:1,within:1,ensur:1,perl:1,occupi:1,inclus:1,mkd:1,span:1,question:1,nosidebar:1,textual:1,custom:1,guess_encod:1,subst:1,includ:1,suit:1,myfunc:1,properli:1,link:1,translat:1,newer:1,delta:1,line:[0,1],listtyp:1,concaten:1,latex_preambl:1,utf:1,consist:1,inline_tag:1,apricot:1,access:1,someus:1,"export":1,similar:1,knob_left:1,repres:1,incomplet:1,home:1,curl:1,titl:1,invalid:1,bibfil:1,bracket:1,prev1:1,newcommands_keep:1,nice:1,mathpazo:1,colored_table_row:1,svn:1,rst2latex:1,bsummari:1,depth:1,far:1,code:[0,1],partial:1,totem:1,rtf:1,makeidx:1,refs3:1,refs2:1,refs1:1,compact:1,cython:1,showthread:1,elsewher:1,send:1,becam:1,sens:1,fenics_minim:1,docoment:1,titlepag:1,makotempl:1,volum:1,untouch:1,relev:1,tri:1,"20435c":1,button:1,ryan:1,"try":1,impli:1,exted:1,fortun:1,natur:1,odt:1,jump:1,video:1,haiku:1,download:1,click:1,index:[0,1],femdeq:1,compar:1,resembl:1,multimedia:1,cell:1,experiment:1,remove_inline_com:1,mathjax:1,tveito:1,deduc:1,whatev:1,vibrat:1,bibitem:1,matplotlib:1,html_fenic:1,bodi:1,let:1,dmovie15:1,ubuntu:[0,1],vertic:1,sinc:1,convert:1,convers:1,larger:1,chang:1,problemat:1,chanc:1,firefox:1,appli:1,colors1:1,apt:1,cloud:1,from:[0,1],tmp_missing_:1,live:1,mydir:1,next:1,websit:1,few:1,postprocess:1,sort:1,slim:1,comparison:1,trail:1,langtangen_pedersen_2002:1,retriev:1,annoi:1,column:1,obvious:1,meet:1,proof:1,control:1,quickstart:1,process:1,sudo:1,blue_section_head:1,tag:[0,1],doconce_install_al:1,tarbal:1,surfac:1,subdirectori:1,instead:1,sin:1,yellowish:1,frac:1,stop:1,mypack:1,earth2moon:1,exemplifi:1,keep_pygments_html_bg:1,colors2:1,essenti:1,light:1,counter:1,correspond:1,element:1,issu:1,epstopdf:1,allow:1,dmint:1,elif:1,movi:[0,1],move:1,comma:1,libav:1,myprog:1,outer:1,latex_head:1,chosen:1,therefor:1,docx:1,crash:1,python:1,handi:1,dat:1,mention:1,textopc:1,somewher:1,inline_tag_end:1,edit:1,wdiff:1,slide:[0,1],mode:1,mystyl:1,"10pt":1,pygment:1,subset:1,intellig:1,meta:1,subsec:1,our:1,special:[0,1],out:1,variabl:[0,1],matrix:1,esummari:1,sandbox:1,texliv:1,suitabl:1,rel:1,ref:1,red:1,statist:1,insid:1,manipul:1,standalon:1,dictionari:1,pedersen:1,indent:1,could:1,ask:1,movie15:1,keep:1,length:1,outsid:1,navier:1,geometri:1,cyberspac:1,softwar:1,manuscript:1,blogger:1,rbrack:1,texshop:1,date:1,"long":1,mkdir:1,system:1,messag:1,termin:1,siam:1,"final":1,shell:1,bhint:1,bblock:1,cyb:1,rst:1,newtheorem:1,exactli:1,myfram:1,structur:1,charact:1,steer:1,viewer:1,explicit:1,have:1,tabl:[0,1],need:1,turn:1,border:1,table4:1,minted_python:1,preced:1,which:1,divers:1,singl:1,unless:1,preliminari:1,who:1,ooxml:1,awl:1,mplayer:1,twitter_bootstrap:1,segment:1,"class":1,epub:1,"_build":1,todonot:1,latin1:1,url:1,hardcod:1,face:1,pipe:1,bibtex:1,determin:1,ubuntu_vers:1,superscript:1,fact:1,smpeg:1,text:[0,1],skip_inline_com:1,knob_forward:1,blognam:1,graybox1:1,graybox2:1,graybox3:1,thicker:1,emac:[0,1],titlesec:1,html_templat:1,dispers:1,jal:1,"_mydoc":1,suppos:1,conclus:1,local:1,ksh:1,meant:1,mythem:1,contribut:1,familiar:1,autom:1,pressbook:1,enabl:1,bisect:1,theorem_fundamental1:1,ewarn:1,grai:1,blogspot:1,integr:1,contain:1,typset:1,end1:1,frame:1,"_doconce_debug":1,incoveni:1,pngmath:1,correctli:1,boundari:1,written:1,hyperbaseurl:1,neither:1,email:1,kei:1,job:1,entir:1,exclam:1,embed:1,addit:1,hyperref:1,nabla:1,equal:1,thereaft:1,etc:1,eta:1,html_slide_them:1,html5:[0,1],comment:[0,1],cxx:1,guidelin:1,distinguish:1,respect:1,ifthen:1,x_y:1,quit:1,mjpegtool:1,blueish2:1,m2html:1,json:1,treat:1,curli:1,both:1,split_:1,bremark:1,media9:1,togeth:1,graphicx:1,present:1,multi:1,vimeo:1,align:1,defin:[0,1],customiz:1,almost:1,demo:[0,1],texttt:1,site:1,change_encod:1,simulate_and_plot:1,revis:1,scienc:1,satisfi:1,cross:[0,1],handl:1,html_pyramid:1,template_vagr:1,mydoc:1,inc:1,difficult:1,http:1,ref1:1,expans:1,ref3:1,ref2:1,ref5:1,effect:1,a4pap:1,redcloud:1,logfil:1,php:1,expand:1,off:1,center:1,openofficeword:1,nevertheless:1,well:1,difflib:1,autoplai:1,exampl:[0,1],command:1,english:1,undefin:1,usual:1,distanc:1,less:1,obtain:1,tcl:1,fenic:1,web:1,makefil:[0,1],add:1,other:[0,1],bibliographi:[0,1],match:1,dextra_sect:1,css3:1,rememb:1,hpl:1,piec:[0,1],realiz:1,know:1,tick:1,testm:1,insert:1,resid:1,like:1,success:1,unord:1,necessari:1,dlatex_head:1,page:[0,1],"11px":1,underscror:1,captur:1,suppli:1,python_anst:1,scipy_lectur:1,latex_print:1,proper:1,guarante:1,tmp:1,lead:1,avoid:1,yellowbox:1,leav:1,newfil:1,speak:1,mathmpl:1,investig:1,journal:1,usag:1,host:1,encourav:1,although:1,simpler:1,about:1,actual:1,rst2:1,linenumb:1,powerpoint:1,own:1,amsmath:1,automat:1,bsol:1,merg:1,citat:1,pictur:1,trigger:1,"var":1,"function":[0,1],multigrid:1,unexpect:1,ean:1,overflow:1,inlin:[0,1],bug:1,count:1,made:1,wise:1,wish:1,googlecod:1,displai:1,troubl:1,below:1,limit:1,otherwis:1,problem:[0,1],"int":1,dure:1,tmp_preprocess__filenam:1,enotic:1,novemb:1,implement:1,pip:1,sphinxjp:1,probabl:1,detail:1,book:1,bool:1,table_x:1,branch:1,varieti:1,fontspec:1,repeat:1,shown:1,no_mako:1,debian:[0,1],sphinx:[0,1],eof:1,scientif:1,rule:1,portion:1,openoffic:1,f77:1},objtypes:{},titles:["Doconce
Manual","Doconce
Description"],objnames:{},filenames:["index","manual"]})
+Search.setIndex({objects:{},terms:{mydoc2:1,linebreak:1,yellow:1,four:1,fig2:1,fig3:1,fig1:1,consider:1,spellcheck:1,ecollin:1,usepackag:1,matlab:1,under:1,preprocess:[0,1],yourdoc:1,everi:1,wrapper_tech:1,"void":1,rise:1,theorem_count:1,affect:1,pygments_html_lineno:1,disturb:1,upload:1,vector:1,math:1,darkgrai:1,relsiz:1,dirnam:1,direct:1,consequ:1,second:1,esol:1,blue:1,mpeg:1,extra_sect:1,"new":1,net:1,never:1,here:1,"const":1,python_an:1,interpret:1,forum:1,ptex2tex:1,precis:1,loop:1,studi:1,brought:1,unix:1,org:1,outro:1,txt:1,shcod:1,describ:1,would:1,includemovi:1,doconc:[0,1],call:1,typo:1,recommend:1,calc:1,type:1,pdfcrop:1,relat:1,footerbgcolor:1,notic:1,warn:1,mwk:1,rootdir:1,si2uchh3qim:1,automake_sphinx:1,must:1,springer:1,word:1,player:1,setup:1,work:1,split_rst:1,root:1,overrid:1,give:1,da6pap:1,somefil:1,caution:1,want:1,ddevic:1,attract:1,end:1,quot:1,ordinari:1,vagrant:1,how:1,answer:1,perspect:1,updat:1,recogn:1,after:1,befor:1,wrong:1,demonstr:1,basicstrap:1,attempt:1,pdfnup:1,bootstrap:1,mwiki:1,neglect:1,myeq1:1,maintain:1,environ:[0,1],eblock:1,enter:1,order:1,srclib:1,deck:1,over:1,becaus:1,jpeg:1,keyboard:1,flexibl:1,vari:1,myfil:1,fit:1,setspac:1,better:1,offic:1,fig:1,comprehens:1,html_style:1,easier:1,miiton:1,them:1,var1:1,thei:1,safe:1,"break":1,yourself:1,choic:1,sphinxext:1,each:1,debug:[0,1],side:1,mean:1,pdflatex:[0,1],laboratori:1,logg:1,extract:1,goe:1,content:[0,1],rewrit:1,fairli:1,sphinx_dir:1,reader:1,forth:1,linear:1,navig:1,situat:1,standard:1,acrobat:1,reformul:1,bwarn:1,argument:[0,1],filter:1,iso:1,examples_as_exercis:1,onto:1,no_pygments_html:1,"__theorem":1,rang:1,html_theme_opt:1,render:1,independ:1,biomed:1,restrict:1,instruct:1,alreadi:1,"__abstract":1,primari:1,top:1,sometim:1,mercuri:1,underlin:1,master:1,too:1,similarli:1,toc:1,consol:1,tool:1,xkeyval:1,somewhat:1,knob:1,simula:1,solvin:1,charcter:1,past:1,mydoc_solar:1,keyword:1,provid:1,tree:1,usepack:1,project:[0,1],doonc:1,"5mm":1,admonit:[0,1],fashion:1,dvar1:1,modern:1,raw:1,pylon:1,seen:1,mint:1,minu:1,minted_cpp:1,latter:1,even:1,though:1,pdiff:1,ebook:1,regular:1,letter:1,choos:1,style_vagr:1,tradit:1,don:1,doc:1,flow:1,doe:1,dummi:1,abbrev:1,declar:1,unchang:1,winther:1,random:1,pygments_html_styl:1,syntax:1,mediawiki:1,indentend:1,theme_dir:1,involv:1,layout:1,explain:1,configur:1,theme:1,rich:1,shoutwiki:1,agni:1,watch:1,fluid:1,encourg:1,cloud_spthem:1,makeindex:1,report:1,keyword2:1,keyword1:1,youtub:1,briefer:1,emb:1,"public":1,ban:1,respond:1,kolmogorov:1,pdftool:1,result:1,fail:1,best:1,awar:1,databas:1,wikipedia:1,figur:[0,1],simplest:1,awai:1,approach:1,accord:1,slides_beam:1,extend:1,extens:1,lazi:1,preprocessor:1,extent:1,toler:1,han:1,howev:1,subitem:1,cod:1,docbook:1,seri:1,com:1,mardal:1,dbook:1,height:1,stylefil:1,documentstyl:1,path:1,diff:1,guid:1,assum:1,summar:1,duplic:1,union:1,numpi:1,three:1,been:1,much:1,sphinxdir:1,basic:[0,1],futur:1,quickli:1,life:1,deeper:1,spit:1,xxy:1,xxx:1,anywher:1,els:1,emploi:1,ugli:1,ident:1,subentri:1,gnu:1,servic:1,properti:1,sourceforg:1,aim:1,dept:1,aid:1,anchor:1,pyramid:1,coher:1,conv:1,a6pap:1,conf:1,sever:1,mako:[0,1],disabl:1,perform:1,suggest:1,make:1,complex:1,split:[0,1],texinfo:1,complet:1,a2p:1,slides_html:1,mytext:1,hand:1,bibliograph:1,norwegian:1,pngmath_dvipng_arg:1,tune:1,moondist:1,redefin:1,kept:1,undesir:1,thi:1,endif:1,everyth:1,giftran:1,left:1,identifi:1,just:1,mydoc_bloodish:1,rst2odt:1,xelatex:[0,1],human:1,ifdef:1,kdiff3:1,yet:1,languag:[0,1],easi:1,mix:1,interfer:1,fortran:1,cp2texmf:1,save:1,explanatori:1,gave:1,mayb:1,boldfac:1,fromto:1,background:1,shadow:1,wrapfig:1,measur:1,table4:1,specif:1,arbitrari:1,manual:[0,1],docutil:1,www:1,right:1,old:1,intern:1,toctre:1,successfulli:1,total:1,collect:1,univ:1,core:1,plu:1,bold:1,fancyvrb:1,repositori:1,post:[0,1],chapter:1,slightli:1,surround:1,unfortun:1,algn:1,"__proof":1,produc:1,ppa:1,basenam:1,"float":1,encod:1,fancybox:1,down:1,wrap:1,accordingli:1,git:1,perldoc:1,suffici:1,support:1,transform:1,why:1,avail:1,width:1,wordpress:1,editor:1,fraction:1,analysi:1,head:1,satisfactorili:1,form:1,offer:1,solar:1,"true":1,rerun:1,featur:[0,1],classic:1,request:1,"abstract":1,ephas:1,postscript:1,exist:1,check:1,assembl:1,somenam:1,tkdiff:1,eremark:1,when:1,test:1,diffpack:1,matur:1,notif:1,intend:1,asterisk:1,consid:1,occasion:1,stoke:1,bitbucket:1,longer:1,bullet:1,phone:1,ignor:1,maxdepth:1,time:1,beamer:[0,1],nxn:1,concept:1,row:1,middl:1,depend:[0,1],unnumb:1,flask:1,texmf:1,proj:1,sourc:[0,1],xpro:1,brows:1,seemingli:1,baselinestretch:1,level:1,did:1,relbarbgcolor:1,iter:1,item:1,preprocesor:1,combine_imag:1,team:1,quick:[0,1],sidebarlinkcolor:1,round:1,dir:1,sign:1,filestem:1,dmath:1,appear:1,anywai:1,current:1,rst2xml:1,mydoc_vagr:1,meld:1,xml:1,autogener:1,gener:[0,1],disclaim:[0,1],modif:1,address:1,locat:1,along:1,box:1,shift:1,trial:1,behav:1,myvar:1,slidecel:1,extra:1,tweak:[0,1],modul:[0,1],ipi:1,prefer:1,backtick:1,visibl:1,instal:[0,1],should:1,regex:1,dvipdf:1,univers:1,helvetica:1,todai:1,subvers:1,stylesheet:1,criteria:1,checkout:1,share:1,newcommand:[0,1],visual:1,appendix:1,indic:[0,1],examin:1,easiest:1,dhelvetica:1,slogan:1,uniqu:1,impel:1,can:1,cal:1,purpos:1,ehint:1,claim:1,encapsul:1,bloodish:1,backslash:1,topic:1,abort:1,occur:1,alwai:1,differenti:1,multipl:1,oslo:1,no_abort:1,write:[0,1],pure:1,tile:1,ispel:1,map:1,clone:1,codetermin:1,mac:1,mai:1,underscor:1,data:1,man:1,mdframe:1,favorit:1,inform:1,"switch":1,cannot:1,combin:1,ssh:1,epydoc:1,boldface_:1,"_part0000_mydoc":1,equip:1,still:1,mainli:1,entiti:1,group:1,passag:1,platform:1,window:1,doconce_head:1,main:1,non:1,recal:1,matcher:1,initi:1,half:1,now:1,discuss:1,nor:1,name:1,config:1,separ:1,mydoc_html_file_collect:1,admon:1,compil:1,f2f2f2:1,replac:1,individu:1,continu:1,backport:1,year:1,happen:1,reportlab:1,space:1,bnotic:1,formula:1,md2html:1,correct:1,headlin:1,fontsiz:1,mako_strict_undefin:1,institut:1,care:1,"__a":1,wai:1,modest:1,thing:1,place:1,view:1,nicknam:1,imposs:1,frequent:1,first:1,origin:1,directli:1,carri:1,onc:1,arrai:1,bluish:1,lsb_releas:1,fast:1,open:1,predefin:1,size:1,given:1,xunicod:1,sheet:1,convent:1,gif:1,white:1,conveni:1,cite:1,forthcom:1,especi:1,copi:[0,1],bsubex:1,specifi:1,"short":1,enclos:1,than:1,png:1,wide:1,instanc:1,posit:1,zsh:1,browser:1,pre:1,unoconv:1,sai:1,nicer:1,pro:1,svnroot:1,ani:1,dash:1,zumbusch:1,mislead:1,engin:1,squar:1,destroi:1,moreov:1,note:[0,1],myeq2:1,take:1,includegraph:1,begin:1,sure:1,normal:1,track:1,fix_bibtex4publish:1,pair:1,icon:1,latex:[0,1],renam:1,later:1,typeset:[0,1],preambl:1,main_myproj:1,viscou:1,show:1,scitool:1,bright:1,corner:1,unfinish:1,slot:1,onli:1,activ:1,analyz:1,microtyp:1,overwritten:1,variou:1,get:1,xcod:1,tailor:1,springer_collect:1,requir:1,reveal:1,tikz:1,cppcod:1,seldom:1,rst2pdf:1,paper:1,next1:1,where:1,summari:1,wiki:[0,1],"_sever":1,detect:1,xetex:1,label:1,enough:1,between:1,"import":1,inputenc:1,parent:1,screen:1,come:1,tug:1,img:1,tutori:1,mani:1,fix:1,among:1,acceler:1,color:1,overview:[0,1],inspir:1,period:1,pop:1,colon:1,typic:1,ultim:1,segfault:1,mark:1,structuredtext:1,encapusl:1,emphas:1,resolut:1,f90:1,f95:1,impati:1,former:1,those:1,"case":1,thesi:1,invok:1,advantag:1,ctrl:1,henc:1,destin:1,eras:1,ascii:[0,1],pdftk:1,develop:1,author:1,media:1,same:1,html:[0,1],document:[0,1],equat:1,ifram:1,nest:1,assist:1,extern:1,mycount:1,appropri:1,inconsist:1,macro:[0,1],markup:[0,1],ccq:1,sreen:1,without:1,kaar:1,venu:1,execut:1,documentclass:1,rest:[0,1],without_solut:1,flavor:1,hint:1,except:1,littl:1,blog:[0,1],framebord:1,treatment:1,exercis:[0,1],real:1,around:1,read:1,swig:1,nonnest:1,dark:1,grid:1,envir:1,world:1,mydict:1,whitespac:1,cdot:1,inted:1,integ:1,either:1,"_static":1,output:[0,1],fulfil:1,thpack:1,palatino:1,shadowbox:1,constitut:1,definit:1,legal:1,moon:1,subproblem:1,exit:1,refer:[0,1],power:1,inspect:1,tables2csv:1,fulli:1,regexp:1,src:1,split_html:1,stand:1,act:1,mytempl:1,dtodonot:1,myroutin:1,fundamental1:1,terminolog:1,pagebreak:1,yyi:1,your:1,wikibook:1,log:1,her:1,area:1,haskel:1,start:1,lot:1,strictli:1,verb:1,verbatim:[0,1],bundl:1,jul:1,streamtub:1,diffus:1,blueish:1,untag:1,pull:1,possibl:1,"default":1,plaympeg:1,creol:1,externaldocu:1,xcolor:1,creat:1,certain:1,strongli:1,intro:1,decreas:1,file:[0,1],again:1,googl:1,valid:1,you:1,condens:1,sequenc:1,symbol:1,langtangen_et_al_2002:1,sidebartextcolor:1,includemedia:1,exerinfo:1,tmp_mako__filenam:1,unbalanc:1,backward:1,directori:1,descript:[0,1],lbrack:1,potenti:1,cpp:1,escap:1,my_adapted_vagrant_templ:1,all:1,forget:1,illustr:1,dollar:1,"___sec2":1,follow:1,alt:1,external_movie_view:1,iconv:1,articl:1,program:[0,1],introduc:1,straightforward:1,fals:1,helvet:1,util:1,"1px":1,movie_control:1,mechan:1,texconv:1,veri:1,strang:1,unalt:1,nileshbans:1,list:[0,1],adjust:1,plain:[0,1],small:1,dxelatex:1,tex:[0,1],design:1,pass:1,further:1,what:[0,1],sub:1,section:1,netpbm:1,delet:1,version:1,method:1,full:1,hash:1,verbatim_text:1,misspel:1,sophist:1,behaviour:1,trunk:1,strong:1,modifi:1,valu:[0,1],search:[0,1],newlin:1,prior:1,amount:1,pick:1,action:1,narrow:1,via:1,depart:1,rightsidebar:1,filenam:1,href:1,html_theme:1,proceed:1,two:1,formul:1,taken:1,more:1,diamond:1,desir:1,ital:1,dnote:1,flag:1,stick:1,particular:1,known:1,shkumagai:1,none:1,valuabl:1,outlin:1,histori:1,paragraph:1,learn:1,rst2html:1,def:1,uncom:1,inline_tag_begin:1,dexternal_movie_view:1,accept:1,phrase:1,string:1,cours:1,csh:1,divid:1,rather:1,anoth:1,spreadsheet:1,snippet:1,csv:1,simpl:1,css:1,agogo:1,resourc:1,referenc:[0,1],variant:1,"_text":1,fignam:1,wave:1,associ:1,github:1,md2latex:1,footer:[0,1],confus:1,caus:1,testdoc:1,egg:1,help:1,devhelp:1,soon:1,scientist:1,through:1,myarr:1,paramet:1,style:1,roemer:1,ptext2tex:1,amsfont:1,gwiki:[0,1],might:1,fool:1,recip:1,good:1,"return":[0,1],sentenc:1,sphinxfix_localurl:1,petter:1,parenthesi:1,epsfig:1,troubleshoot:[0,1],easili:1,achiev:1,fpro:1,found:1,dir2:1,dir1:1,maketitl:1,sidebarbgcolor:1,hard:1,idea:[0,1],procedur:1,realli:1,heavi:1,beyond:1,"_part":1,publish:1,research:1,footnot:1,lineno:1,print:1,subsubsect:1,my_fil:1,advanc:1,pub:1,effect:1,reason:1,base:1,put:1,teach:1,bash:1,launch:1,veloc:1,omit:1,dpalatino:1,caption:1,perhap:1,fcod:1,ubuntuforum:1,major:1,feel:1,famou:1,misc:1,number:1,unovonv:1,smaller:[0,1],done:1,construct:1,blank:1,miss:[0,1],fanci:1,differ:[0,1],pandoc:[0,1],without_answ:1,cpp_an:1,interact:1,least:1,latexdiff:1,statement:1,cfg:1,illeg:1,scheme:1,evinc:1,option:1,part:1,pars:[0,1],myclass:1,kind:1,ffmpeg:1,whenev:1,remov:[0,1],bibliographystyl:1,horizont:1,reus:1,store:1,sty:1,cleaner:1,comput:[0,1],packag:1,anslist:1,built:1,self:1,also:1,institution2:1,institution3:1,institution1:1,distribut:1,csv2tabl:1,previou:1,reach:1,most:1,plai:1,exer:1,destruct:1,ext:1,clean:1,microsoft:1,think:1,sublist:1,diffpdf:1,session:1,particularli:1,font:1,fine:1,find:1,auctex:1,impact:1,mwlib:1,mjolnir:1,writer:1,solut:1,templat:1,smtplib:1,remedi:1,express:1,nativ:1,libreoffic:1,target:1,eq1:1,common:1,set:1,dump:1,creator:1,see:1,sed:1,close:1,someth:1,mybibtexfil:1,no_preprocess:1,subdir:1,experi:1,birkenfeld:1,altern:1,impressj:1,imagemagick:1,numer:1,javascript:1,subexercis:1,ipython:1,water:1,last:1,delimit:1,hyperlink:1,alon:1,"_part0001_mydoc":1,context:1,forgotten:1,pdf:1,whole:1,load:1,markdown:[0,1],simpli:1,point:1,header:[0,1],pycod:1,linux:1,mistak:1,throughout:1,becom:1,java:1,devic:1,due:1,empti:1,newcommands_replac:1,eart2moon_sol:1,strategi:1,invis:1,imag:1,remark:1,epytext:1,understand:1,demand:1,look:1,bluish2:1,formatt:[0,1],"while":1,smart:1,abov:1,error:1,subsitut:1,vlinux:1,pack:1,subsect:1,propag:1,html_admon:1,readi:1,itself:1,rid:1,minim:1,shorter:1,archiv:1,myslid:1,esubex:1,alert:1,user:1,cwiki:1,recent:1,lower:1,task:1,entri:1,elev:1,propos:1,explan:1,pygments_html:1,langtangen:1,restructuredtext:[0,1],shortcut:1,informat:1,theorem:[0,1],input:1,subroutin:1,format:[0,1],big:1,bib:1,backquot:1,table2:1,table3:1,semi:1,brace:1,xxdiff:1,resolv:1,"_part0002_mydoc":1,popular:1,ignorn:1,encount:1,sketch:1,often:1,simplifi:1,creation:1,some:1,back:1,understood:1,montag:1,per:1,substitut:1,mathemat:[0,1],larg:1,retro:1,prog:1,object:1,run:1,newcommand_replac:1,step:[0,1],qthelp:1,idx:1,materi:1,idl:1,allowfullscreen:1,langtangen_2003a:1,block:[0,1],file3:1,file2:1,file1:1,doubl:1,emphasi:1,file4:1,within:1,ensur:1,perl:1,occupi:1,inclus:1,mkd:1,span:1,question:1,nosidebar:1,textual:1,custom:1,guess_encod:1,subst:1,includ:1,suit:1,myfunc:1,properli:1,link:1,translat:1,newer:1,delta:1,line:[0,1],listtyp:1,concaten:1,latex_preambl:1,utf:1,consist:1,inline_tag:1,apricot:1,access:1,someus:1,"export":1,similar:1,knob_left:1,repres:1,incomplet:1,home:1,curl:1,titl:1,invalid:1,bibfil:1,bracket:1,prev1:1,newcommands_keep:1,nice:1,mathpazo:1,colored_table_row:1,svn:1,rst2latex:1,bsummari:1,depth:1,far:1,code:[0,1],partial:1,totem:1,rtf:1,html_output:1,makeidx:1,refs3:1,refs2:1,refs1:1,compact:1,cython:1,showthread:1,elsewher:1,send:1,becam:1,aris:1,fenics_minim:1,docoment:1,titlepag:1,makotempl:1,volum:1,untouch:1,relev:1,tri:1,"20435c":1,button:1,ryan:1,"try":1,impli:1,exted:1,fortun:1,natur:1,cfd:1,odt:1,jump:1,video:1,haiku:1,download:1,click:1,index:[0,1],femdeq:1,compar:1,resembl:1,multimedia:1,cell:1,experiment:1,remove_inline_com:1,mathjax:1,tveito:1,deduc:1,whatev:1,vibrat:1,bibitem:1,matplotlib:1,html_fenic:1,bodi:1,let:1,dmovie15:1,ubuntu:[0,1],vertic:1,sinc:1,convert:1,convers:1,larger:1,chang:1,problemat:1,chanc:1,firefox:1,appli:1,colors1:1,apt:1,cloud:1,from:[0,1],tmp_missing_:1,live:1,mydir:1,next:1,websit:1,few:1,postprocess:1,sort:1,slim:1,comparison:1,trail:1,langtangen_pedersen_2002:1,retriev:1,annoi:1,linenumb:1,obvious:1,meet:1,proof:1,control:1,quickstart:1,process:1,sudo:1,blue_section_head:1,tag:[0,1],doconce_install_al:1,tarbal:1,surfac:1,subdirectori:1,instead:1,sin:1,yellowish:1,frac:1,stop:1,mypack:1,earth2moon:1,exemplifi:1,keep_pygments_html_bg:1,colors2:1,essenti:1,light:1,counter:1,correspond:1,element:1,issu:1,epstopdf:1,allow:1,dmint:1,elif:1,movi:[0,1],move:1,comma:1,libav:1,myprog:1,outer:1,latex_head:1,chosen:1,clickabl:1,therefor:1,docx:1,crash:1,python:1,handi:1,dat:1,mention:1,textopc:1,somewher:1,inline_tag_end:1,edit:1,wdiff:1,slide:[0,1],mode:1,mystyl:1,"10pt":1,pygment:1,subset:1,intellig:1,meta:1,subsec:1,our:1,special:[0,1],out:1,variabl:[0,1],matrix:1,esummari:1,texliv:1,suitabl:1,rel:1,ref:1,red:1,statist:1,insid:1,manipul:1,standalon:1,dictionari:1,pedersen:1,indent:1,could:1,ask:1,movie15:1,keep:1,length:1,outsid:1,navier:1,geometri:1,cyberspac:1,softwar:1,manuscript:1,blogger:1,rbrack:1,texshop:1,date:1,"long":1,mkdir:1,system:1,messag:1,termin:1,siam:1,"final":1,shell:1,bhint:1,bblock:1,cyb:1,rst:1,newtheorem:1,exactli:1,myfram:1,structur:1,charact:1,sens:1,steer:1,viewer:1,explicit:1,have:1,tabl:[0,1],need:1,turn:1,border:1,sandbox:1,minted_python:1,preced:1,which:1,divers:1,singl:1,unless:1,preliminari:1,who:1,ooxml:1,awl:1,mplayer:1,twitter_bootstrap:1,segment:1,"class":1,epub:1,"_build":1,todonot:1,latin1:1,url:1,hardcod:1,face:1,pipe:1,bibtex:1,determin:1,ubuntu_vers:1,superscript:1,fact:1,smpeg:1,text:[0,1],skip_inline_com:1,knob_forward:1,blognam:1,graybox1:1,graybox2:1,graybox3:1,thicker:1,emac:[0,1],titlesec:1,html_templat:1,dispers:1,jal:1,"_mydoc":1,suppos:1,conclus:1,local:1,ksh:1,meant:1,mythem:1,contribut:1,familiar:1,autom:1,pressbook:1,enabl:1,bisect:1,theorem_fundamental1:1,ewarn:1,grai:1,blogspot:1,integr:1,contain:1,typset:1,end1:1,frame:1,"_doconce_debug":1,incoveni:1,pngmath:1,correctli:1,boundari:1,written:1,hyperbaseurl:1,neither:1,email:1,kei:1,job:1,entir:1,exclam:1,embed:1,incompress:1,addit:1,hyperref:1,nabla:1,equal:1,thereaft:1,etc:1,eta:1,html_slide_them:1,html5:[0,1],comment:[0,1],cxx:1,guidelin:1,distinguish:1,respect:1,ifthen:1,x_y:1,quit:1,mjpegtool:1,blueish2:1,m2html:1,json:1,treat:1,curli:1,both:1,split_:1,bremark:1,media9:1,togeth:1,graphicx:1,present:1,multi:1,vimeo:1,align:1,defin:[0,1],customiz:1,almost:1,demo:[0,1],texttt:1,site:1,change_encod:1,simulate_and_plot:1,revis:1,scienc:1,satisfi:1,cross:[0,1],handl:1,html_pyramid:1,template_vagr:1,mydoc:1,inc:1,difficult:1,http:1,ref1:1,expans:1,ref3:1,ref2:1,ref5:1,ref4:1,a4pap:1,redcloud:1,logfil:1,php:1,expand:1,off:1,center:1,openofficeword:1,nevertheless:1,well:1,difflib:1,autoplai:1,exampl:[0,1],command:1,english:1,undefin:1,usual:1,distanc:1,less:1,obtain:1,tcl:1,fenic:1,web:1,makefil:[0,1],script:1,add:1,other:[0,1],bibliographi:[0,1],match:1,dextra_sect:1,css3:1,rememb:1,hpl:1,piec:[0,1],realiz:1,know:1,denser:1,tick:1,testm:1,insert:1,resid:1,like:1,success:1,unord:1,necessari:1,dlatex_head:1,page:[0,1],"11px":1,underscror:1,captur:1,suppli:1,python_anst:1,scipy_lectur:1,proper:1,guarante:1,tmp:1,lead:1,avoid:1,yellowbox:1,leav:1,newfil:1,speak:1,mathmpl:1,investig:1,journal:1,usag:1,host:1,encourav:1,although:1,simpler:1,about:1,actual:1,rst2:1,column:1,powerpoint:1,own:1,amsmath:1,automat:1,bsol:1,merg:1,citat:1,pictur:1,trigger:1,"var":1,"function":[0,1],multigrid:1,unexpect:1,ean:1,overflow:1,inlin:[0,1],bug:1,count:1,made:1,wise:1,wish:1,googlecod:1,displai:1,troubl:1,below:1,limit:1,otherwis:1,problem:[0,1],"int":1,dure:1,tmp_preprocess__filenam:1,enotic:1,novemb:1,implement:1,pip:1,sphinxjp:1,probabl:1,detail:1,book:1,bool:1,table_x:1,branch:1,varieti:1,fontspec:1,repeat:1,shown:1,basename_html_file_collect:1,no_mako:1,debian:[0,1],sphinx:[0,1],eof:1,scientif:1,rule:1,portion:1,openoffic:1,f77:1},objtypes:{},titles:["Doconce
Manual","Doconce
Description"],objnames:{},filenames:["index","manual"]})
=======================================
--- /doc/demos/manual/manual.cwiki Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.cwiki Sat Jul 13 00:16:44 2013
@@ -1,7 +1,7 @@
#summary Doconce Description
<wiki:toc max_depth="2" />
By **Hans Petter Langtangen**
-=== Jun 28, 2013 ===
+=== Jul 13, 2013 ===

<wiki:comment> lines beginning with # are doconce comment lines
</wiki:comment>
<wiki:comment> (documents can also have mako comment lines) </wiki:comment>
@@ -605,6 +605,8 @@

== HTML ==

+=== Basics ===
+
Making an HTML version of a Doconce file {{{mydoc.do.txt}}}
is performed by
{{{
@@ -612,6 +614,21 @@
}}}
The resulting file {{{mydoc.html}}} can be loaded into any web browser for
viewing.

+=== Typesetting of Code ===
+
+If the Pygments package (including the {{{pygmentize}}} program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument {{{--no_pygments_html}}}
+turns off the use of Pygments and makes code blocks appear with
+plain ({{{pre}}}) HTML tags. The option {{{--pygments_html_linenos}}} turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by {{{--pygments_html_style=style}}}, where
{{{style}}}
+can be {{{default}}}, {{{emacs}}}, {{{perldoc}}}, and other valid names for
+Pygments styles.
+
+
+=== HTML Styles ===
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -631,22 +648,14 @@
links to the CSS stylesheet in {{{filename}}}. Several stylesheets can
be specified: {{{--ccs=file1.css,file2.css,file3.css}}}.

+=== HTML templates ===
+
Templates are HTML files with "slots" {{{%(main)s}}} for the main body
of text, {{{%(title)s}}} for the title, and {{{%(date)s}}} for the date.
Doconce comes with a few templates. The usage of templates is
described in a
[[https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html|separate
document]]. That document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the {{{pygmentize}}} program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument {{{--no_pygments_html}}}
-turns off the use of Pygments and makes code blocks appear with
-plain ({{{pre}}}) HTML tags. The option {{{--pygments_html_linenos}}} turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by {{{--pygments_html_style=style}}}, where
{{{style}}}
-can be {{{default}}}, {{{emacs}}}, {{{perldoc}}}, and other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": "
[[https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html]]" on this
topic. The template file must contain
valid HTML code and can have three "slots": {{{%(title)s}}} for a title,
@@ -670,6 +679,36 @@
that are used if the document contains {{{!split}}} commands for splitting
it into many pages.

+=== The HTML File Collection ===
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+{{{.basename_html_file_collection}}}, where {{{basename}}} is the filestem
of
+the Doconce file (i.e., the Doconce source is in {{{basename.do.txt}}}).
+
+=== Filenames ===
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the {{{--html_output=basename}}} option, where {{{basename}}} is
the
+filestem of the associated HTML files. The
+{{{.basename_html_file_collection}}} file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: {{{mydoc_bloodish.html}}}, {{{mydoc_solarized}}}, and
+{{{mydoc_vagrant}}}.
+
+{{{
+Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+Terminal> doconce split_html mydoc_bloodish.html
+Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant --pygments_html_style=default \
+ --html_template=templates/my_adapted_vagrant_template.html
+Terminal> doconce split_html mydoc_vagrant.html
+}}}

== Blog Posts ==

@@ -803,9 +842,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option {{{--latex_printed}}} makes some adjustments for documents
+An option {{{-DDEVICE=paper}}} makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, {{{-DDEVICE=screen}}}, creates a PDF file for reading
+on a screen where links are clickable.

//Step 2.// Run {{{ptex2tex}}} (if you have it) to make a standard LaTeX
file,
{{{
@@ -840,11 +881,11 @@
* {{{A4PAPER}}} for A4 paper size
* {{{A6PAPER}}} for A6 paper size (suitable for reading PDFs on phones)
* {{{MOVIE}}} for specifying how movies are handled: the value
{{{media9}}} implies the {{{media9}}} package and the {{{\includemedia}}}
command (default), while other values are {{{movie15}}}
({{{\includemovie}}} command), {{{multimedia}}} (for Beamer-style
{{{\movie}}} command), or {{{href-run}}} (for the plain {{{\hrun:file}}}
command)
+ * {{{MOVIE_CONTROLS}}} adds buttons for starting/stopping movies if the
{{{media9}}} package is used.
* {{{PREAMBLE}}} to turn the LaTeX preamble on or off (i.e., complete
document or document to be included elsewhere - and note that the
preamble is only included if the document has a title, author, and date)
* {{{MINTED}}} for inclusion of the minted package for typesetting of
code with the Pygments tool (which requires {{{latex}}} or {{{pdflatex}}}
to be run with the {{{-shell-escape}}} option)
* {{{TODONOTES}}} for using the fancy {{{todonotes}}} package for
typesetting inline comments (looks much like track changes in MS Word).
This macro has only effect if inline comments are used (name, colon,
and comment inside brackets).
* {{{LINENUMBERS}}} for inclusion of line numbers in the text.
- * {{{AMON}}} for setting the type of admonitions: {{{"colors"}}} for
colored boxes with icons, {{{"graybox1"}}} for gray frame boxes with
rounded corners (default), {{{"graybox2"}}} for narrower square gray
frame boxes (except for summary, which for A4 format is small and with
wrapped text around if it does not contain verbatim code), or
{{{"paragraph"}}} for simple, plain paragraph headings and ordinary text
* {{{COLORED_TABLE_ROWS}}} for coloring every other table rows (set
this variable to {{{gray}}} or {{{blue}}})
* {{{BLUE_SECTION_HEADINGS}}} for blue section and subsection headings
* {{{LATEX_HEADING}}} for the typesetting of the title, author, parts
of preamble (values: {{{traditional}}} for traditional LaTeX heading,
{{{titlepage}}} for a separate titlepage, {{{Springer_collection}}} for
edited volumes on Springer, {{{beamer}}} for Beamer slides,
{{{doconce_heading}}} (default) for listing institutions after names)
@@ -881,9 +922,17 @@
begin and end for blocks inside {{{!bc fpro}}} and {{{!ec}}}). Specifying
{{{envir=ans:nt}}} means that all other environments are typeset with the
{{{anslistings.sty}}} package, e.g., {{{!bc cppcod}}} will then result in
-{{{\begin{c++}}}}. If no environments like {{{sys}}}, {{{fpro}}}, or the
common
-{{{envir}}} are defined on the command line, the plain
{{{\begin{verbatim}}}}
-and {{{\end{verbatim}}}} used.
+{{{\begin{c++}}}}. A predefined shortcut as in {{{shcod=Verbatim-0.85}}}
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+{{{shcod=Verbatim-indent}}} implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+{{{\begin{Verbatim}}}} instruction using the syntax illustrated for
+the {{{sys}}} environments above.
+
+If no environments like {{{sys}}}, {{{fpro}}}, or the common
+{{{envir}}} are defined on the command line, the plain
{{{\begin{Verbatim}}}}
+and {{{\end{Verbatim}}}} instructions are used.


//Step 2b (optional).// Edit the {{{mydoc.tex}}} file to your needs.
@@ -1486,6 +1535,7 @@


Here are some examples:
+
{{{
__Abstract.__ The following text just attempts to exemplify
various section headings.
@@ -1494,11 +1544,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1525,7 +1570,7 @@

Figures are recognized by the special line syntax
{{{
-FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+FIGURE:[filename, height=400 width=600 frac=0.8] caption

}}}
The filename can be without extension, and Doconce will search for an
@@ -1534,10 +1579,21 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's {{{convert}}} utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats {{{html}}}, {{{rst}}}, {{{sphinx}}},
while
+the frac specification is used for {{{latex}}} and {{{pdflatex}}} to
specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+//Warning.//
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for {{{TITLE:}}} and {{{AUTHOR:}}} lines, all
information
related to a figure line //must be written on the same line//. Introducing
@@ -1616,12 +1672,16 @@
{{{
MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
}}}
Note that there must be a blank line after every {{{MOVIE:}}} command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

+ [[http://www.youtube.com/watch?v=sI2uCHH3qIM]]
+
+ CFD. [[http://vimeo.com/55562330]]
+
== Copying Computer Code from Source Files ==

Another type of special lines starts with {{{@@@CODE}}} and enables copying
=======================================
--- /doc/demos/manual/manual.do.txt Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.do.txt Sat Jul 13 00:16:44 2013
@@ -57,7 +57,7 @@

# Example on including another Doconce file:

-# #include "../tutorial/_doconce2anything.do.txt"
+# #include "../tutorial/doconce2anything.do.txt"



@@ -245,6 +245,7 @@


Here are some examples:
+
!bc
__Abstract.__ The following text just attempts to exemplify
various section headings.
@@ -253,11 +254,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -284,7 +280,7 @@

Figures are recognized by the special line syntax
!bc
-FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+FIGURE:[filename, height=400 width=600 frac=0.8] caption

!ec
The filename can be without extension, and Doconce will search for an
@@ -293,16 +289,28 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's `convert` utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats `html`, `rst`, `sphinx`, while
+the frac specification is used for `latex` and `pdflatex` to specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+!bwarning
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for `TITLE:` and `AUTHOR:` lines, all information
related to a figure line *must be written on the same line*. Introducing
newlines in a long caption will destroy the formatting (only the
part of the caption appearing on the same line as `FIGURE:` will be
included in the formatted caption).
+!ewarning

FIGURE:[figs/streamtubes, width=400] Streamtube visualization of a fluid
flow. label{fig:viz}

@@ -374,12 +382,16 @@
!bc
MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
!ec
Note that there must be a blank line after every `MOVIE:` command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

+MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]
+
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
+
===== Copying Computer Code from Source Files =====

Another type of special lines starts with `@@@CODE` and enables copying
=======================================
--- /doc/demos/manual/manual.epytext Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.epytext Sat Jul 13 00:16:44 2013
@@ -1,6 +1,6 @@
TITLE: Doconce Description
BY: Hans Petter Langtangen (Center for Biomedical Computing, Simula
Research Laboratory, and Department of Informatics, University of Oslo)
-DATE: Jun 28, 2013
+DATE: Jul 13, 2013
What Is Doconce?
================

@@ -645,6 +645,9 @@
HTML
----

+Basics
+~~~~~~
+
Making an HTML version of a Doconce file C{mydoc.do.txt}
is performed by::

@@ -653,6 +656,23 @@

The resulting file C{mydoc.html} can be loaded into any web browser for
viewing.

+Typesetting of Code
+~~~~~~~~~~~~~~~~~~~
+
+If the Pygments package (including the C{pygmentize} program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument C{--no_pygments_html}
+turns off the use of Pygments and makes code blocks appear with
+plain (C{pre}) HTML tags. The option C{--pygments_html_linenos} turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by C{--pygments_html_style=style}, where C{style}
+can be C{default}, C{emacs}, C{perldoc}, and other valid names for
+Pygments styles.
+
+
+HTML Styles
+~~~~~~~~~~~
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -672,22 +692,15 @@
links to the CSS stylesheet in C{filename}. Several stylesheets can
be specified: C{--ccs=file1.css,file2.css,file3.css}.

+HTML templates
+~~~~~~~~~~~~~~
+
Templates are HTML files with "slots" C{%(main)s} for the main body
of text, C{%(title)s} for the title, and C{%(date)s} for the date.
Doconce comes with a few templates. The usage of templates is
described in a U{separate
document<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>}.
That document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the C{pygmentize} program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument C{--no_pygments_html}
-turns off the use of Pygments and makes code blocks appear with
-plain (C{pre}) HTML tags. The option C{--pygments_html_linenos} turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by C{--pygments_html_style=style}, where C{style}
-can be C{default}, C{emacs}, C{perldoc}, and other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": "
U{https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>}"
on this topic. The template file must contain
valid HTML code and can have three "slots": C{%(title)s} for a title,
@@ -712,6 +725,38 @@
that are used if the document contains C{!split} commands for splitting
it into many pages.

+The HTML File Collection
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+C{.basename_html_file_collection}, where C{basename} is the filestem of
+the Doconce file (i.e., the Doconce source is in C{basename.do.txt}).
+
+Filenames
+~~~~~~~~~
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the C{--html_output=basename} option, where C{basename} is the
+filestem of the associated HTML files. The
+C{.basename_html_file_collection} file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: C{mydoc_bloodish.html}, C{mydoc_solarized}, and
+C{mydoc_vagrant}::
+
+
+ Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+ Terminal> doconce split_html mydoc_bloodish.html
+ Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+ Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant
--pygments_html_style=default \
+
--html_template=templates/my_adapted_vagrant_template.html
+ Terminal> doconce split_html mydoc_vagrant.html
+

Blog Posts
----------
@@ -851,9 +896,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option C{--latex_printed} makes some adjustments for documents
+An option C{-DDEVICE=paper} makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, C{-DDEVICE=screen}, creates a PDF file for reading
+on a screen where links are clickable.

I{Step 2.} Run C{ptex2tex} (if you have it) to make a standard LaTeX file::

@@ -894,6 +941,8 @@
while other values are C{movie15} (C{\includemovie} command),
C{multimedia} (for Beamer-style C{\movie} command),
or C{href-run} (for the plain C{\href{run:file}} command)
+ - C{MOVIE_CONTROLS} adds buttons for starting/stopping movies if the
+ C{media9} package is used.
- C{PREAMBLE} to turn the LaTeX preamble on or off (i.e., complete
document
or document to be included elsewhere - and note that
the preamble is only included
@@ -906,12 +955,6 @@
macro has only effect if inline comments are used (name, colon,
and comment inside brackets).
- C{LINENUMBERS} for inclusion of line numbers in the text.
- - C{AMON} for setting the type of admonitions: C{"colors"} for colored
- boxes with icons, C{"graybox1"} for gray frame boxes with rounded
- corners (default), C{"graybox2"} for narrower square gray frame boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or C{"paragraph"} for simple, plain paragraph headings and ordinary text
- C{COLORED_TABLE_ROWS} for coloring every other table rows (set this
variable to C{gray} or C{blue})
- C{BLUE_SECTION_HEADINGS} for blue section and subsection headings
@@ -954,9 +997,17 @@
begin and end for blocks inside C{!bc fpro} and C{!ec}). Specifying
C{envir=ans:nt} means that all other environments are typeset with the
C{anslistings.sty} package, e.g., C{!bc cppcod} will then result in
-C{\begin{c++}}. If no environments like C{sys}, C{fpro}, or the common
-C{envir} are defined on the command line, the plain C{\begin{verbatim}}
-and C{\end{verbatim}} used.
+C{\begin{c++}}. A predefined shortcut as in C{shcod=Verbatim-0.85}
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+C{shcod=Verbatim-indent} implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+C{\begin{Verbatim}} instruction using the syntax illustrated for
+the C{sys} environments above.
+
+If no environments like C{sys}, C{fpro}, or the common
+C{envir} are defined on the command line, the plain C{\begin{Verbatim}}
+and C{\end{Verbatim}} instructions are used.


I{Step 2b (optional).} Edit the C{mydoc.tex} file to your needs.
@@ -1603,11 +1654,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is
written).

- ========= Example on a Chapter Heading =========
-
- Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1634,7 +1680,7 @@
Figures are recognized by the special line syntax::


- FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+ FIGURE:[filename, height=400 width=600 frac=0.8] caption


The filename can be without extension, and Doconce will search for an
@@ -1643,10 +1689,21 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's C{convert} utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats C{html}, C{rst}, C{sphinx}, while
+the frac specification is used for C{latex} and C{pdflatex} to specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+I{Warning.}
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for C{TITLE:} and C{AUTHOR:} lines, all information
related to a figure line I{must be written on the same line}. Introducing
@@ -1724,11 +1781,15 @@

MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420
height=315]

- MOVIE: [http://vimeo.com/55562330, width=500 height=278]
Computational fluid dynamics movie.
+ MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.

Note that there must be a blank line after every C{MOVIE:} command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.
+
+
U{http://www.youtube.com/watch?v=sI2uCHH3qIM<http://www.youtube.com/watch?v=sI2uCHH3qIM>}
+
+ CFD. U{http://vimeo.com/55562330<http://vimeo.com/55562330>}

Copying Computer Code from Source Files
---------------------------------------
=======================================
--- /doc/demos/manual/manual.gwiki Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.gwiki Sat Jul 13 00:16:44 2013
@@ -1,7 +1,7 @@
#summary Doconce Description

By *Hans Petter Langtangen*
-==== Jun 28, 2013 ====
+==== Jul 13, 2013 ====

<wiki:comment> lines beginning with # are doconce comment lines
</wiki:comment>
<wiki:comment> (documents can also have mako comment lines) </wiki:comment>
@@ -604,6 +604,8 @@

==== HTML ====

+==== Basics ====
+
Making an HTML version of a Doconce file `mydoc.do.txt`
is performed by
{{{
@@ -611,6 +613,21 @@
}}}
The resulting file `mydoc.html` can be loaded into any web browser for
viewing.

+==== Typesetting of Code ====
+
+If the Pygments package (including the `pygmentize` program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument `--no_pygments_html`
+turns off the use of Pygments and makes code blocks appear with
+plain (`pre`) HTML tags. The option `--pygments_html_linenos` turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by `--pygments_html_style=style`, where `style`
+can be `default`, `emacs`, `perldoc`, and other valid names for
+Pygments styles.
+
+
+==== HTML Styles ====
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -630,22 +647,14 @@
links to the CSS stylesheet in `filename`. Several stylesheets can
be specified: `--ccs=file1.css,file2.css,file3.css`.

+==== HTML templates ====
+
Templates are HTML files with "slots" `%(main)s` for the main body
of text, `%(title)s` for the title, and `%(date)s` for the date.
Doconce comes with a few templates. The usage of templates is
described in a
[https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html separate
document]. That document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the `pygmentize` program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument `--no_pygments_html`
-turns off the use of Pygments and makes code blocks appear with
-plain (`pre`) HTML tags. The option `--pygments_html_linenos` turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by `--pygments_html_style=style`, where `style`
-can be `default`, `emacs`, `perldoc`, and other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a [
https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html tutorial] on
this topic. The template file must contain
valid HTML code and can have three "slots": `%(title)s` for a title,
@@ -669,6 +678,36 @@
that are used if the document contains `!split` commands for splitting
it into many pages.

+==== The HTML File Collection ====
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+`.basename_html_file_collection`, where `basename` is the filestem of
+the Doconce file (i.e., the Doconce source is in `basename.do.txt`).
+
+==== Filenames ====
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the `--html_output=basename` option, where `basename` is the
+filestem of the associated HTML files. The
+`.basename_html_file_collection` file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: `mydoc_bloodish.html`, `mydoc_solarized`, and
+`mydoc_vagrant`.
+
+{{{
+Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+Terminal> doconce split_html mydoc_bloodish.html
+Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant --pygments_html_style=default \
+ --html_template=templates/my_adapted_vagrant_template.html
+Terminal> doconce split_html mydoc_vagrant.html
+}}}

==== Blog Posts ====

@@ -802,9 +841,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option `--latex_printed` makes some adjustments for documents
+An option `-DDEVICE=paper` makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, `-DDEVICE=screen`, creates a PDF file for reading
+on a screen where links are clickable.

*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,
{{{
@@ -839,11 +880,11 @@
* `A4PAPER` for A4 paper size
* `A6PAPER` for A6 paper size (suitable for reading PDFs on phones)
* `MOVIE` for specifying how movies are handled: the value `media9`
implies the `media9` package and the `\includemedia` command (default),
while other values are `movie15` (`\includemovie` command), `multimedia`
(for Beamer-style `\movie` command), or `href-run` (for the plain
`\hrun:file` command)
+ * `MOVIE_CONTROLS` adds buttons for starting/stopping movies if the
`media9` package is used.
* `PREAMBLE` to turn the LaTeX preamble on or off (i.e., complete
document or document to be included elsewhere - and note that the
preamble is only included if the document has a title, author, and date)
* `MINTED` for inclusion of the minted package for typesetting of code
with the Pygments tool (which requires `latex` or `pdflatex` to be run
with the `-shell-escape` option)
* `TODONOTES` for using the fancy `todonotes` package for typesetting
inline comments (looks much like track changes in MS Word). This macro
has only effect if inline comments are used (name, colon, and comment
inside brackets).
* `LINENUMBERS` for inclusion of line numbers in the text.
- * `AMON` for setting the type of admonitions: `"colors"` for colored
boxes with icons, `"graybox1"` for gray frame boxes with rounded corners
(default), `"graybox2"` for narrower square gray frame boxes (except for
summary, which for A4 format is small and with wrapped text around if it
does not contain verbatim code), or `"paragraph"` for simple, plain
paragraph headings and ordinary text
* `COLORED_TABLE_ROWS` for coloring every other table rows (set this
variable to `gray` or `blue`)
* `BLUE_SECTION_HEADINGS` for blue section and subsection headings
* `LATEX_HEADING` for the typesetting of the title, author, parts of
preamble (values: `traditional` for traditional LaTeX heading,
`titlepage` for a separate titlepage, `Springer_collection` for edited
volumes on Springer, `beamer` for Beamer slides, `doconce_heading`
(default) for listing institutions after names)
@@ -880,10 +921,18 @@
begin and end for blocks inside `!bc fpro` and `!ec`). Specifying
`envir=ans:nt` means that all other environments are typeset with the
`anslistings.sty` package, e.g., `!bc cppcod` will then result in
-`\begin{c++}`. If no environments like `sys`, `fpro`, or the common
-`envir` are defined on the command line, the plain `\begin{verbatim}`
-and `\end{verbatim}` used.
+`\begin{c++}`. A predefined shortcut as in `shcod=Verbatim-0.85`
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+`shcod=Verbatim-indent` implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+`\begin{Verbatim}` instruction using the syntax illustrated for
+the `sys` environments above.

+If no environments like `sys`, `fpro`, or the common
+`envir` are defined on the command line, the plain `\begin{Verbatim}`
+and `\end{Verbatim}` instructions are used.
+

*Step 2b (optional).* Edit the `mydoc.tex` file to your needs.
For example, you may want to substitute `section` by `section*` to
@@ -1493,6 +1542,7 @@


Here are some examples:
+
{{{
__Abstract.__ The following text just attempts to exemplify
various section headings.
@@ -1501,11 +1551,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1532,7 +1577,7 @@

Figures are recognized by the special line syntax
{{{
-FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+FIGURE:[filename, height=400 width=600 frac=0.8] caption

}}}
The filename can be without extension, and Doconce will search for an
@@ -1541,10 +1586,21 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's `convert` utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats `html`, `rst`, `sphinx`, while
+the frac specification is used for `latex` and `pdflatex` to specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+*Warning.*
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for `TITLE:` and `AUTHOR:` lines, all information
related to a figure line *must be written on the same line*. Introducing
@@ -1552,8 +1608,6 @@
part of the caption appearing on the same line as `FIGURE:` will be
included in the formatted caption).

-
-
---------------------------------------------------------------

Figure: Streamtube visualization of a fluid flow. (fig:viz)
@@ -1637,12 +1691,16 @@
{{{
MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
}}}
Note that there must be a blank line after every `MOVIE:` command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

+ http://www.youtube.com/watch?v=sI2uCHH3qIM
+
+ CFD. http://vimeo.com/55562330
+
==== Copying Computer Code from Source Files ====

Another type of special lines starts with `@@@CODE` and enables copying
=======================================
--- /doc/demos/manual/manual.html Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.html Sat Jul 13 00:16:44 2013
@@ -94,60 +94,66 @@
(' Notes ', 2, None, '___sec21'),
(' Demo of different formats ', 2, None, '___sec22'),
(' HTML ', 2, None, '___sec23'),
- (' Blog Posts ', 2, None, '___sec24'),
- (' Pandoc and Markdown ', 2, None, '___sec25'),
- (' LaTeX ', 2, None, '___sec26'),
- (' PDFLaTeX ', 2, None, '___sec27'),
- (' XeLaTeX ', 2, None, '___sec28'),
- (' Plain ASCII Text ', 2, None, '___sec29'),
- (' reStructuredText ', 2, None, '___sec30'),
- (' Sphinx ', 2, None, '___sec31'),
- (' The manual Sphinx procedure ', 3, None, '___sec32'),
- (' Wiki Formats ', 2, None, '___sec33'),
- (' Tweaking the Doconce Output ', 2, None, '___sec34'),
- (' The Doconce Markup Language ', 1, None, '___sec35'),
- (' Lists ', 2, None, '___sec36'),
- (' Special Lines ', 2, None, '___sec37'),
- (' Special Lines ', 1, None, '___sec38'),
- (' Figures ', 2, None, '___sec39'),
- (' Movies ', 2, None, '___sec40'),
+ (' Basics ', 3, None, '___sec24'),
+ (' Typesetting of Code ', 3, None, '___sec25'),
+ (' HTML Styles ', 3, None, '___sec26'),
+ (' HTML templates ', 3, None, '___sec27'),
+ (' The HTML File Collection ', 3, None, '___sec28'),
+ (' Filenames ', 3, None, '___sec29'),
+ (' Blog Posts ', 2, None, '___sec30'),
+ (' Pandoc and Markdown ', 2, None, '___sec31'),
+ (' LaTeX ', 2, None, '___sec32'),
+ (' PDFLaTeX ', 2, None, '___sec33'),
+ (' XeLaTeX ', 2, None, '___sec34'),
+ (' Plain ASCII Text ', 2, None, '___sec35'),
+ (' reStructuredText ', 2, None, '___sec36'),
+ (' Sphinx ', 2, None, '___sec37'),
+ (' The manual Sphinx procedure ', 3, None, '___sec38'),
+ (' Wiki Formats ', 2, None, '___sec39'),
+ (' Tweaking the Doconce Output ', 2, None, '___sec40'),
+ (' The Doconce Markup Language ', 1, None, '___sec41'),
+ (' Lists ', 2, None, '___sec42'),
+ (' Special Lines ', 2, None, '___sec43'),
+ (' Special Lines ', 1, None, '___sec44'),
+ (' Figures ', 2, None, '___sec45'),
+ (' Movies ', 2, None, '___sec46'),
(' Copying Computer Code from Source Files ',
2,
None,
- '___sec41'),
+ '___sec47'),
(' Inline Tagging ', 2, 'inline:tagging', 'inline:tagging'),
- (' Emphasized Words ', 3, None, '___sec43'),
- (' Inline Verbatim Text ', 3, None, '___sec44'),
- (' Links to Web Addresses ', 3, None, '___sec45'),
- (' Links to Local Files ', 3, None, '___sec46'),
- (' Inline Comments ', 3, None, '___sec47'),
- (' Inline Mathematics ', 3, None, '___sec48'),
- (' Comments ', 2, None, '___sec49'),
- (' Cross-Referencing ', 2, None, '___sec50'),
+ (' Emphasized Words ', 3, None, '___sec49'),
+ (' Inline Verbatim Text ', 3, None, '___sec50'),
+ (' Links to Web Addresses ', 3, None, '___sec51'),
+ (' Links to Local Files ', 3, None, '___sec52'),
+ (' Inline Comments ', 3, None, '___sec53'),
+ (' Inline Mathematics ', 3, None, '___sec54'),
+ (' Comments ', 2, None, '___sec55'),
+ (' Cross-Referencing ', 2, None, '___sec56'),
(' Generalized Cross-Referencing ',
2,
'manual:genrefs',
'manual:genrefs'),
- (' Index ', 2, None, '___sec52'),
- (' Bibliography ', 2, None, '___sec53'),
+ (' Index ', 2, None, '___sec58'),
+ (' Bibliography ', 2, None, '___sec59'),
(' Importing your data to the Publish database ',
3,
None,
- '___sec54'),
- (' Requirements to input data ', 3, None, '___sec55'),
+ '___sec60'),
+ (' Requirements to input data ', 3, None, '___sec61'),
(' Adding new references to the database ',
3,
None,
- '___sec56'),
- (' Exporting the database ', 3, None, '___sec57'),
- (' Referring to publications ', 3, None, '___sec58'),
- (' Specifying the Publish database ', 3, None, '___sec59'),
- (' LaTeX bibliography style ', 3, None, '___sec60'),
- (' Tables ', 2, None, '___sec61'),
+ '___sec62'),
+ (' Exporting the database ', 3, None, '___sec63'),
+ (' Referring to publications ', 3, None, '___sec64'),
+ (' Specifying the Publish database ', 3, None, '___sec65'),
+ (' LaTeX bibliography style ', 3, None, '___sec66'),
+ (' Tables ', 2, None, '___sec67'),
(' Exercises, Problems, Projects, and Examples ',
2,
None,
- '___sec62'),
+ '___sec68'),
(' Blocks of Verbatim Computer Code ',
2,
'sec:verbatim:blocks',
@@ -159,180 +165,183 @@
(' Mathematics for PowerPoint/OpenOffice ',
3,
None,
- '___sec65'),
+ '___sec71'),
(' Macros (Newcommands) ', 2, 'newcommands', 'newcommands'),
- (' Admonitions ', 2, None, '___sec67'),
- (' Preprocessing Steps ', 2, None, '___sec68'),
+ (' Admonitions ', 2, None, '___sec73'),
+ (' Preprocessing Steps ', 2, None, '___sec74'),
(' Splitting Documents into Smaller Pieces ',
2,
None,
- '___sec69'),
- (' Missing Features ', 2, None, '___sec70'),
- (' Header and Footer ', 2, None, '___sec71'),
+ '___sec75'),
+ (' Missing Features ', 2, None, '___sec76'),
+ (' Header and Footer ', 2, None, '___sec77'),
(' Emacs Doconce Formatter ',
2,
'emacs:doconce',
'emacs:doconce'),
- (' Writing Slides ', 1, None, '___sec73'),
- (' Overview ', 2, None, '___sec74'),
- (' HTML5 Slides ', 2, None, '___sec75'),
- (' Potential Problems ', 3, None, '___sec76'),
- (' LaTeX Beamer Slides ', 2, None, '___sec77'),
- (' Themes ', 3, None, '___sec78'),
- (' Mako Programming ', 1, None, '___sec79'),
- (' The Basics of Mako ', 2, None, '___sec80'),
+ (' Writing Slides ', 1, None, '___sec79'),
+ (' Overview ', 2, None, '___sec80'),
+ (' HTML5 Slides ', 2, None, '___sec81'),
+ (' Potential Problems ', 3, None, '___sec82'),
+ (' LaTeX Beamer Slides ', 2, None, '___sec83'),
+ (' Themes ', 3, None, '___sec84'),
+ (' Mako Programming ', 1, None, '___sec85'),
+ (' The Basics of Mako ', 2, None, '___sec86'),
(' Example: Defining a Theorem Environment ',
2,
'manual:theorem:envir',
'manual:theorem:envir'),
- (' Troubleshooting ', 1, None, '___sec82'),
- (' Disclaimer ', 2, None, '___sec83'),
- (' General Problems ', 2, None, '___sec84'),
+ (' Troubleshooting ', 1, None, '___sec88'),
+ (' Disclaimer ', 2, None, '___sec89'),
+ (' General Problems ', 2, None, '___sec90'),
(' Spellcheck reports a lot of mistakes related LaTeX math ',
3,
None,
- '___sec85'),
+ '___sec91'),
(' Doconce aborts because of a syntax error that is not an
error ',
3,
None,
- '___sec86'),
+ '___sec92'),
(' The Mako preprocessor is seemingly not run ',
3,
None,
- '___sec87'),
+ '___sec93'),
(' The Mako preprocessor is fooled by Doconce text ',
3,
None,
- '___sec88'),
+ '___sec94'),
(' The Mako preprocessor claims a variable is undefined ',
3,
None,
- '___sec89'),
+ '___sec95'),
(' Something goes wrong in the preprocessing step ',
3,
None,
- '___sec90'),
- (' Figure captions are incomplete ', 3, None, '___sec91'),
- (' Preprocessor directives do not work ', 3,
None, '___sec92'),
- (' Problems with boldface and emphasize ', 3,
None, '___sec93'),
+ '___sec96'),
+ (' Figure captions are incomplete ', 3, None, '___sec97'),
+ (' Preprocessor directives do not work ', 3,
None, '___sec98'),
+ (' Problems with boldface and emphasize ', 3,
None, '___sec99'),
(' Links to local directories do not work ',
3,
+ None,
+ '___sec100'),
+ (' Links are not typeset correctly ', 3, None, '___sec101'),
+ (' Inline verbatim code is not detected ',
+ 3,
None,
- '___sec94'),
- (' Links are not typeset correctly ', 3, None, '___sec95'),
- (' Inline verbatim code is not detected ', 3,
None, '___sec96'),
+ '___sec102'),
(' Inline verbatim text is not formatted correctly ',
3,
None,
- '___sec97'),
- (' Strange non-English characters ', 3, None, '___sec98'),
- (' Wrong Norwegian charcters ', 3, None, '___sec99'),
+ '___sec103'),
+ (' Strange non-English characters ', 3, None, '___sec104'),
+ (' Wrong Norwegian charcters ', 3, None, '___sec105'),
(' Too short underlining of reST headlines ',
3,
None,
- '___sec100'),
+ '___sec106'),
(' Found !bt but no tex blocks extracted (BUG) ',
3,
None,
- '___sec101'),
+ '___sec107'),
(' Examples are typset with environment delimiters visible ',
3,
None,
- '___sec102'),
+ '___sec108'),
(' Emacs editing does not work properly because of "regexp
overflow" ',
3,
None,
- '___sec103'),
- (' Problems with code or Tex Blocks ', 2, None, '___sec104'),
- (' Code or math block errors in reST ', 3,
None, '___sec105'),
+ '___sec109'),
+ (' Problems with code or Tex Blocks ', 2, None, '___sec110'),
+ (' Code or math block errors in reST ', 3,
None, '___sec111'),
(' Strange errors around code or TeX blocks in reST ',
3,
None,
- '___sec106'),
+ '___sec112'),
(' Something is wrong with a verbatim code block ',
3,
None,
- '___sec107'),
+ '___sec113'),
(' Code/TeX block is not shown in reST format ',
3,
None,
- '___sec108'),
+ '___sec114'),
(' Verbatim code blocks inside lists look ugly ',
3,
None,
- '___sec109'),
+ '___sec115'),
(' LaTeX code blocks inside lists look ugly ',
3,
None,
- '___sec110'),
- (' Problems with reST/Sphinx Output ', 2, None, '___sec111'),
- (' Title level inconsistent ', 3, None, '___sec112'),
- (' Lists do not appear in .rst files ', 3,
None, '___sec113'),
+ '___sec116'),
+ (' Problems with reST/Sphinx Output ', 2, None, '___sec117'),
+ (' Title level inconsistent ', 3, None, '___sec118'),
+ (' Lists do not appear in .rst files ', 3,
None, '___sec119'),
(' Error message "Undefined substitution..." from reST ',
3,
None,
- '___sec114'),
- (' Warning about duplicate link names ', 3,
None, '___sec115'),
- (' Inconsistent headings in reST ', 3, None, '___sec116'),
+ '___sec120'),
+ (' Warning about duplicate link names ', 3,
None, '___sec121'),
+ (' Inconsistent headings in reST ', 3, None, '___sec122'),
(' No code environment appears before "bc ipy" blocks ',
3,
None,
- '___sec117'),
- (' Problems with LaTeX Output ', 2, None, '___sec118'),
+ '___sec123'),
+ (' Problems with LaTeX Output ', 2, None, '___sec124'),
(' LaTeX does not like underscores in URLs ',
3,
None,
- '___sec119'),
+ '___sec125'),
(" Error when running latex: You must have 'pygmentize'
installed ",
3,
None,
- '___sec120'),
+ '___sec126'),
(' Why are the LaTeX section headings smaller than normal? ',
3,
None,
- '___sec121'),
+ '___sec127'),
(' Can I have LaTeX figures with shadows? ',
3,
None,
- '___sec122'),
+ '___sec128'),
(' How can I use my fancy LaTeX environments? ',
3,
None,
- '___sec123'),
- (' The LaTeX file does not compile ', 3, None, '___sec124'),
- (' Inline verbatim gives error ', 3, None, '___sec125'),
- (' Errors in figure captions ', 3, None, '___sec126'),
- (' Chapters are ignored ', 3, None, '___sec127'),
+ '___sec129'),
+ (' The LaTeX file does not compile ', 3, None, '___sec130'),
+ (' Inline verbatim gives error ', 3, None, '___sec131'),
+ (' Errors in figure captions ', 3, None, '___sec132'),
+ (' Chapters are ignored ', 3, None, '___sec133'),
(' I want to tune the top of the LaTeX file ',
3,
None,
- '___sec128'),
- (' Problems with gwiki Output ', 2, None, '___sec129'),
- (' Strange nested lists in gwiki ', 3, None, '___sec130'),
+ '___sec134'),
+ (' Problems with gwiki Output ', 2, None, '___sec135'),
+ (' Strange nested lists in gwiki ', 3, None, '___sec136'),
(' Lists in gwiki look ugly in the gwiki source ',
3,
None,
- '___sec131'),
- (' Problems with HTML Output ', 2, None, '___sec132'),
+ '___sec137'),
+ (' Problems with HTML Output ', 2, None, '___sec138'),
(' MathJax formulas are not properly rendered ',
3,
None,
- '___sec133'),
+ '___sec139'),
(' How can I change the layout of the HTML page? ',
3,
None,
- '___sec134'),
+ '___sec140'),
(' Why do figures look ugly when using HTML templates? ',
3,
None,
- '___sec135'),
- (' Debugging ', 2, None, '___sec136'),
- (' Basic Parsing Ideas ', 1, None, '___sec137'),
+ '___sec141'),
+ (' Debugging ', 2, None, '___sec142'),
+ (' Basic Parsing Ideas ', 1, None, '___sec143'),
(' Typesetting of Function Arguments, Return Values, and
Variables ',
2,
None,
- '___sec138'),
- (' References ', 1, None, '___sec139')]}
+ '___sec144'),
+ (' References ', 1, None, '___sec145')]}
end of tocinfo -->

<body>
@@ -384,7 +393,7 @@
<center>[1] <b>Center for Biomedical Computing, Simula Research
Laboratory</b></center>
<center>[2] <b>Department of Informatics, University of Oslo</b></center>
<p>
-<center><h4>Jun 28, 2013</h4></center> <!-- date -->
+<center><h4>Jul 13, 2013</h4></center> <!-- date -->
<p>
<!-- lines beginning with # are doconce comment lines -->
<!-- (documents can also have mako comment lines) -->
@@ -1112,6 +1121,8 @@

<h3>HTML <a name="___sec23"></a></h3>

+<h4>Basics <a name="___sec24"></a></h4>
+
<p>
Making an HTML version of a Doconce file <code>mydoc.do.txt</code>
is performed by
@@ -1121,6 +1132,21 @@
<!-- end verbatim block -->
The resulting file <code>mydoc.html</code> can be loaded into any web
browser for viewing.

+<h4>Typesetting of Code <a name="___sec25"></a></h4>
+
+<p>
+If the Pygments package (including the <code>pygmentize</code> program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument
<code>--no_pygments_html</code>
+turns off the use of Pygments and makes code blocks appear with
+plain (<code>pre</code>) HTML tags. The option
<code>--pygments_html_linenos</code> turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by <code>--pygments_html_style=style</code>, where
<code>style</code>
+can be <code>default</code>, <code>emacs</code>, <code>perldoc</code>, and
other valid names for
+Pygments styles.
+
+<h4>HTML Styles <a name="___sec26"></a></h4>
+
<p>
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
@@ -1146,6 +1172,8 @@
links to the CSS stylesheet in <code>filename</code>. Several stylesheets
can
be specified: <code>--ccs=file1.css,file2.css,file3.css</code>.

+<h4>HTML templates <a name="___sec27"></a></h4>
+
<p>
Templates are HTML files with "slots" <code>%(main)s</code> for the main
body
of text, <code>%(title)s</code> for the title, and <code>%(date)s</code>
for the date.
@@ -1153,17 +1181,6 @@
described in a <a
href="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html">separate
document</a>. That document describes how you your Doconce-generated
HTML file can have any specified layout.

-<p>
-If the Pygments package (including the <code>pygmentize</code> program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument
<code>--no_pygments_html</code>
-turns off the use of Pygments and makes code blocks appear with
-plain (<code>pre</code>) HTML tags. The option
<code>--pygments_html_linenos</code> turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by <code>--pygments_html_style=style</code>, where
<code>style</code>
-can be <code>default</code>, <code>emacs</code>, <code>perldoc</code>, and
other valid names for
-Pygments styles.
-
<p>
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": " <a
href="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html"><tt>https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html</tt></a>"
on this topic. The template file must contain
@@ -1189,7 +1206,42 @@
that are used if the document contains <code>!split</code> commands for
splitting
it into many pages.

-<h3>Blog Posts <a name="___sec24"></a></h3>
+<h4>The HTML File Collection <a name="___sec28"></a></h4>
+
+<p>
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+<code>.basename_html_file_collection</code>, where <code>basename</code>
is the filestem of
+the Doconce file (i.e., the Doconce source is in
<code>basename.do.txt</code>).
+
+<h4>Filenames <a name="___sec29"></a></h4>
+
+<p>
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the <code>--html_output=basename</code> option, where
<code>basename</code> is the
+filestem of the associated HTML files. The
+<code>.basename_html_file_collection</code> file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: <code>mydoc_bloodish.html</code>,
<code>mydoc_solarized</code>, and
+<code>mydoc_vagrant</code>.
+
+<p>
+<!-- begin verbatim block sys-->
+<pre><code>Terminal&gt; doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+Terminal&gt; doconce split_html mydoc_bloodish.html
+Terminal&gt; doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+Terminal&gt; doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant --pygments_html_style=default \
+ --html_template=templates/my_adapted_vagrant_template.html
+Terminal&gt; doconce split_html mydoc_vagrant.html
+</code></pre>
+<!-- end verbatim block -->
+
+<h3>Blog Posts <a name="___sec30"></a></h3>

<p>
Doconce can be used for writing blog posts provided the blog site accepts
@@ -1257,7 +1309,7 @@
instance) and produce very nice-looking books. There is no support
for mathematics in the text, though.

-<h3>Pandoc and Markdown <a name="___sec25"></a></h3>
+<h3>Pandoc and Markdown <a name="___sec31"></a></h3>

<p>
Output in Pandoc's extended Markdown format results from
@@ -1326,7 +1378,7 @@
The <code>-s</code> option adds a proper header and footer to the
<code>mydoc.html</code> file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.

-<h3>LaTeX <a name="___sec26"></a></h3>
+<h3>LaTeX <a name="___sec32"></a></h3>

<p>
Making a LaTeX file <code>mydoc.tex</code> from <code>mydoc.do.txt</code>
is done in two steps:
@@ -1349,9 +1401,11 @@
so that your commands are defined.

<p>
-An option <code>--latex_printed</code> makes some adjustments for documents
+An option <code>-DDEVICE=paper</code> makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, <code>-DDEVICE=screen</code>, creates a PDF file for reading
+on a screen where links are clickable.

<p>
<b>Step 2.</b>
@@ -1399,6 +1453,8 @@
while other values are <code>movie15</code> (<code>\includemovie</code>
command),
<code>multimedia</code> (for Beamer-style <code>\movie</code> command),
or <code>href-run</code> (for the plain <code>\href{run:file}</code>
command)</li>
+ <li> <code>MOVIE_CONTROLS</code> adds buttons for starting/stopping
movies if the
+ <code>media9</code> package is used.</li>
<li> <code>PREAMBLE</code> to turn the LaTeX preamble on or off (i.e.,
complete document
or document to be included elsewhere - and note that
the preamble is only included
@@ -1411,12 +1467,6 @@
macro has only effect if inline comments are used (name, colon,
and comment inside brackets).</li>
<li> <code>LINENUMBERS</code> for inclusion of line numbers in the
text.</li>
- <li> <code>AMON</code> for setting the type of admonitions:
<code>"colors"</code> for colored
- boxes with icons, <code>"graybox1"</code> for gray frame boxes with
rounded
- corners (default), <code>"graybox2"</code> for narrower square gray
frame boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or <code>"paragraph"</code> for simple, plain paragraph headings and
ordinary text</li>
<li> <code>COLORED_TABLE_ROWS</code> for coloring every other table rows
(set this
variable to <code>gray</code> or <code>blue</code>)</li>
<li> <code>BLUE_SECTION_HEADINGS</code> for blue section and subsection
headings</li>
@@ -1462,9 +1512,18 @@
begin and end for blocks inside <code>!bc fpro</code> and
<code>!ec</code>). Specifying
<code>envir=ans:nt</code> means that all other environments are typeset
with the
<code>anslistings.sty</code> package, e.g., <code>!bc cppcod</code> will
then result in
-<code>\begin{c++}</code>. If no environments like <code>sys</code>,
<code>fpro</code>, or the common
-<code>envir</code> are defined on the command line, the plain
<code>\begin{verbatim}</code>
-and <code>\end{verbatim}</code> used.
+<code>\begin{c++}</code>. A predefined shortcut as in
<code>shcod=Verbatim-0.85</code>
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+<code>shcod=Verbatim-indent</code> implies indentation of the verbatim
text.
+Alternatively, one can provide all desired parameters
+<code>\begin{Verbatim}</code> instruction using the syntax illustrated for
+the <code>sys</code> environments above.
+
+<p>
+If no environments like <code>sys</code>, <code>fpro</code>, or the common
+<code>envir</code> are defined on the command line, the plain
<code>\begin{Verbatim}</code>
+and <code>\end{Verbatim}</code> instructions are used.

<p>
<b>Step 2b (optional).</b>
@@ -1537,7 +1596,7 @@
specifications with <code>doconce ptex2tex</code>), the minted package is
automatically
included so there is no need for the <code>-DMINTED</code> option.

-<h3>PDFLaTeX <a name="___sec27"></a></h3>
+<h3>PDFLaTeX <a name="___sec33"></a></h3>

<p>
Running <code>pdflatex</code> instead of <code>latex</code> follows almost
the same steps,
@@ -1555,7 +1614,7 @@
</code></pre>
<!-- end verbatim block -->

-<h3>XeLaTeX <a name="___sec28"></a></h3>
+<h3>XeLaTeX <a name="___sec34"></a></h3>

<p>
XeLaTeX is an alternative to pdfLaTeX and is run in almost the
@@ -1570,7 +1629,7 @@
</code></pre>
<!-- end verbatim block -->

-<h3>Plain ASCII Text <a name="___sec29"></a></h3>
+<h3>Plain ASCII Text <a name="___sec35"></a></h3>

<p>
We can go from Doconce "back to" plain untagged text suitable for viewing
@@ -1581,7 +1640,7 @@
</code></pre>
<!-- end verbatim block -->

-<h3>reStructuredText <a name="___sec30"></a></h3>
+<h3>reStructuredText <a name="___sec36"></a></h3>

<p>
Going from Doconce to reStructuredText gives a lot of possibilities to
@@ -1637,7 +1696,7 @@
<li> <a
href="http://nileshbansal.blogspot.com/2007/12/latex-to-openofficeword.html"><tt>http://nileshbansal.blogspot.com/2007/12/latex-to-openofficeword.html</tt></a></li>
</ul>

-<h3>Sphinx <a name="___sec31"></a></h3>
+<h3>Sphinx <a name="___sec37"></a></h3>

<p>
Sphinx documents demand quite some steps in their creation. We have
automated
@@ -1799,7 +1858,7 @@
</code></pre>
<!-- end verbatim block -->

-<h4>The manual Sphinx procedure <a name="___sec32"></a></h4>
+<h4>The manual Sphinx procedure <a name="___sec38"></a></h4>

<p>
If it is not desirable to use the autogenerated scripts explained
@@ -1909,7 +1968,7 @@
(<code>code-block:: python</code> in Sphinx syntax) and
<code>cppcod</code> gives C++, but
all such arguments can be customized both for Sphinx and LaTeX output.

-<h3>Wiki Formats <a name="___sec33"></a></h3>
+<h3>Wiki Formats <a name="___sec39"></a></h3>

<p>
There are many different wiki formats, but Doconce only supports three:
@@ -1956,7 +2015,7 @@
available. There are instructions in the file for doing this. Usually,
one performs this substitution automatically (see next section).

-<h3>Tweaking the Doconce Output <a name="___sec34"></a></h3>
+<h3>Tweaking the Doconce Output <a name="___sec40"></a></h3>

<p>
Occasionally, one would like to tweak the output in a certain format
@@ -1971,13 +2030,13 @@
format(s). The <code>make.sh</code> files in <code>docs/manual</code> and
<code>docs/tutorial</code>
constitute comprehensive examples on how such scripts can be made.

-<h2>The Doconce Markup Language <a name="___sec35"></a></h2>
+<h2>The Doconce Markup Language <a name="___sec41"></a></h2>

<p>
The Doconce format introduces four constructs to markup text:
lists, special lines, inline tags, and environments.

-<h3>Lists <a name="___sec36"></a></h3>
+<h3>Lists <a name="___sec42"></a></h3>

<p>
An unordered bullet list makes use of the <code>*</code> as bullet sign
@@ -2083,7 +2142,7 @@
lines)
</dl>

-<h3>Special Lines <a name="___sec37"></a></h3>
+<h3>Special Lines <a name="___sec43"></a></h3>

<p>
The Doconce markup language has a concept called <em>special lines</em>.
@@ -2180,6 +2239,8 @@

<p>
Here are some examples:
+
+<p>
<!-- begin verbatim block -->
<pre><code>__Abstract.__ The following text just attempts to exemplify
various section headings.
@@ -2188,11 +2249,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -2210,9 +2266,9 @@
</code></pre>
<!-- end verbatim block -->

-<h2>Special Lines <a name="___sec38"></a></h2>
+<h2>Special Lines <a name="___sec44"></a></h2>

-<h3>Figures <a name="___sec39"></a></h3>
+<h3>Figures <a name="___sec45"></a></h3>

<p>
<!-- Note: need extra blank after FIGURE and MOVIE in !bc environments -->
@@ -2222,7 +2278,7 @@
<p>
Figures are recognized by the special line syntax
<!-- begin verbatim block -->
-<pre><code>FIGURE:[filename, height=xxx width=yyy scale=zzz] possible
caption
+<pre><code>FIGURE:[filename, height=400 width=600 frac=0.8] caption

</code></pre>
<!-- end verbatim block -->
@@ -2233,10 +2289,23 @@
(using ImageMagick's <code>convert</code> utility).

<p>
-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats <code>html</code>, <code>rst</code>,
<code>sphinx</code>, while
+the frac specification is used for <code>latex</code> and
<code>pdflatex</code> to specify
+the width of the image as a fraction of the text width.
+
+<p>
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+<p>
+<div class="alert alert-block alert-warning
alert-text-normal"><b>Warning.</b>
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

<p>
Note also that, like for <code>TITLE:</code> and <code>AUTHOR:</code>
lines, all information
@@ -2244,7 +2313,7 @@
newlines in a long caption will destroy the formatting (only the
part of the caption appearing on the same line as <code>FIGURE:</code>
will be
included in the formatted caption).
-
+</div>
<p>
<center> <!-- figure -->
<hr class="figure">
@@ -2264,7 +2333,7 @@
<code>Y</code> in the vertical direction (<code>tile 2x</code> means two
figures per row
and <code>-tile x2</code> means two rows).

-<h3>Movies <a name="___sec40"></a></h3>
+<h3>Movies <a name="___sec46"></a></h3>

<p>
Here is an example on the <code>MOVIE:</code> keyword for embedding
movies. This
@@ -2341,14 +2410,25 @@
<!-- begin verbatim block -->
<pre><code>MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420
height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
</code></pre>
<!-- end verbatim block -->
Note that there must be a blank line after every <code>MOVIE:</code>
command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

-<h3>Copying Computer Code from Source Files <a name="___sec41"></a></h3>
+<p>
+
+<iframe width="420" height="315"
src="http://www.youtube.com/embed/sI2uCHH3qIM" frameborder="0"
allowfullscreen></iframe>
+
+
+<p>
+
+<iframe width="500" height="278"
src="http://player.vimeo.com/video/55562330" frameborder="0"
allowfullscreen></iframe>
+
+<em>CFD.</em>
+
+<h3>Copying Computer Code from Source Files <a name="___sec47"></a></h3>

<p>
Another type of special lines starts with <code>@@@CODE</code> and enables
copying
@@ -2363,7 +2443,7 @@
<font color="blue">colored words</font>,
plus LaTeX/TeX inline mathematics, such as \( \nu = \sin(x) \).

-<h4>Emphasized Words <a name="___sec43"></a></h4>
+<h4>Emphasized Words <a name="___sec49"></a></h4>

<p>
Emphasized text is typeset inside a pair of asterisk, and there should
@@ -2382,7 +2462,7 @@
The line above gets typeset as
<b>several words in boldface</b> followed by <em>ephasized text</em>.

-<h4>Inline Verbatim Text <a name="___sec44"></a></h4>
+<h4>Inline Verbatim Text <a name="___sec50"></a></h4>

<p>
Verbatim text, typically used for short inline code,
@@ -2410,7 +2490,7 @@
becomes correct (sometimes a trial and error process - sticking to
very simple formatting usually avoids such problems).
</div>
-<h4>Links to Web Addresses <a name="___sec45"></a></h4>
+<h4>Links to Web Addresses <a name="___sec51"></a></h4>

<p>
Web addresses with links are typeset as
@@ -2437,7 +2517,7 @@
with a leading space and a trailing space, comma, semi-colon, or question
mark (but not period!) becomes a link with the web address as link text.)

-<h4>Links to Local Files <a name="___sec46"></a></h4>
+<h4>Links to Local Files <a name="___sec52"></a></h4>

<p>
Links to files ending in <code>.txt</code>, <code>.html</code>,
<code>.pdf</code>, <code>.py</code>, <code>.f</code>,
@@ -2515,7 +2595,7 @@
<!-- <code>_static</code> directory - links in the <code>.rst</code> files
are automatically -->
<!-- adjusted.) -->

-<h4>Inline Comments <a name="___sec47"></a></h4>
+<h4>Inline Comments <a name="___sec53"></a></h4>

<p>
Doconce also supports inline comments in the text:
@@ -2548,7 +2628,7 @@
comment in parenthesis), but in LaTeX very visible color boxes
are used (via the <code>todonotes</code> package).

-<h4>Inline Mathematics <a name="___sec48"></a></h4>
+<h4>Inline Mathematics <a name="___sec54"></a></h4>

<p>
Inline mathematics is written as in LaTeX, i.e., inside dollar signs.
@@ -2578,7 +2658,7 @@
is an \( n\times n \) matrix, and \( \bf x \) and \( \bf b \)
are vectors of length \( n \)."

-<h3>Comments <a name="___sec49"></a></h3>
+<h3>Comments <a name="___sec55"></a></h3>

<p>
Comments intended to be (sometimes) visible in the output document and
@@ -2618,7 +2698,7 @@
preprocessor and an if-else block with a variable that is undefined
(typically something like a test <code># #ifdef EXTRA</code> in
Preprocess).

-<h3>Cross-Referencing <a name="___sec50"></a></h3>
+<h3>Cross-Referencing <a name="___sec56"></a></h3>

<p>
References and labels are supported. The syntax is simple:
@@ -2749,7 +2829,7 @@
</code></pre>
<!-- end verbatim block -->

-<h3>Index <a name="___sec52"></a></h3>
+<h3>Index <a name="___sec58"></a></h3>

<p>
An index can be created for the <code>latex</code>, <code>rst</code>, and
<code>sphinx</code> formats
@@ -2782,7 +2862,7 @@
The keywords in the index are automatically placed in a meta
tag in <code>html</code> output such that search engines can make use of
the them.

-<h3>Bibliography <a name="___sec53"></a></h3>
+<h3>Bibliography <a name="___sec59"></a></h3>

<p>
Doconce applies the software tool <a
href="https://bitbucket.org/logg/publish">Publish</a> to handle the
bibliography in a
@@ -2797,7 +2877,7 @@
<a href="https://bitbucket.org/logg/publish"><tt>bitbucket.org</tt></a>,
move to the
<code>publish</code> directory and run <code>sudo python setup.py
install</code>.

-<h4>Importing your data to the Publish database <a
name="___sec54"></a></h4>
+<h4>Importing your data to the Publish database <a
name="___sec60"></a></h4>

<p>
Many scientists have their bibliographic data in the BibTex format. Here we
@@ -2819,7 +2899,7 @@
and <code>venues.list</code> along with your Doconce document files (e.g.,
add them to
your version control system).

-<h4>Requirements to input data <a name="___sec55"></a></h4>
+<h4>Requirements to input data <a name="___sec61"></a></h4>

<p>
<div class="alert alert-block alert-notice
alert-text-normal"><b>Notice.</b>
@@ -2850,7 +2930,7 @@
One can add a, b, c, and so forth if several keys feature the same
authors and year.

-<h4>Adding new references to the database <a name="___sec56"></a></h4>
+<h4>Adding new references to the database <a name="___sec62"></a></h4>

<p>
When you get some new BibTeX references you simply put them in
@@ -2858,7 +2938,7 @@
to update the database. You may also consider editing the
<code>papers.pub</code>
file directly when adding new references.

-<h4>Exporting the database <a name="___sec57"></a></h4>
+<h4>Exporting the database <a name="___sec63"></a></h4>

<p>
Export of everything in the database to
@@ -2874,7 +2954,7 @@
done). Doconce will automatically export the database to BibTeX if
the output format is <code>latex</code> or <code>pdflatex</code>.

-<h4>Referring to publications <a name="___sec58"></a></h4>
+<h4>Referring to publications <a name="___sec64"></a></h4>

<p>
We use the command
@@ -2906,7 +2986,7 @@
brackets and the corresponding references are listed in the order they
are cited.

-<h4>Specifying the Publish database <a name="___sec59"></a></h4>
+<h4>Specifying the Publish database <a name="___sec65"></a></h4>

<p>
The specification of the Publish database file in the Doconce document
@@ -2929,7 +3009,7 @@
and included in the document, while in all other formats, suitable
text is produced from the database.

-<h4>LaTeX bibliography style <a name="___sec60"></a></h4>
+<h4>LaTeX bibliography style <a name="___sec66"></a></h4>

<p>
The bibliography style is "plain" in LaTeX output. To change this, just
@@ -2942,7 +3022,7 @@
</code></pre>
<!-- end verbatim block -->

-<h3>Tables <a name="___sec61"></a></h3>
+<h3>Tables <a name="___sec67"></a></h3>

<p>
A table like
@@ -3036,7 +3116,7 @@
</code></pre>
<!-- end verbatim block -->

-<h3>Exercises, Problems, Projects, and Examples <a
name="___sec62"></a></h3>
+<h3>Exercises, Problems, Projects, and Examples <a
name="___sec68"></a></h3>

<p>
Doconce has special support for four types of "exercises", named
@@ -3523,7 +3603,7 @@
</code></pre>
<!-- end verbatim block -->

-<h4>Mathematics for PowerPoint/OpenOffice <a name="___sec65"></a></h4>
+<h4>Mathematics for PowerPoint/OpenOffice <a name="___sec71"></a></h4>

<p>
If you have LaTeX mathematics written in Doconce, it is fairly easy
@@ -3576,7 +3656,7 @@
line (multi-line newcommands are too hard to parse with regular
expressions).

-<h3>Admonitions <a name="___sec67"></a></h3>
+<h3>Admonitions <a name="___sec73"></a></h3>

<p>
Doconce offers strong support for admonition environments, such
@@ -3710,7 +3790,7 @@
<li> <code>yellowbox</code> has icons and a light yellow background.</li>
</ul>

-<h3>Preprocessing Steps <a name="___sec68"></a></h3>
+<h3>Preprocessing Steps <a name="___sec74"></a></h3>

<p>
Doconce allows preprocessor commands for, e.g., including files,
@@ -3789,7 +3869,7 @@
More advanced use of mako can include Python code that may automate
the writing of parts of the document.

-<h3>Splitting Documents into Smaller Pieces <a name="___sec69"></a></h3>
+<h3>Splitting Documents into Smaller Pieces <a name="___sec75"></a></h3>

<p>
Long documents are conveniently split into smaller Doconce files.
@@ -3885,7 +3965,7 @@
performed by the <code>doconce slides_beamer</code> command and does not
result
in individual files like <code>split_rst</code> and
<code>split_html</code> do.

-<h3>Missing Features <a name="___sec70"></a></h3>
+<h3>Missing Features <a name="___sec76"></a></h3>

<p>
Doconce does not aim to support sophisticated typesetting, simply because
@@ -3919,7 +3999,7 @@
a Doconce document to a ready docoment in another format. Inside this
script, we may edit and fine-tune the output from Doconce.

-<h3>Header and Footer <a name="___sec71"></a></h3>
+<h3>Header and Footer <a name="___sec77"></a></h3>

<p>
Some formats use a header and footer in the document. LaTeX and
@@ -3975,7 +4055,7 @@
the different shortcuts and see how handy they are in learning
Doconce and saving much typing!

-<h2>Writing Slides <a name="___sec73"></a></h2>
+<h2>Writing Slides <a name="___sec79"></a></h2>

<p>
It is a fast procedure to make slides from large amounts of Doconce
@@ -3999,7 +4079,7 @@
color for code</li>
</ul>

-<h3>Overview <a name="___sec74"></a></h3>
+<h3>Overview <a name="___sec80"></a></h3>
***The diff for this file has been truncated for email.***
=======================================
--- /doc/demos/manual/manual.md Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.md Sat Jul 13 00:16:44 2013
@@ -1,6 +1,6 @@
% Doconce Description
% Hans Petter Langtangen at Center for Biomedical Computing, Simula
Research Laboratory and Department of Informatics, University of Oslo
-% Jun 28, 2013
+% Jul 13, 2013

<!-- lines beginning with # are doconce comment lines -->
<!-- (documents can also have mako comment lines) -->
@@ -693,6 +693,8 @@

### HTML

+#### Basics
+
Making an HTML version of a Doconce file `mydoc.do.txt`
is performed by

@@ -702,6 +704,21 @@

The resulting file `mydoc.html` can be loaded into any web browser for
viewing.

+#### Typesetting of Code
+
+If the Pygments package (including the `pygmentize` program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument `--no_pygments_html`
+turns off the use of Pygments and makes code blocks appear with
+plain (`pre`) HTML tags. The option `--pygments_html_linenos` turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by `--pygments_html_style=style`, where `style`
+can be `default`, `emacs`, `perldoc`, and other valid names for
+Pygments styles.
+
+
+#### HTML Styles
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -724,22 +741,14 @@
links to the CSS stylesheet in `filename`. Several stylesheets can
be specified: `--ccs=file1.css,file2.css,file3.css`.

+#### HTML templates
+
Templates are HTML files with "slots" `%(main)s` for the main body
of text, `%(title)s` for the title, and `%(date)s` for the date.
Doconce comes with a few templates. The usage of templates is
described in a [separate
document](https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html).
That document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the `pygmentize` program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument `--no_pygments_html`
-turns off the use of Pygments and makes code blocks appear with
-plain (`pre`) HTML tags. The option `--pygments_html_linenos` turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by `--pygments_html_style=style`, where `style`
-can be `default`, `emacs`, `perldoc`, and other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": "
<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>" on this
topic. The template file must contain
valid HTML code and can have three "slots": `%(title)s` for a title,
@@ -765,6 +774,37 @@
that are used if the document contains `!split` commands for splitting
it into many pages.

+#### The HTML File Collection
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+`.basename_html_file_collection`, where `basename` is the filestem of
+the Doconce file (i.e., the Doconce source is in `basename.do.txt`).
+
+#### Filenames
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the `--html_output=basename` option, where `basename` is the
+filestem of the associated HTML files. The
+`.basename_html_file_collection` file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: `mydoc_bloodish.html`, `mydoc_solarized`, and
+`mydoc_vagrant`.
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.Bash}
+Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+Terminal> doconce split_html mydoc_bloodish.html
+Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant --pygments_html_style=default \
+ --html_template=templates/my_adapted_vagrant_template.html
+Terminal> doconce split_html mydoc_vagrant.html
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

### Blog Posts

@@ -915,9 +955,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option `--latex_printed` makes some adjustments for documents
+An option `-DDEVICE=paper` makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, `-DDEVICE=screen`, creates a PDF file for reading
+on a screen where links are clickable.

*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,

@@ -966,6 +1008,9 @@
`multimedia` (for Beamer-style `\movie` command),
or `href-run` (for the plain `\href{run:file}` command)

+ * `MOVIE_CONTROLS` adds buttons for starting/stopping movies if the
+ `media9` package is used.
+
* `PREAMBLE` to turn the LaTeX preamble on or off (i.e., complete document
or document to be included elsewhere - and note that
the preamble is only included
@@ -982,13 +1027,6 @@

* `LINENUMBERS` for inclusion of line numbers in the text.

- * `AMON` for setting the type of admonitions: `"colors"` for colored
- boxes with icons, `"graybox1"` for gray frame boxes with rounded
- corners (default), `"graybox2"` for narrower square gray frame boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or `"paragraph"` for simple, plain paragraph headings and ordinary text
-
* `COLORED_TABLE_ROWS` for coloring every other table rows (set this
variable to `gray` or `blue`)

@@ -1034,9 +1072,17 @@
begin and end for blocks inside `!bc fpro` and `!ec`). Specifying
`envir=ans:nt` means that all other environments are typeset with the
`anslistings.sty` package, e.g., `!bc cppcod` will then result in
-`\begin{c++}`. If no environments like `sys`, `fpro`, or the common
-`envir` are defined on the command line, the plain `\begin{verbatim}`
-and `\end{verbatim}` used.
+`\begin{c++}`. A predefined shortcut as in `shcod=Verbatim-0.85`
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+`shcod=Verbatim-indent` implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+`\begin{Verbatim}` instruction using the syntax illustrated for
+the `sys` environments above.
+
+If no environments like `sys`, `fpro`, or the common
+`envir` are defined on the command line, the plain `\begin{Verbatim}`
+and `\end{Verbatim}` instructions are used.


*Step 2b (optional).* Edit the `mydoc.tex` file to your needs.
@@ -1706,6 +1752,7 @@

Here are some examples:

+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
__Abstract.__ The following text just attempts to exemplify
various section headings.
@@ -1714,11 +1761,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1746,7 +1788,7 @@
Figures are recognized by the special line syntax

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+FIGURE:[filename, height=400 width=600 frac=0.8] caption

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

@@ -1756,10 +1798,21 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's `convert` utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats `html`, `rst`, `sphinx`, while
+the frac specification is used for `latex` and `pdflatex` to specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+*Warning.*
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for `TITLE:` and `AUTHOR:` lines, all information
related to a figure line *must be written on the same line*. Introducing
@@ -1846,13 +1899,24 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Note that there must be a blank line after every `MOVIE:` command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

+
+<iframe width="420" height="315"
src="http://www.youtube.com/embed/sI2uCHH3qIM" frameborder="0"
allowfullscreen></iframe>
+
+
+
+<iframe width="500" height="278"
src="http://player.vimeo.com/video/55562330" frameborder="0"
allowfullscreen></iframe>
+
+<em>CFD.</em>
+
+
+
### Copying Computer Code from Source Files

Another type of special lines starts with `@@@CODE` and enables copying
=======================================
--- /doc/demos/manual/manual.mwiki Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.mwiki Sat Jul 13 00:16:44 2013
@@ -1,7 +1,7 @@
#TITLE (actually governed by the filename): Doconce Description

By '''Hans Petter Langtangen'''
-==== Jun 28, 2013 ====
+==== Jul 13, 2013 ====

<!-- lines beginning with # are doconce comment lines -->
<!-- (documents can also have mako comment lines) -->
@@ -635,6 +635,8 @@

==== HTML ====

+==== Basics ====
+
Making an HTML version of a Doconce file <code>mydoc.do.txt</code>
is performed by
<syntaxhighlight lang="bash">
@@ -642,6 +644,21 @@
</syntaxhighlight>
The resulting file <code>mydoc.html</code> can be loaded into any web
browser for viewing.

+==== Typesetting of Code ====
+
+If the Pygments package (including the <code>pygmentize</code> program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument
<code>--no_pygments_html</code>
+turns off the use of Pygments and makes code blocks appear with
+plain (<code>pre</code>) HTML tags. The option
<code>--pygments_html_linenos</code> turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by <code>--pygments_html_style=style</code>, where
<code>style</code>
+can be <code>default</code>, <code>emacs</code>, <code>perldoc</code>, and
other valid names for
+Pygments styles.
+
+
+==== HTML Styles ====
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -664,22 +681,14 @@
links to the CSS stylesheet in <code>filename</code>. Several stylesheets
can
be specified: <code>--ccs=file1.css,file2.css,file3.css</code>.

+==== HTML templates ====
+
Templates are HTML files with "slots" <code>%(main)s</code> for the main
body
of text, <code>%(title)s</code> for the title, and <code>%(date)s</code>
for the date.
Doconce comes with a few templates. The usage of templates is
described in a
[https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html separate
document]. That document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the <code>pygmentize</code> program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument
<code>--no_pygments_html</code>
-turns off the use of Pygments and makes code blocks appear with
-plain (<code>pre</code>) HTML tags. The option
<code>--pygments_html_linenos</code> turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by <code>--pygments_html_style=style</code>, where
<code>style</code>
-can be <code>default</code>, <code>emacs</code>, <code>perldoc</code>, and
other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a [
https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html tutorial] on
this topic. The template file must contain
valid HTML code and can have three "slots": <code>%(title)s</code> for a
title,
@@ -703,6 +712,36 @@
that are used if the document contains <code>!split</code> commands for
splitting
it into many pages.

+==== The HTML File Collection ====
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+<code>.basename_html_file_collection</code>, where <code>basename</code>
is the filestem of
+the Doconce file (i.e., the Doconce source is in
<code>basename.do.txt</code>).
+
+==== Filenames ====
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the <code>--html_output=basename</code> option, where
<code>basename</code> is the
+filestem of the associated HTML files. The
+<code>.basename_html_file_collection</code> file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: <code>mydoc_bloodish.html</code>,
<code>mydoc_solarized</code>, and
+<code>mydoc_vagrant</code>.
+
+<syntaxhighlight lang="bash">
+Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+Terminal> doconce split_html mydoc_bloodish.html
+Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant --pygments_html_style=default \
+ --html_template=templates/my_adapted_vagrant_template.html
+Terminal> doconce split_html mydoc_vagrant.html
+</syntaxhighlight>

==== Blog Posts ====

@@ -849,9 +888,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option <code>--latex_printed</code> makes some adjustments for documents
+An option <code>-DDEVICE=paper</code> makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, <code>-DDEVICE=screen</code>, creates a PDF file for reading
+on a screen where links are clickable.

''Step 2.''
Run <code>ptex2tex</code> (if you have it) to make a standard LaTeX file,
@@ -892,6 +933,8 @@
while other values are <code>movie15</code> (<code>\includemovie</code>
command),
<code>multimedia</code> (for Beamer-style <code>\movie</code> command),
or <code>href-run</code> (for the plain <code>\hrun:file</code> command)
+ <li> <code>MOVIE_CONTROLS</code> adds buttons for starting/stopping
movies if the
+ <code>media9</code> package is used.
<li> <code>PREAMBLE</code> to turn the LaTeX preamble on or off (i.e.,
complete document
or document to be included elsewhere - and note that
the preamble is only included
@@ -904,12 +947,6 @@
macro has only effect if inline comments are used (name, colon,
and comment inside brackets).
<li> <code>LINENUMBERS</code> for inclusion of line numbers in the text.
- <li> <code>AMON</code> for setting the type of admonitions:
<code>"colors"</code> for colored
- boxes with icons, <code>"graybox1"</code> for gray frame boxes with
rounded
- corners (default), <code>"graybox2"</code> for narrower square gray
frame boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or <code>"paragraph"</code> for simple, plain paragraph headings and
ordinary text
<li> <code>COLORED_TABLE_ROWS</code> for coloring every other table rows
(set this
variable to <code>gray</code> or <code>blue</code>)
<li> <code>BLUE_SECTION_HEADINGS</code> for blue section and subsection
headings
@@ -952,9 +989,17 @@
begin and end for blocks inside <code>!bc fpro</code> and
<code>!ec</code>). Specifying
<code>envir=ans:nt</code> means that all other environments are typeset
with the
<code>anslistings.sty</code> package, e.g., <code>!bc cppcod</code> will
then result in
-<code>\begin{c++}</code>. If no environments like <code>sys</code>,
<code>fpro</code>, or the common
-<code>envir</code> are defined on the command line, the plain
<code>\begin{verbatim}</code>
-and <code>\end{verbatim}</code> used.
+<code>\begin{c++}</code>. A predefined shortcut as in
<code>shcod=Verbatim-0.85</code>
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+<code>shcod=Verbatim-indent</code> implies indentation of the verbatim
text.
+Alternatively, one can provide all desired parameters
+<code>\begin{Verbatim}</code> instruction using the syntax illustrated for
+the <code>sys</code> environments above.
+
+If no environments like <code>sys</code>, <code>fpro</code>, or the common
+<code>envir</code> are defined on the command line, the plain
<code>\begin{Verbatim}</code>
+and <code>\end{Verbatim}</code> instructions are used.


''Step 2b (optional).''
@@ -1591,6 +1636,7 @@


Here are some examples:
+
<syntaxhighlight lang="text">
__Abstract.__ The following text just attempts to exemplify
various section headings.
@@ -1599,11 +1645,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1630,7 +1671,7 @@

Figures are recognized by the special line syntax
<syntaxhighlight lang="text">
-FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+FIGURE:[filename, height=400 width=600 frac=0.8] caption

</syntaxhighlight>
The filename can be without extension, and Doconce will search for an
@@ -1639,17 +1680,31 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's <code>convert</code> utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats <code>html</code>, <code>rst</code>,
<code>sphinx</code>, while
+the frac specification is used for <code>latex</code> and
<code>pdflatex</code> to specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+
+{{mbox
+| type = warning
+| textstyle = font-size: 90%;
+| text = '''Warning.''' Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for <code>TITLE:</code> and <code>AUTHOR:</code>
lines, all information
related to a figure line ''must be written on the same line''. Introducing
newlines in a long caption will destroy the formatting (only the
part of the caption appearing on the same line as <code>FIGURE:</code>
will be
included in the formatted caption).
-
+}}

[[File:Streamtubes.png|frame|400px|alt=Streamtubes.png|Streamtube
visualization of a fluid flow. (fig:viz)]] <!-- not yet uploaded to
common.wikimedia.org -->

@@ -1725,12 +1780,16 @@
<syntaxhighlight lang="text">
MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
</syntaxhighlight>
Note that there must be a blank line after every <code>MOVIE:</code>
command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

+ http://www.youtube.com/watch?v=sI2uCHH3qIM
+
+ CFD. http://vimeo.com/55562330
+
==== Copying Computer Code from Source Files ====

Another type of special lines starts with <code>@@@CODE</code> and enables
copying
=======================================
--- /doc/demos/manual/manual.p.tex Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.p.tex Sat Jul 13 00:16:44 2013
@@ -44,9 +44,7 @@
\documentclass[%
oneside, % oneside: electronic viewing, twoside: printing
final, % or draft (marks overfull hboxes)
-chapterprefix=true, % "Chapter" word at beginning of each chapter
-open=right % start new chapters on odd-numbered pages
-10pt]{book}
+10pt]{article}

\listfiles % print all files needed to compile this document

@@ -318,16 +316,16 @@


% #if LATEX_HEADING == "traditional"
-\date{Jun 28, 2013}
+\date{Jul 13, 2013}
\maketitle
% #elif LATEX_HEADING == "beamer"
-\date{Jun 28, 2013
+\date{Jul 13, 2013
% <titlepage figure>
}
% #elif LATEX_HEADING == "titlepage"

\ \\ [10mm]
-{\large\textsf{Jun 28, 2013}}
+{\large\textsf{Jul 13, 2013}}

\end{center}
\vfill
@@ -335,7 +333,7 @@

% #else
\begin{center}
-Jun 28, 2013
+Jul 13, 2013
\end{center}

\vspace{1cm}
@@ -983,6 +981,7 @@

\subsection{HTML}

+\paragraph{Basics.}
Making an HTML version of a Doconce file \code{mydoc.do.txt}
is performed by
\bsys
@@ -990,6 +989,19 @@
\esys
The resulting file \code{mydoc.html} can be loaded into any web browser
for viewing.

+\paragraph{Typesetting of Code.}
+If the Pygments package (including the \code{pygmentize} program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument \code{--no_pygments_html}
+turns off the use of Pygments and makes code blocks appear with
+plain (\code{pre}) HTML tags. The option \code{--pygments_html_linenos}
turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by \code{--pygments_html_style=style}, where
\code{style}
+can be \code{default}, \code{emacs}, \code{perldoc}, and other valid names
for
+Pygments styles.
+
+
+\paragraph{HTML Styles.}
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -1015,22 +1027,13 @@
links to the CSS stylesheet in \code{filename}. Several stylesheets can
be specified: \code{--ccs=file1.css,file2.css,file3.css}.

+\paragraph{HTML templates.}
Templates are HTML files with "slots" \code{%(main)s} for the main body
of text, \code{%(title)s} for the title, and \code{%(date)s} for the date.
Doconce comes with a few templates. The usage of templates is
described in a
\href{{https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html}}{separate
document}. That document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the \code{pygmentize} program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument \code{--no_pygments_html}
-turns off the use of Pygments and makes code blocks appear with
-plain (\code{pre}) HTML tags. The option \code{--pygments_html_linenos}
turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by \code{--pygments_html_style=style}, where
\code{style}
-can be \code{default}, \code{emacs}, \code{perldoc}, and other valid names
for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": "
\href{{https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html}}{\nolinkurl{https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html}}"
on this topic. The template file must contain
valid HTML code and can have three "slots": \code{%(title)s} for a title,
@@ -1054,6 +1057,34 @@
that are used if the document contains \code{!split} commands for splitting
it into many pages.

+\paragraph{The HTML File Collection.}
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+\code{.basename_html_file_collection}, where \code{basename} is the
filestem of
+the Doconce file (i.e., the Doconce source is in \code{basename.do.txt}).
+
+\paragraph{Filenames.}
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the \code{--html_output=basename} option, where \code{basename} is
the
+filestem of the associated HTML files. The
+\code{.basename_html_file_collection} file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: \code{mydoc_bloodish.html}, \code{mydoc_solarized}, and
+\code{mydoc_vagrant}.
+
+\bsys
+Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+Terminal> doconce split_html mydoc_bloodish.html
+Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant --pygments_html_style=default \
+ --html_template=templates/my_adapted_vagrant_template.html
+Terminal> doconce split_html mydoc_vagrant.html
+\esys

\subsection{Blog Posts}

@@ -1198,9 +1229,11 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.

-An option \code{--latex_printed} makes some adjustments for documents
+An option \code{-DDEVICE=paper} makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, \code{-DDEVICE=screen}, creates a PDF file for reading
+on a screen where links are clickable.

\paragraph{Step 2.}
Run \code{ptex2tex} (if you have it) to make a standard {\LaTeX} file,
@@ -1246,6 +1279,9 @@
\code{multimedia} (for Beamer-style \code{\movie} command),
or \code{href-run} (for the plain \code{\href{run:file}} command)

+ \item \code{MOVIE_CONTROLS} adds buttons for starting/stopping movies if
the
+ \code{media9} package is used.
+
\item \code{PREAMBLE} to turn the {\LaTeX} preamble on or off (i.e.,
complete document
or document to be included elsewhere - and note that
the preamble is only included
@@ -1262,13 +1298,6 @@

\item \code{LINENUMBERS} for inclusion of line numbers in the text.

- \item \code{AMON} for setting the type of admonitions: \code{"colors"}
for colored
- boxes with icons, \code{"graybox1"} for gray frame boxes with rounded
- corners (default), \code{"graybox2"} for narrower square gray frame
boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or \code{"paragraph"} for simple, plain paragraph headings and ordinary
text
-
\item \code{COLORED_TABLE_ROWS} for coloring every other table rows (set
this
variable to \code{gray} or \code{blue})

@@ -1314,9 +1343,17 @@
begin and end for blocks inside \code{!bc fpro} and \code{!ec}).
Specifying
\code{envir=ans:nt} means that all other environments are typeset with the
\code{anslistings.sty} package, e.g., \code{!bc cppcod} will then result in
-\code{\begin{c++}}. If no environments like \code{sys}, \code{fpro}, or
the common
-\code{envir} are defined on the command line, the plain
\code{\begin{verbatim}}
-and \code{\end{verbatim}} used.
+\code{\begin{c++}}. A predefined shortcut as in \code{shcod=Verbatim-0.85}
+results in denser
+vertical spacing (baselinestretch 0.85 in {\LaTeX} terminology), and
+\code{shcod=Verbatim-indent} implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+\code{\begin{Verbatim}} instruction using the syntax illustrated for
+the \code{sys} environments above.
+
+If no environments like \code{sys}, \code{fpro}, or the common
+\code{envir} are defined on the command line, the plain
\code{\begin{Verbatim}}
+and \code{\end{Verbatim}} instructions are used.


\paragraph{Step 2b (optional).}
@@ -1970,6 +2007,7 @@


Here are some examples:
+
\bccq
__Abstract.__ The following text just attempts to exemplify
various section headings.
@@ -1978,11 +2016,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -2009,7 +2042,7 @@

Figures are recognized by the special line syntax
\bccq
-FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+FIGURE:[filename, height=400 width=600 frac=0.8] caption

\eccq
The filename can be without extension, and Doconce will search for an
@@ -2018,17 +2051,29 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's \code{convert} utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats \code{html}, \code{rst}, \code{sphinx},
while
+the frac specification is used for \code{latex} and \code{pdflatex} to
specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in {\LaTeX} formats or HTML.
+The caption may contain a label for referencing the figure.
+
+
+\begin{graybox1admon}[Warning.]
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for \code{TITLE:} and \code{AUTHOR:} lines, all
information
related to a figure line \emph{must be written on the same line}.
Introducing
newlines in a long caption will destroy the formatting (only the
part of the caption appearing on the same line as \code{FIGURE:} will be
included in the formatted caption).
-
+\end{graybox1admon}

\begin{figure}[ht]
\centerline{\includegraphics[width=0.9\linewidth]{figs/streamtubes.eps}}
@@ -2066,13 +2111,24 @@
(Movie figs/mjolnir.mpeg: play
\href{{mjolnir.html}}{\nolinkurl{mjolnir.html}})
% #if MOVIE == "media9"
\includemedia[
+width=0.8\linewidth,
label=figs/mjolnir.mpeg,
-activate=pageopen,
-width=0.9\linewidth,
-addresource=figs/mjolnir.mpeg,
+activate=pageopen, % or onclick or pagevisible
+addresource=figs/mjolnir.mpeg, % embed the video in the PDF
flashvars={
-source=figs/mjolnir.mpeg,
-&autoPlay=true}]{VPlayer.swf}
+source=figs/mjolnir.mpeg
+&autoPlay=true
+&loop=true
+&scaleMode=letterbox % preserve aspect ration while scaling this video
+}]{}{VPlayer.swf}
+
+% #ifdef MOVIE_CONTROLS
+\mediabutton[
+ mediacommand=figs/mjolnir.mpeg:playPause,
+ overface=\\textcolor{blue}{\fbox{\strut Play/Pause}},
+ downface=\\textcolor{red}{\fbox{\strut Play/Pause}}
+ ]{\fhox{\strut Play/Pause}}
+% #endif

% #elif MOVIE == "movie15"
\includemovie[poster,
@@ -2153,11 +2209,15 @@
\bccq
MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
\eccq
Note that there must be a blank line after every \code{MOVIE:} command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.
+
+
\href{{http://www.youtube.com/watch?v=sI2uCHH3qIM}}{\nolinkurl{http://www.youtube.com/watch?v=sI2uCHH3qIM}}
+
+ CFD.
\href{{http://vimeo.com/55562330}}{\nolinkurl{http://vimeo.com/55562330}}

\subsection{Copying Computer Code from Source Files}

=======================================
--- /doc/demos/manual/manual.pdf Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.pdf Sat Jul 13 00:16:44 2013
Binary file, no diff available.
=======================================
--- /doc/demos/manual/manual.rst Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.rst Sat Jul 13 00:16:44 2013
@@ -5,7 +5,7 @@
===================

:Author: Hans Petter Langtangen
-:Date: Jun 28, 2013
+:Date: Jul 13, 2013

.. lines beginning with # are doconce comment lines

@@ -695,6 +695,9 @@
HTML
----

+Basics
+~~~~~~
+
Making an HTML version of a Doconce file ``mydoc.do.txt``
is performed by::

@@ -703,6 +706,23 @@

The resulting file ``mydoc.html`` can be loaded into any web browser for
viewing.

+Typesetting of Code
+~~~~~~~~~~~~~~~~~~~
+
+If the Pygments package (including the ``pygmentize`` program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument ``--no_pygments_html``
+turns off the use of Pygments and makes code blocks appear with
+plain (``pre``) HTML tags. The option ``--pygments_html_linenos`` turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by ``--pygments_html_style=style``, where ``style``
+can be ``default``, ``emacs``, ``perldoc``, and other valid names for
+Pygments styles.
+
+
+HTML Styles
+~~~~~~~~~~~
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -725,22 +745,15 @@
links to the CSS stylesheet in ``filename``. Several stylesheets can
be specified: ``--ccs=file1.css,file2.css,file3.css``.

+HTML templates
+~~~~~~~~~~~~~~
+
Templates are HTML files with "slots" ``%(main)s`` for the main body
of text, ``%(title)s`` for the title, and ``%(date)s`` for the date.
Doconce comes with a few templates. The usage of templates is
described in a `separate document
<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>`_. That
document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the ``pygmentize`` program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument ``--no_pygments_html``
-turns off the use of Pygments and makes code blocks appear with
-plain (``pre``) HTML tags. The option ``--pygments_html_linenos`` turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by ``--pygments_html_style=style``, where ``style``
-can be ``default``, ``emacs``, ``perldoc``, and other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": "
`<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>`_" on
this topic. The template file must contain
valid HTML code and can have three "slots": ``%(title)s`` for a title,
@@ -765,6 +778,38 @@
that are used if the document contains ``!split`` commands for splitting
it into many pages.

+The HTML File Collection
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+``.basename_html_file_collection``, where ``basename`` is the filestem of
+the Doconce file (i.e., the Doconce source is in ``basename.do.txt``).
+
+Filenames
+~~~~~~~~~
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the ``--html_output=basename`` option, where ``basename`` is the
+filestem of the associated HTML files. The
+``.basename_html_file_collection`` file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: ``mydoc_bloodish.html``, ``mydoc_solarized``, and
+``mydoc_vagrant``::
+
+
+ Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+ Terminal> doconce split_html mydoc_bloodish.html
+ Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+ Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant
--pygments_html_style=default \
+
--html_template=templates/my_adapted_vagrant_template.html
+ Terminal> doconce split_html mydoc_vagrant.html
+

Blog Posts
----------
@@ -916,9 +961,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option ``--latex_printed`` makes some adjustments for documents
+An option ``-DDEVICE=paper`` makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, ``-DDEVICE=screen``, creates a PDF file for reading
+on a screen where links are clickable.

*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file::

@@ -965,6 +1012,9 @@
``multimedia`` (for Beamer-style ``\movie`` command),
or ``href-run`` (for the plain `\h`run:file`_` command)

+ * ``MOVIE_CONTROLS`` adds buttons for starting/stopping movies if the
+ ``media9`` package is used.
+
* ``PREAMBLE`` to turn the LaTeX preamble on or off (i.e., complete
document
or document to be included elsewhere - and note that
the preamble is only included
@@ -981,13 +1031,6 @@

* ``LINENUMBERS`` for inclusion of line numbers in the text.

- * ``AMON`` for setting the type of admonitions: ``"colors"`` for colored
- boxes with icons, ``"graybox1"`` for gray frame boxes with rounded
- corners (default), ``"graybox2"`` for narrower square gray frame boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or ``"paragraph"`` for simple, plain paragraph headings and ordinary
text
-
* ``COLORED_TABLE_ROWS`` for coloring every other table rows (set this
variable to ``gray`` or ``blue``)

@@ -1032,9 +1075,17 @@
begin and end for blocks inside ``!bc fpro`` and ``!ec``). Specifying
``envir=ans:nt`` means that all other environments are typeset with the
``anslistings.sty`` package, e.g., ``!bc cppcod`` will then result in
-``\begin{c++}``. If no environments like ``sys``, ``fpro``, or the common
-``envir`` are defined on the command line, the plain ``\begin{verbatim}``
-and ``\end{verbatim}`` used.
+``\begin{c++}``. A predefined shortcut as in ``shcod=Verbatim-0.85``
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+``shcod=Verbatim-indent`` implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+``\begin{Verbatim}`` instruction using the syntax illustrated for
+the ``sys`` environments above.
+
+If no environments like ``sys``, ``fpro``, or the common
+``envir`` are defined on the command line, the plain ``\begin{Verbatim}``
+and ``\end{Verbatim}`` instructions are used.


*Step 2b (optional).* Edit the ``mydoc.tex`` file to your needs.
@@ -1696,11 +1747,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is
written).

- ========= Example on a Chapter Heading =========
-
- Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1733,7 +1779,7 @@
Figures are recognized by the special line syntax::


- FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+ FIGURE:[filename, height=400 width=600 frac=0.8] caption


The filename can be without extension, and Doconce will search for an
@@ -1742,16 +1788,28 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's ``convert`` utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats ``html``, ``rst``, ``sphinx``, while
+the frac specification is used for ``latex`` and ``pdflatex`` to specify
+the width of the image as a fraction of the text width.

-Note also that, like for ``TITLE:`` and ``AUTHOR:`` lines, all information
-related to a figure line *must be written on the same line*. Introducing
-newlines in a long caption will destroy the formatting (only the
-part of the caption appearing on the same line as ``FIGURE:`` will be
-included in the formatted caption).
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+
+.. warning::
+ Note the comma
+ between the filename and the figure size specifications and
+ that there should be no space around the = sign. This syntax must
+ be strictly followed.
+
+ Note also that, like for ``TITLE:`` and ``AUTHOR:`` lines, all
information
+ related to a figure line *must be written on the same line*.
Introducing
+ newlines in a long caption will destroy the formatting (only the
+ part of the caption appearing on the same line as ``FIGURE:`` will be
+ included in the formatted caption).


.. _fig:viz:
@@ -1844,12 +1902,27 @@

MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420
height=315]

- MOVIE: [http://vimeo.com/55562330, width=500 height=278]
Computational fluid dynamics movie.
+ MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.

Note that there must be a blank line after every ``MOVIE:`` command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

+.. raw:: html
+
+ <iframe width="420" height="315"
src="http://www.youtube.com/embed/sI2uCHH3qIM" frameborder="0"
allowfullscreen></iframe>
+
+
+
+.. raw:: html
+
+ <iframe width="500" height="278"
src="http://player.vimeo.com/video/55562330" frameborder="0"
allowfullscreen></iframe>
+
+ <em>CFD.</em>
+
+
+
+
Copying Computer Code from Source Files
---------------------------------------

=======================================
--- /doc/demos/manual/manual.rst.html Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.rst.html Sat Jul 13 00:16:44 2013
@@ -327,7 +327,7 @@
<tbody valign="top">
<tr class="field"><th class="field-name">Author:</th><td
class="field-body">Hans Petter Langtangen</td>
</tr>
-<tr class="field"><th class="field-name">Date:</th><td
class="field-body">Jun 28, 2013</td>
+<tr class="field"><th class="field-name">Date:</th><td
class="field-body">Jul 13, 2013</td>
</tr>
</tbody>
</table>
@@ -927,12 +927,29 @@
</div>
<div class="section" id="html">
<h2>HTML</h2>
+<div class="section" id="basics">
+<h3>Basics</h3>
<p>Making an HTML version of a Doconce file <tt class="docutils
literal">mydoc.do.txt</tt>
is performed by:</p>
<pre class="literal-block">
Terminal&gt; doconce format html mydoc
</pre>
<p>The resulting file <tt class="docutils literal">mydoc.html</tt> can be
loaded into any web browser for viewing.</p>
+</div>
+<div class="section" id="typesetting-of-code">
+<h3>Typesetting of Code</h3>
+<p>If the Pygments package (including the <tt class="docutils
literal">pygmentize</tt> program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument <tt class="docutils
literal"><span class="pre">--no_pygments_html</span></tt>
+turns off the use of Pygments and makes code blocks appear with
+plain (<tt class="docutils literal">pre</tt>) HTML tags. The option <tt
class="docutils literal"><span
class="pre">--pygments_html_linenos</span></tt> turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by <tt class="docutils literal"><span
class="pre">--pygments_html_style=style</span></tt>, where <tt
class="docutils literal">style</tt>
+can be <tt class="docutils literal">default</tt>, <tt class="docutils
literal">emacs</tt>, <tt class="docutils literal">perldoc</tt>, and other
valid names for
+Pygments styles.</p>
+</div>
+<div class="section" id="html-styles">
+<h3>HTML Styles</h3>
<p>The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.</p>
@@ -952,20 +969,14 @@
Doconce write the built-in style to that file. Otherwise the HTML
links to the CSS stylesheet in <tt class="docutils literal">filename</tt>.
Several stylesheets can
be specified: <tt class="docutils literal"><span
class="pre">--ccs=file1.css,file2.css,file3.css</span></tt>.</p>
+</div>
+<div class="section" id="html-templates">
+<h3>HTML templates</h3>
<p>Templates are HTML files with &quot;slots&quot; <tt class="docutils
literal">%(main)s</tt> for the main body
of text, <tt class="docutils literal">%(title)s</tt> for the title, and
<tt class="docutils literal">%(date)s</tt> for the date.
Doconce comes with a few templates. The usage of templates is
described in a <a class="reference external"
href="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html">separate
document</a>. That document describes how you your Doconce-generated
HTML file can have any specified layout.</p>
-<p>If the Pygments package (including the <tt class="docutils
literal">pygmentize</tt> program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument <tt class="docutils
literal"><span class="pre">--no_pygments_html</span></tt>
-turns off the use of Pygments and makes code blocks appear with
-plain (<tt class="docutils literal">pre</tt>) HTML tags. The option <tt
class="docutils literal"><span
class="pre">--pygments_html_linenos</span></tt> turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by <tt class="docutils literal"><span
class="pre">--pygments_html_style=style</span></tt>, where <tt
class="docutils literal">style</tt>
-can be <tt class="docutils literal">default</tt>, <tt class="docutils
literal">emacs</tt>, <tt class="docutils literal">perldoc</tt>, and other
valid names for
-Pygments styles.</p>
<p>The HTML file can be embedded in a template with your own tailored
design, see a &quot;tutorial&quot;: &quot; <a class="reference external"
href="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html">https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html</a>&quot;
on this topic. The template file must contain
valid HTML code and can have three &quot;slots&quot;: <tt class="docutils
literal">%(title)s</tt> for a title,
@@ -989,6 +1000,37 @@
that are used if the document contains <tt class="docutils
literal">!split</tt> commands for splitting
it into many pages.</p>
</div>
+<div class="section" id="the-html-file-collection">
+<h3>The HTML File Collection</h3>
+<p>There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+<tt class="docutils literal">.basename_html_file_collection</tt>, where
<tt class="docutils literal">basename</tt> is the filestem of
+the Doconce file (i.e., the Doconce source is in <tt class="docutils
literal">basename.do.txt</tt>).</p>
+</div>
+<div class="section" id="filenames">
+<h3>Filenames</h3>
+<p>An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the <tt class="docutils literal"><span
class="pre">--html_output=basename</span></tt> option, where <tt
class="docutils literal">basename</tt> is the
+filestem of the associated HTML files. The
+<tt class="docutils literal">.basename_html_file_collection</tt> file
lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: <tt class="docutils literal">mydoc_bloodish.html</tt>,
<tt class="docutils literal">mydoc_solarized</tt>, and
+<tt class="docutils literal">mydoc_vagrant</tt>:</p>
+<pre class="literal-block">
+Terminal&gt; doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+Terminal&gt; doconce split_html mydoc_bloodish.html
+Terminal&gt; doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+Terminal&gt; doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant --pygments_html_style=default \
+ --html_template=templates/my_adapted_vagrant_template.html
+Terminal&gt; doconce split_html mydoc_vagrant.html
+</pre>
+</div>
+</div>
<div class="section" id="blog-posts">
<h2>Blog Posts</h2>
<p>Doconce can be used for writing blog posts provided the blog site
accepts
@@ -1117,9 +1159,11 @@
<tt class="docutils literal">newcommands_replace.tex</tt> (see the section
<a class="reference internal" href="#macros-newcommands">Macros
(Newcommands)</a>).
If these files are present, they are included in the LaTeX document
so that your commands are defined.</p>
-<p>An option <tt class="docutils literal"><span
class="pre">--latex_printed</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">-DDEVICE=paper</span></tt> makes some adjustments for documents
aimed at being printed. For example, links to web resources are
-associated with a footnote listing the complete web address (URL).</p>
+associated with a footnote listing the complete web address (URL).
+The default, <tt class="docutils literal"><span
class="pre">-DDEVICE=screen</span></tt>, creates a PDF file for reading
+on a screen where links are clickable.</p>
<p><em>Step 2.</em> Run <tt class="docutils literal">ptex2tex</tt> (if you
have it) to make a standard LaTeX file:</p>
<pre class="literal-block">
Terminal&gt; ptex2tex mydoc
@@ -1155,6 +1199,8 @@
while other values are <tt class="docutils literal">movie15</tt> (<tt
class="docutils literal">\includemovie</tt> command),
<tt class="docutils literal">multimedia</tt> (for Beamer-style <tt
class="docutils literal">\movie</tt> command),
or <tt class="docutils literal"><span class="pre">href-run</span></tt>
(for the plain <cite>h`run:file`_</cite> command)</li>
+<li><tt class="docutils literal">MOVIE_CONTROLS</tt> adds buttons for
starting/stopping movies if the
+<tt class="docutils literal">media9</tt> package is used.</li>
<li><tt class="docutils literal">PREAMBLE</tt> to turn the LaTeX preamble
on or off (i.e., complete document
or document to be included elsewhere - and note that
the preamble is only included
@@ -1167,12 +1213,6 @@
macro has only effect if inline comments are used (name, colon,
and comment inside brackets).</li>
<li><tt class="docutils literal">LINENUMBERS</tt> for inclusion of line
numbers in the text.</li>
-<li><tt class="docutils literal">AMON</tt> for setting the type of
admonitions: <tt class="docutils literal">&quot;colors&quot;</tt> for
colored
-boxes with icons, <tt class="docutils literal">&quot;graybox1&quot;</tt>
for gray frame boxes with rounded
-corners (default), <tt class="docutils literal">&quot;graybox2&quot;</tt>
for narrower square gray frame boxes
-(except for summary, which for A4 format is small and with wrapped
-text around if it does not contain verbatim code),
-or <tt class="docutils literal">&quot;paragraph&quot;</tt> for simple,
plain paragraph headings and ordinary text</li>
<li><tt class="docutils literal">COLORED_TABLE_ROWS</tt> for coloring
every other table rows (set this
variable to <tt class="docutils literal">gray</tt> or <tt class="docutils
literal">blue</tt>)</li>
<li><tt class="docutils literal">BLUE_SECTION_HEADINGS</tt> for blue
section and subsection headings</li>
@@ -1213,9 +1253,16 @@
begin and end for blocks inside <tt class="docutils literal">!bc fpro</tt>
and <tt class="docutils literal">!ec</tt>). Specifying
<tt class="docutils literal">envir=ans:nt</tt> means that all other
environments are typeset with the
<tt class="docutils literal">anslistings.sty</tt> package, e.g., <tt
class="docutils literal">!bc cppcod</tt> will then result in
-<tt class="docutils literal"><span class="pre">\begin{c++}</span></tt>. If
no environments like <tt class="docutils literal">sys</tt>, <tt
class="docutils literal">fpro</tt>, or the common
-<tt class="docutils literal">envir</tt> are defined on the command line,
the plain <tt class="docutils literal">\begin{verbatim}</tt>
-and <tt class="docutils literal">\end{verbatim}</tt> used.</p>
+<tt class="docutils literal"><span class="pre">\begin{c++}</span></tt>. A
predefined shortcut as in <tt class="docutils literal"><span
class="pre">shcod=Verbatim-0.85</span></tt>
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+<tt class="docutils literal"><span
class="pre">shcod=Verbatim-indent</span></tt> implies indentation of the
verbatim text.
+Alternatively, one can provide all desired parameters
+<tt class="docutils literal">\begin{Verbatim}</tt> instruction using the
syntax illustrated for
+the <tt class="docutils literal">sys</tt> environments above.</p>
+<p>If no environments like <tt class="docutils literal">sys</tt>, <tt
class="docutils literal">fpro</tt>, or the common
+<tt class="docutils literal">envir</tt> are defined on the command line,
the plain <tt class="docutils literal">\begin{Verbatim}</tt>
+and <tt class="docutils literal">\end{Verbatim}</tt> instructions are
used.</p>
<p><em>Step 2b (optional).</em> Edit the <tt class="docutils
literal">mydoc.tex</tt> file to your needs.
For example, you may want to substitute <tt class="docutils
literal">section</tt> by <tt class="docutils literal">section*</tt> to
avoid numbering of sections, you may want to insert linebreaks
@@ -1782,11 +1829,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1813,22 +1855,33 @@
<!-- !ec up to the caption line -->
<p>Figures are recognized by the special line syntax:</p>
<pre class="literal-block">
-FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+FIGURE:[filename, height=400 width=600 frac=0.8] caption
</pre>
<p>The filename can be without extension, and Doconce will search for an
appropriate file with the right extension. If the extension is wrong,
say <tt class="docutils literal">.eps</tt> when requesting an HTML format,
Doconce tries to find another
file, and if not, the given file is converted to a proper format
(using ImageMagick's <tt class="docutils literal">convert</tt>
utility).</p>
-<p>The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.</p>
-<p>Note also that, like for <tt class="docutils literal">TITLE:</tt> and
<tt class="docutils literal">AUTHOR:</tt> lines, all information
+<p>The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats <tt class="docutils literal">html</tt>,
<tt class="docutils literal">rst</tt>, <tt class="docutils
literal">sphinx</tt>, while
+the frac specification is used for <tt class="docutils literal">latex</tt>
and <tt class="docutils literal">pdflatex</tt> to specify
+the width of the image as a fraction of the text width.</p>
+<p>The figure caption is optional. If omitted, the figure appears
&quot;inline&quot;
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.</p>
+<div class="warning">
+<p class="first admonition-title">Warning</p>
+<p>Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.</p>
+<p class="last">Note also that, like for <tt class="docutils
literal">TITLE:</tt> and <tt class="docutils literal">AUTHOR:</tt> lines,
all information
related to a figure line <em>must be written on the same line</em>.
Introducing
newlines in a long caption will destroy the formatting (only the
part of the caption appearing on the same line as <tt class="docutils
literal">FIGURE:</tt> will be
included in the formatted caption).</p>
+</div>
<div class="figure" id="fig-viz">
<img alt="figs/streamtubes.png" src="figs/streamtubes.png" style="width:
400px;" />
<p class="caption"><em>Streamtube visualization of a fluid flow</em>
(fig:viz)</p>
@@ -1891,12 +1944,14 @@
<pre class="literal-block">
MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
</pre>
<p>Note that there must be a blank line after every <tt class="docutils
literal">MOVIE:</tt> command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.</p>
-</div>
+<iframe width="420" height="315"
src="http://www.youtube.com/embed/sI2uCHH3qIM" frameborder="0"
allowfullscreen></iframe><iframe width="500" height="278"
src="http://player.vimeo.com/video/55562330" frameborder="0"
allowfullscreen></iframe>
+
+<em>CFD.</em></div>
<div class="section" id="copying-computer-code-from-source-files">
<h2>Copying Computer Code from Source Files</h2>
<p>Another type of special lines starts with <tt class="docutils
literal"><span class="pre">&#64;&#64;&#64;CODE</span></tt> and enables
copying
@@ -3379,7 +3434,7 @@
<div class="section" id="mako-programming">
<h1>Mako Programming</h1>
<div class="system-message">
-<p class="system-message-title">System Message: WARNING/2 (<tt
class="docutils">manual.rst</tt>, line 3513); <em><a
href="#id15">backlink</a></em></p>
+<p class="system-message-title">System Message: WARNING/2 (<tt
class="docutils">manual.rst</tt>, line 3586); <em><a
href="#id15">backlink</a></em></p>
Duplicate explicit target name: &quot;mako&quot;.</div>
<p>The <a class="reference external"
href="http://docs.makotemplates.org/">Mako</a> templating engine is used
as preprocessor for Doconce documents, but the <a class="reference
external" href="http://code.google.com/p/preprocess">Preprocess</a> is run
prior to Mako and is recommended for
=======================================
--- /doc/demos/manual/manual.rst.pdf Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.rst.pdf Sat Jul 13 00:16:44 2013
Binary file, no diff available.
=======================================
--- /doc/demos/manual/manual.rst.tex Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.rst.tex Sat Jul 13 00:16:44 2013
@@ -82,7 +82,7 @@
Hans Petter Langtangen

\item[{Date:}]
-Jun 28, 2013
+Jul 13, 2013

\end{DUfieldlist}

@@ -1041,6 +1041,15 @@
\addcontentsline{toc}{subsection}{HTML}%
\label{html}%
}
+
+
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ Basics%
+ \addcontentsline{toc}{subsubsection}{Basics}%
+ \label{basics}%
+}

Making an HTML version of a Doconce file \texttt{mydoc.do.txt}
is performed by:
@@ -1051,6 +1060,34 @@
\end{quote}

The resulting file \texttt{mydoc.html} can be loaded into any web browser
for viewing.
+
+
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ Typesetting of Code%
+ \addcontentsline{toc}{subsubsection}{Typesetting of Code}%
+ \label{typesetting-of-code}%
+}
+
+If the Pygments package (including the \texttt{pygmentize} program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument
\texttt{-{}-no\_pygments\_html}
+turns off the use of Pygments and makes code blocks appear with
+plain (\texttt{pre}) HTML tags. The option
\texttt{-{}-pygments\_html\_linenos} turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by \texttt{-{}-pygments\_html\_style=style}, where
\texttt{style}
+can be \texttt{default}, \texttt{emacs}, \texttt{perldoc}, and other valid
names for
+Pygments styles.
+
+
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ HTML Styles%
+ \addcontentsline{toc}{subsubsection}{HTML Styles}%
+ \label{html-styles}%
+}

The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
@@ -1082,22 +1119,21 @@
links to the CSS stylesheet in \texttt{filename}. Several stylesheets can
be specified: \texttt{-{}-ccs=file1.css,file2.css,file3.css}.

+
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ HTML templates%
+ \addcontentsline{toc}{subsubsection}{HTML templates}%
+ \label{html-templates}%
+}
+
Templates are HTML files with ``slots'' \texttt{\%(main)s} for the main
body
of text, \texttt{\%(title)s} for the title, and \texttt{\%(date)s} for the
date.
Doconce comes with a few templates. The usage of templates is
described in a
\href{https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html}{separate
document}. That document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the \texttt{pygmentize} program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument
\texttt{-{}-no\_pygments\_html}
-turns off the use of Pygments and makes code blocks appear with
-plain (\texttt{pre}) HTML tags. The option
\texttt{-{}-pygments\_html\_linenos} turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by \texttt{-{}-pygments\_html\_style=style}, where
\texttt{style}
-can be \texttt{default}, \texttt{emacs}, \texttt{perldoc}, and other valid
names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a ``tutorial'': ``
\url{https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html}'' on
this topic. The template file must contain
valid HTML code and can have three ``slots'': \texttt{\%(title)s} for a
title,
@@ -1123,6 +1159,52 @@
\texttt{-{}-html\_style=vagrant}. With this style, one has nice navigation
buttons
that are used if the document contains \texttt{!split} commands for
splitting
it into many pages.
+
+
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ The HTML File Collection%
+ \addcontentsline{toc}{subsubsection}{The HTML File Collection}%
+ \label{the-html-file-collection}%
+}
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+\texttt{.basename\_html\_file\_collection}, where \texttt{basename} is the
filestem of
+the Doconce file (i.e., the Doconce source is in \texttt{basename.do.txt}).
+
+
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ Filenames%
+ \addcontentsline{toc}{subsubsection}{Filenames}%
+ \label{filenames}%
+}
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the \texttt{-{}-html\_output=basename} option, where
\texttt{basename} is the
+filestem of the associated HTML files. The
+\texttt{.basename\_html\_file\_collection} file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: \texttt{mydoc\_bloodish.html},
\texttt{mydoc\_solarized}, and
+\texttt{mydoc\_vagrant}:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+Terminal>~doconce~format~html~mydoc~-{}-html\_style=bloodish~\textbackslash{}\\
+~~~~~~~~~~-{}-html\_output=mydoc\_bloodish\\
+Terminal>~doconce~split\_html~mydoc\_bloodish.html\\
+Terminal>~doconce~format~html~mydoc~-{}-html\_style=solarized~\textbackslash{}\\
+~~~~~~~~~~-{}-html\_output=mydoc\_solarized~-{}-pygments\_html=perldoc~\textbackslash{}\\
+~~~~~~~~~~-{}-html\_admon=apricot\\
+Terminal>~doconce~format~html~mydoc~-{}-html\_style=vagrant~\textbackslash{}\\
+~~~~~~~~~~-{}-html\_output=mydoc\_vagrant~-{}-pygments\_html\_style=default~\textbackslash{}\\
+~~~~~~~~~~-{}-html\_template=templates/my\_adapted\_vagrant\_template.html\\
+Terminal>~doconce~split\_html~mydoc\_vagrant.html
+}
+\end{quote}


%___________________________________________________________________________
@@ -1324,9 +1406,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option \texttt{-{}-latex\_printed} makes some adjustments for documents
+An option \texttt{-DDEVICE=paper} makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, \texttt{-DDEVICE=screen}, creates a PDF file for reading
+on a screen where links are clickable.

\emph{Step 2.} Run \texttt{ptex2tex} (if you have it) to make a standard
LaTeX file:
%
@@ -1382,6 +1466,9 @@
\texttt{multimedia} (for Beamer-style \texttt{\textbackslash{}movie}
command),
or \texttt{href-run} (for the plain \DUroletitlereference{h`run:file`\_}
command)

+\item \texttt{MOVIE\_CONTROLS} adds buttons for starting/stopping movies
if the
+\texttt{media9} package is used.
+
\item \texttt{PREAMBLE} to turn the LaTeX preamble on or off (i.e.,
complete document
or document to be included elsewhere - and note that
the preamble is only included
@@ -1398,13 +1485,6 @@

\item \texttt{LINENUMBERS} for inclusion of line numbers in the text.

-\item \texttt{AMON} for setting the type of admonitions: \texttt{"colors"}
for colored
-boxes with icons, \texttt{"graybox1"} for gray frame boxes with rounded
-corners (default), \texttt{"graybox2"} for narrower square gray frame boxes
-(except for summary, which for A4 format is small and with wrapped
-text around if it does not contain verbatim code),
-or \texttt{"paragraph"} for simple, plain paragraph headings and ordinary
text
-
\item \texttt{COLORED\_TABLE\_ROWS} for coloring every other table rows
(set this
variable to \texttt{gray} or \texttt{blue})

@@ -1455,9 +1535,17 @@
begin and end for blocks inside \texttt{!bc fpro} and \texttt{!ec}).
Specifying
\texttt{envir=ans:nt} means that all other environments are typeset with
the
\texttt{anslistings.sty} package, e.g., \texttt{!bc cppcod} will then
result in
-\texttt{\textbackslash{}begin\{c++\}}. If no environments like
\texttt{sys}, \texttt{fpro}, or the common
-\texttt{envir} are defined on the command line, the plain
\texttt{\textbackslash{}begin\{verbatim\}}
-and \texttt{\textbackslash{}end\{verbatim\}} used.
+\texttt{\textbackslash{}begin\{c++\}}. A predefined shortcut as in
\texttt{shcod=Verbatim-0.85}
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+\texttt{shcod=Verbatim-indent} implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+\texttt{\textbackslash{}begin\{Verbatim\}} instruction using the syntax
illustrated for
+the \texttt{sys} environments above.
+
+If no environments like \texttt{sys}, \texttt{fpro}, or the common
+\texttt{envir} are defined on the command line, the plain
\texttt{\textbackslash{}begin\{Verbatim\}}
+and \texttt{\textbackslash{}end\{Verbatim\}} instructions are used.

\emph{Step 2b (optional).} Edit the \texttt{mydoc.tex} file to your needs.
For example, you may want to substitute \texttt{section} by
\texttt{section*} to
@@ -2272,11 +2360,6 @@
(this~affects~only~`latex`~output,~where~the~appendix~formatting\\
is~used~-~all~other~formats~just~leave~the~heading~as~it~is~written).\\
~\\
-=========~Example~on~a~Chapter~Heading~=========\\
-~\\
-Some~text.\\
-~\\
-~\\
=======~Example~on~a~Section~Heading~=======\\
~\\
The~running~text~goes~here.\\
@@ -2321,7 +2404,7 @@
Figures are recognized by the special line syntax:
%
\begin{quote}{\ttfamily \raggedright \noindent
-FIGURE:{[}filename,~height=xxx~width=yyy~scale=zzz{]}~possible~caption
+FIGURE:{[}filename,~height=400~width=600~frac=0.8{]}~caption
}
\end{quote}

@@ -2331,16 +2414,30 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's \texttt{convert} utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats \texttt{html}, \texttt{rst},
\texttt{sphinx}, while
+the frac specification is used for \texttt{latex} and \texttt{pdflatex} to
specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears ``inline''
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+\DUadmonition[warning]{
+\DUtitle[warning]{Warning}
+
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for \texttt{TITLE:} and \texttt{AUTHOR:} lines, all
information
related to a figure line \emph{must be written on the same line}.
Introducing
newlines in a long caption will destroy the formatting (only the
part of the caption appearing on the same line as \texttt{FIGURE:} will be
included in the formatted caption).
+}
\begin{figure}
\phantomsection\label{fig-viz}

\noindent\makebox[\textwidth][c]{\includegraphics[width=400bp]{figs/streamtubes}}
@@ -2435,7 +2532,7 @@
\begin{quote}{\ttfamily \raggedright \noindent

MOVIE:~{[}http://www.youtube.com/watch?v=sI2uCHH3qIM,~width=420~height=315{]}\\
~\\
-MOVIE:~{[}http://vimeo.com/55562330,~width=500~height=278{]}~Computational~fluid~dynamics~movie.
+MOVIE:~{[}http://vimeo.com/55562330,~width=500~height=278{]}~CFD.
}
\end{quote}

@@ -4623,7 +4720,7 @@
\DUtitle[system-message]{system-message}


-{\color{red}WARNING/2} in \texttt{manual.rst}, line~3513
+{\color{red}WARNING/2} in \texttt{manual.rst}, line~3586

\hyperlink{id15}{
Duplicate explicit target name: ``mako''.
=======================================
--- /doc/demos/manual/manual.sphinx.rst Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.sphinx.rst Sat Jul 13 00:16:44 2013
@@ -5,7 +5,7 @@
===================

:Author: Hans Petter Langtangen
-:Date: Jun 28, 2013
+:Date: Jul 13, 2013

.. lines beginning with # are doconce comment lines

@@ -763,6 +763,9 @@
HTML
----

+Basics
+~~~~~~
+
Making an HTML version of a Doconce file ``mydoc.do.txt``
is performed by

@@ -772,6 +775,23 @@

The resulting file ``mydoc.html`` can be loaded into any web browser for
viewing.

+Typesetting of Code
+~~~~~~~~~~~~~~~~~~~
+
+If the Pygments package (including the ``pygmentize`` program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument ``--no_pygments_html``
+turns off the use of Pygments and makes code blocks appear with
+plain (``pre``) HTML tags. The option ``--pygments_html_linenos`` turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by ``--pygments_html_style=style``, where ``style``
+can be ``default``, ``emacs``, ``perldoc``, and other valid names for
+Pygments styles.
+
+
+HTML Styles
+~~~~~~~~~~~
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -794,22 +814,15 @@
links to the CSS stylesheet in ``filename``. Several stylesheets can
be specified: ``--ccs=file1.css,file2.css,file3.css``.

+HTML templates
+~~~~~~~~~~~~~~
+
Templates are HTML files with "slots" ``%(main)s`` for the main body
of text, ``%(title)s`` for the title, and ``%(date)s`` for the date.
Doconce comes with a few templates. The usage of templates is
described in a `separate document
<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>`_. That
document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the ``pygmentize`` program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument ``--no_pygments_html``
-turns off the use of Pygments and makes code blocks appear with
-plain (``pre``) HTML tags. The option ``--pygments_html_linenos`` turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by ``--pygments_html_style=style``, where ``style``
-can be ``default``, ``emacs``, ``perldoc``, and other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": "
`<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>`_" on
this topic. The template file must contain
valid HTML code and can have three "slots": ``%(title)s`` for a title,
@@ -835,6 +848,40 @@
that are used if the document contains ``!split`` commands for splitting
it into many pages.

+The HTML File Collection
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+``.basename_html_file_collection``, where ``basename`` is the filestem of
+the Doconce file (i.e., the Doconce source is in ``basename.do.txt``).
+
+Filenames
+~~~~~~~~~
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the ``--html_output=basename`` option, where ``basename`` is the
+filestem of the associated HTML files. The
+``.basename_html_file_collection`` file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: ``mydoc_bloodish.html``, ``mydoc_solarized``, and
+``mydoc_vagrant``.
+
+
+.. code-block:: console
+
+ Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+ Terminal> doconce split_html mydoc_bloodish.html
+ Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+ Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant
--pygments_html_style=default \
+
--html_template=templates/my_adapted_vagrant_template.html
+ Terminal> doconce split_html mydoc_vagrant.html
+

Blog Posts
----------
@@ -995,9 +1042,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option ``--latex_printed`` makes some adjustments for documents
+An option ``-DDEVICE=paper`` makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, ``-DDEVICE=screen``, creates a PDF file for reading
+on a screen where links are clickable.

*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,

@@ -1047,6 +1096,9 @@
``multimedia`` (for Beamer-style ``\movie`` command),
or ``href-run`` (for the plain `\h:ref:`run:file`` command)

+ * ``MOVIE_CONTROLS`` adds buttons for starting/stopping movies if the
+ ``media9`` package is used.
+
* ``PREAMBLE`` to turn the LaTeX preamble on or off (i.e., complete
document
or document to be included elsewhere - and note that
the preamble is only included
@@ -1063,13 +1115,6 @@

* ``LINENUMBERS`` for inclusion of line numbers in the text.

- * ``AMON`` for setting the type of admonitions: ``"colors"`` for colored
- boxes with icons, ``"graybox1"`` for gray frame boxes with rounded
- corners (default), ``"graybox2"`` for narrower square gray frame boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or ``"paragraph"`` for simple, plain paragraph headings and ordinary
text
-
* ``COLORED_TABLE_ROWS`` for coloring every other table rows (set this
variable to ``gray`` or ``blue``)

@@ -1115,9 +1160,17 @@
begin and end for blocks inside ``!bc fpro`` and ``!ec``). Specifying
``envir=ans:nt`` means that all other environments are typeset with the
``anslistings.sty`` package, e.g., ``!bc cppcod`` will then result in
-``\begin{c++}``. If no environments like ``sys``, ``fpro``, or the common
-``envir`` are defined on the command line, the plain ``\begin{verbatim}``
-and ``\end{verbatim}`` used.
+``\begin{c++}``. A predefined shortcut as in ``shcod=Verbatim-0.85``
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+``shcod=Verbatim-indent`` implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+``\begin{Verbatim}`` instruction using the syntax illustrated for
+the ``sys`` environments above.
+
+If no environments like ``sys``, ``fpro``, or the common
+``envir`` are defined on the command line, the plain ``\begin{Verbatim}``
+and ``\end{Verbatim}`` instructions are used.


*Step 2b (optional).* Edit the ``mydoc.tex`` file to your needs.
@@ -1836,6 +1889,7 @@

Here are some examples:

+
.. code-block:: text


@@ -1846,11 +1900,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is
written).

- ========= Example on a Chapter Heading =========
-
- Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1885,7 +1934,7 @@
.. code-block:: text


- FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+ FIGURE:[filename, height=400 width=600 frac=0.8] caption


The filename can be without extension, and Doconce will search for an
@@ -1894,16 +1943,28 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's ``convert`` utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats ``html``, ``rst``, ``sphinx``, while
+the frac specification is used for ``latex`` and ``pdflatex`` to specify
+the width of the image as a fraction of the text width.

-Note also that, like for ``TITLE:`` and ``AUTHOR:`` lines, all information
-related to a figure line *must be written on the same line*. Introducing
-newlines in a long caption will destroy the formatting (only the
-part of the caption appearing on the same line as ``FIGURE:`` will be
-included in the formatted caption).
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+
+.. warning::
+ Note the comma
+ between the filename and the figure size specifications and
+ that there should be no space around the = sign. This syntax must
+ be strictly followed.
+
+ Note also that, like for ``TITLE:`` and ``AUTHOR:`` lines, all
information
+ related to a figure line *must be written on the same line*.
Introducing
+ newlines in a long caption will destroy the formatting (only the
+ part of the caption appearing on the same line as ``FIGURE:`` will be
+ included in the formatted caption).


.. _fig:viz:
@@ -2003,12 +2064,27 @@

MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420
height=315]

- MOVIE: [http://vimeo.com/55562330, width=500 height=278]
Computational fluid dynamics movie.
+ MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.

Note that there must be a blank line after every ``MOVIE:`` command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

+.. raw:: html
+
+ <iframe width="420" height="315"
src="http://www.youtube.com/embed/sI2uCHH3qIM" frameborder="0"
allowfullscreen></iframe>
+
+
+
+.. raw:: html
+
+ <iframe width="500" height="278"
src="http://player.vimeo.com/video/55562330" frameborder="0"
allowfullscreen></iframe>
+
+ <em>CFD.</em>
+
+
+
+
Copying Computer Code from Source Files
---------------------------------------

=======================================
--- /doc/demos/manual/manual.tex Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.tex Sat Jul 13 00:16:44 2013
@@ -11,9 +11,7 @@
\documentclass[%
oneside, % oneside: electronic viewing, twoside: printing
final, % or draft (marks overfull hboxes)
-chapterprefix=true, % "Chapter" word at beginning of each chapter
-open=right % start new chapters on odd-numbered pages
-10pt]{book}
+10pt]{article}

\listfiles % print all files needed to compile this document

@@ -146,7 +144,7 @@


\begin{center}
-Jun 28, 2013
+Jul 13, 2013
\end{center}

\vspace{1cm}
@@ -255,7 +253,7 @@

Doconce itself is pure Python code hosted at
\href{{http://code.google.com/p/doconce}}{\nolinkurl{http://code.google.com/p/doconce}}.
Its installation from the
Mercurial (\Verb!hg!) source follows the standard procedure:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
# Doconce
hg clone https://code.google.com/p/doconce/ doconce
cd doconce
@@ -265,7 +263,7 @@
Since Doconce is frequently updated, it is recommended to use the
above procedure and whenever a problem occurs, make sure to
update to the most recent version:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
cd doconce
hg pull
hg update
@@ -288,7 +286,7 @@
If you make use of the
\href{{http://code.google.com/p/preprocess}}{Preprocess}
preprocessor, this program must be installed:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
svn checkout http://preprocess.googlecode.com/svn/trunk/ preprocess
cd preprocess
cd doconce
@@ -300,13 +298,13 @@
\href{{http://www.makotemplates.org}}{Mako}. Its installation is most
conveniently done by \Verb!pip!,

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
pip install Mako
\end{Verbatim}
This command requires \Verb!pip! to be installed. On Debian Linux systems,
such as Ubuntu, the installation is simply done by

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
sudo apt-get install python-pip
\end{Verbatim}
Alternatively, one can install from the \Verb!pip!
\href{{http://pypi.python.org/pypi/pip}}{source code}.
@@ -324,7 +322,7 @@
image files to a proper format if needed. The
\href{{http://www.imagemagick.org/script/index.php}}{ImageMagick suite} can
be installed on all major platforms.
On Debian Linux (including Ubuntu) systems one can simply write

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
sudo apt-get install imagemagick
\end{Verbatim}

@@ -333,14 +331,14 @@
the \Verb!pdftk!, \Verb!pdfnup!, and \Verb!pdfcrop! programs from the
\Verb!texlive-extra-utils!
Debian package. The latter gets installed by

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
sudo apt-get install texlive-extra-utils
\end{Verbatim}

Automatic image conversion from EPS to PDF calls up \Verb!epstopdf!, which
can be installed by

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
sudo apt-get install texlive-font-utils
\end{Verbatim}

@@ -348,7 +346,7 @@
The utility \Verb!doconce spellcheck! applies the \Verb!ispell! program for
spellcheck. On Debian (including Ubuntu) it is installed by

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
sudo apt-get install ispell
\end{Verbatim}

@@ -358,13 +356,13 @@
in your document. On the website, click on \emph{Clone}, copy the
command and run it:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
hg clone https://bitbucket.org/logg/publish
\end{Verbatim}
Thereafter go to the \Verb!publish! directory and run the \Verb!setup.py!
script
for installing Publish:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
cd publish
sudo python setup.py
\end{Verbatim}
@@ -375,7 +373,7 @@
verbatim code blocks you need
\href{{http://code.google.com/p/ptex2tex}}{ptex2tex},
which is installed by

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
svn checkout http://ptex2tex.googlecode.com/svn/trunk/ ptex2tex
cd ptex2tex
sudo python setup.py install
@@ -383,7 +381,7 @@
It may happen that you need additional style files, you can run
a script, \Verb!cp2texmf.sh!:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
cd latex
sh cp2texmf.sh # copy stylefiles to ~/texmf directory
cd ../..
@@ -392,7 +390,7 @@
that \Verb!ptex2tex! potentially makes use of. Some more standard
stylefiles
are also needed. These are installed by

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
sudo apt-get install texlive
\end{Verbatim}
on Debian Linux (including Ubuntu) systems. TeXShop on Mac comes with
@@ -407,18 +405,18 @@
and popular among many
users. This style requires the package
\href{{http://pygments.org}}{Pygments}
to be installed. On Debian Linux,
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
sudo apt-get install python-pygments
\end{Verbatim}
Alternatively, the package can be installed manually:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
hg clone ssh://h...@bitbucket.org/birkenfeld/pygments-main pygments
cd pygments
sudo python setup.py install
\end{Verbatim}
One can also do the simple

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
pip install sphinx
\end{Verbatim}
which also installs pygments.
@@ -453,7 +451,7 @@

Relevant Debian packages that gives you all of these {\LaTeX} packages are

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
texlive
texlive-extra-utils
texlive-latex-extra
@@ -461,7 +459,7 @@
\end{Verbatim}
On old Ubuntu 12.04 one has to do \Verb!sudo add-apt-repository
ppa:texlive-backports/ppa! and \Verb!sudo apt-get update! first, or
alternatively install these as well:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
texlive-math-extra
texlive-bibtex-extra
texlive-xetex
@@ -484,7 +482,7 @@
HTML, XML, OpenOffice, and so on, through the
\href{{http://docutils.sourceforge.net}}{docutils} package. The
installation of the
most recent version can be done by

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
svn checkout \
http://docutils.svn.sourceforge.net/svnroot/docutils/trunk/docutils
cd docutils
@@ -493,13 +491,13 @@
\end{Verbatim}
The command

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
pip install sphinx
\end{Verbatim}
installs Docutils along with Sphinx and Pygments.

To use the OpenOffice suite you will typically on Debian systems install
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
sudo apt-get install unovonv libreoffice libreoffice-dmaths
\end{Verbatim}

@@ -514,7 +512,7 @@
\href{{http://sphinx.pocoo.org}}{Sphinx software},
installed by

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
hg clone https://bitbucket.org/birkenfeld/sphinx
cd sphinx
sudo python setup.py install
@@ -522,7 +520,7 @@
\end{Verbatim}
An alternative is

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
pip install sphinx
\end{Verbatim}

@@ -550,7 +548,7 @@
translated to a range of other formats. Installation of
\href{{http://johnmacfarlane.net/pandoc/}}{Pandoc}, written in Haskell, is
most
easily done by

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
sudo apt-get install pandoc
\end{Verbatim}
on Debian (Ubuntu) systems.
@@ -558,7 +556,7 @@
\paragraph{Epydoc Output.}
When the output format is \Verb!epydoc! one needs that program too,
installed
by
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
svn co https://epydoc.svn.sourceforge.net/svnroot/epydoc/trunk/epydoc
epydoc
cd epydoc
sudo make install
@@ -605,7 +603,7 @@
On Debian (including Ubuntu) systems, it is straightforward to install the
long series of Doconce dependencies:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
# Version control systems
sudo apt-get install -y mercurial git subversion

@@ -678,7 +676,7 @@
\index{demos}

The current text is generated from a Doconce format stored in the
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
docs/manual/manual.do.txt
\end{Verbatim}
file in the Doconce source code tree. We have made a
@@ -691,7 +689,7 @@
Doconce file to obtain documents in various formats.

Another demo is found in
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
docs/tutorial/tutorial.do.txt
\end{Verbatim}
In the \Verb!tutorial! directory there is also a \Verb!make.sh! file
producing a
@@ -707,11 +705,11 @@

Transformation of a Doconce document \Verb!mydoc.do.txt! to various other
formats apply the script \Verb!doconce format!:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format format mydoc.do.txt
\end{Verbatim}
or just
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format format mydoc
\end{Verbatim}

@@ -727,7 +725,7 @@
carries out the commands explained below. If our Doconce source
is in \Verb!main_myproj.do.txt!, we run

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
doconce makefile main_myproj html pdflatex sphinx
\end{Verbatim}
to produce the necessary output for generating HTML, \textsc{pdf}{\LaTeX},
and
@@ -744,7 +742,7 @@
The \Verb!preprocess! and \Verb!mako! programs are used to preprocess the
file, and options to \Verb!preprocess! and/or \Verb!mako! can be added
after the
filename. For example,
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format latex mydoc -Dextra_sections -DVAR1=5 #
preprocess
Terminal> doconce format latex yourdoc extra_sections=True VAR1=5 # mako
\end{Verbatim}
@@ -760,12 +758,12 @@
running \Verb!preprocess! and \Verb!mako!, respectively.

Inline comments in the text are removed from the output by
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format latex mydoc --skip_inline_comments
\end{Verbatim}
One can also remove all such comments from the original Doconce
file by running:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce remove_inline_comments mydoc
\end{Verbatim}
This action is convenient when a Doconce document reaches its final form
@@ -792,13 +790,27 @@

\subsection{HTML}

+\paragraph{Basics.}
Making an HTML version of a Doconce file \Verb!mydoc.do.txt!
is performed by
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format html mydoc
\end{Verbatim}
The resulting file \Verb!mydoc.html! can be loaded into any web browser
for viewing.

+\paragraph{Typesetting of Code.}
+If the Pygments package (including the \Verb!pygmentize! program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument \Verb!--no_pygments_html!
+turns off the use of Pygments and makes code blocks appear with
+plain (\Verb!pre!) HTML tags. The option \Verb!--pygments_html_linenos!
turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by \Verb!--pygments_html_style=style!, where
\Verb!style!
+can be \Verb!default!, \Verb!emacs!, \Verb!perldoc!, and other valid names
for
+Pygments styles.
+
+
+\paragraph{HTML Styles.}
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -824,22 +836,13 @@
links to the CSS stylesheet in \Verb!filename!. Several stylesheets can
be specified: \Verb!--ccs=file1.css,file2.css,file3.css!.

+\paragraph{HTML templates.}
Templates are HTML files with "slots" \Verb!%(main)s! for the main body
of text, \Verb!%(title)s! for the title, and \Verb!%(date)s! for the date.
Doconce comes with a few templates. The usage of templates is
described in a
\href{{https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html}}{separate
document}. That document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the \Verb!pygmentize! program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument \Verb!--no_pygments_html!
-turns off the use of Pygments and makes code blocks appear with
-plain (\Verb!pre!) HTML tags. The option \Verb!--pygments_html_linenos!
turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by \Verb!--pygments_html_style=style!, where
\Verb!style!
-can be \Verb!default!, \Verb!emacs!, \Verb!perldoc!, and other valid names
for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": "
\href{{https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html}}{\nolinkurl{https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html}}"
on this topic. The template file must contain
valid HTML code and can have three "slots": \Verb!%(title)s! for a title,
@@ -855,7 +858,7 @@
document directory, edit the template as needed (also check that
paths to the \Verb!css! and \Verb!js! subdirectories are correct -
according
to how you store the template files), and run
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format html mydoc --html_template=mytemplate.html
\end{Verbatim}
The template in \Verb!style_vagrant! also needs an extra option
@@ -863,6 +866,34 @@
that are used if the document contains \Verb!!split! commands for splitting
it into many pages.

+\paragraph{The HTML File Collection.}
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+\Verb!.basename_html_file_collection!, where \Verb!basename! is the
filestem of
+the Doconce file (i.e., the Doconce source is in \Verb!basename.do.txt!).
+
+\paragraph{Filenames.}
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the \Verb!--html_output=basename! option, where \Verb!basename! is
the
+filestem of the associated HTML files. The
+\Verb!.basename_html_file_collection! file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: \Verb!mydoc_bloodish.html!, \Verb!mydoc_solarized!, and
+\Verb!mydoc_vagrant!.
+
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
+Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+Terminal> doconce split_html mydoc_bloodish.html
+Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant --pygments_html_style=default \
+ --html_template=templates/my_adapted_vagrant_template.html
+Terminal> doconce split_html mydoc_vagrant.html
+\end{Verbatim}

\subsection{Blog Posts}

@@ -898,7 +929,7 @@
Figure files must be uploaded to some web site and the filenames name must
be replaced by the relevant URL. This can be automatically edited:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
cp mydoc.do.txt mydoc2.do.txt
url="https//raw.github.com/someuser/someuser.github.com"
dir="master/project/dir1/dir2"
@@ -931,12 +962,12 @@
\subsection{Pandoc and Markdown}

Output in Pandoc's extended Markdown format results from
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format pandoc mydoc
\end{Verbatim}
The name of the output file is \Verb!mydoc.mkd!.
From this format one can go to numerous other formats:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> pandoc -R -t mediawiki -o mydoc.mwk --toc mydoc.mkd
\end{Verbatim}
Pandoc supports \Verb!latex!, \Verb!html!, \Verb!odt! (OpenOffice),
\Verb!docx! (Microsoft
@@ -948,7 +979,7 @@
\Verb!pandoc! needs adjustments to provide full support for MathJax
{\LaTeX}
mathematics, and for this purpose one should use \Verb!doconce md2html!:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format pandoc mydoc
Terminal> doconce m2html mydoc
\end{Verbatim}
@@ -959,7 +990,7 @@
document): \Verb!doconce format pandoc! and then translating using
\Verb!doconce md2latex! (which runs \Verb!pandoc!), or \Verb!doconce format
latex!, and then
going from {\LaTeX} to the desired format using \Verb!pandoc!.
Here is an example on the latter strategy:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format latex mydoc
Terminal> doconce ptex2tex mydoc
Terminal> doconce replace '\Verb!' '\verb!' mydoc.tex
@@ -978,7 +1009,7 @@
Here is an example where we take a Doconce snippet (without title, author,
and date), maybe with some unnumbered equations, and quickly generate
HTML with mathematics displayed my MathJax:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format pandoc mydoc
Terminal> pandoc -t html -o mydoc.html -s --mathjax mydoc.mkd
\end{Verbatim}
@@ -996,7 +1027,7 @@
\paragraph{Step 1.}
Filter the doconce text to a pre-LaTeX form \Verb!mydoc.p.tex! for
the \Verb!ptex2tex! program (or \Verb!doconce ptex2tex!):
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format latex mydoc
\end{Verbatim}
LaTeX-specific commands ("newcommands") in math formulas and similar
@@ -1005,17 +1036,19 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.

-An option \Verb!--latex_printed! makes some adjustments for documents
+An option \Verb!-DDEVICE=paper! makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, \Verb!-DDEVICE=screen!, creates a PDF file for reading
+on a screen where links are clickable.

\paragraph{Step 2.}
Run \Verb!ptex2tex! (if you have it) to make a standard {\LaTeX} file,
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> ptex2tex mydoc
\end{Verbatim}
In case you do not have \Verb!ptex2tex!, you may run a (very) simplified
version:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce ptex2tex mydoc
\end{Verbatim}

@@ -1023,7 +1056,7 @@
that can be used to steer certain properties of the {\LaTeX} document.
For example, to turn on the Helvetica font instead of the standard
Computer Modern font, run
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> ptex2tex -DHELVETICA mydoc
Terminal> doconce ptex2tex mydoc -DHELVETICA # alternative
\end{Verbatim}
@@ -1053,6 +1086,9 @@
\Verb!multimedia! (for Beamer-style \Verb!\movie! command),
or \Verb!href-run! (for the plain \Verb!\href{run:file}! command)

+ \item \Verb!MOVIE_CONTROLS! adds buttons for starting/stopping movies if
the
+ \Verb!media9! package is used.
+
\item \Verb!PREAMBLE! to turn the {\LaTeX} preamble on or off (i.e.,
complete document
or document to be included elsewhere - and note that
the preamble is only included
@@ -1069,13 +1105,6 @@

\item \Verb!LINENUMBERS! for inclusion of line numbers in the text.

- \item \Verb!AMON! for setting the type of admonitions: \Verb!"colors"!
for colored
- boxes with icons, \Verb!"graybox1"! for gray frame boxes with rounded
- corners (default), \Verb!"graybox2"! for narrower square gray frame
boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or \Verb!"paragraph"! for simple, plain paragraph headings and ordinary
text
-
\item \Verb!COLORED_TABLE_ROWS! for coloring every other table rows (set
this
variable to \Verb!gray! or \Verb!blue!)

@@ -1109,7 +1138,7 @@
Also the \Verb!doconce ptex2tex! command supports preprocessor directives
for processing the \Verb!.p.tex! file. The command allows specifications
of code environments as well. Here is an example:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce ptex2tex mydoc -DLATEX_HEADING=traditional \
-DPALATINO -DA6PAPER \
"sys=\begin{quote}\begin{verbatim}@\end{verbatim}\end{quote}" \
@@ -1121,10 +1150,18 @@
begin and end for blocks inside \Verb!!bc fpro! and \Verb!!ec!).
Specifying
\Verb!envir=ans:nt! means that all other environments are typeset with the
\Verb!anslistings.sty! package, e.g., \Verb!!bc cppcod! will then result in
-\Verb!\begin{c++}!. If no environments like \Verb!sys!, \Verb!fpro!, or
the common
-\Verb!envir! are defined on the command line, the plain
\Verb!\begin{verbatim}!
-and \Verb!\end{verbatim}! used.
+\Verb!\begin{c++}!. A predefined shortcut as in \Verb!shcod=Verbatim-0.85!
+results in denser
+vertical spacing (baselinestretch 0.85 in {\LaTeX} terminology), and
+\Verb!shcod=Verbatim-indent! implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+\Verb!\begin{Verbatim}! instruction using the syntax illustrated for
+the \Verb!sys! environments above.

+If no environments like \Verb!sys!, \Verb!fpro!, or the common
+\Verb!envir! are defined on the command line, the plain
\Verb!\begin{Verbatim}!
+and \Verb!\end{Verbatim}! instructions are used.
+

\paragraph{Step 2b (optional).}
Edit the \Verb!mydoc.tex! file to your needs.
@@ -1135,7 +1172,7 @@
commands. The former works with substituting text directly, while the
latter performs substitutions using regular expressions.
You will use \Verb!doconce replace! to edit \Verb!section{! to
\Verb!section*{!:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce replace 'section{' 'section*{' mydoc.tex
\end{Verbatim}
For fixing the line break of a title, you may pick a word in the
@@ -1143,7 +1180,7 @@
\Verb!doconce subst! this is easy employing regular expressions with
a group before "Using" and a group after:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce subst 'title\{(.+)Using (.+)\}' \
'title{\g<1> \\\\ [1.5mm] Using \g<2>' mydoc.tex
\end{Verbatim}
@@ -1156,7 +1193,7 @@
\paragraph{Step 3.}
Compile \Verb!mydoc.tex!
and create the PDF file:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> latex mydoc
Terminal> latex mydoc
Terminal> makeindex mydoc # if index
@@ -1171,12 +1208,12 @@
\Verb!.ptex2tex.cfg! or \Verb!$HOME/.ptex2tex.cfg!), the minted {\LaTeX}
package is
needed. This package is included by running \Verb!ptex2tex! with the
\Verb!-DMINTED! option:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> ptex2tex -DMINTED mydoc
\end{Verbatim}
In this case, \Verb!latex! must be run with the
\Verb!-shell-escape! option:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> latex -shell-escape mydoc
Terminal> latex -shell-escape mydoc
Terminal> makeindex mydoc # if index
@@ -1193,11 +1230,11 @@

Running \Verb!pdflatex! instead of \Verb!latex! follows almost the same
steps,
but the start is
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format latex mydoc
\end{Verbatim}
Then \Verb!ptex2tex! is run as explained above, and finally
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> pdflatex -shell-escape mydoc
Terminal> makeindex mydoc # if index
Terminal> bibitem mydoc # if bibliography
@@ -1209,7 +1246,7 @@
XeLaTeX is an alternative to \textsc{pdf}{\LaTeX} and is run in almost the
same way, except for the \Verb!-DXELATEX! flag to ptex2tex:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format pdflatex mydoc
Terminal> doconce ptex2tex mydoc -DXELATEX
Terminal> ptex2tex -DXELATEX mydoc # alternative
@@ -1222,7 +1259,7 @@
We can go from Doconce "back to" plain untagged text suitable for viewing
in terminal windows, inclusion in email text, or for insertion in
computer source code:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format plain mydoc.do.txt # results in mydoc.txt
\end{Verbatim}

@@ -1231,11 +1268,11 @@
Going from Doconce to reStructuredText gives a lot of possibilities to
go to other formats. First we filter the Doconce text to a
reStructuredText file \Verb!mydoc.rst!:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format rst mydoc.do.txt
\end{Verbatim}
We may now produce various other formats:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> rst2html.py mydoc.rst > mydoc.html # html
Terminal> rst2latex.py mydoc.rst > mydoc.tex # latex
Terminal> rst2xml.py mydoc.rst > mydoc.xml # XML
@@ -1247,14 +1284,14 @@
However, it is more convenient to use the program \Verb!unovonv!
to convert between the many formats OpenOffice supports \emph{on the
command line}.
Run
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> unoconv --show
\end{Verbatim}
to see all the formats that are supported.
For example, the following commands take
\Verb!mydoc.odt! to Microsoft Office Open XML format,
classic MS Word format, and PDF:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> unoconv -f ooxml mydoc.odt
Terminal> unoconv -f doc mydoc.odt
Terminal> unoconv -f pdf mydoc.odt
@@ -1280,7 +1317,7 @@

Sphinx documents demand quite some steps in their creation. We have
automated
most of the steps through the \Verb!doconce sphinx_dir! command:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce sphinx_dir author="authors' names" \
title="some title" version=1.0 dirname=sphinxdir \
theme=mytheme file1 file2 file3 ...
@@ -1296,7 +1333,7 @@
Sphinx (the default theme is \Verb!'default'!).

With a single-file document in \Verb!mydoc.do.txt! one often just runs
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce sphinx_dir mydoc
\end{Verbatim}
and then an appropriate Sphinx directory \Verb!sphinx-rootdir! is made with
@@ -1365,7 +1402,7 @@
\Verb!make-themes.sh! can make HTML documents with one or more themes.
For example,
to realize the themes \Verb!fenics!, \Verb!pyramid!, and \Verb!pylon! one
writes
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> ./make-themes.sh fenics pyramid pylon
\end{Verbatim}
The resulting directories with HTML documents are \Verb!_build/html_fenics!
@@ -1391,7 +1428,7 @@
Alternatively, you may write a little script using \Verb!doconce replace!
to replace a portion of text in \Verb!conf.py! by a new one:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
doconce replace "elif html_theme == 'scipy_lectures':
html_theme_options = {
'nosidebar': 'true',
@@ -1416,7 +1453,7 @@
The final alternative is to save the edited \Verb!conf.py! file somewhere
and reuse it the next time \Verb!doconce sphinx_dir! is run

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
doconce sphinx_dir theme=scipy_lectures \
conf.py=../some/path/conf.py mydoc
\end{Verbatim}
@@ -1428,7 +1465,7 @@

\paragraph{Step 1.}
Translate Doconce into the Sphinx format:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format sphinx mydoc
\end{Verbatim}

@@ -1436,7 +1473,7 @@
Create a Sphinx root directory
either manually or by using the interactive \Verb!sphinx-quickstart!
program. Here is a scripted version of the steps with the latter:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
mkdir sphinx-rootdir
sphinx-quickstart <<EOF
sphinx-rootdir
@@ -1471,7 +1508,7 @@

\paragraph{Step 3.}
Copy the \Verb!mydoc.rst! file to the Sphinx root directory:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> cp mydoc.rst sphinx-rootdir
\end{Verbatim}
If you have figures in your document, the relative paths to those will
@@ -1484,7 +1521,7 @@
\paragraph{Step 4.}
Edit the generated \Verb!index.rst! file so that \Verb!mydoc.rst!
is included, i.e., add \Verb!mydoc! to the \Verb!toctree! section so that
it becomes
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
.. toctree::
:maxdepth: 2

@@ -1494,7 +1531,7 @@

\paragraph{Step 5.}
Generate, for instance, an HTML version of the Sphinx source:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
make clean # remove old versions
make html
\end{Verbatim}
@@ -1507,7 +1544,7 @@

\paragraph{Step 6.}
View the result:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> firefox _build/html/index.html
\end{Verbatim}

@@ -1526,7 +1563,7 @@
These formats are called
\Verb!gwiki!, \Verb!mwiki!, and \Verb!cwiki!, respectively.
Transformation from Doconce to these formats is done by
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> doconce format gwiki mydoc.do.txt
Terminal> doconce format mwiki mydoc.do.txt
Terminal> doconce format cwiki mydoc.do.txt
@@ -1586,7 +1623,7 @@
An unordered bullet list makes use of the \Verb!*! as bullet sign
and is indented as follows

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
* item 1

* item 2
@@ -1626,7 +1663,7 @@
In an ordered list, each item starts with an \Verb!o! (as the first letter
in "ordered"):

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
o item 1
o item 2
* subitem 1
@@ -1659,7 +1696,7 @@
In a description list, each item is recognized by a dash followed
by a keyword followed by a colon:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
- keyword1: explanation of keyword1

- keyword2: explanation
@@ -1697,7 +1734,7 @@
title is treated as the rest of the line, so is the date, but the
author text consists of the name and associated institution(s) with
the syntax
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
name at institution1 and institution2 and institution3
\end{Verbatim}
The \Verb!at! with surrounding spaces
@@ -1705,13 +1742,13 @@
to the author name, and the \Verb!and! with surrounding spaces is
essential as delimiter between different institutions.
An email address can optionally be included, using the syntax
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
name Email: some...@site.net at institution1 and institution2
\end{Verbatim}
Multiple authors require multiple \Verb!AUTHOR:! lines. All information
associated with \Verb!TITLE:! and \Verb!AUTHOR:! keywords must appear on a
single
line. Here is an example:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
TITLE: On an Ultimate Markup Language
AUTHOR: H. P. Langtangen at Center for Biomedical Computing, Simula
Research Laboratory & Dept. of Informatics, Univ. of Oslo
AUTHOR: Kaare Dump Email: du...@cyb.space.com at Segfault, Cyberspace Inc.
@@ -1724,7 +1761,7 @@
only the author names appear. Some formats have
"intelligence" in listing authors and institutions, e.g., the plain text
format:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Hans Petter Langtangen [1, 2]
Kaare Dump (du...@cyb.space.com) [3]
A. Dummy Author
@@ -1741,7 +1778,7 @@

\paragraph{Table of Contents.}
A table of contents can be generated by the line
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
TOC: on
\end{Verbatim}
This line is usually placed after the \Verb!DATE:! line.
@@ -1777,7 +1814,8 @@


Here are some examples:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
__Abstract.__ The following text just attempts to exemplify
various section headings.

@@ -1785,11 +1823,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1815,8 +1848,8 @@
% !ec up to the caption line

Figures are recognized by the special line syntax
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
-FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
+FIGURE:[filename, height=400 width=600 frac=0.8] caption

\end{Verbatim}
The filename can be without extension, and Doconce will search for an
@@ -1825,17 +1858,29 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's \Verb!convert! utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats \Verb!html!, \Verb!rst!, \Verb!sphinx!,
while
+the frac specification is used for \Verb!latex! and \Verb!pdflatex! to
specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in {\LaTeX} formats or HTML.
+The caption may contain a label for referencing the figure.
+
+
+\begin{graybox1admon}[Warning.]
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for \Verb!TITLE:! and \Verb!AUTHOR:! lines, all
information
related to a figure line \emph{must be written on the same line}.
Introducing
newlines in a long caption will destroy the formatting (only the
part of the caption appearing on the same line as \Verb!FIGURE:! will be
included in the formatted caption).
-
+\end{graybox1admon}

\begin{figure}[ht]
\centerline{\includegraphics[width=0.9\linewidth]{figs/streamtubes.eps}}
@@ -1848,7 +1893,7 @@

Combining several image files into one, in a table fashion, can be done by
the
\Verb!montage! program from the ImageMagick suite:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
montage -background white -geometry 100% -tile 2x \
file1.png file2.png ... file4.png result.png
\end{Verbatim}
@@ -1862,7 +1907,7 @@
feature works well for the \Verb!latex!, \Verb!html!, \Verb!rst!, and
\Verb!sphinx! formats.
Other formats try to generate some HTML file and link to that file
for showing the movie.
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
MOVIE: [filename, height=xxx width=yyy] possible caption

\end{Verbatim}
@@ -1872,13 +1917,17 @@

(Movie figs/mjolnir.mpeg: play
\href{{mjolnir.html}}{\nolinkurl{mjolnir.html}})
\includemedia[
+width=0.8\linewidth,
label=figs/mjolnir.mpeg,
-activate=pageopen,
-width=0.9\linewidth,
-addresource=figs/mjolnir.mpeg,
+activate=pageopen, % or onclick or pagevisible
+addresource=figs/mjolnir.mpeg, % embed the video in the PDF
flashvars={
-source=figs/mjolnir.mpeg,
-&autoPlay=true}]{VPlayer.swf}
+source=figs/mjolnir.mpeg
+&autoPlay=true
+&loop=true
+&scaleMode=letterbox % preserve aspect ration while scaling this video
+}]{}{VPlayer.swf}
+



@@ -1900,7 +1949,7 @@
variable \Verb!MOVIE15!. There is an associated variable
\Verb!EXTERNAL_MOVIE_VIEWER! which can be defined to launch an external
viewer when displaying the PDF file (in Acrobat Reader):
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Terminal> ptex2tex -DMOVIE15 -DEXTERNAL_MOVIE_VIEWER mydoc
\end{Verbatim}

@@ -1925,14 +1974,18 @@
\noindent
A typical \Verb!MOVIE! command with a YouTube movie is then

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.
\end{Verbatim}
Note that there must be a blank line after every \Verb!MOVIE:! command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.
+
+
\href{{http://www.youtube.com/watch?v=sI2uCHH3qIM}}{\nolinkurl{http://www.youtube.com/watch?v=sI2uCHH3qIM}}
+
+ CFD.
\href{{http://vimeo.com/55562330}}{\nolinkurl{http://vimeo.com/55562330}}

\subsection{Copying Computer Code from Source Files}

@@ -1954,12 +2007,12 @@
\paragraph{Emphasized Words.}
Emphasized text is typeset inside a pair of asterisk, and there should
be no spaces between an asterisk and the emphasized text, as in
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
*emphasized words*
\end{Verbatim}

Boldface font is recognized by an underscore instead of an asterisk:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
_several words in boldface_ followed by *ephasized text*.
\end{Verbatim}
The line above gets typeset as
@@ -1968,7 +2021,7 @@
\paragraph{Inline Verbatim Text.}
***The diff for this file has been truncated for email.***
=======================================
--- /doc/demos/manual/manual.txt Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.txt Sat Jul 13 00:16:44 2013
@@ -6,7 +6,7 @@
[1] Center for Biomedical Computing, Simula Research Laboratory
[2] Department of Informatics, University of Oslo

-Date: Jun 28, 2013
+Date: Jul 13, 2013

What Is Doconce?
================
@@ -662,6 +662,9 @@
HTML
----

+Basics
+~~~~~~
+
Making an HTML version of a Doconce file mydoc.do.txt
is performed by::

@@ -670,6 +673,23 @@

The resulting file mydoc.html can be loaded into any web browser for
viewing.

+Typesetting of Code
+~~~~~~~~~~~~~~~~~~~
+
+If the Pygments package (including the pygmentize program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument --no_pygments_html
+turns off the use of Pygments and makes code blocks appear with
+plain (pre) HTML tags. The option --pygments_html_linenos turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by --pygments_html_style=style, where style
+can be default, emacs, perldoc, and other valid names for
+Pygments styles.
+
+
+HTML Styles
+~~~~~~~~~~~
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -692,22 +712,15 @@
links to the CSS stylesheet in filename. Several stylesheets can
be specified: --ccs=file1.css,file2.css,file3.css.

+HTML templates
+~~~~~~~~~~~~~~
+
Templates are HTML files with "slots" %(main)s for the main body
of text, %(title)s for the title, and %(date)s for the date.
Doconce comes with a few templates. The usage of templates is
described in a separate document
(https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html). That
document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the pygmentize program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument --no_pygments_html
-turns off the use of Pygments and makes code blocks appear with
-plain (pre) HTML tags. The option --pygments_html_linenos turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by --pygments_html_style=style, where style
-can be default, emacs, perldoc, and other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a tutorial (
https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html) on this
topic. The template file must contain
valid HTML code and can have three "slots": %(title)s for a title,
@@ -732,6 +745,38 @@
that are used if the document contains !split commands for splitting
it into many pages.

+The HTML File Collection
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+.basename_html_file_collection, where basename is the filestem of
+the Doconce file (i.e., the Doconce source is in basename.do.txt).
+
+Filenames
+~~~~~~~~~
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the --html_output=basename option, where basename is the
+filestem of the associated HTML files. The
+.basename_html_file_collection file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: mydoc_bloodish.html, mydoc_solarized, and
+mydoc_vagrant::
+
+
+ Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+ Terminal> doconce split_html mydoc_bloodish.html
+ Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+ Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant
--pygments_html_style=default \
+
--html_template=templates/my_adapted_vagrant_template.html
+ Terminal> doconce split_html mydoc_vagrant.html
+

Blog Posts
----------
@@ -873,9 +918,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option --latex_printed makes some adjustments for documents
+An option -DDEVICE=paper makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, -DDEVICE=screen, creates a PDF file for reading
+on a screen where links are clickable.

*Step 2.* Run ptex2tex (if you have it) to make a standard LaTeX file::

@@ -922,6 +969,9 @@
multimedia (for Beamer-style \movie command),
or href-run (for the plain \href{run:file} command)

+ * MOVIE_CONTROLS adds buttons for starting/stopping movies if the
+ media9 package is used.
+
* PREAMBLE to turn the LaTeX preamble on or off (i.e., complete document
or document to be included elsewhere - and note that
the preamble is only included
@@ -938,13 +988,6 @@

* LINENUMBERS for inclusion of line numbers in the text.

- * AMON for setting the type of admonitions: "colors" for colored
- boxes with icons, "graybox1" for gray frame boxes with rounded
- corners (default), "graybox2" for narrower square gray frame boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or "paragraph" for simple, plain paragraph headings and ordinary text
-
* COLORED_TABLE_ROWS for coloring every other table rows (set this
variable to gray or blue)

@@ -989,10 +1032,18 @@
begin and end for blocks inside !bc fpro and !ec). Specifying
envir=ans:nt means that all other environments are typeset with the
anslistings.sty package, e.g., !bc cppcod will then result in
-\begin{c++}. If no environments like sys, fpro, or the common
-envir are defined on the command line, the plain \begin{verbatim}
-and \end{verbatim} used.
+\begin{c++}. A predefined shortcut as in shcod=Verbatim-0.85
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+shcod=Verbatim-indent implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+\begin{Verbatim} instruction using the syntax illustrated for
+the sys environments above.

+If no environments like sys, fpro, or the common
+envir are defined on the command line, the plain \begin{Verbatim}
+and \end{Verbatim} instructions are used.
+

*Step 2b (optional).* Edit the mydoc.tex file to your needs.
For example, you may want to substitute section by section* to
@@ -1652,11 +1703,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is
written).

- ========= Example on a Chapter Heading =========
-
- Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -1683,7 +1729,7 @@
Figures are recognized by the special line syntax::


- FIGURE:[filename, height=xxx width=yyy scale=zzz] possible caption
+ FIGURE:[filename, height=400 width=600 frac=0.8] caption


The filename can be without extension, and Doconce will search for an
@@ -1692,10 +1738,21 @@
file, and if not, the given file is converted to a proper format
(using ImageMagick's convert utility).

-The height, width, and scale keywords (and others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.
+The height, width, and frac keywords can be included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats html, rst, sphinx, while
+the frac specification is used for latex and pdflatex to specify
+the width of the image as a fraction of the text width.
+
+The figure caption is optional. If omitted, the figure appears "inline"
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the figure.
+
+*Warning.*
+Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.

Note also that, like for TITLE: and AUTHOR: lines, all information
related to a figure line *must be written on the same line*. Introducing
@@ -1774,12 +1831,16 @@

MOVIE: [http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420
height=315]

- MOVIE: [http://vimeo.com/55562330, width=500 height=278]
Computational fluid dynamics movie.
+ MOVIE: [http://vimeo.com/55562330, width=500 height=278] CFD.

Note that there must be a blank line after every MOVIE: command.
The width and height parameters are not required, but leaving them out
may lead to movie sizes you do not want.

+ http://www.youtube.com/watch?v=sI2uCHH3qIM
+
+ CFD. http://vimeo.com/55562330
+
Copying Computer Code from Source Files
---------------------------------------

=======================================
--- /doc/demos/manual/manual.xml Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual.xml Sat Jul 13 00:16:44 2013
@@ -2,7 +2,7 @@
<!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils
Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd">
<!-- Generated by Docutils 0.9 -->
<document source="manual.rst"><comment xml:space="preserve">Automatically
generated reST file from Doconce source
-(http://code.google.com/p/doconce/)</comment><section
ids="doconce-description" names="doconce\ description"><title>Doconce
Description</title><field_list><field><field_name>Author</field_name><field_body><paragraph>Hans
Petter
Langtangen</paragraph></field_body></field><field><field_name>Date</field_name><field_body><paragraph>Jun
28, 2013</paragraph></field_body></field></field_list><comment
xml:space="preserve">lines beginning with # are doconce comment
lines</comment><comment xml:space="preserve">(documents can also have mako
comment lines)</comment><target refid="what-is-doconce"/></section><section
ids="id1 what-is-doconce" names="what\ is\ doconce?
what:is:doconce"><title>What Is Doconce?</title><paragraph>Doconce is a
very simple and minimally tagged markup language that
+(http://code.google.com/p/doconce/)</comment><section
ids="doconce-description" names="doconce\ description"><title>Doconce
Description</title><field_list><field><field_name>Author</field_name><field_body><paragraph>Hans
Petter
Langtangen</paragraph></field_body></field><field><field_name>Date</field_name><field_body><paragraph>Jul
13, 2013</paragraph></field_body></field></field_list><comment
xml:space="preserve">lines beginning with # are doconce comment
lines</comment><comment xml:space="preserve">(documents can also have mako
comment lines)</comment><target refid="what-is-doconce"/></section><section
ids="id1 what-is-doconce" names="what\ is\ doconce?
what:is:doconce"><title>What Is Doconce?</title><paragraph>Doconce is a
very simple and minimally tagged markup language that
looks like ordinary ASCII text, much like what you would use in an
email, but the text can be transformed to numerous other formats,
including HTML, Sphinx, LaTeX, PDF, reStructuredText (reST), Markdown,
@@ -276,8 +276,16 @@
for readers but still nice to archive as part of the document for
future revisions.</paragraph></section><section
ids="demo-of-different-formats" names="demo\ of\ different\
formats"><title>Demo of different formats</title><paragraph>A simple
scientific report is available in <reference name="a lot of different
formats"
refuri="http://hplgit.github.com/teamods/writing_reports/doconce_commands.html">a
lot of different formats</reference><target
ids="a-lot-of-different-formats" names="a\ lot\ of\ different\ formats"
refuri="http://hplgit.github.com/teamods/writing_reports/doconce_commands.html"/>.
How to create the different formats is explained in more depth
-in the coming sections.</paragraph></section><section ids="html"
names="html"><title>HTML</title><paragraph>Making an HTML version of a
Doconce file <literal>mydoc.do.txt</literal>
-is performed by:</paragraph><literal_block
xml:space="preserve">Terminal&gt; doconce format html
mydoc</literal_block><paragraph>The resulting file
<literal>mydoc.html</literal> can be loaded into any web browser for
viewing.</paragraph><paragraph>The HTML style can be defined either in the
header of the HTML file,
+in the coming sections.</paragraph></section><section ids="html"
names="html"><title>HTML</title><section ids="basics"
names="basics"><title>Basics</title><paragraph>Making an HTML version of a
Doconce file <literal>mydoc.do.txt</literal>
+is performed by:</paragraph><literal_block
xml:space="preserve">Terminal&gt; doconce format html
mydoc</literal_block><paragraph>The resulting file
<literal>mydoc.html</literal> can be loaded into any web browser for
viewing.</paragraph></section><section ids="typesetting-of-code"
names="typesetting\ of\ code"><title>Typesetting of
Code</title><paragraph>If the Pygments package (including the
<literal>pygmentize</literal> program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument
<literal>--no_pygments_html</literal>
+turns off the use of Pygments and makes code blocks appear with
+plain (<literal>pre</literal>) HTML tags. The option
<literal>--pygments_html_linenos</literal> turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by <literal>--pygments_html_style=style</literal>,
where <literal>style</literal>
+can be <literal>default</literal>, <literal>emacs</literal>,
<literal>perldoc</literal>, and other valid names for
+Pygments styles.</paragraph></section><section ids="html-styles"
names="html\ styles"><title>HTML Styles</title><paragraph>The HTML style
can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.</paragraph><paragraph>An
external CSS file <literal>filename</literal> used by setting the
command-line
argument <literal>--css=filename</literal>. There available built-in
styles are
@@ -285,19 +293,11 @@
style
(yellowish),</paragraph></list_item><list_item><paragraph><literal>blueish</literal>:
a simple style with blue headings
(default),</paragraph></list_item><list_item><paragraph><literal>blueish2</literal>:
a variant of
<emphasis>bluish</emphasis>,</paragraph></list_item><list_item><paragraph><literal>bloodish</literal>:
as <literal>bluish</literal>, but dark read as
color.</paragraph></list_item></bullet_list></block_quote><paragraph>Using
<literal>--css=filename</literal> where <literal>filename</literal> is a
non-existing file makes
Doconce write the built-in style to that file. Otherwise the HTML
links to the CSS stylesheet in <literal>filename</literal>. Several
stylesheets can
-be specified:
<literal>--ccs=file1.css,file2.css,file3.css</literal>.</paragraph><paragraph>Templates
are HTML files with &quot;slots&quot; <literal>%(main)s</literal> for the
main body
+be specified:
<literal>--ccs=file1.css,file2.css,file3.css</literal>.</paragraph></section><section
ids="html-templates" names="html\ templates"><title>HTML
templates</title><paragraph>Templates are HTML files with &quot;slots&quot;
<literal>%(main)s</literal> for the main body
of text, <literal>%(title)s</literal> for the title, and
<literal>%(date)s</literal> for the date.
Doconce comes with a few templates. The usage of templates is
described in a <reference name="separate document"
refuri="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html">separate
document</reference><target ids="separate-document" names="separate\
document"
refuri="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html"/>.
That document describes how you your Doconce-generated
-HTML file can have any specified layout.</paragraph><paragraph>If the
Pygments package (including the <literal>pygmentize</literal> program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument
<literal>--no_pygments_html</literal>
-turns off the use of Pygments and makes code blocks appear with
-plain (<literal>pre</literal>) HTML tags. The option
<literal>--pygments_html_linenos</literal> turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by <literal>--pygments_html_style=style</literal>,
where <literal>style</literal>
-can be <literal>default</literal>, <literal>emacs</literal>,
<literal>perldoc</literal>, and other valid names for
-Pygments styles.</paragraph><paragraph>The HTML file can be embedded in a
template with your own tailored
+HTML file can have any specified layout.</paragraph><paragraph>The HTML
file can be embedded in a template with your own tailored
design, see a &quot;tutorial&quot;: &quot; <reference
name="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html"
refuri="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html">https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html</reference><target
ids="https-doconce-googlecode-com-hg-doc-design-wrapper-tech-html"
names="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html"
refuri="https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html"/>&quot;
on this topic. The template file must contain
valid HTML code and can have three &quot;slots&quot;:
<literal>%(title)s</literal> for a title,
<literal>%(date)s</literal> for a date, and <literal>%(main)s</literal>
for the main body of text. The
@@ -314,7 +314,26 @@
to how you store the template files), and run:</paragraph><literal_block
xml:space="preserve">Terminal&gt; doconce format html mydoc
--html_template=mytemplate.html</literal_block><paragraph>The template in
<literal>style_vagrant</literal> also needs an extra option
<literal>--html_style=vagrant</literal>. With this style, one has nice
navigation buttons
that are used if the document contains <literal>!split</literal> commands
for splitting
-it into many pages.</paragraph></section><section ids="blog-posts"
names="blog\ posts"><title>Blog Posts</title><paragraph>Doconce can be used
for writing blog posts provided the blog site accepts
+it into many pages.</paragraph></section><section
ids="the-html-file-collection" names="the\ html\ file\
collection"><title>The HTML File Collection</title><paragraph>There are
usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+<literal>.basename_html_file_collection</literal>, where
<literal>basename</literal> is the filestem of
+the Doconce file (i.e., the Doconce source is in
<literal>basename.do.txt</literal>).</paragraph></section><section
ids="filenames" names="filenames"><title>Filenames</title><paragraph>An
HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the <literal>--html_output=basename</literal> option, where
<literal>basename</literal> is the
+filestem of the associated HTML files. The
+<literal>.basename_html_file_collection</literal> file lists all the
needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: <literal>mydoc_bloodish.html</literal>,
<literal>mydoc_solarized</literal>, and
+<literal>mydoc_vagrant</literal>:</paragraph><literal_block
xml:space="preserve">Terminal&gt; doconce format html mydoc
--html_style=bloodish \
+ --html_output=mydoc_bloodish
+Terminal&gt; doconce split_html mydoc_bloodish.html
+Terminal&gt; doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+Terminal&gt; doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant --pygments_html_style=default \
+ --html_template=templates/my_adapted_vagrant_template.html
+Terminal&gt; doconce split_html
mydoc_vagrant.html</literal_block></section></section><section
ids="blog-posts" names="blog\ posts"><title>Blog
Posts</title><paragraph>Doconce can be used for writing blog posts provided
the blog site accepts
raw HTML code. Google's Blogger service (<literal>blogger.com</literal> or
<literal>blogname.blogspot.com</literal>) is particularly well suited
since it also
allows extensive LaTeX mathematics via
MathJax.</paragraph><enumerated_list enumtype="arabic" prefix=""
suffix="."><list_item><paragraph>Write the blog text as a Doconce document
without any
@@ -377,9 +396,11 @@
can be placed in files <literal>newcommands.tex</literal>,
<literal>newcommands_keep.tex</literal>, or
<literal>newcommands_replace.tex</literal> (see the section <reference
name="Macros (Newcommands)" refid="macros-newcommands">Macros
(Newcommands)</reference>).
If these files are present, they are included in the LaTeX document
-so that your commands are defined.</paragraph><paragraph>An option
<literal>--latex_printed</literal> makes some adjustments for documents
+so that your commands are defined.</paragraph><paragraph>An option
<literal>-DDEVICE=paper</literal> makes some adjustments for documents
aimed at being printed. For example, links to web resources are
-associated with a footnote listing the complete web address
(URL).</paragraph><paragraph><emphasis>Step 2.</emphasis> Run
<literal>ptex2tex</literal> (if you have it) to make a standard LaTeX
file:</paragraph><literal_block xml:space="preserve">Terminal&gt; ptex2tex
mydoc</literal_block><paragraph>In case you do not have
<literal>ptex2tex</literal>, you may run a (very) simplified
version:</paragraph><literal_block xml:space="preserve">Terminal&gt;
doconce ptex2tex mydoc</literal_block><paragraph>Note that Doconce
generates a <literal>.p.tex</literal> file with some preprocessor macros
+associated with a footnote listing the complete web address (URL).
+The default, <literal>-DDEVICE=screen</literal>, creates a PDF file for
reading
+on a screen where links are
clickable.</paragraph><paragraph><emphasis>Step 2.</emphasis> Run
<literal>ptex2tex</literal> (if you have it) to make a standard LaTeX
file:</paragraph><literal_block xml:space="preserve">Terminal&gt; ptex2tex
mydoc</literal_block><paragraph>In case you do not have
<literal>ptex2tex</literal>, you may run a (very) simplified
version:</paragraph><literal_block xml:space="preserve">Terminal&gt;
doconce ptex2tex mydoc</literal_block><paragraph>Note that Doconce
generates a <literal>.p.tex</literal> file with some preprocessor macros
that can be used to steer certain properties of the LaTeX document.
For example, to turn on the Helvetica font instead of the standard
Computer Modern font, run:</paragraph><literal_block
xml:space="preserve">Terminal&gt; ptex2tex -DHELVETICA mydoc
@@ -392,7 +413,8 @@
implies the <literal>media9</literal> package and the
<literal>\includemedia</literal> command (default),
while other values are <literal>movie15</literal>
(<literal>\includemovie</literal> command),
<literal>multimedia</literal> (for Beamer-style <literal>\movie</literal>
command),
-or <literal>href-run</literal> (for the plain
<title_reference>h`run:file`_</title_reference>
command)</paragraph></list_item><list_item><paragraph><literal>PREAMBLE</literal>
to turn the LaTeX preamble on or off (i.e., complete document
+or <literal>href-run</literal> (for the plain
<title_reference>h`run:file`_</title_reference>
command)</paragraph></list_item><list_item><paragraph><literal>MOVIE_CONTROLS</literal>
adds buttons for starting/stopping movies if the
+<literal>media9</literal> package is
used.</paragraph></list_item><list_item><paragraph><literal>PREAMBLE</literal>
to turn the LaTeX preamble on or off (i.e., complete document
or document to be included elsewhere - and note that
the preamble is only included
if the document has a title, author, and
date)</paragraph></list_item><list_item><paragraph><literal>MINTED</literal>
for inclusion of the minted package for typesetting of
@@ -400,12 +422,7 @@
or <literal>pdflatex</literal> to be run with the
<literal>-shell-escape</literal>
option)</paragraph></list_item><list_item><paragraph><literal>TODONOTES</literal>
for using the fancy <literal>todonotes</literal> package for typesetting
inline comments (looks much like track changes in MS Word). This
macro has only effect if inline comments are used (name, colon,
-and comment inside
brackets).</paragraph></list_item><list_item><paragraph><literal>LINENUMBERS</literal>
for inclusion of line numbers in the
text.</paragraph></list_item><list_item><paragraph><literal>AMON</literal>
for setting the type of admonitions: <literal>&quot;colors&quot;</literal>
for colored
-boxes with icons, <literal>&quot;graybox1&quot;</literal> for gray frame
boxes with rounded
-corners (default), <literal>&quot;graybox2&quot;</literal> for narrower
square gray frame boxes
-(except for summary, which for A4 format is small and with wrapped
-text around if it does not contain verbatim code),
-or <literal>&quot;paragraph&quot;</literal> for simple, plain paragraph
headings and ordinary
text</paragraph></list_item><list_item><paragraph><literal>COLORED_TABLE_ROWS</literal>
for coloring every other table rows (set this
+and comment inside
brackets).</paragraph></list_item><list_item><paragraph><literal>LINENUMBERS</literal>
for inclusion of line numbers in the
text.</paragraph></list_item><list_item><paragraph><literal>COLORED_TABLE_ROWS</literal>
for coloring every other table rows (set this
variable to <literal>gray</literal> or
<literal>blue</literal>)</paragraph></list_item><list_item><paragraph><literal>BLUE_SECTION_HEADINGS</literal>
for blue section and subsection
headings</paragraph></list_item><list_item><paragraph><literal>LATEX_HEADING</literal>
for the typesetting of the title, author, parts of
preamble (values: <literal>traditional</literal> for traditional LaTeX
heading,
<literal>titlepage</literal> for a separate titlepage,
<literal>Springer_collection</literal> for
@@ -434,9 +451,15 @@
begin and end for blocks inside <literal>!bc fpro</literal> and
<literal>!ec</literal>). Specifying
<literal>envir=ans:nt</literal> means that all other environments are
typeset with the
<literal>anslistings.sty</literal> package, e.g., <literal>!bc
cppcod</literal> will then result in
-<literal>\begin{c++}</literal>. If no environments like
<literal>sys</literal>, <literal>fpro</literal>, or the common
-<literal>envir</literal> are defined on the command line, the plain
<literal>\begin{verbatim}</literal>
-and <literal>\end{verbatim}</literal>
used.</paragraph><paragraph><emphasis>Step 2b (optional).</emphasis> Edit
the <literal>mydoc.tex</literal> file to your needs.
+<literal>\begin{c++}</literal>. A predefined shortcut as in
<literal>shcod=Verbatim-0.85</literal>
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+<literal>shcod=Verbatim-indent</literal> implies indentation of the
verbatim text.
+Alternatively, one can provide all desired parameters
+<literal>\begin{Verbatim}</literal> instruction using the syntax
illustrated for
+the <literal>sys</literal> environments above.</paragraph><paragraph>If no
environments like <literal>sys</literal>, <literal>fpro</literal>, or the
common
+<literal>envir</literal> are defined on the command line, the plain
<literal>\begin{Verbatim}</literal>
+and <literal>\end{Verbatim}</literal> instructions are
used.</paragraph><paragraph><emphasis>Step 2b (optional).</emphasis> Edit
the <literal>mydoc.tex</literal> file to your needs.
For example, you may want to substitute <literal>section</literal> by
<literal>section*</literal> to
avoid numbering of sections, you may want to insert linebreaks
(and perhaps space) in the title, etc. This can be automatically
@@ -754,11 +777,6 @@
(this affects only `latex` output, where the appendix formatting
is used - all other formats just leave the heading as it is written).

-========= Example on a Chapter Heading =========
-
-Some text.
-
-
======= Example on a Section Heading =======

The running text goes here.
@@ -772,18 +790,24 @@

The running text goes here.

-__A Paragraph.__ The running text goes
here.</literal_block></section></section><section ids="special-lines-2"
names="special\ lines\ (2)"><title>Special Lines (2)</title><section
ids="figures" names="figures"><title>Figures</title><comment
xml:space="preserve">Note: need extra blank after FIGURE and MOVIE in !bc
environments</comment><comment xml:space="preserve">because doconce
treats !ec as part of the caption and moves the</comment><comment
xml:space="preserve">!ec up to the caption line</comment><paragraph>Figures
are recognized by the special line syntax:</paragraph><literal_block
xml:space="preserve">FIGURE:[filename, height=xxx width=yyy scale=zzz]
possible caption</literal_block><paragraph>The filename can be without
extension, and Doconce will search for an
+__A Paragraph.__ The running text goes
here.</literal_block></section></section><section ids="special-lines-2"
names="special\ lines\ (2)"><title>Special Lines (2)</title><section
ids="figures" names="figures"><title>Figures</title><comment
xml:space="preserve">Note: need extra blank after FIGURE and MOVIE in !bc
environments</comment><comment xml:space="preserve">because doconce
treats !ec as part of the caption and moves the</comment><comment
xml:space="preserve">!ec up to the caption line</comment><paragraph>Figures
are recognized by the special line syntax:</paragraph><literal_block
xml:space="preserve">FIGURE:[filename, height=400 width=600 frac=0.8]
caption</literal_block><paragraph>The filename can be without extension,
and Doconce will search for an
appropriate file with the right extension. If the extension is wrong,
say <literal>.eps</literal> when requesting an HTML format, Doconce tries
to find another
file, and if not, the given file is converted to a proper format
-(using ImageMagick's <literal>convert</literal>
utility).</paragraph><paragraph>The height, width, and scale keywords (and
others) can be included
-if desired and may have effect for some formats. Note the comma
-between the sespecifications and that there should be no space
-around the = sign.</paragraph><paragraph>Note also that, like for
<literal>TITLE:</literal> and <literal>AUTHOR:</literal> lines, all
information
+(using ImageMagick's <literal>convert</literal>
utility).</paragraph><paragraph>The height, width, and frac keywords can be
included
+if desired and may have effect for some formats: the height and width
+are used for output in the formats <literal>html</literal>,
<literal>rst</literal>, <literal>sphinx</literal>, while
+the frac specification is used for <literal>latex</literal> and
<literal>pdflatex</literal> to specify
+the width of the image as a fraction of the text
width.</paragraph><paragraph>The figure caption is optional. If omitted,
the figure appears &quot;inline&quot;
+in the text without any figure environment in LaTeX formats or HTML.
+The caption may contain a label for referencing the
figure.</paragraph><warning><paragraph>Note the comma
+between the filename and the figure size specifications and
+that there should be no space around the = sign. This syntax must
+be strictly followed.</paragraph><paragraph>Note also that, like for
<literal>TITLE:</literal> and <literal>AUTHOR:</literal> lines, all
information
related to a figure line <emphasis>must be written on the same
line</emphasis>. Introducing
newlines in a long caption will destroy the formatting (only the
part of the caption appearing on the same line as
<literal>FIGURE:</literal> will be
-included in the formatted caption).</paragraph><target
refid="fig-viz"/><figure ids="fig-viz" names="fig:viz"><image
uri="figs/streamtubes.png" width="400"/><caption><emphasis>Streamtube
visualization of a fluid flow</emphasis>
(fig:viz)</caption></figure><paragraph>Combining several image files into
one, in a table fashion, can be done by the
+included in the formatted caption).</paragraph></warning><target
refid="fig-viz"/><figure ids="fig-viz" names="fig:viz"><image
uri="figs/streamtubes.png" width="400"/><caption><emphasis>Streamtube
visualization of a fluid flow</emphasis>
(fig:viz)</caption></figure><paragraph>Combining several image files into
one, in a table fashion, can be done by the
<literal>montage</literal> program from the ImageMagick
suite:</paragraph><literal_block xml:space="preserve">montage -background
white -geometry 100% -tile 2x \
file1.png file2.png ... file4.png
result.png</literal_block><paragraph>The option <literal>-tile
XxY</literal> gives <literal>X</literal> figures in the horizontal
direction and
<literal>Y</literal> in the vertical direction (<literal>tile 2x</literal>
means two figures per row
@@ -812,9 +836,11 @@
You should equip the <literal>MOVIE:</literal> command with the right
width and height
of <emphasis>embedded</emphasis> YouTube and Vimeo movies. The recipe goes
as follows:</paragraph><enumerated_list enumtype="arabic" prefix=""
suffix="."><list_item><paragraph>click on <emphasis>Share</emphasis> (and
on YouTube then
<emphasis>Embed</emphasis>)</paragraph></list_item><list_item><paragraph>note
the height and width of the embedded
movie</paragraph></list_item></enumerated_list><paragraph>A typical
<literal>MOVIE</literal> command with a YouTube movie is
then:</paragraph><literal_block xml:space="preserve">MOVIE:
[http://www.youtube.com/watch?v=sI2uCHH3qIM, width=420 height=315]

-MOVIE: [http://vimeo.com/55562330, width=500 height=278] Computational
fluid dynamics movie.</literal_block><paragraph>Note that there must be a
blank line after every <literal>MOVIE:</literal> command.
+MOVIE: [http://vimeo.com/55562330, width=500 height=278]
CFD.</literal_block><paragraph>Note that there must be a blank line after
every <literal>MOVIE:</literal> command.
The width and height parameters are not required, but leaving them out
-may lead to movie sizes you do not want.</paragraph></section><section
ids="copying-computer-code-from-source-files" names="copying\ computer\
code\ from\ source\ files"><title>Copying Computer Code from Source
Files</title><paragraph>Another type of special lines starts with
<literal>@@@CODE</literal> and enables copying
+may lead to movie sizes you do not want.</paragraph><raw format="html"
xml:space="preserve">&lt;iframe width=&quot;420&quot;
height=&quot;315&quot;
src=&quot;http://www.youtube.com/embed/sI2uCHH3qIM&quot;
frameborder=&quot;0&quot; allowfullscreen&gt;&lt;/iframe&gt;</raw><raw
format="html" xml:space="preserve">&lt;iframe width=&quot;500&quot;
height=&quot;278&quot;
src=&quot;http://player.vimeo.com/video/55562330&quot;
frameborder=&quot;0&quot; allowfullscreen&gt;&lt;/iframe&gt;
+
+&lt;em&gt;CFD.&lt;/em&gt;</raw></section><section
ids="copying-computer-code-from-source-files" names="copying\ computer\
code\ from\ source\ files"><title>Copying Computer Code from Source
Files</title><paragraph>Another type of special lines starts with
<literal>@@@CODE</literal> and enables copying
of computer code from a file directly into a verbatim environment, see
the section <reference name="Blocks of Verbatim Computer Code"
refid="blocks-of-verbatim-computer-code">Blocks of Verbatim Computer
Code</reference> below.</paragraph><target
refid="inline-tagging"/></section><section ids="id4 inline-tagging"
names="inline\ tagging inline:tagging"><title>Inline
Tagging</title><paragraph>Doconce supports tags for <emphasis>emphasized
phrases</emphasis>, <strong>boldface phrases</strong>,
and <literal>verbatim text</literal> (also called type writer text, for
inline code),
@@ -1649,7 +1675,7 @@
(the main color of the slides) and <literal>Y</literal> is <reference
name="plain"
refuri="http://hplgit.github.io/teamods/doconce/demo/demo_red_plain.pdf">plain</reference><target
ids="plain" names="plain"
refuri="http://hplgit.github.io/teamods/doconce/demo/demo_red_plain.pdf"/>
for simple layout and
<reference name="shadow"
refuri="http://hplgit.github.io/teamods/doconce/demo/demo_blue_shadow.pdf">shadow</reference><target
ids="shadow" names="shadow"
refuri="http://hplgit.github.io/teamods/doconce/demo/demo_blue_shadow.pdf"/>
-for shadowed boxes and more visual structure in the
slides.</paragraph></section></section></section><section
ids="mako-programming" names="mako\ programming"><title>Mako
Programming</title><system_message backrefs="id15" level="2" line="3513"
source="manual.rst" type="WARNING"><paragraph>Duplicate explicit target
name: &quot;mako&quot;.</paragraph></system_message><paragraph>The
<reference name="Mako"
refuri="http://docs.makotemplates.org/">Mako</reference><target
dupnames="mako" ids="id15" refuri="http://docs.makotemplates.org/"/>
templating engine is used
+for shadowed boxes and more visual structure in the
slides.</paragraph></section></section></section><section
ids="mako-programming" names="mako\ programming"><title>Mako
Programming</title><system_message backrefs="id15" level="2" line="3586"
source="manual.rst" type="WARNING"><paragraph>Duplicate explicit target
name: &quot;mako&quot;.</paragraph></system_message><paragraph>The
<reference name="Mako"
refuri="http://docs.makotemplates.org/">Mako</reference><target
dupnames="mako" ids="id15" refuri="http://docs.makotemplates.org/"/>
templating engine is used
as preprocessor for Doconce documents, but the <reference
name="Preprocess"
refuri="http://code.google.com/p/preprocess">Preprocess</reference><target
dupnames="preprocess" ids="id16"
refuri="http://code.google.com/p/preprocess"/> is run prior to Mako and is
recommended for
including other files via <literal># #include
&quot;filename&quot;</literal>. Preprocess is also
sufficient for if-else tests to steer which parts of the text that
=======================================
--- /doc/demos/manual/manual_pdflatex.pdf Fri Jun 28 09:22:02 2013
+++ /doc/demos/manual/manual_pdflatex.pdf Sat Jul 13 00:16:44 2013
Binary file, no diff available.
=======================================
--- /doc/demos/quickref/html/.buildinfo Sat Mar 23 02:00:37 2013
+++ /doc/demos/quickref/html/.buildinfo Sat Jul 13 00:16:44 2013
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When
it is not found, a full rebuild will be done.
-config: e6de0e0cefa732423aa1a265b1f9c917
+config: 9ca91569b20bc2d4094df3d5df526c30
tags: fbb0d17656682115ca4d033fb2f83ba1
=======================================
--- /doc/demos/quickref/html/_sources/quickref.txt Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/html/_sources/quickref.txt Sat Jul 13 00:16:44 2013
@@ -5,7 +5,7 @@
-----------------------

:Author: Hans Petter Langtangen
-:Date: Jun 29, 2013
+:Date: Jul 13, 2013

**WARNING: This quick reference is very incomplete!**

@@ -518,7 +518,7 @@
.. code-block:: text


- FIGURE: [relative/path/to/figurefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}
+ FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here
goes the caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}

@@ -527,15 +527,24 @@

1. A mandatory comma after the figure/movie filename,

- 2. all of the command must appear on a single line,
+ 2. no comments between ``width``, ``height``, and ``frac`` and no spaces
+ around the ``=`` characters,

- 3. there must be a blank line after the command.
+ 3. all of the command must appear on a single line,
+
+ 4. there must be a blank line after the command.

The figure file can be listed without extension. Doconce will then find
the version of the file with the most appropriate extension for the chosen
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The ``width``
+and ``height`` parameters affect HTML formats (``html``, ``rst``,
``sphinx``),
+while ``frac`` is the width of the image as a fraction of the total text
+width in the ``latex`` and ``pdflatex`` formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/html/_static/pygments.css Fri Mar 8 04:26:55 2013
+++ /doc/demos/quickref/html/_static/pygments.css Sat Jul 13 00:16:44 2013
@@ -13,11 +13,11 @@
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
-.highlight .go { color: #303030 } /* Generic.Output */
+.highlight .go { color: #333333 } /* Generic.Output */
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading
*/
-.highlight .gt { color: #0040D0 } /* Generic.Traceback */
+.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /*
Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace
*/
=======================================
--- /doc/demos/quickref/html/_static/searchtools.js Fri Mar 8 04:26:55 2013
+++ /doc/demos/quickref/html/_static/searchtools.js Sat Jul 13 00:16:44 2013
@@ -301,7 +301,7 @@
},

query : function(query) {
- var stopwords =
["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
+ var stopwords =
["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"];

// Stem the searchterms and add them to the correct list
var stemmer = new Stemmer();
=======================================
--- /doc/demos/quickref/html/genindex.html Sun Apr 28 14:32:34 2013
+++ /doc/demos/quickref/html/genindex.html Sat Jul 13 00:16:44 2013
@@ -17,7 +17,7 @@

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
- URL_ROOT: './',
+ URL_ROOT: '',
VERSION: '0.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
@@ -98,7 +98,7 @@
</div>
<div class="footer">
&copy; Copyright 2013, HPL.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2pre.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
=======================================
--- /doc/demos/quickref/html/index.html Sun Apr 28 14:32:34 2013
+++ /doc/demos/quickref/html/index.html Sat Jul 13 00:16:44 2013
@@ -15,7 +15,7 @@

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
- URL_ROOT: './',
+ URL_ROOT: '',
VERSION: '0.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
@@ -148,7 +148,7 @@
</div>
<div class="footer">
&copy; Copyright 2013, HPL.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2pre.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
=======================================
--- /doc/demos/quickref/html/quickref.html Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/html/quickref.html Sat Jul 13 00:16:44 2013
@@ -15,7 +15,7 @@

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
- URL_ROOT: './',
+ URL_ROOT: '',
VERSION: '0.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
@@ -64,7 +64,7 @@
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Author:</th><td
class="field-body">Hans Petter Langtangen</td>
</tr>
-<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body">Jun 29, 2013</td>
+<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body">Jul 13, 2013</td>
</tr>
</tbody>
</table>
@@ -548,7 +548,7 @@
<div class="section" id="figures-and-movies">
<h1>Figures and Movies<a class="headerlink" href="#figures-and-movies"
title="Permalink to this headline">¶</a></h1>
<p>Figures and movies have almost equal syntax:</p>
-<div class="highlight-text"><div class="highlight"><pre>FIGURE:
[relative/path/to/figurefile, width=500] Here goes the caption which must
be on a single line. label{some:fig:label}
+<div class="highlight-text"><div class="highlight"><pre>FIGURE:
[relative/path/to/figurefile, width=500 frac=0.8] Here goes the caption
which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. label{some:fig:label}
</pre></div>
@@ -557,6 +557,8 @@
<blockquote>
<div><ol class="arabic simple">
<li>A mandatory comma after the figure/movie filename,</li>
+<li>no comments between <tt class="docutils literal"><span
class="pre">width</span></tt>, <tt class="docutils literal"><span
class="pre">height</span></tt>, and <tt class="docutils literal"><span
class="pre">frac</span></tt> and no spaces
+around the <tt class="docutils literal"><span class="pre">=</span></tt>
characters,</li>
<li>all of the command must appear on a single line,</li>
<li>there must be a blank line after the command.</li>
</ol>
@@ -565,6 +567,11 @@
the version of the file with the most appropriate extension for the chosen
output format. If not suitable version is found, Doconce will convert
another format to the needed one.</p>
+<p>The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The <tt
class="docutils literal"><span class="pre">width</span></tt>
+and <tt class="docutils literal"><span class="pre">height</span></tt>
parameters affect HTML formats (<tt class="docutils literal"><span
class="pre">html</span></tt>, <tt class="docutils literal"><span
class="pre">rst</span></tt>, <tt class="docutils literal"><span
class="pre">sphinx</span></tt>),
+while <tt class="docutils literal"><span class="pre">frac</span></tt> is
the width of the image as a fraction of the total text
+width in the <tt class="docutils literal"><span
class="pre">latex</span></tt> and <tt class="docutils literal"><span
class="pre">pdflatex</span></tt> formats.</p>
<p>Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.</p>
@@ -1122,7 +1129,7 @@
</div>
<div class="footer">
&copy; Copyright 2013, HPL.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2pre.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
=======================================
--- /doc/demos/quickref/html/search.html Sun Apr 28 14:32:34 2013
+++ /doc/demos/quickref/html/search.html Sat Jul 13 00:16:44 2013
@@ -15,7 +15,7 @@

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
- URL_ROOT: './',
+ URL_ROOT: '',
VERSION: '0.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
@@ -102,7 +102,7 @@
</div>
<div class="footer">
&copy; Copyright 2013, HPL.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2pre.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
=======================================
--- /doc/demos/quickref/html/searchindex.js Sat Jun 8 16:09:14 2013
+++ /doc/demos/quickref/html/searchindex.js Sat Jul 13 00:16:44 2013
@@ -1,1 +1,1 @@
-Search.setIndex({objects:{},terms:{all:0,code:[0,1],partial:0,illustr:0,thi:0,name1:0,dollar:0,"__summari":0,snip:0,ellips:0,dirnam:0,follow:0,moon:0,hierarch:0,cython:0,spellcheck:0,readabl:0,specif:0,rel:0,program:[0,1],matlab:0,under:0,preprocess:[0,1],extra_materi:0,gitdiff:0,norm:0,sourc:0,xpro:0,straightforward:0,bbl2rst:0,output_imag:0,util:0,table3:0,lrr:0,veri:0,han:0,exact:0,gwiki:0,md2html:0,level:0,noalign:0,list:[0,1],item:0,combine_imag:0,math:0,plain:0,quick:[0,1],refer:[0,1],dir:0,work:0,monospac:0,cfg:0,newcommands_replac:0,direct:0,sign:0,tex:0,second:0,video:0,ipynb:0,pmb:0,further:0,do_file2:0,replace_from_fil:0,index:[0,1],what:0,appear:0,dept:0,item2:0,item3:0,section:[0,1],item1:0,anywai:0,current:0,abbrevi:0,version:0,bibfil:0,remove_inline_com:0,net:0,"public":0,full:0,deriv:0,gener:[0,1],slides_beam:0,here:0,subex:0,let:0,path:0,becom:0,modifi:0,valu:0,box:0,search:1,ptex2tex:0,def:0,action:0,cwiki:0,slidecel:0,configur:0,extra:0,appli:0,modul:1,filenam:0,unix:0,txt:0,univ:0,unit:0,regex:0,plot:0,from:0,regist:0,two:0,todai:0,next:0,doconc:[0,1],formul:0,recommend:0,gwiki_figsubst:0,type:[0,1],start:0,more:0,desir:0,peopl:0,relat:0,problem:0,notic:0,newcommand:0,warn:0,rootdir:0,appendix:0,name2:0,accept:0,examin:0,particular:0,mylogo:0,automake_sphinx:0,effort:0,must:0,tabular:0,none:0,word:0,restor:0,setup:0,outlin:0,smallskip:0,other:0,paragraph:0,can:0,split_rst:0,eenvirnam:0,purpos:0,aliv:0,ehint:0,latexfil:0,give:0,process:0,backslash:0,indic:[0,1],topic:0,somefil:0,liter:0,want:0,phrase:0,standard:0,prece:0,benvirnam:0,subitem1:0,alwai:0,subitem2:0,end:0,turn:0,oslo:0,ordinari:0,spreadsheet:0,snippet:0,how:0,figurefil:0,answer:0,subproject:0,perspect:0,sin:0,regener:0,resourc:[0,1],referenc:0,"_o7iuiftbku":0,clone:0,after:0,spot:0,reflect:0,befor:0,notebook:0,date:[0,1],multipl:0,underscor:0,data:0,parallel:0,physic:0,"short":0,practic:0,"__head":0,footer:0,dotal:0,mwiki:0,element:0,inform:0,preced:0,environ:[0,1],outout:0,allow:0,anoth:0,testdoc:0,epydoc:0,dmint:0,behav:0,help:0,ellipsearea1:0,movi:[0,1],gradual:0,over:0,mission:0,keyword3:0,paper:0,comma:0,myfil:0,latex_exercise_toc:0,write:0,style:0,render:0,fit:0,latex_head:0,chosen:0,fix:0,segfault:0,html:0,fig:0,onc:0,comprehens:0,main:0,non:0,"return":0,python:0,sentenc:0,sphinxfix_localurl:0,dat:0,half:0,petter:0,csv:0,name:0,edit:0,simpl:0,separ:0,easili:0,slide:0,list_label:0,each:0,found:0,pygment:0,pdflatex:0,citat:[0,1],map:0,laboratori:0,individu:0,year:0,recogn:0,special:0,out:0,space:0,goe:0,publish:0,research:0,content:[0,1],sphinx_dir:0,suitabl:0,creolo:0,reader:0,print:0,formula:0,subsubsect:0,ref:0,red:0,common:0,multilin:0,author_yyyi:0,insid:0,advanc:0,situat:0,guess:0,pub:0,parenthesi:0,headlin:0,small:0,base:0,put:0,companion:0,output_fil:0,bash:0,feb:0,indent:0,veloc:0,script:0,caption:0,perhap:0,place:0,outsid:0,onto:0,frequent:0,first:0,directli:0,blogger:0,independ:0,qualiti:0,number:0,biomed:0,mai:0,done:0,"__abstract":0,blank:0,fanci:0,differ:0,dump:0,convent:0,pandoc:0,without_answ:0,messag:0,latexdiff:0,too:0,statement:0,similarli:0,toc:0,john:0,cite:0,store:0,forthcom:0,shell:0,consol:0,option:0,tool:0,copi:0,bsubex:0,specifi:0,cyb:0,github:0,enclos:0,termin:0,rst:0,simula:0,larg:0,than:0,png:0,md2latex:0,wide:0,kind:0,third:0,keyword:[0,1],provid:0,remov:0,tree:0,emac:[0,1],"final":0,project:0,latex_foot:0,admonit:0,seri:0,sai:0,comput:[0,1],doconce_program:0,pro:0,argument:0,dash:0,packag:0,have:0,tabl:[0,1],need:0,bhint:0,mint:0,verbatim:[0,1],wolframalpha:0,latter:0,table4:0,note:0,also:0,exampl:0,which:0,combin:0,do_file3:0,institution2:0,noth:0,singl:0,institution1:0,diffprog:0,begin:0,sure:0,distribut:0,mytab:0,pdiff:0,csv2tabl:0,endif:0,frac:0,kan:0,most:0,regular:0,exer:0,pair:0,sub:0,tradit:0,latex:[0,1],todonot:0,latin1:0,make_figure_code_link:0,url:0,doc:0,adopt:0,typeset:0,pipe:0,dummi:0,declar:0,bibtex:0,exp:0,databas:0,consqut:0,"___sec2":0,left:0,preambl:0,notion:0,translat:0,show:0,text:0,skip_inline_com:0,verbos:0,sublist:0,syntax:[0,1],mediawiki:0,"_boldface_":0,session:0,font:0,fine:0,find:0,cell:0,onli:0,kept:0,layout:0,pretti:0,explain:0,writer:0,activ:0,figur:[0,1],should:0,theme:0,tune:0,footnot:0,local:0,old2new_format:0,meant:0,variou:0,get:0,moviefil:0,xcod:0,express:0,watch:0,ellipse_area1_sol:0,subexer_a:0,subexer_b:0,outlet:0,increas:0,keyword2:0,keyword1:0,youtub:0,requir:0,bar:0,enabl:0,cppcod:0,author1_etal_yyyi:0,book:0,integr:0,contain:0,ban:0,through:0,grab:0,where:0,summari:0,wiki:0,set:0,creller:0,frame:0,see:0,mandatori:0,result:0,horizont:0,latin2html:0,best:0,kei:0,profession:0,pattern:0,wikipedia:0,label:[0,1],written:0,between:0,"import":0,approach:0,email:0,accord:0,extend:0,clean:0,dtotonot:0,extens:0,entir:0,preprocessor:0,extent:0,highlight:0,ipython:0,come:0,embed:0,aim:0,both:0,last:0,delimit:0,howev:0,nabla:0,equal:0,slide_typ:0,etc:0,instanc:0,equat:0,sketch:0,logic:0,mani:0,com:0,subexercis:0,load:0,acceler:0,markdown:0,color:0,doconcefil:0,pop:0,walk:0,header:0,pycod:0,respect:0,assum:0,summar:0,blog:0,ultim:[0,1],vertic:0,fortran:0,numpi:0,three:0,empti:0,structuredtext:0,much:0,besid:0,treat:0,interest:0,"abstract":0,emphas:0,imag:0,xxx:0,hline:0,convert:0,epytext:0,ani:0,insertdocstr:0,former:0,present:0,allips:0,"case":0,ugli:0,multi:0,ident:0,thesi:0,look:0,raw:0,vimeo:0,align:0,envirnam:0,trick:0,defin:0,"while":0,abov:0,report:0,margin:0,subsect:0,propag:0,utilz:0,ctrl:0,almost:0,them:0,player:0,itself:0,docnam:0,ascii:0,sever:0,mako:0,latex_dislik:0,develop:0,author:[0,1],perform:0,make:0,belong:0,same:0,handl:0,tutori:0,split:0,myotherdoc:0,mydoc:0,document:0,bring:0,complet:0,ifram:0,http:0,slides_html:0,charact:0,esubex:0,effect:0,hand:0,capabl:[0,1],student:0,pdf:0,extern:0,robust:0,typic:0,expand:0,moondist:0,appropri:0,least:0,center:0,macro:0,markup:[0,1],well:0,difflib:0,off:0,without:0,command:0,kaar:0,multicolumn:0,choos:0,esol:0,everyth:0,usual:0,comment:[0,1],construct:0,identifi:0,just:0,less:0,when:0,wikibook:0,rest:0,without_solut:0,via:0,human:0,ifdef:0,cod:0,kdiff3:0,sphinxfix_local_url:0,languag:[0,1],web:0,langtangen:0,adr:0,easi:0,hint:0,restructuredtext:0,makefil:0,except:0,shortcut:0,informat:0,framebord:0,add:0,cyberspac:0,bibliographi:[0,1],exercis:[0,1],primit:0,els:0,determin:0,match:0,around:0,format:[0,1],read:0,hpl:0,bib:0,boldfac:0,distanc:0,enivor:0,grid:0,fromto:0,background:0,part:0,height:0,mydict:0,table2:0,insert:0,expand_command:0,like:0,success:0,cdot:0,brace:0,manual:0,necessari:0,either:0,"_static":0,complete_fil:0,colon:0,page:[0,1],yyyi:0,www:0,right:0,often:0,short_titl:0,some:0,back:0,understood:0,intern:0,enumer:0,diff:0,proper:0,home:0,googl:0,montag:0,shcod:0,avoid:0,cut:0,per:0,whole:0,subproblem:0,substitut:0,mathemat:[0,1],change_encod:0,select:0,mode:0,plu:0,run:0,usag:0,tables2csv:0,solut:0,step:0,bbl:0,output:0,image2:0,image1:0,chapter:0,src:0,actual:0,fix_bibtex4publish:0,column:0,restructredtext:0,slightli:0,surround:0,manag:0,split_html:0,allowfullscreen:0,stand:0,backup:0,produc:0,block:0,file3:0,file2:0,file1:0,own:0,dextra:0,devic:0,inlin:[0,1],within:0,encod:0,sol:0,bsol:0,chang:0,perl:0,occupi:0,git:0,institut:0,wai:0,area:0,support:[0,1],question:0,transform:0,"long":0,custom:0,guess_encod:0,width:0,subst:0,wordpress:0,includ:0,lot:0,replac:0,icon:0,analysi:0,head:0,form:0,ean:0,jun:0,author1_author2_yyyi:0,substutit:0,diffus:0,link:0,ethz:0,ellipse_area:0,line:[0,1],highest:0,untag:0,utf:0,do_fil:0,consist:0,possibl:0,"default":0,googlecod:0,displai:0,directori:0,below:0,those:0,otherwis:0,externaldocu:0,similar:0,curv:0,featur:0,creat:0,certain:0,dure:0,subsec:0,repres:0,incomplet:0,intro:0,file:0,logo:0,doe:0,check:0,inc:0,assembl:0,again:0,tick:0,somenam:0,quot:0,titl:[0,1],eremark:0,excel:0,detail:0,latex2doconc:0,valid:0,table_x:0,varieti:0,test:0,newcommands_keep:0,nice:0,reller:0,wildcard:0,symbol:0,remove_exercise_answ:0,docstr:0,bremark:0,beamer:0,html_colorbullet:0,sphinx:0,bullet:0,anywher:0,descript:0,rule:0,portion:0,time:0,cpp:0,teamod:0,shpro:0,name3:0},objtypes:{},titles:["Doconce
Quick
Reference","On an Ultimate Markup
Language"],objnames:{},filenames:["quickref","index"]})
+Search.setIndex({objects:{},terms:{all:0,code:[0,1],partial:0,illustr:0,thi:0,name1:0,dollar:0,"__summari":0,snip:0,ellips:0,dirnam:0,follow:0,moon:0,hierarch:0,cython:0,spellcheck:0,readabl:0,specif:0,rel:0,program:[0,1],matlab:0,under:0,preprocess:[0,1],extra_materi:0,gitdiff:0,norm:0,sourc:0,xpro:0,straightforward:0,bbl2rst:0,output_imag:0,util:0,table3:0,lrr:0,veri:0,affect:0,exact:0,gwiki:0,md2html:0,level:0,noalign:0,list:[0,1],item:0,combine_imag:0,math:0,plain:0,quick:[0,1],refer:[0,1],dir:0,work:0,monospac:0,cfg:0,newcommands_replac:0,direct:0,sign:0,tex:0,second:0,video:0,ipynb:0,pmb:0,further:0,do_file2:0,replace_from_fil:0,index:[0,1],what:0,appear:0,dept:0,item2:0,item3:0,section:[0,1],item1:0,anywai:0,current:0,abbrevi:0,version:0,bibfil:0,remove_inline_com:0,net:0,"public":0,full:0,deriv:0,gener:[0,1],slides_beam:0,here:0,subex:0,let:0,path:0,becom:0,modifi:0,valu:0,box:0,search:1,ptex2tex:0,def:0,action:0,cwiki:0,slidecel:0,configur:0,extra:0,appli:0,modul:1,filenam:0,unix:0,txt:0,univ:0,unit:0,regex:0,plot:0,from:0,regist:0,two:0,todai:0,next:0,doconc:[0,1],formul:0,recommend:0,gwiki_figsubst:0,type:[0,1],start:0,more:0,desir:0,peopl:0,relat:0,problem:0,notic:0,newcommand:0,warn:0,rootdir:0,appendix:0,name2:0,accept:0,examin:0,particular:0,mylogo:0,automake_sphinx:0,effort:0,must:0,tabular:0,none:0,word:0,restor:0,setup:0,outlin:0,smallskip:0,other:0,paragraph:0,can:0,split_rst:0,eenvirnam:0,purpos:0,aliv:0,ehint:0,latexfil:0,give:0,process:0,backslash:0,indic:[0,1],topic:0,somefil:0,liter:0,want:0,phrase:0,standard:0,prece:0,benvirnam:0,subitem1:0,alwai:0,subitem2:0,end:0,turn:0,oslo:0,ordinari:0,spreadsheet:0,snippet:0,how:0,figurefil:0,consist:0,answer:0,subproject:0,perspect:0,sin:0,regener:0,resourc:[0,1],referenc:0,"_o7iuiftbku":0,clone:0,after:0,spot:0,reflect:0,befor:0,notebook:0,date:[0,1],multipl:0,underscor:0,data:0,parallel:0,physic:0,"short":0,practic:0,"__head":0,footer:0,dotal:0,mwiki:0,element:0,inform:0,preced:0,environ:[0,1],outout:0,allow:0,anoth:0,testdoc:0,epydoc:0,dmint:0,behav:0,help:0,ellipsearea1:0,movi:[0,1],gradual:0,over:0,mission:0,keyword3:0,paper:0,comma:0,myfil:0,paramet:0,latex_exercise_toc:0,write:0,style:0,render:0,fit:0,latex_head:0,chosen:0,fix:0,segfault:0,html:0,fig:0,onc:0,comprehens:0,main:0,non:0,"return":0,python:0,sentenc:0,sphinxfix_localurl:0,dat:0,half:0,petter:0,csv:0,name:0,edit:0,simpl:0,separ:0,easili:0,slide:0,list_label:0,each:0,found:0,pygment:0,pdflatex:0,citat:[0,1],map:0,laboratori:0,individu:0,year:0,recogn:0,special:0,out:0,space:0,goe:0,publish:0,research:0,content:[0,1],sphinx_dir:0,suitabl:0,creolo:0,reader:0,print:0,formula:0,subsubsect:0,ref:0,red:0,common:0,multilin:0,author_yyyi:0,insid:0,advanc:0,situat:0,guess:0,pub:0,parenthesi:0,headlin:0,small:0,base:0,put:0,companion:0,output_fil:0,bash:0,feb:0,indent:0,veloc:0,omit:0,caption:0,perhap:0,place:0,outsid:0,onto:0,frequent:0,first:0,directli:0,blogger:0,independ:0,qualiti:0,number:0,biomed:0,mai:0,done:0,"__abstract":0,blank:0,fanci:0,differ:0,dump:0,convent:0,pandoc:0,without_answ:0,messag:0,latexdiff:0,too:0,statement:0,similarli:0,toc:0,john:0,cite:0,store:0,forthcom:0,shell:0,consol:0,option:0,tool:0,copi:0,bsubex:0,specifi:0,cyb:0,github:0,enclos:0,termin:0,rst:0,simula:0,larg:0,than:0,png:0,md2latex:0,wide:0,kind:0,third:0,keyword:[0,1],provid:0,remov:0,tree:0,emac:[0,1],"final":0,project:0,latex_foot:0,admonit:0,seri:0,sai:0,comput:[0,1],doconce_program:0,pro:0,argument:0,dash:0,packag:0,have:0,tabl:[0,1],need:0,bhint:0,mint:0,verbatim:[0,1],wolframalpha:0,latter:0,table4:0,note:0,also:0,exampl:0,which:0,combin:0,do_file3:0,institution2:0,noth:0,singl:0,institution1:0,diffprog:0,begin:0,sure:0,distribut:0,mytab:0,pdiff:0,csv2tabl:0,endif:0,frac:0,kan:0,most:0,regular:0,exer:0,pair:0,sub:0,tradit:0,latex:[0,1],todonot:0,latin1:0,make_figure_code_link:0,url:0,doc:0,adopt:0,typeset:0,pipe:0,dummi:0,declar:0,bibtex:0,exp:0,databas:0,consqut:0,"___sec2":0,left:0,preambl:0,notion:0,translat:0,show:0,text:0,skip_inline_com:0,verbos:0,sublist:0,syntax:[0,1],mediawiki:0,"_boldface_":0,session:0,font:0,fine:0,find:0,cell:0,onli:0,kept:0,layout:0,pretti:0,explain:0,writer:0,activ:0,figur:[0,1],should:0,theme:0,tune:0,footnot:0,local:0,old2new_format:0,meant:0,variou:0,get:0,moviefil:0,xcod:0,express:0,watch:0,ellipse_area1_sol:0,subexer_a:0,subexer_b:0,outlet:0,increas:0,keyword2:0,keyword1:0,youtub:0,requir:0,bar:0,enabl:0,cppcod:0,author1_etal_yyyi:0,book:0,integr:0,contain:0,ban:0,through:0,grab:0,where:0,summari:0,wiki:0,set:0,creller:0,frame:0,latex_dislik:0,see:0,mandatori:0,result:0,charact:0,latin2html:0,best:0,kei:0,profession:0,pattern:0,wikipedia:0,label:[0,1],written:0,between:0,"import":0,approach:0,email:0,accord:0,extend:0,clean:0,dtotonot:0,extens:0,entir:0,preprocessor:0,extent:0,highlight:0,ipython:0,come:0,embed:0,aim:0,both:0,last:0,delimit:0,howev:0,nabla:0,equal:0,slide_typ:0,etc:0,instanc:0,equat:0,sketch:0,logic:0,mani:0,com:0,subexercis:0,load:0,acceler:0,markdown:0,color:0,doconcefil:0,pop:0,walk:0,header:0,pycod:0,respect:0,assum:0,summar:0,blog:0,ultim:[0,1],vertic:0,framebord:0,numpi:0,three:0,empti:0,structuredtext:0,much:0,besid:0,treat:0,interest:0,"abstract":0,emphas:0,imag:0,xxx:0,hline:0,convert:0,epytext:0,ani:0,insertdocstr:0,former:0,present:0,allips:0,"case":0,ugli:0,multi:0,ident:0,thesi:0,look:0,raw:0,vimeo:0,align:0,envirnam:0,trick:0,defin:0,"while":0,abov:0,report:0,margin:0,subsect:0,propag:0,utilz:0,ctrl:0,almost:0,them:0,player:0,itself:0,docnam:0,ascii:0,sever:0,mako:0,horizont:0,develop:0,author:[0,1],perform:0,make:0,belong:0,same:0,handl:0,tutori:0,split:0,myotherdoc:0,mydoc:0,document:0,bring:0,complet:0,ifram:0,http:0,slides_html:0,esubex:0,effect:0,hand:0,capabl:[0,1],student:0,pdf:0,extern:0,robust:0,typic:0,expand:0,moondist:0,appropri:0,least:0,center:0,macro:0,markup:[0,1],well:0,difflib:0,off:0,without:0,command:0,kaar:0,multicolumn:0,choos:0,esol:0,everyth:0,usual:0,comment:[0,1],construct:0,identifi:0,just:0,less:0,when:0,wikibook:0,rest:0,without_solut:0,via:0,human:0,ifdef:0,cod:0,kdiff3:0,sphinxfix_local_url:0,languag:[0,1],web:0,langtangen:0,adr:0,easi:0,hint:0,restructuredtext:0,makefil:0,except:0,shortcut:0,informat:0,script:0,add:0,cyberspac:0,bibliographi:[0,1],exercis:[0,1],primit:0,els:0,determin:0,match:0,around:0,format:[0,1],read:0,hpl:0,bib:0,boldfac:0,distanc:0,enivor:0,grid:0,fromto:0,background:0,part:0,height:0,mydict:0,table2:0,insert:0,expand_command:0,like:0,success:0,cdot:0,brace:0,manual:0,necessari:0,either:0,"_static":0,complete_fil:0,colon:0,page:[0,1],yyyi:0,www:0,right:0,often:0,short_titl:0,some:0,back:0,understood:0,intern:0,enumer:0,diff:0,proper:0,home:0,googl:0,total:0,montag:0,shcod:0,avoid:0,cut:0,per:0,whole:0,subproblem:0,substitut:0,mathemat:[0,1],change_encod:0,select:0,mode:0,plu:0,run:0,usag:0,tables2csv:0,solut:0,step:0,bbl:0,output:0,image2:0,image1:0,chapter:0,src:0,actual:0,fix_bibtex4publish:0,column:0,restructredtext:0,slightli:0,surround:0,manag:0,split_html:0,allowfullscreen:0,stand:0,mean:0,backup:0,produc:0,block:0,file3:0,file2:0,file1:0,own:0,dextra:0,devic:0,inlin:[0,1],within:0,encod:0,sol:0,bsol:0,chang:0,perl:0,occupi:0,git:0,institut:0,wai:0,area:0,support:[0,1],question:0,transform:0,"long":0,custom:0,guess_encod:0,width:0,subst:0,wordpress:0,includ:0,fraction:0,replac:0,icon:0,analysi:0,head:0,form:0,ean:0,fortran:0,jul:0,author1_author2_yyyi:0,substutit:0,diffus:0,link:0,ethz:0,ellipse_area:0,line:[0,1],highest:0,untag:0,utf:0,do_fil:0,han:0,possibl:0,"default":0,googlecod:0,displai:0,directori:0,below:0,those:0,otherwis:0,externaldocu:0,similar:0,curv:0,featur:0,creat:0,certain:0,dure:0,subsec:0,repres:0,incomplet:0,intro:0,file:0,logo:0,doe:0,check:0,inc:0,assembl:0,again:0,tick:0,somenam:0,quot:0,titl:[0,1],eremark:0,excel:0,detail:0,latex2doconc:0,valid:0,table_x:0,varieti:0,test:0,newcommands_keep:0,nice:0,reller:0,wildcard:0,symbol:0,remove_exercise_answ:0,docstr:0,bremark:0,beamer:0,html_colorbullet:0,sphinx:0,bullet:0,anywher:0,lot:0,descript:0,rule:0,portion:0,time:0,cpp:0,teamod:0,shpro:0,name3:0},objtypes:{},titles:["Doconce
Quick
Reference","On an Ultimate Markup
Language"],objnames:{},filenames:["quickref","index"]})
=======================================
--- /doc/demos/quickref/quickref.cwiki Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.cwiki Sat Jul 13 00:16:44 2013
@@ -1,7 +1,7 @@
#summary Doconce Quick Reference
<wiki:toc max_depth="2" />
By **Hans Petter Langtangen**
-=== Jun 29, 2013 ===
+=== Jul 13, 2013 ===

<<TableOfContents>>

@@ -432,7 +432,7 @@

Figures and movies have almost equal syntax:
{{{
-FIGURE: [relative/path/to/figurefile, width=500] Here goes the caption
which must be on a single line. label{some:fig:label}
+FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here goes the
caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. label{some:fig:label}

@@ -441,6 +441,7 @@


# A mandatory comma after the figure/movie filename,
+ # no comments between {{{width}}}, {{{height}}}, and {{{frac}}} and no
spaces around the {{{=}}} characters,
# all of the command must appear on a single line,
# there must be a blank line after the command.

@@ -449,6 +450,12 @@
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The {{{width}}}
+and {{{height}}} parameters affect HTML formats ({{{html}}}, {{{rst}}},
{{{sphinx}}}),
+while {{{frac}}} is the width of the image as a fraction of the total text
+width in the {{{latex}}} and {{{pdflatex}}} formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.do.txt Wed May 29 03:39:51 2013
+++ /doc/demos/quickref/quickref.do.txt Sat Jul 13 00:16:44 2013
@@ -433,7 +433,7 @@

Figures and movies have almost equal syntax:
!bc
-FIGURE: [relative/path/to/figurefile, width=500] Here goes the caption
which must be on a single line. label{some:fig:label}
+FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here goes the
caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. label{some:fig:label}

@@ -441,6 +441,8 @@
Note three important syntax details:

o A mandatory comma after the figure/movie filename,
+ o no comments between `width`, `height`, and `frac` and no spaces
+ around the `=` characters,
o all of the command must appear on a single line,
o there must be a blank line after the command.

@@ -449,6 +451,12 @@
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The `width`
+and `height` parameters affect HTML formats (`html`, `rst`, `sphinx`),
+while `frac` is the width of the image as a fraction of the total text
+width in the `latex` and `pdflatex` formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.epytext Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.epytext Sat Jul 13 00:16:44 2013
@@ -1,6 +1,6 @@
TITLE: Doconce Quick Reference
BY: Hans Petter Langtangen (Center for Biomedical Computing, Simula
Research Laboratory, and Department of Informatics, University of Oslo)
-DATE: Jun 29, 2013
+DATE: Jul 13, 2013
B{WARNING: This quick reference is very incomplete!}

I{Mission.} Enable writing documentation with much mathematics and
@@ -452,7 +452,7 @@
Figures and movies have almost equal syntax::


- FIGURE: [relative/path/to/figurefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}
+ FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here
goes the caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}

@@ -460,14 +460,22 @@
Note three important syntax details:

1. A mandatory comma after the figure/movie filename,
- 2. all of the command must appear on a single line,
- 3. there must be a blank line after the command.
+ 2. no comments between C{width}, C{height}, and C{frac} and no spaces
+ around the C{=} characters,
+ 3. all of the command must appear on a single line,
+ 4. there must be a blank line after the command.

The figure file can be listed without extension. Doconce will then find
the version of the file with the most appropriate extension for the chosen
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The C{width}
+and C{height} parameters affect HTML formats (C{html}, C{rst}, C{sphinx}),
+while C{frac} is the width of the image as a fraction of the total text
+width in the C{latex} and C{pdflatex} formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.gwiki Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.gwiki Sat Jul 13 00:16:44 2013
@@ -1,7 +1,7 @@
#summary Doconce Quick Reference

By *Hans Petter Langtangen*
-==== Jun 29, 2013 ====
+==== Jul 13, 2013 ====

<wiki: toc max_depth="2" />

@@ -430,7 +430,7 @@

Figures and movies have almost equal syntax:
{{{
-FIGURE: [relative/path/to/figurefile, width=500] Here goes the caption
which must be on a single line. label{some:fig:label}
+FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here goes the
caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. label{some:fig:label}

@@ -439,6 +439,7 @@


# A mandatory comma after the figure/movie filename,
+ # no comments between `width`, `height`, and `frac` and no spaces
around the `=` characters,
# all of the command must appear on a single line,
# there must be a blank line after the command.

@@ -447,6 +448,12 @@
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The `width`
+and `height` parameters affect HTML formats (`html`, `rst`, `sphinx`),
+while `frac` is the width of the image as a fraction of the total text
+width in the `latex` and `pdflatex` formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.html Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.html Sat Jul 13 00:16:44 2013
@@ -41,7 +41,7 @@
-webkit-border-radius: 4px; -moz-border-radius: 4px;
border-radius: 4px
color: #555;
- background-color: whiteSmoke;
+ background-color: #f8f8f8;
background-position: 10px 5px;
background-repeat: no-repeat;
background-size: 38px;
@@ -132,7 +132,7 @@
<center>[1] <b>Center for Biomedical Computing, Simula Research
Laboratory</b></center>
<center>[2] <b>Department of Informatics, University of Oslo</b></center>
<p>
-<center><h4>Jun 29, 2013</h4></center> <!-- date -->
+<center><h4>Jul 13, 2013</h4></center> <!-- date -->

<h2>Table of contents</h2>

@@ -671,7 +671,7 @@
<p>
Figures and movies have almost equal syntax:
<!-- begin verbatim block -->
-<pre><code>FIGURE: [relative/path/to/figurefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}
+<pre><code>FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here
goes the caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. label{some:fig:label}

@@ -683,6 +683,8 @@

<ol>
<li> A mandatory comma after the figure/movie filename,</li>
+ <li> no comments between <code>width</code>, <code>height</code>, and
<code>frac</code> and no spaces
+ around the <code>=</code> characters,</li>
<li> all of the command must appear on a single line,</li>
<li> there must be a blank line after the command.</li>
</ol>
@@ -692,6 +694,13 @@
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+<p>
+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The
<code>width</code>
+and <code>height</code> parameters affect HTML formats (<code>html</code>,
<code>rst</code>, <code>sphinx</code>),
+while <code>frac</code> is the width of the image as a fraction of the
total text
+width in the <code>latex</code> and <code>pdflatex</code> formats.
+
<p>
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
=======================================
--- /doc/demos/quickref/quickref.md Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.md Sat Jul 13 00:16:44 2013
@@ -1,6 +1,6 @@
% Doconce Quick Reference
% Hans Petter Langtangen at Center for Biomedical Computing, Simula
Research Laboratory and Department of Informatics, University of Oslo
-% Jun 29, 2013
+% Jul 13, 2013

<!-- Table of contents: Run pandoc with --toc option -->

@@ -485,7 +485,7 @@
Figures and movies have almost equal syntax:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-FIGURE: [relative/path/to/figurefile, width=500] Here goes the caption
which must be on a single line. \label{some:fig:label}
+FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here goes the
caption which must be on a single line. \label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. \label{some:fig:label}

@@ -495,15 +495,24 @@

1. A mandatory comma after the figure/movie filename,

- 2. all of the command must appear on a single line,
+ 2. no comments between `width`, `height`, and `frac` and no spaces
+ around the `=` characters,

- 3. there must be a blank line after the command.
+ 3. all of the command must appear on a single line,
+
+ 4. there must be a blank line after the command.

The figure file can be listed without extension. Doconce will then find
the version of the file with the most appropriate extension for the chosen
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The `width`
+and `height` parameters affect HTML formats (`html`, `rst`, `sphinx`),
+while `frac` is the width of the image as a fraction of the total text
+width in the `latex` and `pdflatex` formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.mwiki Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.mwiki Sat Jul 13 00:16:44 2013
@@ -1,7 +1,7 @@
#TITLE (actually governed by the filename): Doconce Quick Reference

By '''Hans Petter Langtangen'''
-==== Jun 29, 2013 ====
+==== Jul 13, 2013 ====

__TOC__

@@ -460,7 +460,7 @@

Figures and movies have almost equal syntax:
<syntaxhighlight lang="text">
-FIGURE: [relative/path/to/figurefile, width=500] Here goes the caption
which must be on a single line. label{some:fig:label}
+FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here goes the
caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. label{some:fig:label}

@@ -470,6 +470,8 @@

<ol>
<li> A mandatory comma after the figure/movie filename,
+ <li> no comments between <code>width</code>, <code>height</code>, and
<code>frac</code> and no spaces
+ around the <code>=</code> characters,
<li> all of the command must appear on a single line,
<li> there must be a blank line after the command.
</ol>
@@ -479,6 +481,12 @@
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The
<code>width</code>
+and <code>height</code> parameters affect HTML formats (<code>html</code>,
<code>rst</code>, <code>sphinx</code>),
+while <code>frac</code> is the width of the image as a fraction of the
total text
+width in the <code>latex</code> and <code>pdflatex</code> formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.p.tex Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.p.tex Sat Jul 13 00:16:44 2013
@@ -110,10 +110,11 @@
% #endif

% Hyperlinks in PDF:
+\definecolor{linkcolor}{rgb}{0,0,0.4}
\usepackage[%
colorlinks=true,
- linkcolor=blue,
- urlcolor=blue,
+ linkcolor=linkcolor,
+ urlcolor=linkcolor,
citecolor=black,
filecolor=black,
%filecolor=blue,
@@ -162,10 +163,10 @@

% Admonition is an oval gray box
\newmdenv[
- backgroundcolor=gray!10, %% white with 10%% gray
+ backgroundcolor=gray!5, %% white with 5%% gray
skipabove=\topsep,
skipbelow=\topsep,
- outerlinewidth=0.5,
+ outerlinewidth=0,
leftmargin=0,
rightmargin=0,
roundcorner=5,
@@ -309,16 +310,16 @@


% #if LATEX_HEADING == "traditional"
-\date{Jun 29, 2013}
+\date{Jul 13, 2013}
\maketitle
% #elif LATEX_HEADING == "beamer"
-\date{Jun 29, 2013
+\date{Jul 13, 2013
% <titlepage figure>
}
% #elif LATEX_HEADING == "titlepage"

\ \\ [10mm]
-{\large\textsf{Jun 29, 2013}}
+{\large\textsf{Jul 13, 2013}}

\end{center}
\vfill
@@ -326,7 +327,7 @@

% #else
\begin{center}
-Jun 29, 2013
+Jul 13, 2013
\end{center}

\vspace{1cm}
@@ -810,6 +811,7 @@
also allow advanced {\LaTeX} features and fine tuning of resulting
PDF document.
\end{graybox1admon}
+
\paragraph{LaTeX Newcommands.}
The author can define \code{newcommand} statements in files with names
\code{newcommands*.tex}. Such commands should only be used for mathematics
@@ -827,7 +829,7 @@

Figures and movies have almost equal syntax:
\bccq
-FIGURE: [relative/path/to/figurefile, width=500] Here goes the caption
which must be on a single line. label{some:fig:label}
+FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here goes the
caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. label{some:fig:label}

@@ -837,6 +839,9 @@
\begin{enumerate}
\item A mandatory comma after the figure/movie filename,

+ \item no comments between \code{width}, \code{height}, and \code{frac}
and no spaces
+ around the \code{=} characters,
+
\item all of the command must appear on a single line,

\item there must be a blank line after the command.
@@ -848,6 +853,12 @@
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or {\LaTeX} formats). The
\code{width}
+and \code{height} parameters affect HTML formats (\code{html}, \code{rst},
\code{sphinx}),
+while \code{frac} is the width of the image as a fraction of the total text
+width in the \code{latex} and \code{pdflatex} formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.pdf Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.pdf Sat Jul 13 00:16:44 2013
Binary file, no diff available.
=======================================
--- /doc/demos/quickref/quickref.rst Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.rst Sat Jul 13 00:16:44 2013
@@ -5,7 +5,7 @@
-----------------------

:Author: Hans Petter Langtangen
-:Date: Jun 29, 2013
+:Date: Jul 13, 2013

.. contents:: Table of Contents
:depth: 2
@@ -489,7 +489,7 @@
Figures and movies have almost equal syntax::


- FIGURE: [relative/path/to/figurefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}
+ FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here
goes the caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}

@@ -498,15 +498,24 @@

1. A mandatory comma after the figure/movie filename,

- 2. all of the command must appear on a single line,
+ 2. no comments between ``width``, ``height``, and ``frac`` and no spaces
+ around the ``=`` characters,

- 3. there must be a blank line after the command.
+ 3. all of the command must appear on a single line,
+
+ 4. there must be a blank line after the command.

The figure file can be listed without extension. Doconce will then find
the version of the file with the most appropriate extension for the chosen
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The ``width``
+and ``height`` parameters affect HTML formats (``html``, ``rst``,
``sphinx``),
+while ``frac`` is the width of the image as a fraction of the total text
+width in the ``latex`` and ``pdflatex`` formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.rst.html Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.rst.html Sat Jul 13 00:16:44 2013
@@ -327,7 +327,7 @@
<tbody valign="top">
<tr class="field"><th class="field-name">Author:</th><td
class="field-body">Hans Petter Langtangen</td>
</tr>
-<tr class="field"><th class="field-name">Date:</th><td
class="field-body">Jun 29, 2013</td>
+<tr class="field"><th class="field-name">Date:</th><td
class="field-body">Jul 13, 2013</td>
</tr>
</tbody>
</table>
@@ -845,7 +845,7 @@
<h1><a class="toc-backref" href="#id12">Figures and Movies</a></h1>
<p>Figures and movies have almost equal syntax:</p>
<pre class="literal-block">
-FIGURE: [relative/path/to/figurefile, width=500] Here goes the caption
which must be on a single line. label{some:fig:label}
+FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here goes the
caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. label{some:fig:label}
</pre>
@@ -853,6 +853,8 @@
<blockquote>
<ol class="arabic simple">
<li>A mandatory comma after the figure/movie filename,</li>
+<li>no comments between <tt class="docutils literal">width</tt>, <tt
class="docutils literal">height</tt>, and <tt class="docutils
literal">frac</tt> and no spaces
+around the <tt class="docutils literal">=</tt> characters,</li>
<li>all of the command must appear on a single line,</li>
<li>there must be a blank line after the command.</li>
</ol>
@@ -861,6 +863,11 @@
the version of the file with the most appropriate extension for the chosen
output format. If not suitable version is found, Doconce will convert
another format to the needed one.</p>
+<p>The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The <tt
class="docutils literal">width</tt>
+and <tt class="docutils literal">height</tt> parameters affect HTML
formats (<tt class="docutils literal">html</tt>, <tt class="docutils
literal">rst</tt>, <tt class="docutils literal">sphinx</tt>),
+while <tt class="docutils literal">frac</tt> is the width of the image as
a fraction of the total text
+width in the <tt class="docutils literal">latex</tt> and <tt
class="docutils literal">pdflatex</tt> formats.</p>
<p>Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.</p>
=======================================
--- /doc/demos/quickref/quickref.rst.pdf Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.rst.pdf Sat Jul 13 00:16:44 2013
Binary file, no diff available.
=======================================
--- /doc/demos/quickref/quickref.rst.tex Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.rst.tex Sat Jul 13 00:16:44 2013
@@ -75,7 +75,7 @@
Hans Petter Langtangen

\item[{Date:}]
-Jun 29, 2013
+Jul 13, 2013

\end{DUfieldlist}

@@ -896,7 +896,7 @@
Figures and movies have almost equal syntax:
%
\begin{quote}{\ttfamily \raggedright \noindent
-FIGURE:~{[}relative/path/to/figurefile,~width=500{]}~Here~goes~the~caption~which~must~be~on~a~single~line.~label\{some:fig:label\}\\
+FIGURE:~{[}relative/path/to/figurefile,~width=500~frac=0.8{]}~Here~goes~the~caption~which~must~be~on~a~single~line.~label\{some:fig:label\}\\
~\\

MOVIE:~{[}relative/path/to/moviefile,~width=500{]}~Here~goes~the~caption~which~must~be~on~a~single~line.~label\{some:fig:label\}
}
@@ -914,6 +914,9 @@

\item A mandatory comma after the figure/movie filename,

+\item no comments between \texttt{width}, \texttt{height}, and
\texttt{frac} and no spaces
+around the \texttt{=} characters,
+
\item all of the command must appear on a single line,

\item there must be a blank line after the command.
@@ -926,6 +929,12 @@
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The
\texttt{width}
+and \texttt{height} parameters affect HTML formats (\texttt{html},
\texttt{rst}, \texttt{sphinx}),
+while \texttt{frac} is the width of the image as a fraction of the total
text
+width in the \texttt{latex} and \texttt{pdflatex} formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.st Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.st Sat Jul 13 00:16:44 2013
@@ -1,6 +1,6 @@
TITLE: Doconce Quick Reference
BY: Hans Petter Langtangen (Center for Biomedical Computing, Simula
Research Laboratory, and Department of Informatics, University of Oslo)
-DATE: Jun 29, 2013
+DATE: Jul 13, 2013
**WARNING: This quick reference is very incomplete!**

*Mission.* Enable writing documentation with much mathematics and
@@ -436,7 +436,7 @@
Figures and movies have almost equal syntax::


- FIGURE: [relative/path/to/figurefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}
+ FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here
goes the caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}

@@ -444,14 +444,22 @@
Note three important syntax details:

1. A mandatory comma after the figure/movie filename,
- 2. all of the command must appear on a single line,
- 3. there must be a blank line after the command.
+ 2. no comments between 'width', 'height', and 'frac' and no spaces
+ around the '=' characters,
+ 3. all of the command must appear on a single line,
+ 4. there must be a blank line after the command.

The figure file can be listed without extension. Doconce will then find
the version of the file with the most appropriate extension for the chosen
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The 'width'
+and 'height' parameters affect HTML formats ('html', 'rst', 'sphinx'),
+while 'frac' is the width of the image as a fraction of the total text
+width in the 'latex' and 'pdflatex' formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.tex Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.tex Sat Jul 13 00:16:44 2013
@@ -34,10 +34,11 @@
\renewcommand\familydefault{phv}

% Hyperlinks in PDF:
+\definecolor{linkcolor}{rgb}{0,0,0.4}
\usepackage[%
colorlinks=true,
- linkcolor=blue,
- urlcolor=blue,
+ linkcolor=linkcolor,
+ urlcolor=linkcolor,
citecolor=black,
filecolor=black,
%filecolor=blue,
@@ -72,10 +73,10 @@

% Admonition is an oval gray box
\newmdenv[
- backgroundcolor=gray!10, %% white with 10%% gray
+ backgroundcolor=gray!5, %% white with 5%% gray
skipabove=\topsep,
skipbelow=\topsep,
- outerlinewidth=0.5,
+ outerlinewidth=0,
leftmargin=0,
rightmargin=0,
roundcorner=5,
@@ -140,7 +141,7 @@


\begin{center}
-Jun 29, 2013
+Jul 13, 2013
\end{center}

\vspace{1cm}
@@ -243,7 +244,7 @@
A typical example of giving a title, a set of authors, a date,
and an optional table of contents
reads
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
TITLE: On an Ultimate Markup Language
AUTHOR: H. P. Langtangen at Center for Biomedical Computing, Simula
Research Laboratory & Dept. of Informatics, Univ. of Oslo
AUTHOR: Kaare Dump Email: du...@cyb.space.com at Segfault, Cyberspace Inc.
@@ -253,7 +254,7 @@
\end{Verbatim}
The entire title must appear on a single line.
The author syntax is
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
name Email: some...@adr.net at institution1 & institution2
\end{Verbatim}
where the email is optional, the "at" keyword is required if one or
@@ -308,7 +309,7 @@
\emph{emphasized words}. Similarly, an underscore surrounds words that
appear in boldface: \Verb!_boldface_! becomes \textbf{boldface}. Colored
words
are also possible: the text
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
`color{red}{two red words}`
\end{Verbatim}
becomes \textcolor{red}{two red words}.
@@ -320,7 +321,7 @@
consqutive numbers,
and \emph{description} lists, where each item starts with \Verb!-! followed
by a keyword and a colon.
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Here is a bullet list:

* item1
@@ -436,7 +437,7 @@
Inline comments meant as messages or notes, to authors during development
in particular,
are enabled by the syntax
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
[name: running text]
\end{Verbatim}
where \Verb!name! is the name or ID of an author or reader making the
comment,
@@ -450,7 +451,7 @@
make it very easy to spot the comments.

Running
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
doconce format html mydoc.do.txt --skip_inline_comments
\end{Verbatim}
removes all inline comments from the output. This feature makes it easy
@@ -458,14 +459,14 @@

All inline comments to readers can also be physically
removed from the Doconce source by
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
doconce remove_inline_comments mydoc.do.txt
\end{Verbatim}

\subsection{Verbatim/Computer Code}

Inline verbatim code is typeset within back-ticks, as in
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Some sentence with `words in verbatim style`.
\end{Verbatim}
resulting in Some sentence with \Verb!words in verbatim style!.
@@ -484,7 +485,7 @@
\Verb!pl! for Perl. For output in \Verb!latex! one can let \Verb!xxx!
reflect any
defined verbatim environment in the \Verb!ptex2tex! configuration file
(\Verb!.ptex2tex.cfg!). For \Verb!sphinx! output one can insert a comment
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
# sphinx code-blocks: pycod=python cod=fortran cppcod=c++ sys=console
\end{Verbatim}
that maps environments (\Verb!xxx!) onto valid language types for
@@ -497,7 +498,7 @@
Here is an example of computer code (see the source of this document
for exact syntax):

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
from numpy import sin, cos, exp, pi

def f(x, y, z, t):
@@ -507,7 +508,7 @@
% When showing copy from file in !bc envir, indent a character - otherwise
% ptex2tex is confused and starts copying...
Computer code can also be copied from a file:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
@@@CODE doconce_program.sh
@@@CODE doconce_program.sh fromto: doconce clean@^doconce split_rst
@@@CODE doconce_program.sh from-to: doconce clean@^doconce split_rst
@@ -554,7 +555,7 @@
$Ax=b$. To help increase readability in other formats than \Verb!sphinx!,
\Verb!latex!, and \Verb!pdflatex!, inline mathematics may have a more human
readable companion expression. The syntax is like
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
$\sin(\norm{\bf u})$|$sin(||u||)$
\end{Verbatim}
That is, the {\LaTeX} expression appears to the left of a vertical bar
(pipe
@@ -566,7 +567,7 @@
and
\Verb!!et! (begin/end TeX) directives starting on the beginning of a line:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
!bt
\begin{align*}
\nabla\cdot \pmb{u} &= 0,\\
@@ -583,7 +584,7 @@
\end{align*}
Here is a single equation:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
!bt
\[ \frac{\partial\pmb{u}}{\partial t} + \pmb{u}\cdot\nabla\pmb{u} = 0.\]
!et
@@ -620,6 +621,7 @@
also allow advanced {\LaTeX} features and fine tuning of resulting
PDF document.
\end{graybox1admon}
+
\paragraph{LaTeX Newcommands.}
The author can define \Verb!newcommand! statements in files with names
\Verb!newcommands*.tex!. Such commands should only be used for mathematics
@@ -636,8 +638,8 @@
\subsection{Figures and Movies}

Figures and movies have almost equal syntax:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
-FIGURE: [relative/path/to/figurefile, width=500] Here goes the caption
which must be on a single line. label{some:fig:label}
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
+FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here goes the
caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line. label{some:fig:label}

@@ -647,6 +649,9 @@
\begin{enumerate}
\item A mandatory comma after the figure/movie filename,

+ \item no comments between \Verb!width!, \Verb!height!, and \Verb!frac!
and no spaces
+ around the \Verb!=! characters,
+
\item all of the command must appear on a single line,

\item there must be a blank line after the command.
@@ -658,12 +663,18 @@
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or {\LaTeX} formats). The
\Verb!width!
+and \Verb!height! parameters affect HTML formats (\Verb!html!, \Verb!rst!,
\Verb!sphinx!),
+while \Verb!frac! is the width of the image as a fraction of the total text
+width in the \Verb!latex! and \Verb!pdflatex! formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.

Combining several image files into one can be done by the
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
doconce combine_images image1 image2 ... output_image
\end{Verbatim}
This command applies \Verb!montage! or PDF-based tools to combine the
images
@@ -672,7 +683,7 @@
YouTube and Vimeo movies will be embedded in \Verb!html! and \Verb!sphinx!
documents
and otherwise be represented by a link. The syntax is

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
MOVIE: [http://www.youtube.com/watch?v=_O7iUiftbKU, width=420 height=315]
YouTube movie.

MOVIE: [http://vimeo.com/55562330, width=500 height=278] Vimeo movie.
@@ -687,7 +698,7 @@

The table in Section~\ref{quick:sections} was written with this
syntax:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
|----------------c--------|------------------c--------------------|
| Section type | Syntax |
|----------------l--------|------------------l--------------------|
@@ -734,7 +745,7 @@
is adopted
from {\LaTeX} with a very similar syntax. As in {\LaTeX}, a label can be
inserted anywhere, using the syntax
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
label{name}
\end{Verbatim}
with no backslash
@@ -744,7 +755,7 @@
\Verb!c! is some name for the particular unit that has a label.

A reference to the label \Verb!name! is written as
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
ref{name}
\end{Verbatim}
again with no backslash before \Verb!ref!.
@@ -757,7 +768,7 @@
\subsection{Citations and Bibliography}

Single citations are written as
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
cite{name}
\end{Verbatim}
where \Verb!name! is a logical name
@@ -767,7 +778,7 @@
\Verb!YYYY! is the year of the publication.
Multiple citations at once is possible by separating the logical names
by comma:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
cite{name1,name2,name3}
\end{Verbatim}

@@ -787,7 +798,7 @@
to work with many small, independent documents in parallel with
a book assembly of some of the small elements.
The syntax of a generalized reference is
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
ref[internal][cite][external]

# Example:
@@ -812,7 +823,7 @@
Doconce supports creating an index of keywords. A certain keyword
is registered for the index by a syntax like (no
backslash!)
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
index{name}
\end{Verbatim}
It is recommended to place any index of this type outside
@@ -828,7 +839,7 @@
transforming a \Verb!.do.txt! file to some format. Here is the
list of capabilities:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
Usage: doconce command [optional arguments]
commands: format help sphinx_dir subst replace replace_from_file clean
spellcheck ptex2tex expand_commands combine_images guess_encoding
change_encoding gwiki_figsubst md2html remove_inline_comments grab remove
remove_exercise_answers split_rst split_html slides_html slides_beamer
latin2html latex_header latex_footer bbl2rst html_colorbullets list_labels
teamod sphinxfix_localURLs make_figure_code_links latex_exercise_toc
insertdocstr old2new_format latex2doconce latex_dislikes pygmentize
makefile diff gitdiff fix_bibtex4publish csv2table

@@ -999,7 +1010,7 @@

\noindent
A typical sketch of a a problem without subexercises goes as follows:
-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
===== Problem: Derive the Formula for the Area of an Ellipse =====
label{problem:ellipsearea1}
file=ellipse_area.pdf
@@ -1022,7 +1033,7 @@
is enclosed in braces, the type is left out of the title in the
output. For example, the if the title line above reads

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
===== {Problem}: Derive the Formula for the Area of an Ellipse =====
\end{Verbatim}
the title becomes just "Derive the ...".
@@ -1030,7 +1041,7 @@
An exercise with subproblems, answers and full solutions has this
setup-up:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
===== Exercise: Determine the Distance to the Moon =====
label{exer:moondist}

@@ -1127,7 +1138,7 @@
document, "comment out" a large portion of text, and to write
format-specific
constructions:

-\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.85,xleftmargin=0mm]
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
# #include "myotherdoc.do.txt"

# #if FORMAT in ("latex", "pdflatex")
=======================================
--- /doc/demos/quickref/quickref.txt Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.txt Sat Jul 13 00:16:44 2013
@@ -6,7 +6,7 @@
[1] Center for Biomedical Computing, Simula Research Laboratory
[2] Department of Informatics, University of Oslo

-Date: Jun 29, 2013
+Date: Jul 13, 2013

Table of contents:

@@ -504,7 +504,7 @@
Figures and movies have almost equal syntax::


- FIGURE: [relative/path/to/figurefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}
+ FIGURE: [relative/path/to/figurefile, width=500 frac=0.8] Here
goes the caption which must be on a single line. label{some:fig:label}

MOVIE: [relative/path/to/moviefile, width=500] Here goes the
caption which must be on a single line. label{some:fig:label}

@@ -513,15 +513,24 @@

1. A mandatory comma after the figure/movie filename,

- 2. all of the command must appear on a single line,
+ 2. no comments between width, height, and frac and no spaces
+ around the = characters,

- 3. there must be a blank line after the command.
+ 3. all of the command must appear on a single line,
+
+ 4. there must be a blank line after the command.

The figure file can be listed without extension. Doconce will then find
the version of the file with the most appropriate extension for the chosen
output format. If not suitable version is found, Doconce will convert
another format to the needed one.

+The caption is optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The width
+and height parameters affect HTML formats (html, rst, sphinx),
+while frac is the width of the image as a fraction of the total text
+width in the latex and pdflatex formats.
+
Movie files can either be a video or a wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a movie.
=======================================
--- /doc/demos/quickref/quickref.xml Sat Jun 29 07:54:16 2013
+++ /doc/demos/quickref/quickref.xml Sat Jul 13 00:16:44 2013
@@ -2,7 +2,7 @@
<!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils
Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd">
<!-- Generated by Docutils 0.9 -->
<document source="quickref.rst"><comment
xml:space="preserve">Automatically generated reST file from Doconce source
-(http://code.google.com/p/doconce/)</comment><section
ids="doconce-quick-reference" names="doconce\ quick\ reference"><title
refid="id1">Doconce Quick
Reference</title><field_list><field><field_name>Author</field_name><field_body><paragraph>Hans
Petter
Langtangen</paragraph></field_body></field><field><field_name>Date</field_name><field_body><paragraph>Jun
29, 2013</paragraph></field_body></field></field_list><topic
classes="contents" ids="table-of-contents" names="table\ of\
contents"><title>Table of
Contents</title><bullet_list><list_item><paragraph><reference ids="id1"
refid="doconce-quick-reference">Doconce Quick
Reference</reference></paragraph></list_item><list_item><paragraph><reference
ids="id2" refid="supported-formats">Supported
Formats</reference></paragraph></list_item><list_item><paragraph><reference
ids="id3" refid="emacs-syntax-support">Emacs syntax
support</reference></paragraph></list_item><list_item><paragraph><reference
ids="id4" refid="title-authors-and-date">Title, Authors, and
Date</reference></paragraph></list_item><list_item><paragraph><reference
ids="id5" refid="section-types">Section
Types</reference></paragraph></list_item><list_item><paragraph><reference
ids="id6" refid="inline-formatting">Inline
Formatting</reference></paragraph></list_item><list_item><paragraph><reference
ids="id7"
refid="lists">Lists</reference></paragraph></list_item><list_item><paragraph><reference
ids="id8" refid="comment-lines">Comment
lines</reference></paragraph></list_item><list_item><paragraph><reference
ids="id9" refid="inline-comments">Inline
comments</reference></paragraph></list_item><list_item><paragraph><reference
ids="id10" refid="verbatim-computer-code">Verbatim/Computer
Code</reference></paragraph></list_item><list_item><paragraph><reference
ids="id11" refid="latex-mathematics">LaTeX
Mathematics</reference></paragraph></list_item><list_item><paragraph><reference
ids="id12" refid="figures-and-movies">Figures and
Movies</reference></paragraph></list_item><list_item><paragraph><reference
ids="id13"
refid="tables">Tables</reference></paragraph></list_item><list_item><paragraph><reference
ids="id14" refid="labels-and-references">Labels and
References</reference></paragraph></list_item><list_item><paragraph><reference
ids="id15" refid="citations-and-bibliography">Citations and
Bibliography</reference></paragraph></list_item><list_item><paragraph><reference
ids="id16" refid="generalized-citations">Generalized
Citations</reference></paragraph></list_item><list_item><paragraph><reference
ids="id17" refid="index-of-keywords">Index of
Keywords</reference></paragraph></list_item><list_item><paragraph><reference
ids="id18" refid="capabilities-of-the-program-doconce">Capabilities of The
Program
<literal>doconce</literal></reference></paragraph></list_item><list_item><paragraph><reference
ids="id19"
refid="exercises">Exercises</reference></paragraph></list_item><list_item><paragraph><reference
ids="id20"
refid="environments">Environments</reference></paragraph></list_item><list_item><paragraph><reference
ids="id21"
refid="preprocessing">Preprocessing</reference></paragraph></list_item><list_item><paragraph><reference
ids="id22"
refid="resources">Resources</reference></paragraph></list_item></bullet_list></topic><paragraph><strong>WARNING:
This quick reference is very
incomplete!</strong></paragraph><paragraph><emphasis>Mission.</emphasis>
Enable writing documentation with much mathematics and
+(http://code.google.com/p/doconce/)</comment><section
ids="doconce-quick-reference" names="doconce\ quick\ reference"><title
refid="id1">Doconce Quick
Reference</title><field_list><field><field_name>Author</field_name><field_body><paragraph>Hans
Petter
Langtangen</paragraph></field_body></field><field><field_name>Date</field_name><field_body><paragraph>Jul
13, 2013</paragraph></field_body></field></field_list><topic
classes="contents" ids="table-of-contents" names="table\ of\
contents"><title>Table of
Contents</title><bullet_list><list_item><paragraph><reference ids="id1"
refid="doconce-quick-reference">Doconce Quick
Reference</reference></paragraph></list_item><list_item><paragraph><reference
ids="id2" refid="supported-formats">Supported
Formats</reference></paragraph></list_item><list_item><paragraph><reference
ids="id3" refid="emacs-syntax-support">Emacs syntax
support</reference></paragraph></list_item><list_item><paragraph><reference
ids="id4" refid="title-authors-and-date">Title, Authors, and
Date</reference></paragraph></list_item><list_item><paragraph><reference
ids="id5" refid="section-types">Section
Types</reference></paragraph></list_item><list_item><paragraph><reference
ids="id6" refid="inline-formatting">Inline
Formatting</reference></paragraph></list_item><list_item><paragraph><reference
ids="id7"
refid="lists">Lists</reference></paragraph></list_item><list_item><paragraph><reference
ids="id8" refid="comment-lines">Comment
lines</reference></paragraph></list_item><list_item><paragraph><reference
ids="id9" refid="inline-comments">Inline
comments</reference></paragraph></list_item><list_item><paragraph><reference
ids="id10" refid="verbatim-computer-code">Verbatim/Computer
Code</reference></paragraph></list_item><list_item><paragraph><reference
ids="id11" refid="latex-mathematics">LaTeX
Mathematics</reference></paragraph></list_item><list_item><paragraph><reference
ids="id12" refid="figures-and-movies">Figures and
Movies</reference></paragraph></list_item><list_item><paragraph><reference
ids="id13"
refid="tables">Tables</reference></paragraph></list_item><list_item><paragraph><reference
ids="id14" refid="labels-and-references">Labels and
References</reference></paragraph></list_item><list_item><paragraph><reference
ids="id15" refid="citations-and-bibliography">Citations and
Bibliography</reference></paragraph></list_item><list_item><paragraph><reference
ids="id16" refid="generalized-citations">Generalized
Citations</reference></paragraph></list_item><list_item><paragraph><reference
ids="id17" refid="index-of-keywords">Index of
Keywords</reference></paragraph></list_item><list_item><paragraph><reference
ids="id18" refid="capabilities-of-the-program-doconce">Capabilities of The
Program
<literal>doconce</literal></reference></paragraph></list_item><list_item><paragraph><reference
ids="id19"
refid="exercises">Exercises</reference></paragraph></list_item><list_item><paragraph><reference
ids="id20"
refid="environments">Environments</reference></paragraph></list_item><list_item><paragraph><reference
ids="id21"
refid="preprocessing">Preprocessing</reference></paragraph></list_item><list_item><paragraph><reference
ids="id22"
refid="resources">Resources</reference></paragraph></list_item></bullet_list></topic><paragraph><strong>WARNING:
This quick reference is very
incomplete!</strong></paragraph><paragraph><emphasis>Mission.</emphasis>
Enable writing documentation with much mathematics and
computer code <emphasis>once, in one place</emphasis> and include it in
traditional LaTeX
books, thesis, and reports, and without extra efforts also make
professionally looking web versions with Sphinx or HTML. Other outlets
@@ -181,12 +181,17 @@
LaTeX code. This conventions helps make readable documents in formats
without LaTeX support. For <literal>html</literal>,
<literal>sphinx</literal>, <literal>latex</literal>,
<literal>pdflatex</literal>,
<literal>mwiki</literal>, <literal>ipynb</literal>, and
<literal>pandoc</literal>, the mathematics in newcommands is
-rendered nicely anyway.</paragraph></section><section
ids="figures-and-movies" names="figures\ and\ movies"><title
refid="id12">Figures and Movies</title><paragraph>Figures and movies have
almost equal syntax:</paragraph><literal_block xml:space="preserve">FIGURE:
[relative/path/to/figurefile, width=500] Here goes the caption which must
be on a single line. label{some:fig:label}
+rendered nicely anyway.</paragraph></section><section
ids="figures-and-movies" names="figures\ and\ movies"><title
refid="id12">Figures and Movies</title><paragraph>Figures and movies have
almost equal syntax:</paragraph><literal_block xml:space="preserve">FIGURE:
[relative/path/to/figurefile, width=500 frac=0.8] Here goes the caption
which must be on a single line. label{some:fig:label}

-MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line.
label{some:fig:label}</literal_block><paragraph>Note three important syntax
details:</paragraph><block_quote><enumerated_list enumtype="arabic"
prefix="" suffix="."><list_item><paragraph>A mandatory comma after the
figure/movie filename,</paragraph></list_item><list_item><paragraph>all of
the command must appear on a single
line,</paragraph></list_item><list_item><paragraph>there must be a blank
line after the
command.</paragraph></list_item></enumerated_list></block_quote><paragraph>The
figure file can be listed without extension. Doconce will then find
+MOVIE: [relative/path/to/moviefile, width=500] Here goes the caption which
must be on a single line.
label{some:fig:label}</literal_block><paragraph>Note three important syntax
details:</paragraph><block_quote><enumerated_list enumtype="arabic"
prefix="" suffix="."><list_item><paragraph>A mandatory comma after the
figure/movie filename,</paragraph></list_item><list_item><paragraph>no
comments between <literal>width</literal>, <literal>height</literal>, and
<literal>frac</literal> and no spaces
+around the <literal>=</literal>
characters,</paragraph></list_item><list_item><paragraph>all of the command
must appear on a single
line,</paragraph></list_item><list_item><paragraph>there must be a blank
line after the
command.</paragraph></list_item></enumerated_list></block_quote><paragraph>The
figure file can be listed without extension. Doconce will then find
the version of the file with the most appropriate extension for the chosen
output format. If not suitable version is found, Doconce will convert
-another format to the needed one.</paragraph><paragraph>Movie files can
either be a video or a wildcard expression for a
+another format to the needed one.</paragraph><paragraph>The caption is
optional. If omitted, the figure will be inlined (meaning
+no use of any figure environment in HTML or LaTeX formats). The
<literal>width</literal>
+and <literal>height</literal> parameters affect HTML formats
(<literal>html</literal>, <literal>rst</literal>,
<literal>sphinx</literal>),
+while <literal>frac</literal> is the width of the image as a fraction of
the total text
+width in the <literal>latex</literal> and <literal>pdflatex</literal>
formats.</paragraph><paragraph>Movie files can either be a video or a
wildcard expression for a
series of frames. In the latter case, a simple device in an HTML page
will display the individual frame files as a
movie.</paragraph><paragraph>Combining several image files into one can be
done by the:</paragraph><literal_block xml:space="preserve">doconce
combine_images image1 image2 ...
output_image</literal_block><paragraph>This command applies
<literal>montage</literal> or PDF-based tools to combine the images
to get the highest quality.</paragraph><paragraph>YouTube and Vimeo movies
will be embedded in <literal>html</literal> and <literal>sphinx</literal>
documents
=======================================
--- /doc/demos/tutorial/html/.buildinfo Wed Apr 24 00:37:11 2013
+++ /doc/demos/tutorial/html/.buildinfo Sat Jul 13 00:16:44 2013
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When
it is not found, a full rebuild will be done.
-config: 0c6960c214e5fe7098e381772c391ca4
+config: f33a9f59b7ba655d7d818a5236ad21e7
tags: fbb0d17656682115ca4d033fb2f83ba1
=======================================
--- /doc/demos/tutorial/html/_sources/tutorial.txt Wed May 29 03:57:30 2013
+++ /doc/demos/tutorial/html/_sources/tutorial.txt Sat Jul 13 00:16:44 2013
@@ -6,7 +6,7 @@
========================================

:Author: Hans Petter Langtangen
-:Date: May 29, 2013
+:Date: Jul 13, 2013

* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -436,7 +436,7 @@
As see in Figure ref{mysec:fig:myfig}, the key equation
features large, smooth regions *and* abrupt changes.

- FIGURE: [fig/myfile, width=600] My figure. label{mysec:fig:myfig}
+ FIGURE: [fig/myfile, width=600 frac=0.9] My figure.
label{mysec:fig:myfig}

===== References =====

@@ -457,7 +457,7 @@
=============================

Transformation of a Doconce document ``mydoc.do.txt`` to various other
-formats applies the script ``doconce format``:
+formats apply the script ``doconce format``:

.. code-block:: console

@@ -562,6 +562,9 @@
HTML
----

+Basics
+~~~~~~
+
Making an HTML version of a Doconce file ``mydoc.do.txt``
is performed by

@@ -571,6 +574,23 @@

The resulting file ``mydoc.html`` can be loaded into any web browser for
viewing.

+Typesetting of Code
+~~~~~~~~~~~~~~~~~~~
+
+If the Pygments package (including the ``pygmentize`` program)
+is installed, code blocks are typeset with
+aid of this package. The command-line argument ``--no_pygments_html``
+turns off the use of Pygments and makes code blocks appear with
+plain (``pre``) HTML tags. The option ``--pygments_html_linenos`` turns
+on line numbers in Pygments-formatted code blocks. A specific
+Pygments style is set by ``--pygments_html_style=style``, where ``style``
+can be ``default``, ``emacs``, ``perldoc``, and other valid names for
+Pygments styles.
+
+
+HTML Styles
+~~~~~~~~~~~
+
The HTML style can be defined either in the header of the HTML file,
using a named built-in style;
in an external CSS file; or in a template file.
@@ -593,22 +613,15 @@
links to the CSS stylesheet in ``filename``. Several stylesheets can
be specified: ``--ccs=file1.css,file2.css,file3.css``.

+HTML templates
+~~~~~~~~~~~~~~
+
Templates are HTML files with "slots" ``%(main)s`` for the main body
of text, ``%(title)s`` for the title, and ``%(date)s`` for the date.
Doconce comes with a few templates. The usage of templates is
described in a `separate document
<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>`_. That
document describes how you your Doconce-generated
HTML file can have any specified layout.

-If the Pygments package (including the ``pygmentize`` program)
-is installed, code blocks are typeset with
-aid of this package. The command-line argument ``--no_pygments_html``
-turns off the use of Pygments and makes code blocks appear with
-plain (``pre``) HTML tags. The option ``--pygments_html_linenos`` turns
-on line numbers in Pygments-formatted code blocks. A specific
-Pygments style is set by ``--pygments_html_style=style``, where ``style``
-can be ``default``, ``emacs``, ``perldoc``, and other valid names for
-Pygments styles.
-
The HTML file can be embedded in a template with your own tailored
design, see a "tutorial": "
`<https://doconce.googlecode.com/hg/doc/design/wrapper_tech.html>`_" on
this topic. The template file must contain
valid HTML code and can have three "slots": ``%(title)s`` for a title,
@@ -634,6 +647,40 @@
that are used if the document contains ``!split`` commands for splitting
it into many pages.

+The HTML File Collection
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are usually a range of files needed for an HTML document arising
+from a Doconce source. The needed files are listed in
+``.basename_html_file_collection``, where ``basename`` is the filestem of
+the Doconce file (i.e., the Doconce source is in ``basename.do.txt``).
+
+Filenames
+~~~~~~~~~
+
+An HTML version of a Doconce document is often made in different styles,
+calling for a need to rename the HTML output file. This is conveniently
+done by the ``--html_output=basename`` option, where ``basename`` is the
+filestem of the associated HTML files. The
+``.basename_html_file_collection`` file lists all the needed files
+for the HTML document. Here is an example on making three versions of
+the HTML document: ``mydoc_bloodish.html``, ``mydoc_solarized``, and
+``mydoc_vagrant``.
+
+
+.. code-block:: console
+
+ Terminal> doconce format html mydoc --html_style=bloodish \
+ --html_output=mydoc_bloodish
+ Terminal> doconce split_html mydoc_bloodish.html
+ Terminal> doconce format html mydoc --html_style=solarized \
+ --html_output=mydoc_solarized --pygments_html=perldoc \
+ --html_admon=apricot
+ Terminal> doconce format html mydoc --html_style=vagrant \
+ --html_output=mydoc_vagrant
--pygments_html_style=default \
+
--html_template=templates/my_adapted_vagrant_template.html
+ Terminal> doconce split_html mydoc_vagrant.html
+

Blog Posts
----------
@@ -794,9 +841,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.

-An option ``--latex_printed`` makes some adjustments for documents
+An option ``-DDEVICE=paper`` makes some adjustments for documents
aimed at being printed. For example, links to web resources are
associated with a footnote listing the complete web address (URL).
+The default, ``-DDEVICE=screen``, creates a PDF file for reading
+on a screen where links are clickable.

*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,

@@ -846,6 +895,9 @@
``multimedia`` (for Beamer-style ``\movie`` command),
or ``href-run`` (for the plain `\h:ref:`run:file`` command)

+ * ``MOVIE_CONTROLS`` adds buttons for starting/stopping movies if the
+ ``media9`` package is used.
+
* ``PREAMBLE`` to turn the LaTeX preamble on or off (i.e., complete
document
or document to be included elsewhere - and note that
the preamble is only included
@@ -862,13 +914,6 @@

* ``LINENUMBERS`` for inclusion of line numbers in the text.

- * ``AMON`` for setting the type of admonitions: ``"colors"`` for colored
- boxes with icons, ``"graybox1"`` for gray frame boxes with rounded
- corners (default), ``"graybox2"`` for narrower square gray frame boxes
- (except for summary, which for A4 format is small and with wrapped
- text around if it does not contain verbatim code),
- or ``"paragraph"`` for simple, plain paragraph headings and ordinary
text
-
* ``COLORED_TABLE_ROWS`` for coloring every other table rows (set this
variable to ``gray`` or ``blue``)

@@ -914,9 +959,17 @@
begin and end for blocks inside ``!bc fpro`` and ``!ec``). Specifying
``envir=ans:nt`` means that all other environments are typeset with the
``anslistings.sty`` package, e.g., ``!bc cppcod`` will then result in
-``\begin{c++}``. If no environments like ``sys``, ``fpro``, or the common
-``envir`` are defined on the command line, the plain ``\begin{verbatim}``
-and ``\end{verbatim}`` used.
+``\begin{c++}``. A predefined shortcut as in ``shcod=Verbatim-0.85``
+results in denser
+vertical spacing (baselinestretch 0.85 in LaTeX terminology), and
+``shcod=Verbatim-indent`` implies indentation of the verbatim text.
+Alternatively, one can provide all desired parameters
+``\begin{Verbatim}`` instruction using the syntax illustrated for
+the ``sys`` environments above.
+
+If no environments like ``sys``, ``fpro``, or the common
+``envir`` are defined on the command line, the plain ``\begin{Verbatim}``
+and ``\end{Verbatim}`` instructions are used.


*Step 2b (optional).* Edit the ``mydoc.tex`` file to your needs.
=======================================
***Additional files exist in this changeset.***