[doconce] 3 new revisions pushed by h...@simula.no on 2013-08-11 06:54 GMT
2 views
Skip to first unread message
doc...@googlecode.com
Aug 11, 2013, 2:54:54 AM8/11/13
to docon...@googlegroups.com
3 new revisions:
Revision: 7a29362f2eb1
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 08:53:54 2013
Log: HTML5 slides now insert the original body and head contents in
the new...
http://code.google.com/p/doconce/source/detail?r=7a29362f2eb1
Revision: 5402f8455327
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 23:04:17 2013
Log: Intelligent defaults for html_admon and pygments_html_style.
http://code.google.com/p/doconce/source/detail?r=5402f8455327
Revision: a59a054f9d99
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 23:22:34 2013
Log: Regenerated docs with corrections.
http://code.google.com/p/doconce/source/detail?r=a59a054f9d99
==============================================================================
Revision: 7a29362f2eb1
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 08:53:54 2013
Log: HTML5 slides now insert the original body and head contents in
the new header.
http://code.google.com/p/doconce/source/detail?r=7a29362f2eb1
Modified:
/lib/doconce/common.py
/lib/doconce/doconce_config_default.py
/lib/doconce/misc.py
=======================================
--- /lib/doconce/common.py Thu Jul 18 20:58:04 2013
+++ /lib/doconce/common.py Sat Aug 10 08:53:54 2013
@@ -396,15 +396,25 @@
# Consistency check
n = filestr.count(_CODE_BLOCK)
if len(code_blocks) != n:
- print '*** BUG: found %d code block markers for %d initial code
blocks' % (n, len(code_blocks))
- print 'Possible cause: !bc and !ec inside code blocks - replace by
|bc and |ec'
- print 'or mismatch of !bt and !et across files in multi-file
documents'
- print '(run doconce on each file to locate the problem)'
+ print '*** error: found %d code block markers for %d initial code
blocks' % (n, len(code_blocks))
+ print """Possible causes:
+ - mismatch of !bt and !et within one file, such that a !bt
+ swallows code
+ - mismatch of !bt and !et across files in multi-file documents
+ - !bc and !ec inside code blocks - replace by |bc and |ec
+ (run doconce on each file to locate the problem, then on
+ smaller and smaller parts of each file)"""
_abort()
n = filestr.count(_MATH_BLOCK)
if len(tex_blocks) != n:
- print '*** BUG: found %d tex block markers for %d initial tex
blocks\nAbort!' % (n, len(tex_blocks))
- print 'Possible cause: !bt and !et inside code blocks - replace by
|bt and |ec'
+ print '*** error: found %d tex block markers for %d initial tex
blocks\nAbort!' % (n, len(tex_blocks))
+ print """Possible causes:
+ - mismatch of !bc and !ec within one file, such that a !bc
+ swallows tex blocks
+ - mismatch of !bc and !ec across files in multi-file documents
+ - !bt and !et inside code blocks - replace by |bt and |et
+ (run doconce on each file to locate the problem, then on
+ smaller and smaller parts of each file)"""
_abort()
lines = filestr.splitlines()
=======================================
--- /lib/doconce/doconce_config_default.py Sun Jul 21 01:24:05 2013
+++ /lib/doconce/doconce_config_default.py Sat Aug 10 08:53:54 2013
@@ -47,3 +47,5 @@
wordpress = False
tables2csv = False
github_md = False
+sections_up = False
+sections_down = False
=======================================
--- /lib/doconce/misc.py Sun Aug 4 11:57:04 2013
+++ /lib/doconce/misc.py Sat Aug 10 08:53:54 2013
@@ -3168,12 +3168,12 @@
print 'known
themes:', ', '.join(list(all_combinations[slide_tp].keys()))
_abort()
- m = re.search(r'<title>(.*?)</title>', ''.join(parts[0]))
- if m:
- title = m.group(1).strip()
- else:
- title = ''
- slide_syntax[slide_tp]['title'] = title
+ #m = re.search(r'<title>(.*?)</title>', ''.join(parts[0]))
+ #if m:
+ # title = m.group(1).strip()
+ #else:
+ # title = ''
+ #slide_syntax[slide_tp]['title'] = title
slide_syntax[slide_tp]['theme'] = \
slide_syntax[slide_tp]['default_theme'] if (theme == 'default' or
theme.endswith('_default')) else theme
@@ -3183,19 +3183,47 @@
slide_syntax[slide_tp]['body_header'] = \
slide_syntax[slide_tp]['body_header'] % slide_syntax[slide_tp]
+ # Grab the relevant lines in the <head> and <body> parts of
+ # the original header
+ head_lines = []
+ body_lines = []
+ inside_style = False
+ inside_head = False
+ inside_body = False
+ for line in header:
+ if '<head>' in line:
+ inside_head = True
+ continue
+ elif '</head>' in line:
+ inside_head = False
+ continue
+ elif line.strip().startswith('<body'):
+ inside_body = True
+ continue
+ elif '</body>' in line:
+ inside_body = False
+ continue
+ elif line.strip().startswith('<style'):
+ inside_style = True
+ continue
+ elif '</style>' in line:
+ inside_style = False
+ continue
+ if inside_style:
+ continue # skip style lines
+ elif inside_body:
+ body_lines.append(line)
+ elif inside_head:
+ head_lines.append(line)
+ slide_syntax[slide_tp]['head_lines'] = ''.join(head_lines)
+ slide_syntax[slide_tp]['body_lines'] = ''.join(body_lines)
+
+ #<title>%(title)s</title>
slides = """\
<!DOCTYPE html>
-<html lang="en">
-
-<!--
- Automatically translated from Doconce source.
- http://code.google.com/p/doconce
--->
-<head>
-<meta charset="utf-8">
+%(head_lines)s
-<title>%(title)s</title>
%(head_header)s
<!-- Styles for table layout of slides -->
@@ -3208,24 +3236,12 @@
}
</style>
-<!-- Use MathJax to render mathematics -->
-<script type="text/x-mathjax-config">
-MathJax.Hub.Config({
- TeX: {
- equationNumbers: { autoNumber: "AMS" },
- extensions: ["AMSmath.js", "AMSsymbols.js", "autobold.js"]
- }
-});
-</script>
-<script type="text/javascript"
-
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
-</script>
-<!-- Fix slow MathJax rendering in IE8 -->
-<meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7">
-
</head>
%(body_header)s
+
+%(body_lines)s
+
""" % slide_syntax[slide_tp]
for part_no, part in enumerate(parts):
==============================================================================
Revision: 5402f8455327
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 23:04:17 2013
Log: Intelligent defaults for html_admon and pygments_html_style.
http://code.google.com/p/doconce/source/detail?r=5402f8455327
Modified:
/doc/manual/manual.do.txt
/doc/tutorial/doconce2anything.do.txt
/lib/doconce/html.py
/lib/doconce/misc.py
=======================================
--- /doc/manual/manual.do.txt Thu Jul 18 20:58:04 2013
+++ /doc/manual/manual.do.txt Sat Aug 10 23:04:17 2013
@@ -1592,11 +1592,11 @@
Some recommended combinations for admonitions in HTML are
- * `--html_admon=apricot`, `--html_style=solarized`
- * `--html_admon=yellow`, `--html_style=bluish2`, `--no_pygments_html`
- * `--html_admon=yellow`, `--html_style=blueish2`,
`--pygments_html_style=default`
- * `--html_admon=gray`, `--html_style=bloodish`, `--no_pygments_html`
- * `--html_admon=gray`, `--html_style=bloodish`,
`--pygments_html_style=default`
+ * `--html_style=solarized`, `--html_admon=apricot`,
`--pygments_html_style=perldoc`
+ * `--html_style=blueish2`, `--html_admon=yellow`, `--no_pygments_html`
+ * `--html_style=blueish2`, `--html_admon=yellow`,
`--pygments_html_style=default`
+ * `--html_style=bloodish`, `--html_admon=gray`, `--no_pygments_html`
+ * `--html_style=bloodish`, `--html_admon=gray`,
`--pygments_html_style=default`
* `--html_style=vagrant`, `--pygments_html_style=default`,
`--html_template=...`
The `vagrant` HTML style has CSS files that override the definition
=======================================
--- /doc/tutorial/doconce2anything.do.txt Sun Jul 21 01:24:05 2013
+++ /doc/tutorial/doconce2anything.do.txt Sat Aug 10 23:04:17 2013
@@ -187,8 +187,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
=======================================
--- /lib/doconce/html.py Thu Jul 18 20:58:04 2013
+++ /lib/doconce/html.py Sat Aug 10 23:04:17 2013
@@ -246,7 +246,14 @@
if option('no_pygments_html'):
pygm = None
if pygm is not None:
- pygm_style = option('pygments_html_style=', default='default')
+ pygm_style = option('pygments_html_style=', default=None)
+ if pygm_style is None:
+ # Set sensible default values
+ if option('html_style=') == 'solarized':
+ pygm_style = 'perldoc'
+ else:
+ pygm_style = 'default'
+
legal_styles = list(get_all_styles())
legal_styles += ['no', 'none']
if pygm_style not in legal_styles:
@@ -1069,7 +1076,15 @@
keep_pygm_bg = option('keep_pygments_html_bg')
pygments_pattern = r'"background: .+?">'
- html_admon = option('html_admon=', 'gray')
+ html_admon = option('html_admon=', None)
+ if html_admon is None:
+ # Set sensible default value
+ if option('html_style=') == 'solarized':
+ html_admon = 'apricot'
+ elif option('html_style=') == 'blueish2':
+ html_admon = 'yellow'
+ else:
+ html_admon = 'gray'
if html_admon == 'colors':
if not keep_pygm_bg:
block = re.sub(pygments_pattern, r'"background: %%s">' %%
=======================================
--- /lib/doconce/misc.py Sat Aug 10 08:53:54 2013
+++ /lib/doconce/misc.py Sat Aug 10 23:04:17 2013
@@ -6114,6 +6114,9 @@
filename_html = prefix_diff_files + tofile + '.html'
f = open(filename_plain, 'w')
+ # Need to add newlines despite doc saying that trailing newlines
are
+ # inserted...
+ diff_plain = [line + '\n' for line in diff_plain]
f.writelines(diff_plain)
f.close()
==============================================================================
Revision: a59a054f9d99
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 23:22:34 2013
Log: Regenerated docs with corrections.
http://code.google.com/p/doconce/source/detail?r=a59a054f9d99
Modified:
/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/tutorial/html/_sources/tutorial.txt
/doc/demos/tutorial/html/searchindex.js
/doc/demos/tutorial/html/tutorial.html
/doc/demos/tutorial/tutorial.cwiki
/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/tutorial/doconce2anything.do.txt
=======================================
--- /doc/demos/manual/html/_sources/manual.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/html/_sources/manual.txt Sat Aug 10 23:22:34 2013
@@ -5,7 +5,7 @@
===================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
.. lines beginning with # are doconce comment lines
@@ -82,11 +82,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -875,8 +875,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1016,6 +1016,66 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+.. code-block:: text
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running
+
+
+.. code-block:: console
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -1042,11 +1102,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,
@@ -2196,6 +2256,23 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+
+.. code-block:: text
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send `mail <mailto:h...@simula.no>`_ to
+`h...@simula.no <mailto:h...@simula.no>`_.
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -3489,15 +3566,15 @@
Some recommended combinations for admonitions in HTML are
- * ``--html_admon=apricot``, ``--html_style=solarized``
+ * ``--html_style=solarized``, ``--html_admon=apricot``,
``--pygments_html_style=perldoc``
- * ``--html_admon=yellow``, ``--html_style=bluish2``,
``--no_pygments_html``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--no_pygments_html``
- * ``--html_admon=yellow``, ``--html_style=blueish2``,
``--pygments_html_style=default``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--pygments_html_style=default``
- * ``--html_admon=gray``, ``--html_style=bloodish``, ``--no_pygments_html``
+ * ``--html_style=bloodish``, ``--html_admon=gray``, ``--no_pygments_html``
- * ``--html_admon=gray``, ``--html_style=bloodish``,
``--pygments_html_style=default``
+ * ``--html_style=bloodish``, ``--html_admon=gray``,
``--pygments_html_style=default``
* ``--html_style=vagrant``, ``--pygments_html_style=default``,
``--html_template=...``
=======================================
--- /doc/demos/manual/html/manual.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/html/manual.html Sat Aug 10 23:22:34 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">Jul 13, 2013</td>
+<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body">Aug 11, 2013</td>
</tr>
</tbody>
</table>
@@ -116,11 +116,11 @@
</div></blockquote>
<p><em>History.</em> Doconce was developed in 2006 at a time when most
popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.</p>
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.</p>
<p><em>Disclaimer.</em> Doconce is a simple tool, largely based on
interpreting
and handling text through regular expressions. The possibility for
tweaking the layout is obviously limited since the text can go to
@@ -737,8 +737,8 @@
<span class="go"> --html_output=mydoc_bloodish</span>
<span class="go">Terminal> doconce split_html mydoc_bloodish.html</span>
<span class="go">Terminal> 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"> --html_output=mydoc_solarized \</span>
+<span class="go"> --pygments_html_style=perldoc
--html_admon=apricot</span>
<span class="go">Terminal> 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>
@@ -855,6 +855,58 @@
</div>
<p>The <tt class="docutils literal"><span class="pre">-s</span></tt>
option adds a proper header and footer to the <tt class="docutils
literal"><span class="pre">mydoc.html</span></tt> file.
This recipe is a quick way of makeing HTML notes with (some)
mathematics.</p>
+<div class="section" id="github-flavored-markdown">
+<h3>GitHub-flavored Markdown<a class="headerlink"
href="#github-flavored-markdown" title="Permalink to this
headline">¶</a></h3>
+<p>Adding the command-line option <tt class="docutils literal"><span
class="pre">github-md</span></tt> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
class="reference external" href="http://github.com">GitHub</a>. A special
feature is the support of task lists:
+unnumbered lists with <tt class="docutils literal"><span
class="pre">[x]</span></tt> (task done) or <tt class="docutils
literal"><span class="pre">[</span> <span class="pre">]</span></tt> (task
not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:</p>
+<div class="highlight-text"><div class="highlight"><pre>!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</pre></div>
+</div>
+<p>Say this text is stored in a file <tt class="docutils literal"><span
class="pre">mycomments.do.txt</span></tt>. Running</p>
+<div class="highlight-console"><div class="highlight"><pre><span
class="go">Terminal> doconce format pandoc mycomments --github_md</span>
+</pre></div>
+</div>
+<p>produces <tt class="docutils literal"><span
class="pre">mycomments.md</span></tt> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</p>
+</div>
</div>
<div class="section" id="latex">
<h2>LaTeX<a class="headerlink" href="#latex" title="Permalink to this
headline">¶</a></h2>
@@ -869,11 +921,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">-DDEVICE=paper</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">--device=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).
-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>
+The default, <tt class="docutils literal"><span
class="pre">--device=screen</span></tt>, creates a PDF file for reading
+on a screen where links are just 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> ptex2tex mydoc</span>
</pre></div>
@@ -1725,6 +1777,18 @@
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.)</p>
</div>
+<div class="section" id="mail-addresses">
+<h3>Mail Addresses<a class="headerlink" href="#mail-addresses"
title="Permalink to this headline">¶</a></h3>
+<p>Links that launches a mail to a specified address is written as
+ordinary URLs, typically as</p>
+<div class="highlight-text"><div class="highlight"><pre>Send
"mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+</pre></div>
+</div>
+<p>which appears as Send <a class="reference external"
href="mailto:hpl%40simula.no">mail</a> to
+<a class="reference external"
href="mailto:hpl%40simula.no">hpl<span>@</span>simula<span>.</span>no</a>.</p>
+</div>
<div class="section" id="links-to-local-files">
<h3>Links to Local Files<a class="headerlink" href="#links-to-local-files"
title="Permalink to this headline">¶</a></h3>
<p>Links to files ending in <tt class="docutils literal"><span
class="pre">.txt</span></tt>, <tt class="docutils literal"><span
class="pre">.html</span></tt>, <tt class="docutils literal"><span
class="pre">.pdf</span></tt>, <tt class="docutils literal"><span
class="pre">.py</span></tt>, <tt class="docutils literal"><span
class="pre">.f</span></tt>,
@@ -2744,11 +2808,11 @@
<p>Some recommended combinations for admonitions in HTML are</p>
<blockquote>
<div><ul class="simple">
-<li><tt class="docutils literal"><span
class="pre">--html_admon=apricot</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=solarized</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=yellow</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bluish2</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=yellow</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=blueish2</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=gray</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bloodish</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=gray</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bloodish</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=solarized</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=apricot</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=perldoc</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=blueish2</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=yellow</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=blueish2</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=yellow</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=bloodish</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=gray</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=bloodish</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=gray</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
<li><tt class="docutils literal"><span
class="pre">--html_style=vagrant</span></tt>, <tt class="docutils
literal"><span class="pre">--pygments_html_style=default</span></tt>, <tt
class="docutils literal"><span
class="pre">--html_template=...</span></tt></li>
</ul>
</div></blockquote>
@@ -3972,7 +4036,10 @@
</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="#pandoc-and-markdown">Pandoc and
Markdown</a><ul>
+<li><a class="reference internal"
href="#github-flavored-markdown">GitHub-flavored Markdown</a></li>
+</ul>
+</li>
<li><a class="reference internal" href="#latex">LaTeX</a></li>
<li><a class="reference internal" href="#pdflatex">PDFLaTeX</a></li>
<li><a class="reference internal" href="#xelatex">XeLaTeX</a></li>
@@ -3999,6 +4066,7 @@
<li><a class="reference internal" href="#emphasized-words">Emphasized
Words</a></li>
<li><a class="reference internal" href="#inline-verbatim-text">Inline
Verbatim Text</a></li>
<li><a class="reference internal" href="#links-to-web-addresses">Links to
Web Addresses</a></li>
+<li><a class="reference internal" href="#mail-addresses">Mail
Addresses</a></li>
<li><a class="reference internal" href="#links-to-local-files">Links to
Local Files</a></li>
<li><a class="reference internal" href="#inline-comments">Inline
Comments</a></li>
<li><a class="reference internal" href="#inline-mathematics">Inline
Mathematics</a></li>
=======================================
--- /doc/demos/manual/html/searchindex.js Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/html/searchindex.js Sat Aug 10 23:22:34 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,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"]})
+Search.setIndex({objects:{},terms:{mydoc2:1,linebreak:1,yellow:1,four:1,fig2:1,fig3:1,fig1:1,consider:1,spellcheck:1,aug: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,preview: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,attract:1,end:1,quot:1,ordinari:1,vagrant:1,how:1,answer:1,perspect:1,updat:1,dialect: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,equot: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,scipy_lectur: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,tracker: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,mycom:1,satisfactorili:1,form:1,offer:1,solar:1,"true":1,calc: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],backward: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],coeffici: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,mail: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,gaussian: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,noth: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,state: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,bquot: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,github_md: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,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,field: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,nxn: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,remain: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,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,quadrat:1,rid:1,minim:1,shorter: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,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,highlight: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,change_encod: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,heavisid: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,guthub: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,mailto: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,archiv: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,cubic: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],aris: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,"export":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,continu: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 Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.cwiki Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
#summary Doconce Description
<wiki:toc max_depth="2" />
By **Hans Petter Langtangen**
-=== Jul 13, 2013 ===
+=== Aug 11, 2013 ===
<wiki:comment> lines beginning with # are doconce comment lines
</wiki:comment>
<wiki:comment> (documents can also have mako comment lines) </wiki:comment>
@@ -39,11 +39,11 @@
//History.// Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
//Disclaimer.// Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -702,8 +702,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -823,6 +823,60 @@
The {{{-s}}} option adds a proper header and footer to the
{{{mydoc.html}}} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+=== GitHub-flavored Markdown ===
+
+Adding the command-line option {{{github-md}}} turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[[http://github.com|GitHub]]. A special feature is the support of task
lists:
+unnumbered lists with {{{[x]}}} (task done) or {{{[ ]}}} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+{{{
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+}}}
+Say this text is stored in a file {{{mycomments.do.txt}}}. Running
+
+{{{
+Terminal> doconce format pandoc mycomments --github_md
+}}}
+produces {{{mycomments.md}}} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
== LaTeX ==
@@ -842,11 +896,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option {{{-DDEVICE=paper}}} makes some adjustments for documents
+An option {{{--device=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.
+The default, {{{--device=screen}}}, creates a PDF file for reading
+on a screen where links are just clickable.
//Step 2.// Run {{{ptex2tex}}} (if you have it) to make a standard LaTeX
file,
{{{
@@ -1758,6 +1812,19 @@
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.)
+=== Mail Addresses ===
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+{{{
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+}}}
+which appears as Send [[mailto:h...@simula.no|mail]] to
+[[mailto:h...@simula.no|{{{h...@simula.no}}}]].
+
=== Links to Local Files ===
Links to files ending in {{{.txt}}}, {{{.html}}}, {{{.pdf}}}, {{{.py}}},
{{{.f}}},
@@ -2826,11 +2893,11 @@
Some recommended combinations for admonitions in HTML are
- * {{{--html_admon=apricot}}}, {{{--html_style=solarized}}}
- * {{{--html_admon=yellow}}}, {{{--html_style=bluish2}}},
{{{--no_pygments_html}}}
- * {{{--html_admon=yellow}}}, {{{--html_style=blueish2}}},
{{{--pygments_html_style=default}}}
- * {{{--html_admon=gray}}}, {{{--html_style=bloodish}}},
{{{--no_pygments_html}}}
- * {{{--html_admon=gray}}}, {{{--html_style=bloodish}}},
{{{--pygments_html_style=default}}}
+ * {{{--html_style=solarized}}}, {{{--html_admon=apricot}}},
{{{--pygments_html_style=perldoc}}}
+ * {{{--html_style=blueish2}}}, {{{--html_admon=yellow}}},
{{{--no_pygments_html}}}
+ * {{{--html_style=blueish2}}}, {{{--html_admon=yellow}}},
{{{--pygments_html_style=default}}}
+ * {{{--html_style=bloodish}}}, {{{--html_admon=gray}}},
{{{--no_pygments_html}}}
+ * {{{--html_style=bloodish}}}, {{{--html_admon=gray}}},
{{{--pygments_html_style=default}}}
* {{{--html_style=vagrant}}}, {{{--pygments_html_style=default}}},
{{{--html_template=...}}}
The {{{vagrant}}} HTML style has CSS files that override the definition
=======================================
--- /doc/demos/manual/manual.do.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.do.txt Sat Aug 10 23:22:34 2013
@@ -471,6 +471,19 @@
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.)
+=== Mail Addresses ===
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+!bc
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+!ec
+which appears as Send "mail": "mailto:h...@simula.no" to
+"`h...@simula.no`": "mailto:h...@simula.no".
+
=== Links to Local Files ===
Links to files ending in `.txt`, `.html`, `.pdf`, `.py`, `.f`,
@@ -1579,11 +1592,11 @@
Some recommended combinations for admonitions in HTML are
- * `--html_admon=apricot`, `--html_style=solarized`
- * `--html_admon=yellow`, `--html_style=bluish2`, `--no_pygments_html`
- * `--html_admon=yellow`, `--html_style=blueish2`,
`--pygments_html_style=default`
- * `--html_admon=gray`, `--html_style=bloodish`, `--no_pygments_html`
- * `--html_admon=gray`, `--html_style=bloodish`,
`--pygments_html_style=default`
+ * `--html_style=solarized`, `--html_admon=apricot`,
`--pygments_html_style=perldoc`
+ * `--html_style=blueish2`, `--html_admon=yellow`, `--no_pygments_html`
+ * `--html_style=blueish2`, `--html_admon=yellow`,
`--pygments_html_style=default`
+ * `--html_style=bloodish`, `--html_admon=gray`, `--no_pygments_html`
+ * `--html_style=bloodish`, `--html_admon=gray`,
`--pygments_html_style=default`
* `--html_style=vagrant`, `--pygments_html_style=default`,
`--html_template=...`
The `vagrant` HTML style has CSS files that override the definition
=======================================
--- /doc/demos/manual/manual.epytext Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.epytext Sat Aug 10 23:22:34 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: Jul 13, 2013
+DATE: Aug 11, 2013
What Is Doconce?
================
@@ -58,11 +58,11 @@
I{History.} Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
I{Disclaimer.} Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -750,8 +750,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -878,6 +878,61 @@
The C{-s} option adds a proper header and footer to the C{mydoc.html} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option C{github-md} turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
U{GitHub<http://github.com>}. A special feature is the support of task
lists:
+unnumbered lists with C{[x]} (task done) or C{[ ]} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file C{mycomments.do.txt}. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces C{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -896,11 +951,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option C{-DDEVICE=paper} makes some adjustments for documents
+An option C{--device=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.
+The default, C{--device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
I{Step 2.} Run C{ptex2tex} (if you have it) to make a standard LaTeX file::
@@ -1877,6 +1932,20 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as::
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send U{mail<mailto:h...@simula.no>} to
+U{C{h...@simula.no}<mailto:h...@simula.no>}.
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -2986,11 +3055,11 @@
Some recommended combinations for admonitions in HTML are
- - C{--html_admon=apricot}, C{--html_style=solarized}
- - C{--html_admon=yellow}, C{--html_style=bluish2}, C{--no_pygments_html}
- - C{--html_admon=yellow}, C{--html_style=blueish2},
C{--pygments_html_style=default}
- - C{--html_admon=gray}, C{--html_style=bloodish}, C{--no_pygments_html}
- - C{--html_admon=gray}, C{--html_style=bloodish},
C{--pygments_html_style=default}
+ - C{--html_style=solarized}, C{--html_admon=apricot},
C{--pygments_html_style=perldoc}
+ - C{--html_style=blueish2}, C{--html_admon=yellow}, C{--no_pygments_html}
+ - C{--html_style=blueish2}, C{--html_admon=yellow},
C{--pygments_html_style=default}
+ - C{--html_style=bloodish}, C{--html_admon=gray}, C{--no_pygments_html}
+ - C{--html_style=bloodish}, C{--html_admon=gray},
C{--pygments_html_style=default}
- C{--html_style=vagrant}, C{--pygments_html_style=default},
C{--html_template=...}
The C{vagrant} HTML style has CSS files that override the definition
=======================================
--- /doc/demos/manual/manual.gwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.gwiki Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
#summary Doconce Description
By *Hans Petter Langtangen*
-==== Jul 13, 2013 ====
+==== Aug 11, 2013 ====
<wiki:comment> lines beginning with # are doconce comment lines
</wiki:comment>
<wiki:comment> (documents can also have mako comment lines) </wiki:comment>
@@ -39,11 +39,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -701,8 +701,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -822,6 +822,60 @@
The `-s` option adds a proper header and footer to the `mydoc.html` file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+==== GitHub-flavored Markdown ====
+
+Adding the command-line option `github-md` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[http://github.com GitHub]. A special feature is the support of task lists:
+unnumbered lists with `[x]` (task done) or `[ ]` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+{{{
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+}}}
+Say this text is stored in a file `mycomments.do.txt`. Running
+
+{{{
+Terminal> doconce format pandoc mycomments --github_md
+}}}
+produces `mycomments.md` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
==== LaTeX ====
@@ -841,11 +895,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,
{{{
@@ -1776,6 +1830,19 @@
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.)
+==== Mail Addresses ====
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+{{{
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+}}}
+which appears as Send [mailto:h...@simula.no mail] to
+[mailto:h...@simula.no `h...@simula.no`].
+
==== Links to Local Files ====
Links to files ending in `.txt`, `.html`, `.pdf`, `.py`, `.f`,
@@ -2840,11 +2907,11 @@
Some recommended combinations for admonitions in HTML are
- * `--html_admon=apricot`, `--html_style=solarized`
- * `--html_admon=yellow`, `--html_style=bluish2`, `--no_pygments_html`
- * `--html_admon=yellow`, `--html_style=blueish2`,
`--pygments_html_style=default`
- * `--html_admon=gray`, `--html_style=bloodish`, `--no_pygments_html`
- * `--html_admon=gray`, `--html_style=bloodish`,
`--pygments_html_style=default`
+ * `--html_style=solarized`, `--html_admon=apricot`,
`--pygments_html_style=perldoc`
+ * `--html_style=blueish2`, `--html_admon=yellow`, `--no_pygments_html`
+ * `--html_style=blueish2`, `--html_admon=yellow`,
`--pygments_html_style=default`
+ * `--html_style=bloodish`, `--html_admon=gray`, `--no_pygments_html`
+ * `--html_style=bloodish`, `--html_admon=gray`,
`--pygments_html_style=default`
* `--html_style=vagrant`, `--pygments_html_style=default`,
`--html_template=...`
The `vagrant` HTML style has CSS files that override the definition
=======================================
--- /doc/demos/manual/manual.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.html Sat Aug 10 23:22:34 2013
@@ -102,58 +102,60 @@
(' 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'),
+ (' GitHub-flavored Markdown ', 3, None, '___sec32'),
+ (' LaTeX ', 2, None, '___sec33'),
+ (' PDFLaTeX ', 2, None, '___sec34'),
+ (' XeLaTeX ', 2, None, '___sec35'),
+ (' Plain ASCII Text ', 2, None, '___sec36'),
+ (' reStructuredText ', 2, None, '___sec37'),
+ (' Sphinx ', 2, None, '___sec38'),
+ (' The manual Sphinx procedure ', 3, None, '___sec39'),
+ (' Wiki Formats ', 2, None, '___sec40'),
+ (' Tweaking the Doconce Output ', 2, None, '___sec41'),
+ (' The Doconce Markup Language ', 1, None, '___sec42'),
+ (' Lists ', 2, None, '___sec43'),
+ (' Special Lines ', 2, None, '___sec44'),
+ (' Special Lines ', 1, None, '___sec45'),
+ (' Figures ', 2, None, '___sec46'),
+ (' Movies ', 2, None, '___sec47'),
(' Copying Computer Code from Source Files ',
2,
None,
- '___sec47'),
+ '___sec48'),
(' Inline Tagging ', 2, 'inline:tagging', 'inline:tagging'),
- (' 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'),
+ (' Emphasized Words ', 3, None, '___sec50'),
+ (' Inline Verbatim Text ', 3, None, '___sec51'),
+ (' Links to Web Addresses ', 3, None, '___sec52'),
+ (' Mail Addresses ', 3, None, '___sec53'),
+ (' Links to Local Files ', 3, None, '___sec54'),
+ (' Inline Comments ', 3, None, '___sec55'),
+ (' Inline Mathematics ', 3, None, '___sec56'),
+ (' Comments ', 2, None, '___sec57'),
+ (' Cross-Referencing ', 2, None, '___sec58'),
(' Generalized Cross-Referencing ',
2,
'manual:genrefs',
'manual:genrefs'),
- (' Index ', 2, None, '___sec58'),
- (' Bibliography ', 2, None, '___sec59'),
+ (' Index ', 2, None, '___sec60'),
+ (' Bibliography ', 2, None, '___sec61'),
(' Importing your data to the Publish database ',
3,
None,
- '___sec60'),
- (' Requirements to input data ', 3, None, '___sec61'),
+ '___sec62'),
+ (' Requirements to input data ', 3, None, '___sec63'),
(' Adding new references to the database ',
3,
None,
- '___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'),
+ '___sec64'),
+ (' Exporting the database ', 3, None, '___sec65'),
+ (' Referring to publications ', 3, None, '___sec66'),
+ (' Specifying the Publish database ', 3, None, '___sec67'),
+ (' LaTeX bibliography style ', 3, None, '___sec68'),
+ (' Tables ', 2, None, '___sec69'),
(' Exercises, Problems, Projects, and Examples ',
2,
None,
- '___sec68'),
+ '___sec70'),
(' Blocks of Verbatim Computer Code ',
2,
'sec:verbatim:blocks',
@@ -165,183 +167,186 @@
(' Mathematics for PowerPoint/OpenOffice ',
3,
None,
- '___sec71'),
+ '___sec73'),
(' Macros (Newcommands) ', 2, 'newcommands', 'newcommands'),
- (' Admonitions ', 2, None, '___sec73'),
- (' Preprocessing Steps ', 2, None, '___sec74'),
+ (' Admonitions ', 2, None, '___sec75'),
+ (' Preprocessing Steps ', 2, None, '___sec76'),
(' Splitting Documents into Smaller Pieces ',
2,
None,
- '___sec75'),
- (' Missing Features ', 2, None, '___sec76'),
- (' Header and Footer ', 2, None, '___sec77'),
+ '___sec77'),
+ (' Missing Features ', 2, None, '___sec78'),
+ (' Header and Footer ', 2, None, '___sec79'),
(' Emacs Doconce Formatter ',
2,
'emacs:doconce',
'emacs:doconce'),
- (' 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'),
+ (' Writing Slides ', 1, None, '___sec81'),
+ (' Overview ', 2, None, '___sec82'),
+ (' HTML5 Slides ', 2, None, '___sec83'),
+ (' Potential Problems ', 3, None, '___sec84'),
+ (' LaTeX Beamer Slides ', 2, None, '___sec85'),
+ (' Themes ', 3, None, '___sec86'),
+ (' Mako Programming ', 1, None, '___sec87'),
+ (' The Basics of Mako ', 2, None, '___sec88'),
(' Example: Defining a Theorem Environment ',
2,
'manual:theorem:envir',
'manual:theorem:envir'),
- (' Troubleshooting ', 1, None, '___sec88'),
- (' Disclaimer ', 2, None, '___sec89'),
- (' General Problems ', 2, None, '___sec90'),
+ (' Troubleshooting ', 1, None, '___sec90'),
+ (' Disclaimer ', 2, None, '___sec91'),
+ (' General Problems ', 2, None, '___sec92'),
(' Spellcheck reports a lot of mistakes related LaTeX math ',
3,
None,
- '___sec91'),
+ '___sec93'),
(' Doconce aborts because of a syntax error that is not an
error ',
3,
None,
- '___sec92'),
+ '___sec94'),
(' The Mako preprocessor is seemingly not run ',
3,
None,
- '___sec93'),
+ '___sec95'),
(' The Mako preprocessor is fooled by Doconce text ',
3,
None,
- '___sec94'),
+ '___sec96'),
(' The Mako preprocessor claims a variable is undefined ',
3,
None,
- '___sec95'),
+ '___sec97'),
(' Something goes wrong in the preprocessing step ',
3,
+ None,
+ '___sec98'),
+ (' Figure captions are incomplete ', 3, None, '___sec99'),
+ (' Preprocessor directives do not work ', 3,
None, '___sec100'),
+ (' Problems with boldface and emphasize ',
+ 3,
None,
- '___sec96'),
- (' Figure captions are incomplete ', 3, None, '___sec97'),
- (' Preprocessor directives do not work ', 3,
None, '___sec98'),
- (' Problems with boldface and emphasize ', 3,
None, '___sec99'),
+ '___sec101'),
(' Links to local directories do not work ',
3,
None,
- '___sec100'),
- (' Links are not typeset correctly ', 3, None, '___sec101'),
+ '___sec102'),
+ (' Links are not typeset correctly ', 3, None, '___sec103'),
(' Inline verbatim code is not detected ',
3,
None,
- '___sec102'),
+ '___sec104'),
(' Inline verbatim text is not formatted correctly ',
3,
None,
- '___sec103'),
- (' Strange non-English characters ', 3, None, '___sec104'),
- (' Wrong Norwegian charcters ', 3, None, '___sec105'),
+ '___sec105'),
+ (' Strange non-English characters ', 3, None, '___sec106'),
+ (' Wrong Norwegian charcters ', 3, None, '___sec107'),
(' Too short underlining of reST headlines ',
3,
None,
- '___sec106'),
+ '___sec108'),
(' Found !bt but no tex blocks extracted (BUG) ',
3,
None,
- '___sec107'),
+ '___sec109'),
(' Examples are typset with environment delimiters visible ',
3,
None,
- '___sec108'),
+ '___sec110'),
(' Emacs editing does not work properly because of "regexp
overflow" ',
3,
None,
- '___sec109'),
- (' Problems with code or Tex Blocks ', 2, None, '___sec110'),
- (' Code or math block errors in reST ', 3,
None, '___sec111'),
+ '___sec111'),
+ (' Problems with code or Tex Blocks ', 2, None, '___sec112'),
+ (' Code or math block errors in reST ', 3,
None, '___sec113'),
(' Strange errors around code or TeX blocks in reST ',
3,
None,
- '___sec112'),
+ '___sec114'),
(' Something is wrong with a verbatim code block ',
3,
None,
- '___sec113'),
+ '___sec115'),
(' Code/TeX block is not shown in reST format ',
3,
None,
- '___sec114'),
+ '___sec116'),
(' Verbatim code blocks inside lists look ugly ',
3,
None,
- '___sec115'),
+ '___sec117'),
(' LaTeX code blocks inside lists look ugly ',
3,
None,
- '___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'),
+ '___sec118'),
+ (' Problems with reST/Sphinx Output ', 2, None, '___sec119'),
+ (' Title level inconsistent ', 3, None, '___sec120'),
+ (' Lists do not appear in .rst files ', 3,
None, '___sec121'),
(' Error message "Undefined substitution..." from reST ',
3,
None,
- '___sec120'),
- (' Warning about duplicate link names ', 3,
None, '___sec121'),
- (' Inconsistent headings in reST ', 3, None, '___sec122'),
+ '___sec122'),
+ (' Warning about duplicate link names ', 3,
None, '___sec123'),
+ (' Inconsistent headings in reST ', 3, None, '___sec124'),
(' No code environment appears before "bc ipy" blocks ',
3,
None,
- '___sec123'),
- (' Problems with LaTeX Output ', 2, None, '___sec124'),
+ '___sec125'),
+ (' Problems with LaTeX Output ', 2, None, '___sec126'),
(' LaTeX does not like underscores in URLs ',
3,
None,
- '___sec125'),
+ '___sec127'),
(" Error when running latex: You must have 'pygmentize'
installed ",
3,
None,
- '___sec126'),
+ '___sec128'),
(' Why are the LaTeX section headings smaller than normal? ',
3,
None,
- '___sec127'),
+ '___sec129'),
(' Can I have LaTeX figures with shadows? ',
3,
None,
- '___sec128'),
+ '___sec130'),
(' How can I use my fancy LaTeX environments? ',
3,
None,
- '___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'),
+ '___sec131'),
+ (' The LaTeX file does not compile ', 3, None, '___sec132'),
+ (' Inline verbatim gives error ', 3, None, '___sec133'),
+ (' Errors in figure captions ', 3, None, '___sec134'),
+ (' Chapters are ignored ', 3, None, '___sec135'),
(' I want to tune the top of the LaTeX file ',
3,
None,
- '___sec134'),
- (' Problems with gwiki Output ', 2, None, '___sec135'),
- (' Strange nested lists in gwiki ', 3, None, '___sec136'),
+ '___sec136'),
+ (' Problems with gwiki Output ', 2, None, '___sec137'),
+ (' Strange nested lists in gwiki ', 3, None, '___sec138'),
(' Lists in gwiki look ugly in the gwiki source ',
3,
None,
- '___sec137'),
- (' Problems with HTML Output ', 2, None, '___sec138'),
+ '___sec139'),
+ (' Problems with HTML Output ', 2, None, '___sec140'),
(' MathJax formulas are not properly rendered ',
3,
None,
- '___sec139'),
+ '___sec141'),
(' How can I change the layout of the HTML page? ',
3,
None,
- '___sec140'),
+ '___sec142'),
(' Why do figures look ugly when using HTML templates? ',
3,
None,
- '___sec141'),
- (' Debugging ', 2, None, '___sec142'),
- (' Basic Parsing Ideas ', 1, None, '___sec143'),
+ '___sec143'),
+ (' Debugging ', 2, None, '___sec144'),
+ (' Basic Parsing Ideas ', 1, None, '___sec145'),
(' Typesetting of Function Arguments, Return Values, and
Variables ',
2,
None,
- '___sec144'),
- (' References ', 1, None, '___sec145')]}
+ '___sec146'),
+ (' References ', 1, None, '___sec147')]}
end of tocinfo -->
<body>
@@ -393,7 +398,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>Jul 13, 2013</h4></center> <!-- date -->
+<center><h4>Aug 11, 2013</h4></center> <!-- date -->
<p>
<!-- lines beginning with # are doconce comment lines -->
<!-- (documents can also have mako comment lines) -->
@@ -461,11 +466,11 @@
<b>History.</b>
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
<p>
<b>Disclaimer.</b>
@@ -1232,8 +1237,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1378,7 +1383,66 @@
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="___sec32"></a></h3>
+<h4>GitHub-flavored Markdown <a name="___sec32"></a></h4>
+
+<p>
+Adding the command-line option <code>github-md</code> turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
href="http://github.com">GitHub</a>. A special feature is the support of
task lists:
+unnumbered lists with <code>[x]</code> (task done) or <code>[ ]</code>
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+<p>
+<!-- begin verbatim block -->
+<pre><code>!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</code></pre>
+<!-- end verbatim block -->
+Say this text is stored in a file <code>mycomments.do.txt</code>. Running
+
+<p>
+<!-- begin verbatim block sys-->
+<pre><code>Terminal> doconce format pandoc mycomments --github_md
+</code></pre>
+<!-- end verbatim block -->
+produces <code>mycomments.md</code> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
+<h3>LaTeX <a name="___sec33"></a></h3>
<p>
Making a LaTeX file <code>mydoc.tex</code> from <code>mydoc.do.txt</code>
is done in two steps:
@@ -1401,11 +1465,11 @@
so that your commands are defined.
<p>
-An option <code>-DDEVICE=paper</code> makes some adjustments for documents
+An option <code>--device=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.
+The default, <code>--device=screen</code>, creates a PDF file for reading
+on a screen where links are just clickable.
<p>
<b>Step 2.</b>
@@ -1596,7 +1660,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="___sec33"></a></h3>
+<h3>PDFLaTeX <a name="___sec34"></a></h3>
<p>
Running <code>pdflatex</code> instead of <code>latex</code> follows almost
the same steps,
@@ -1614,7 +1678,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>XeLaTeX <a name="___sec34"></a></h3>
+<h3>XeLaTeX <a name="___sec35"></a></h3>
<p>
XeLaTeX is an alternative to pdfLaTeX and is run in almost the
@@ -1629,7 +1693,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Plain ASCII Text <a name="___sec35"></a></h3>
+<h3>Plain ASCII Text <a name="___sec36"></a></h3>
<p>
We can go from Doconce "back to" plain untagged text suitable for viewing
@@ -1640,7 +1704,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>reStructuredText <a name="___sec36"></a></h3>
+<h3>reStructuredText <a name="___sec37"></a></h3>
<p>
Going from Doconce to reStructuredText gives a lot of possibilities to
@@ -1696,7 +1760,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="___sec37"></a></h3>
+<h3>Sphinx <a name="___sec38"></a></h3>
<p>
Sphinx documents demand quite some steps in their creation. We have
automated
@@ -1858,7 +1922,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>The manual Sphinx procedure <a name="___sec38"></a></h4>
+<h4>The manual Sphinx procedure <a name="___sec39"></a></h4>
<p>
If it is not desirable to use the autogenerated scripts explained
@@ -1968,7 +2032,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="___sec39"></a></h3>
+<h3>Wiki Formats <a name="___sec40"></a></h3>
<p>
There are many different wiki formats, but Doconce only supports three:
@@ -2015,7 +2079,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="___sec40"></a></h3>
+<h3>Tweaking the Doconce Output <a name="___sec41"></a></h3>
<p>
Occasionally, one would like to tweak the output in a certain format
@@ -2030,13 +2094,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="___sec41"></a></h2>
+<h2>The Doconce Markup Language <a name="___sec42"></a></h2>
<p>
The Doconce format introduces four constructs to markup text:
lists, special lines, inline tags, and environments.
-<h3>Lists <a name="___sec42"></a></h3>
+<h3>Lists <a name="___sec43"></a></h3>
<p>
An unordered bullet list makes use of the <code>*</code> as bullet sign
@@ -2142,7 +2206,7 @@
lines)
</dl>
-<h3>Special Lines <a name="___sec43"></a></h3>
+<h3>Special Lines <a name="___sec44"></a></h3>
<p>
The Doconce markup language has a concept called <em>special lines</em>.
@@ -2266,9 +2330,9 @@
</code></pre>
<!-- end verbatim block -->
-<h2>Special Lines <a name="___sec44"></a></h2>
+<h2>Special Lines <a name="___sec45"></a></h2>
-<h3>Figures <a name="___sec45"></a></h3>
+<h3>Figures <a name="___sec46"></a></h3>
<p>
<!-- Note: need extra blank after FIGURE and MOVIE in !bc environments -->
@@ -2333,7 +2397,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="___sec46"></a></h3>
+<h3>Movies <a name="___sec47"></a></h3>
<p>
Here is an example on the <code>MOVIE:</code> keyword for embedding
movies. This
@@ -2428,7 +2492,7 @@
<em>CFD.</em>
-<h3>Copying Computer Code from Source Files <a name="___sec47"></a></h3>
+<h3>Copying Computer Code from Source Files <a name="___sec48"></a></h3>
<p>
Another type of special lines starts with <code>@@@CODE</code> and enables
copying
@@ -2443,7 +2507,7 @@
<font color="blue">colored words</font>,
plus LaTeX/TeX inline mathematics, such as \( \nu = \sin(x) \).
-<h4>Emphasized Words <a name="___sec49"></a></h4>
+<h4>Emphasized Words <a name="___sec50"></a></h4>
<p>
Emphasized text is typeset inside a pair of asterisk, and there should
@@ -2462,7 +2526,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="___sec50"></a></h4>
+<h4>Inline Verbatim Text <a name="___sec51"></a></h4>
<p>
Verbatim text, typically used for short inline code,
@@ -2490,7 +2554,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="___sec51"></a></h4>
+<h4>Links to Web Addresses <a name="___sec52"></a></h4>
<p>
Web addresses with links are typeset as
@@ -2517,7 +2581,23 @@
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="___sec52"></a></h4>
+<h4>Mail Addresses <a name="___sec53"></a></h4>
+
+<p>
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+<p>
+<!-- begin verbatim block -->
+<pre><code>Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+</code></pre>
+<!-- end verbatim block -->
+which appears as Send <a href="mailto:h...@simula.no">mail</a> to
+<a href="mailto:h...@simula.no"><tt>h...@simula.no</tt></a>.
+
+<h4>Links to Local Files <a name="___sec54"></a></h4>
<p>
Links to files ending in <code>.txt</code>, <code>.html</code>,
<code>.pdf</code>, <code>.py</code>, <code>.f</code>,
@@ -2595,7 +2675,7 @@
<!-- <code>_static</code> directory - links in the <code>.rst</code> files
are automatically -->
<!-- adjusted.) -->
-<h4>Inline Comments <a name="___sec53"></a></h4>
+<h4>Inline Comments <a name="___sec55"></a></h4>
<p>
Doconce also supports inline comments in the text:
@@ -2628,7 +2708,7 @@
comment in parenthesis), but in LaTeX very visible color boxes
are used (via the <code>todonotes</code> package).
-<h4>Inline Mathematics <a name="___sec54"></a></h4>
+<h4>Inline Mathematics <a name="___sec56"></a></h4>
<p>
Inline mathematics is written as in LaTeX, i.e., inside dollar signs.
@@ -2658,7 +2738,7 @@
is an \( n\times n \) matrix, and \( \bf x \) and \( \bf b \)
are vectors of length \( n \)."
-<h3>Comments <a name="___sec55"></a></h3>
+<h3>Comments <a name="___sec57"></a></h3>
<p>
Comments intended to be (sometimes) visible in the output document and
@@ -2698,7 +2778,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="___sec56"></a></h3>
+<h3>Cross-Referencing <a name="___sec58"></a></h3>
<p>
References and labels are supported. The syntax is simple:
@@ -2829,7 +2909,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Index <a name="___sec58"></a></h3>
+<h3>Index <a name="___sec60"></a></h3>
<p>
An index can be created for the <code>latex</code>, <code>rst</code>, and
<code>sphinx</code> formats
@@ -2862,7 +2942,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="___sec59"></a></h3>
+<h3>Bibliography <a name="___sec61"></a></h3>
<p>
Doconce applies the software tool <a
href="https://bitbucket.org/logg/publish">Publish</a> to handle the
bibliography in a
@@ -2877,7 +2957,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="___sec60"></a></h4>
+<h4>Importing your data to the Publish database <a
name="___sec62"></a></h4>
<p>
Many scientists have their bibliographic data in the BibTex format. Here we
@@ -2899,7 +2979,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="___sec61"></a></h4>
+<h4>Requirements to input data <a name="___sec63"></a></h4>
<p>
<div class="alert alert-block alert-notice
alert-text-normal"><b>Notice.</b>
@@ -2930,7 +3010,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="___sec62"></a></h4>
+<h4>Adding new references to the database <a name="___sec64"></a></h4>
<p>
When you get some new BibTeX references you simply put them in
@@ -2938,7 +3018,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="___sec63"></a></h4>
+<h4>Exporting the database <a name="___sec65"></a></h4>
<p>
Export of everything in the database to
@@ -2954,7 +3034,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="___sec64"></a></h4>
+<h4>Referring to publications <a name="___sec66"></a></h4>
<p>
We use the command
@@ -2986,7 +3066,7 @@
brackets and the corresponding references are listed in the order they
are cited.
-<h4>Specifying the Publish database <a name="___sec65"></a></h4>
+<h4>Specifying the Publish database <a name="___sec67"></a></h4>
<p>
The specification of the Publish database file in the Doconce document
@@ -3009,7 +3089,7 @@
and included in the document, while in all other formats, suitable
text is produced from the database.
-<h4>LaTeX bibliography style <a name="___sec66"></a></h4>
+<h4>LaTeX bibliography style <a name="___sec68"></a></h4>
<p>
The bibliography style is "plain" in LaTeX output. To change this, just
@@ -3022,7 +3102,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Tables <a name="___sec67"></a></h3>
+<h3>Tables <a name="___sec69"></a></h3>
<p>
A table like
@@ -3116,7 +3196,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Exercises, Problems, Projects, and Examples <a
name="___sec68"></a></h3>
+<h3>Exercises, Problems, Projects, and Examples <a
name="___sec70"></a></h3>
<p>
Doconce has special support for four types of "exercises", named
@@ -3603,7 +3683,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Mathematics for PowerPoint/OpenOffice <a name="___sec71"></a></h4>
+<h4>Mathematics for PowerPoint/OpenOffice <a name="___sec73"></a></h4>
<p>
If you have LaTeX mathematics written in Doconce, it is fairly easy
@@ -3656,7 +3736,7 @@
line (multi-line newcommands are too hard to parse with regular
expressions).
-<h3>Admonitions <a name="___sec73"></a></h3>
+<h3>Admonitions <a name="___sec75"></a></h3>
<p>
Doconce offers strong support for admonition environments, such
@@ -3749,11 +3829,11 @@
<p>
<ul>
- <li> <code>--html_admon=apricot</code>,
<code>--html_style=solarized</code></li>
- <li> <code>--html_admon=yellow</code>, <code>--html_style=bluish2</code>,
<code>--no_pygments_html</code></li>
- <li> <code>--html_admon=yellow</code>,
<code>--html_style=blueish2</code>,
<code>--pygments_html_style=default</code></li>
- <li> <code>--html_admon=gray</code>, <code>--html_style=bloodish</code>,
<code>--no_pygments_html</code></li>
- <li> <code>--html_admon=gray</code>, <code>--html_style=bloodish</code>,
<code>--pygments_html_style=default</code></li>
+ <li> <code>--html_style=solarized</code>,
<code>--html_admon=apricot</code>,
<code>--pygments_html_style=perldoc</code></li>
+ <li> <code>--html_style=blueish2</code>,
<code>--html_admon=yellow</code>, <code>--no_pygments_html</code></li>
+ <li> <code>--html_style=blueish2</code>,
<code>--html_admon=yellow</code>,
<code>--pygments_html_style=default</code></li>
+ <li> <code>--html_style=bloodish</code>, <code>--html_admon=gray</code>,
<code>--no_pygments_html</code></li>
+ <li> <code>--html_style=bloodish</code>, <code>--html_admon=gray</code>,
<code>--pygments_html_style=default</code></li>
<li> <code>--html_style=vagrant</code>,
<code>--pygments_html_style=default</code>,
<code>--html_template=...</code></li>
</ul>
@@ -3790,7 +3870,7 @@
<li> <code>yellowbox</code> has icons and a light yellow background.</li>
</ul>
-<h3>Preprocessing Steps <a name="___sec74"></a></h3>
+<h3>Preprocessing Steps <a name="___sec76"></a></h3>
<p>
Doconce allows preprocessor commands for, e.g., including files,
@@ -3869,7 +3949,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="___sec75"></a></h3>
+<h3>Splitting Documents into Smaller Pieces <a name="___sec77"></a></h3>
<p>
Long documents are conveniently split into smaller Doconce files.
@@ -3965,7 +4045,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="___sec76"></a></h3>
+<h3>Missing Features <a name="___sec78"></a></h3>
<p>
Doconce does not aim to support sophisticated typesetting, simply because
@@ -3999,7 +4079,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="___sec77"></a></h3>
+<h3>Header and Footer <a name="___sec79"></a></h3>
<p>
Some formats use a header and footer in the document. LaTeX and
@@ -4055,7 +4135,7 @@
the different shortcuts and see how handy they are in learning
Doconce and saving much typing!
-<h2>Writing Slides <a name="___sec79"></a></h2>
+<h2>Writing Slides <a name="___sec81"></a></h2>
<p>
It is a fast procedure to make slides from large amounts of Doconce
@@ -4079,7 +4159,7 @@
color for code</li>
</ul>
-<h3>Overview <a name="___sec80"></a></h3>
+<h3>Overview <a name="___sec82"></a></h3>
<p>
Basically, Doconce slides are ordinary Doconce text with
<code>!split</code>
@@ -4109,7 +4189,7 @@
slides to be presented through a web browser, and classical
LaTeX Beamer slides.
-<h3>HTML5 Slides <a name="___sec81"></a></h3>
+<h3>HTML5 Slides <a name="___sec83"></a></h3>
<p>
<!-- doconce-adjusted styles: easy to switch between styles since -->
@@ -4128,7 +4208,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Potential Problems <a name="___sec82"></a></h4>
+<h4>Potential Problems <a name="___sec84"></a></h4>
<p>
@@ -4139,12 +4219,12 @@
equations. More edits (automate with <code>doconce subst</code>) might
be needed.</li>
</ul>
-<h3>LaTeX Beamer Slides <a name="___sec83"></a></h3>
+<h3>LaTeX Beamer Slides <a name="___sec85"></a></h3>
<p>
Not yet written...
-<h4>Themes <a name="___sec84"></a></h4>
+<h4>Themes <a name="___sec86"></a></h4>
<p>
Four themes come with Doconce: <code>X_Y</code>, where <code>X</code> is
<code>blue</code> or <code>red</code>
@@ -4153,7 +4233,7 @@
<a
href="http://hplgit.github.io/teamods/doconce/demo/demo_blue_shadow.pdf"><tt>shadow</tt></a>
for shadowed boxes and more visual structure in the slides.
-<h2>Mako Programming <a name="___sec85"></a></h2>
+<h2>Mako Programming <a name="___sec87"></a></h2>
<p>
The <a href="http://docs.makotemplates.org/">Mako</a> templating engine is
used
@@ -4172,7 +4252,7 @@
Mako function call. This problem can give rise to strange error
messages from Mako, usually that a variable is not defined.
</div>
-<h3>The Basics of Mako <a name="___sec86"></a></h3>
+<h3>The Basics of Mako <a name="___sec88"></a></h3>
<p>
Just a preliminary sketch of some Mako code (next example is better!):
@@ -4341,9 +4421,9 @@
the <code>ptex2tex</code> program with all its flexibility for choosing
environments.
Also <code>doconce ptex2tex</code> has some flexibility for typesetting
computer code.
-<h2>Troubleshooting <a name="___sec88"></a></h2>
+<h2>Troubleshooting <a name="___sec90"></a></h2>
-<h3>Disclaimer <a name="___sec89"></a></h3>
+<h3>Disclaimer <a name="___sec91"></a></h3>
<p>
Doconce has some support for syntax checking. If you encounter Python
@@ -4354,9 +4434,9 @@
regular expressions may sometimes fail. Therefore, there is a chance that
legal
Doconce syntax is not treated properly.
-<h3>General Problems <a name="___sec90"></a></h3>
+<h3>General Problems <a name="___sec92"></a></h3>
-<h4>Spellcheck reports a lot of mistakes related LaTeX math <a
name="___sec91"></a></h4>
+<h4>Spellcheck reports a lot of mistakes related LaTeX math <a
name="___sec93"></a></h4>
<p>
The <code>doconce spellcheck</code> command should ignore LaTeX math, but
if
@@ -4366,7 +4446,7 @@
are reported as misspellings. This will fortunately give you hint of
what is wrong with the math typesetting.
-<h4>Doconce aborts because of a syntax error that is not an error <a
name="___sec92"></a></h4>
+<h4>Doconce aborts because of a syntax error that is not an error <a
name="___sec94"></a></h4>
<p>
Doconce searches for typical syntax errors and usually aborts the
@@ -4376,7 +4456,7 @@
<code>--no_abort</code> option on the command line. You may send an email
to the Doconce author at <code>h...@simula.no</code> and report the problem.
-<h4>The Mako preprocessor is seemingly not run <a
name="___sec93"></a></h4>
+<h4>The Mako preprocessor is seemingly not run <a
name="___sec95"></a></h4>
<p>
If you have lines starting with <code>%</code> inside code segments (for
example,
@@ -4385,7 +4465,7 @@
this problem and avoids running Mako. Examine the output from
Doconce: warnings are issued if Mako is not run.
-<h4>The Mako preprocessor is fooled by Doconce text <a
name="___sec94"></a></h4>
+<h4>The Mako preprocessor is fooled by Doconce text <a
name="___sec96"></a></h4>
<p>
Here are possible problems for Mako:
@@ -4397,7 +4477,7 @@
to <code>'T < %.1f'</code> to avoid this confusion.</li>
</ul>
-<h4>The Mako preprocessor claims a variable is undefined <a
name="___sec95"></a></h4>
+<h4>The Mako preprocessor claims a variable is undefined <a
name="___sec97"></a></h4>
<p>
Very often such errors are related to typos when using Mako
@@ -4419,7 +4499,7 @@
the text and apply a "bisection" procedure to locate where
the Mako problem is (without <code>--mako_strict_undefined</code>).
-<h4>Something goes wrong in the preprocessing step <a
name="___sec96"></a></h4>
+<h4>Something goes wrong in the preprocessing step <a
name="___sec98"></a></h4>
<p>
You can examine <code>tmp_preprocess__filename</code> and
<code>tmp_mako__filename</code>,
@@ -4430,7 +4510,7 @@
***The diff for this file has been truncated for email.***
=======================================
--- /doc/demos/manual/manual.md Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.md Sat Aug 10 23:22:34 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
-% Jul 13, 2013
+% Aug 11, 2013
<!-- lines beginning with # are doconce comment lines -->
<!-- (documents can also have mako comment lines) -->
@@ -69,11 +69,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -798,8 +798,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -934,6 +934,64 @@
The `-s` option adds a proper header and footer to the `mydoc.html` file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+#### GitHub-flavored Markdown
+
+Adding the command-line option `github-md` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[GitHub](http://github.com). A special feature is the support of task lists:
+unnumbered lists with `[x]` (task done) or `[ ]` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Say this text is stored in a file `mycomments.do.txt`. Running
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.Bash}
+Terminal> doconce format pandoc mycomments --github_md
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+produces `mycomments.md` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
### LaTeX
@@ -955,11 +1013,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,
@@ -2002,6 +2060,21 @@
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.)
+#### Mail Addresses
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+which appears as Send [mail](mailto:h...@simula.no) to
+[`h...@simula.no`](mailto:h...@simula.no).
+
#### Links to Local Files
Links to files ending in `.txt`, `.html`, `.pdf`, `.py`, `.f`,
@@ -3172,15 +3245,15 @@
Some recommended combinations for admonitions in HTML are
- * `--html_admon=apricot`, `--html_style=solarized`
+ * `--html_style=solarized`, `--html_admon=apricot`,
`--pygments_html_style=perldoc`
- * `--html_admon=yellow`, `--html_style=bluish2`, `--no_pygments_html`
+ * `--html_style=blueish2`, `--html_admon=yellow`, `--no_pygments_html`
- * `--html_admon=yellow`, `--html_style=blueish2`,
`--pygments_html_style=default`
+ * `--html_style=blueish2`, `--html_admon=yellow`,
`--pygments_html_style=default`
- * `--html_admon=gray`, `--html_style=bloodish`, `--no_pygments_html`
+ * `--html_style=bloodish`, `--html_admon=gray`, `--no_pygments_html`
- * `--html_admon=gray`, `--html_style=bloodish`,
`--pygments_html_style=default`
+ * `--html_style=bloodish`, `--html_admon=gray`,
`--pygments_html_style=default`
* `--html_style=vagrant`, `--pygments_html_style=default`,
`--html_template=...`
=======================================
--- /doc/demos/manual/manual.mwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.mwiki Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
#TITLE (actually governed by the filename): Doconce Description
By '''Hans Petter Langtangen'''
-==== Jul 13, 2013 ====
+==== Aug 11, 2013 ====
<!-- lines beginning with # are doconce comment lines -->
<!-- (documents can also have mako comment lines) -->
@@ -67,11 +67,11 @@
''History.''
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
''Disclaimer.''
Doconce is a simple tool, largely based on interpreting
@@ -735,8 +735,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -868,6 +868,60 @@
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.
+==== GitHub-flavored Markdown ====
+
+Adding the command-line option <code>github-md</code> turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[http://github.com GitHub]. A special feature is the support of task lists:
+unnumbered lists with <code>[x]</code> (task done) or <code>[ ]</code>
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+<syntaxhighlight lang="text">
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</syntaxhighlight>
+Say this text is stored in a file <code>mycomments.do.txt</code>. Running
+
+<syntaxhighlight lang="bash">
+Terminal> doconce format pandoc mycomments --github_md
+</syntaxhighlight>
+produces <code>mycomments.md</code> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
==== LaTeX ====
@@ -888,11 +942,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option <code>-DDEVICE=paper</code> makes some adjustments for documents
+An option <code>--device=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.
+The default, <code>--device=screen</code>, creates a PDF file for reading
+on a screen where links are just clickable.
''Step 2.''
Run <code>ptex2tex</code> (if you have it) to make a standard LaTeX file,
@@ -1869,6 +1923,19 @@
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.)
+==== Mail Addresses ====
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+<syntaxhighlight lang="text">
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+</syntaxhighlight>
+which appears as Send [mailto:h...@simula.no mail] to
+[mailto:h...@simula.no <code>h...@simula.no</code>].
+
==== Links to Local Files ====
Links to files ending in <code>.txt</code>, <code>.html</code>,
<code>.pdf</code>, <code>.py</code>, <code>.f</code>,
@@ -2979,11 +3046,11 @@
<ul>
- <li> <code>--html_admon=apricot</code>,
<code>--html_style=solarized</code>
- <li> <code>--html_admon=yellow</code>, <code>--html_style=bluish2</code>,
<code>--no_pygments_html</code>
- <li> <code>--html_admon=yellow</code>,
<code>--html_style=blueish2</code>,
<code>--pygments_html_style=default</code>
- <li> <code>--html_admon=gray</code>, <code>--html_style=bloodish</code>,
<code>--no_pygments_html</code>
- <li> <code>--html_admon=gray</code>, <code>--html_style=bloodish</code>,
<code>--pygments_html_style=default</code>
+ <li> <code>--html_style=solarized</code>,
<code>--html_admon=apricot</code>,
<code>--pygments_html_style=perldoc</code>
+ <li> <code>--html_style=blueish2</code>,
<code>--html_admon=yellow</code>, <code>--no_pygments_html</code>
+ <li> <code>--html_style=blueish2</code>,
<code>--html_admon=yellow</code>, <code>--pygments_html_style=default</code>
+ <li> <code>--html_style=bloodish</code>, <code>--html_admon=gray</code>,
<code>--no_pygments_html</code>
+ <li> <code>--html_style=bloodish</code>, <code>--html_admon=gray</code>,
<code>--pygments_html_style=default</code>
<li> <code>--html_style=vagrant</code>,
<code>--pygments_html_style=default</code>, <code>--html_template=...</code>
</ul>
=======================================
--- /doc/demos/manual/manual.p.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.p.tex Sat Aug 10 23:22:34 2013
@@ -316,16 +316,16 @@
% #if LATEX_HEADING == "traditional"
-\date{Jul 13, 2013}
+\date{Aug 11, 2013}
\maketitle
% #elif LATEX_HEADING == "beamer"
-\date{Jul 13, 2013
+\date{Aug 11, 2013
% <titlepage figure>
}
% #elif LATEX_HEADING == "titlepage"
\ \\ [10mm]
-{\large\textsf{Jul 13, 2013}}
+{\large\textsf{Aug 11, 2013}}
\end{center}
\vfill
@@ -333,7 +333,7 @@
% #else
\begin{center}
-Jul 13, 2013
+Aug 11, 2013
\end{center}
\vspace{1cm}
@@ -413,11 +413,11 @@
\paragraph{History.}
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
\paragraph{Disclaimer.}
Doconce is a simple tool, largely based on interpreting
@@ -1078,8 +1078,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1209,6 +1209,59 @@
The \code{-s} option adds a proper header and footer to the
\code{mydoc.html} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+\paragraph{GitHub-flavored Markdown.}
+Adding the command-line option \code{github-md} turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{{http://github.com}}{GitHub}. A special feature is the support of
task lists:
+unnumbered lists with \code{[x]} (task done) or \code{[ ]} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+\bccq
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+\eccq
+Say this text is stored in a file \code{mycomments.do.txt}. Running
+
+\bsys
+Terminal> doconce format pandoc mycomments --github_md
+\esys
+produces \code{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
\subsection{{\LaTeX}}
@@ -1229,11 +1282,11 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.
-An option \code{-DDEVICE=paper} makes some adjustments for documents
+An option \code{--device=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.
+The default, \code{--device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
\paragraph{Step 2.}
Run \code{ptex2tex} (if you have it) to make a standard {\LaTeX} file,
@@ -2234,7 +2287,7 @@
Doconce supports tags for \emph{emphasized phrases}, \textbf{boldface
phrases},
and \code{verbatim text} (also called type writer text, for inline code),
\textcolor{blue}{colored words},
-plus {\LaTeX}/TeX inline mathematics, such as $\nu = \sin(x)$.
+plus LaTeX/TeX inline mathematics, such as $\nu = \sin(x)$.
\paragraph{Emphasized Words.}
Emphasized text is typeset inside a pair of asterisk, and there should
@@ -2296,6 +2349,18 @@
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.)
+\paragraph{Mail Addresses.}
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+\bccq
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+\eccq
+which appears as Send \href{{mailto:h...@simula.no}}{mail} to
+\href{{mailto:h...@simula.no}}{\nolinkurl{h...@simula.no}}.
+
\paragraph{Links to Local Files.}
Links to files ending in \code{.txt}, \code{.html}, \code{.pdf},
\code{.py}, \code{.f},
\code{.f77}, \code{.f90}, \code{.f95}, \code{.sh}, \code{.csh},
\code{.ksh}, \code{.zsh},
@@ -3043,7 +3108,7 @@
does not introduce any environment in \code{sphinx} output, as interactive
sessions are automatically recognized and handled). All these
definitions of the arguments after \code{!bc} can be redefined in the
-\code{.ptex2tex.cfg} configuration file for ptex2tex/{\LaTeX} and in the
+\code{.ptex2tex.cfg} configuration file for ptex2tex/LaTeX and in the
\code{sphinx code-blocks} comments for Sphinx. Support for other languages
is easily added.
@@ -3408,15 +3473,15 @@
Some recommended combinations for admonitions in HTML are
\begin{itemize}
- \item \code{--html_admon=apricot}, \code{--html_style=solarized}
+ \item \code{--html_style=solarized}, \code{--html_admon=apricot},
\code{--pygments_html_style=perldoc}
- \item \code{--html_admon=yellow}, \code{--html_style=bluish2},
\code{--no_pygments_html}
+ \item \code{--html_style=blueish2}, \code{--html_admon=yellow},
\code{--no_pygments_html}
- \item \code{--html_admon=yellow}, \code{--html_style=blueish2},
\code{--pygments_html_style=default}
+ \item \code{--html_style=blueish2}, \code{--html_admon=yellow},
\code{--pygments_html_style=default}
- \item \code{--html_admon=gray}, \code{--html_style=bloodish},
\code{--no_pygments_html}
+ \item \code{--html_style=bloodish}, \code{--html_admon=gray},
\code{--no_pygments_html}
- \item \code{--html_admon=gray}, \code{--html_style=bloodish},
\code{--pygments_html_style=default}
+ \item \code{--html_style=bloodish}, \code{--html_admon=gray},
\code{--pygments_html_style=default}
\item \code{--html_style=vagrant}, \code{--pygments_html_style=default},
\code{--html_template=...}
\end{itemize}
=======================================
--- /doc/demos/manual/manual.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.pdf Sat Aug 10 23:22:34 2013
File is too large to display a diff.
=======================================
--- /doc/demos/manual/manual.rst Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.rst Sat Aug 10 23:22:34 2013
@@ -5,7 +5,7 @@
===================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
.. lines beginning with # are doconce comment lines
@@ -78,11 +78,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -803,8 +803,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -936,6 +936,61 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -961,11 +1016,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file::
@@ -2012,6 +2067,20 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as::
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send `mail <mailto:h...@simula.no>`_ to
+`h...@simula.no <mailto:h...@simula.no>`_.
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -3193,15 +3262,15 @@
Some recommended combinations for admonitions in HTML are
- * ``--html_admon=apricot``, ``--html_style=solarized``
+ * ``--html_style=solarized``, ``--html_admon=apricot``,
``--pygments_html_style=perldoc``
- * ``--html_admon=yellow``, ``--html_style=bluish2``,
``--no_pygments_html``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--no_pygments_html``
- * ``--html_admon=yellow``, ``--html_style=blueish2``,
``--pygments_html_style=default``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--pygments_html_style=default``
- * ``--html_admon=gray``, ``--html_style=bloodish``, ``--no_pygments_html``
+ * ``--html_style=bloodish``, ``--html_admon=gray``, ``--no_pygments_html``
- * ``--html_admon=gray``, ``--html_style=bloodish``,
``--pygments_html_style=default``
+ * ``--html_style=bloodish``, ``--html_admon=gray``,
``--pygments_html_style=default``
* ``--html_style=vagrant``, ``--pygments_html_style=default``,
``--html_template=...``
=======================================
--- /doc/demos/manual/manual.rst.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.rst.html Sat Aug 10 23:22:34 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">Jul 13, 2013</td>
+<tr class="field"><th class="field-name">Date:</th><td
class="field-body">Aug 11, 2013</td>
</tr>
</tbody>
</table>
@@ -389,11 +389,11 @@
</blockquote>
<p><em>History.</em> Doconce was developed in 2006 at a time when most
popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.</p>
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.</p>
<p><em>Disclaimer.</em> Doconce is a simple tool, largely based on
interpreting
and handling text through regular expressions. The possibility for
tweaking the layout is obviously limited since the text can go to
@@ -1022,8 +1022,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1142,6 +1142,58 @@
</pre>
<p>The <tt class="docutils literal"><span class="pre">-s</span></tt>
option adds a proper header and footer to the <tt class="docutils
literal">mydoc.html</tt> file.
This recipe is a quick way of makeing HTML notes with (some)
mathematics.</p>
+<div class="section" id="github-flavored-markdown">
+<h3>GitHub-flavored Markdown</h3>
+<p>Adding the command-line option <tt class="docutils literal"><span
class="pre">github-md</span></tt> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
class="reference external" href="http://github.com">GitHub</a>. A special
feature is the support of task lists:
+unnumbered lists with <tt class="docutils literal">[x]</tt> (task done) or
<tt class="docutils literal">[ ]</tt> (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:</p>
+<pre class="literal-block">
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</pre>
+<p>Say this text is stored in a file <tt class="docutils
literal">mycomments.do.txt</tt>. Running:</p>
+<pre class="literal-block">
+Terminal> doconce format pandoc mycomments --github_md
+</pre>
+<p>produces <tt class="docutils literal">mycomments.md</tt> which can be
pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</p>
+</div>
</div>
<div class="section" id="latex">
<h2>LaTeX</h2>
@@ -1159,11 +1211,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">-DDEVICE=paper</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">--device=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).
-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>
+The default, <tt class="docutils literal"><span
class="pre">--device=screen</span></tt>, creates a PDF file for reading
+on a screen where links are just 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> ptex2tex mydoc
@@ -2022,6 +2074,18 @@
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.)</p>
</div>
+<div class="section" id="mail-addresses">
+<h3>Mail Addresses</h3>
+<p>Links that launches a mail to a specified address is written as
+ordinary URLs, typically as:</p>
+<pre class="literal-block">
+Send "mail": "mailto:hpl@simula.no"
+# Alternative:
+to "`hpl@simula.no`": "mailto:hpl@simula.no".
+</pre>
+<p>which appears as Send <a class="reference external"
href="mailto:hpl@simula.no">mail</a> to
+<a class="reference external"
href="mailto:hpl@simula.no">hpl@simula.no</a>.</p>
+</div>
<div class="section" id="links-to-local-files">
<h3>Links to Local Files</h3>
<p>Links to files ending in <tt class="docutils literal">.txt</tt>, <tt
class="docutils literal">.html</tt>, <tt class="docutils
literal">.pdf</tt>, <tt class="docutils literal">.py</tt>, <tt
class="docutils literal">.f</tt>,
@@ -3060,11 +3124,11 @@
<p>Some recommended combinations for admonitions in HTML are</p>
<blockquote>
<ul class="simple">
-<li><tt class="docutils literal"><span
class="pre">--html_admon=apricot</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=solarized</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=yellow</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bluish2</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=yellow</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=blueish2</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=gray</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bloodish</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=gray</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bloodish</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=solarized</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=apricot</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=perldoc</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=blueish2</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=yellow</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=blueish2</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=yellow</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=bloodish</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=gray</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=bloodish</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=gray</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
<li><tt class="docutils literal"><span
class="pre">--html_style=vagrant</span></tt>, <tt class="docutils
literal"><span class="pre">--pygments_html_style=default</span></tt>, <tt
class="docutils literal"><span
class="pre">--html_template=...</span></tt></li>
</ul>
</blockquote>
@@ -3434,7 +3498,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 3586); <em><a
href="#id15">backlink</a></em></p>
+<p class="system-message-title">System Message: WARNING/2 (<tt
class="docutils">manual.rst</tt>, line 3655); <em><a
href="#id15">backlink</a></em></p>
Duplicate explicit target name: "mako".</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 Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.rst.pdf Sat Aug 10 23:22:34 2013
Binary file, no diff available.
=======================================
--- /doc/demos/manual/manual.rst.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.rst.tex Sat Aug 10 23:22:34 2013
@@ -82,7 +82,7 @@
Hans Petter Langtangen
\item[{Date:}]
-Jul 13, 2013
+Aug 11, 2013
\end{DUfieldlist}
@@ -168,11 +168,11 @@
\emph{History.} Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
\emph{Disclaimer.} Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -1197,8 +1197,8 @@
~~~~~~~~~~-{}-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\\
+~~~~~~~~~~-{}-html\_output=mydoc\_solarized~\textbackslash{}\\
+~~~~~~~~~~-{}-pygments\_html\_style=perldoc~-{}-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\\
@@ -1376,6 +1376,71 @@
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ GitHub-flavored Markdown%
+ \addcontentsline{toc}{subsubsection}{GitHub-flavored Markdown}%
+ \label{github-flavored-markdown}%
+}
+
+Adding the command-line option \texttt{github-md} turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{http://github.com}{GitHub}. A special feature is the support of task
lists:
+unnumbered lists with \texttt{{[}x{]}} (task done) or \texttt{{[} {]}}
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+!bquote\\
+=====~Problems~with~a~function~=====\\
+~\\
+There~is~a~problem~with~the~`f(x)`~function\\
+~\\
+!bc~pycod\\
+def~f(x):\\
+~~~~return~1~+~x\\
+!ec\\
+This~function~should~be~quadratic.\\
+!equote\\
+~\\
+OK,~this~is~fixed:\\
+~\\
+!bc~pycod\\
+def~f(x,~a=1,~b=1,~c=1):\\
+~~~~return~a*x**2~+~b*x~+~c\\
+!ec\\
+~\\
+=====~Updated~task~list~=====\\
+~\\
+~~~*~{[}x{]}~Offer~an~`f(x)`~function\\
+~~~*~{[}~{]}~Extension~to~cubic~functions\\
+~~~*~{[}x{]}~Allowing~general~coefficient~in~the~quadratic~function\\
+~\\
+===~Remaining~functionality~===\\
+~\\
+|
-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
\\
+|~function~|~purpose~~~~~~~~~~~~~~~~~~~~~~~~|~state~|\\
+|
-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
\\
+|~~`g(x)`~~|~Compute~the~Gaussian~function.~|~Formula~ready.~|\\
+|~~`h(x)`~~|~Heaviside~function.~~~~~~~~~~~~|~Formula~ready.~|\\
+|~~`I(x)`~~|~Indicator~function.~~~~~~~~~~~~|~Nothing~done~yet.~|\\
+|
-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
+}
+\end{quote}
+
+Say this text is stored in a file \texttt{mycomments.do.txt}. Running:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+Terminal>~doconce~format~pandoc~mycomments~-{}-github\_md
+}
+\end{quote}
+
+produces \texttt{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
+
%___________________________________________________________________________
\subsection*{\phantomsection%
@@ -1406,11 +1471,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option \texttt{-DDEVICE=paper} makes some adjustments for documents
+An option \texttt{-{}-device=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.
+The default, \texttt{-{}-device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
\emph{Step 2.} Run \texttt{ptex2tex} (if you have it) to make a standard
LaTeX file:
%
@@ -2668,6 +2733,28 @@
mark (but not period!) becomes a link with the web address as link text.)
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ Mail Addresses%
+ \addcontentsline{toc}{subsubsection}{Mail Addresses}%
+ \label{mail-addresses}%
+}
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+Send~"mail":~"mailto:h...@simula.no"\\
+\#~Alternative:\\
+to~"`h...@simula.no`":~"mailto:h...@simula.no".
+}
+\end{quote}
+
+which appears as Send \href{mailto:h...@simula.no}{mail} to
+\href{mailto:h...@simula.no}{h...@simula.no}.
+
+
%___________________________________________________________________________
\subsubsection*{\phantomsection%
@@ -4120,15 +4207,15 @@
%
\begin{itemize}
-\item \texttt{-{}-html\_admon=apricot}, \texttt{-{}-html\_style=solarized}
+\item \texttt{-{}-html\_style=solarized},
\texttt{-{}-html\_admon=apricot}, \texttt{-{}-pygments\_html\_style=perldoc}
-\item \texttt{-{}-html\_admon=yellow}, \texttt{-{}-html\_style=bluish2},
\texttt{-{}-no\_pygments\_html}
+\item \texttt{-{}-html\_style=blueish2}, \texttt{-{}-html\_admon=yellow},
\texttt{-{}-no\_pygments\_html}
-\item \texttt{-{}-html\_admon=yellow}, \texttt{-{}-html\_style=blueish2},
\texttt{-{}-pygments\_html\_style=default}
+\item \texttt{-{}-html\_style=blueish2}, \texttt{-{}-html\_admon=yellow},
\texttt{-{}-pygments\_html\_style=default}
-\item \texttt{-{}-html\_admon=gray}, \texttt{-{}-html\_style=bloodish},
\texttt{-{}-no\_pygments\_html}
+\item \texttt{-{}-html\_style=bloodish}, \texttt{-{}-html\_admon=gray},
\texttt{-{}-no\_pygments\_html}
-\item \texttt{-{}-html\_admon=gray}, \texttt{-{}-html\_style=bloodish},
\texttt{-{}-pygments\_html\_style=default}
+\item \texttt{-{}-html\_style=bloodish}, \texttt{-{}-html\_admon=gray},
\texttt{-{}-pygments\_html\_style=default}
\item \texttt{-{}-html\_style=vagrant},
\texttt{-{}-pygments\_html\_style=default}, \texttt{-{}-html\_template=...}
@@ -4720,7 +4807,7 @@
\DUtitle[system-message]{system-message}
-{\color{red}WARNING/2} in \texttt{manual.rst}, line~3586
+{\color{red}WARNING/2} in \texttt{manual.rst}, line~3655
\hyperlink{id15}{
Duplicate explicit target name: ``mako''.
=======================================
--- /doc/demos/manual/manual.sphinx.rst Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.sphinx.rst Sat Aug 10 23:22:34 2013
@@ -5,7 +5,7 @@
===================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
.. lines beginning with # are doconce comment lines
@@ -82,11 +82,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -875,8 +875,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1016,6 +1016,66 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+.. code-block:: text
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running
+
+
+.. code-block:: console
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -1042,11 +1102,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,
@@ -2196,6 +2256,23 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+
+.. code-block:: text
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send `mail <mailto:h...@simula.no>`_ to
+`h...@simula.no <mailto:h...@simula.no>`_.
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -3489,15 +3566,15 @@
Some recommended combinations for admonitions in HTML are
- * ``--html_admon=apricot``, ``--html_style=solarized``
+ * ``--html_style=solarized``, ``--html_admon=apricot``,
``--pygments_html_style=perldoc``
- * ``--html_admon=yellow``, ``--html_style=bluish2``,
``--no_pygments_html``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--no_pygments_html``
- * ``--html_admon=yellow``, ``--html_style=blueish2``,
``--pygments_html_style=default``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--pygments_html_style=default``
- * ``--html_admon=gray``, ``--html_style=bloodish``, ``--no_pygments_html``
+ * ``--html_style=bloodish``, ``--html_admon=gray``, ``--no_pygments_html``
- * ``--html_admon=gray``, ``--html_style=bloodish``,
``--pygments_html_style=default``
+ * ``--html_style=bloodish``, ``--html_admon=gray``,
``--pygments_html_style=default``
* ``--html_style=vagrant``, ``--pygments_html_style=default``,
``--html_template=...``
=======================================
--- /doc/demos/manual/manual.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.tex Sat Aug 10 23:22:34 2013
@@ -144,7 +144,7 @@
\begin{center}
-Jul 13, 2013
+Aug 11, 2013
\end{center}
\vspace{1cm}
@@ -223,11 +223,11 @@
\paragraph{History.}
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
\paragraph{Disclaimer.}
Doconce is a simple tool, largely based on interpreting
@@ -887,8 +887,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1016,6 +1016,59 @@
The \Verb!-s! option adds a proper header and footer to the
\Verb!mydoc.html! file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+\paragraph{GitHub-flavored Markdown.}
+Adding the command-line option \Verb!github-md! turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{{http://github.com}}{GitHub}. A special feature is the support of
task lists:
+unnumbered lists with \Verb![x]! (task done) or \Verb![ ]! (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+\end{Verbatim}
+Say this text is stored in a file \Verb!mycomments.do.txt!. Running
+
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
+Terminal> doconce format pandoc mycomments --github_md
+\end{Verbatim}
+produces \Verb!mycomments.md! which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
\subsection{{\LaTeX}}
@@ -1036,11 +1089,11 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.
-An option \Verb!-DDEVICE=paper! makes some adjustments for documents
+An option \Verb!--device=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.
+The default, \Verb!--device=screen!, creates a PDF file for reading
+on a screen where links are just clickable.
\paragraph{Step 2.}
Run \Verb!ptex2tex! (if you have it) to make a standard {\LaTeX} file,
@@ -2002,7 +2055,7 @@
Doconce supports tags for \emph{emphasized phrases}, \textbf{boldface
phrases},
and \Verb!verbatim text! (also called type writer text, for inline code),
\textcolor{blue}{colored words},
-plus {\LaTeX}/TeX inline mathematics, such as $\nu = \sin(x)$.
+plus LaTeX/TeX inline mathematics, such as $\nu = \sin(x)$.
\paragraph{Emphasized Words.}
Emphasized text is typeset inside a pair of asterisk, and there should
@@ -2064,6 +2117,18 @@
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.)
+\paragraph{Mail Addresses.}
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+\end{Verbatim}
+which appears as Send \href{{mailto:h...@simula.no}}{mail} to
+\href{{mailto:h...@simula.no}}{\nolinkurl{h...@simula.no}}.
+
\paragraph{Links to Local Files.}
Links to files ending in \Verb!.txt!, \Verb!.html!, \Verb!.pdf!,
\Verb!.py!, \Verb!.f!,
\Verb!.f77!, \Verb!.f90!, \Verb!.f95!, \Verb!.sh!, \Verb!.csh!,
\Verb!.ksh!, \Verb!.zsh!,
@@ -2810,7 +2875,7 @@
does not introduce any environment in \Verb!sphinx! output, as interactive
sessions are automatically recognized and handled). All these
definitions of the arguments after \Verb!!bc! can be redefined in the
-\Verb!.ptex2tex.cfg! configuration file for ptex2tex/{\LaTeX} and in the
+\Verb!.ptex2tex.cfg! configuration file for ptex2tex/LaTeX and in the
\Verb!sphinx code-blocks! comments for Sphinx. Support for other languages
is easily added.
@@ -3174,15 +3239,15 @@
Some recommended combinations for admonitions in HTML are
\begin{itemize}
- \item \Verb!--html_admon=apricot!, \Verb!--html_style=solarized!
+ \item \Verb!--html_style=solarized!, \Verb!--html_admon=apricot!,
\Verb!--pygments_html_style=perldoc!
- \item \Verb!--html_admon=yellow!, \Verb!--html_style=bluish2!,
\Verb!--no_pygments_html!
+ \item \Verb!--html_style=blueish2!, \Verb!--html_admon=yellow!,
\Verb!--no_pygments_html!
- \item \Verb!--html_admon=yellow!, \Verb!--html_style=blueish2!,
\Verb!--pygments_html_style=default!
+ \item \Verb!--html_style=blueish2!, \Verb!--html_admon=yellow!,
\Verb!--pygments_html_style=default!
- \item \Verb!--html_admon=gray!, \Verb!--html_style=bloodish!,
\Verb!--no_pygments_html!
+ \item \Verb!--html_style=bloodish!, \Verb!--html_admon=gray!,
\Verb!--no_pygments_html!
- \item \Verb!--html_admon=gray!, \Verb!--html_style=bloodish!,
\Verb!--pygments_html_style=default!
+ \item \Verb!--html_style=bloodish!, \Verb!--html_admon=gray!,
\Verb!--pygments_html_style=default!
\item \Verb!--html_style=vagrant!, \Verb!--pygments_html_style=default!,
\Verb!--html_template=...!
\end{itemize}
=======================================
--- /doc/demos/manual/manual.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.txt Sat Aug 10 23:22:34 2013
@@ -6,7 +6,7 @@
[1] Center for Biomedical Computing, Simula Research Laboratory
[2] Department of Informatics, University of Oslo
-Date: Jul 13, 2013
+Date: Aug 11, 2013
What Is Doconce?
================
@@ -72,11 +72,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -770,8 +770,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -900,6 +900,61 @@
The -s option adds a proper header and footer to the mydoc.html file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option github-md turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on GitHub
(http://github.com). A special feature is the support of task lists:
+unnumbered lists with [x] (task done) or [ ] (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file mycomments.do.txt. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces mycomments.md which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -918,11 +973,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option -DDEVICE=paper makes some adjustments for documents
+An option --device=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.
+The default, --device=screen, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ptex2tex (if you have it) to make a standard LaTeX file::
@@ -1927,6 +1982,20 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as::
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send mail (mailto:h...@simula.no) to
+h...@simula.no (mailto:h...@simula.no).
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -3042,15 +3111,15 @@
Some recommended combinations for admonitions in HTML are
- * --html_admon=apricot, --html_style=solarized
+ * --html_style=solarized, --html_admon=apricot,
--pygments_html_style=perldoc
- * --html_admon=yellow, --html_style=bluish2, --no_pygments_html
+ * --html_style=blueish2, --html_admon=yellow, --no_pygments_html
- * --html_admon=yellow, --html_style=blueish2,
--pygments_html_style=default
+ * --html_style=blueish2, --html_admon=yellow,
--pygments_html_style=default
- * --html_admon=gray, --html_style=bloodish, --no_pygments_html
+ * --html_style=bloodish, --html_admon=gray, --no_pygments_html
- * --html_admon=gray, --html_style=bloodish, --pygments_html_style=default
+ * --html_style=bloodish, --html_admon=gray, --pygments_html_style=default
* --html_style=vagrant, --pygments_html_style=default, --html_template=...
=======================================
--- /doc/demos/manual/manual.xml Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.xml Sat Aug 10 23:22:34 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>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
+(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>Aug
11, 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,
@@ -40,11 +40,11 @@
special support for exercises, and produces
cleaner LaTeX and HTML
output.</paragraph></list_item></bullet_list></block_quote><paragraph><emphasis>History.</emphasis>
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer
code.</paragraph><paragraph><emphasis>Disclaimer.</emphasis> Doconce is a
simple tool, largely based on interpreting
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer
code.</paragraph><paragraph><emphasis>Disclaimer.</emphasis> Doconce is a
simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
tweaking the layout is obviously limited since the text can go to
all sorts of sophisticated markup languages. Moreover, because of
@@ -328,8 +328,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -391,16 +391,56 @@
and date), maybe with some unnumbered equations, and quickly generate
HTML with mathematics displayed my MathJax:</paragraph><literal_block
xml:space="preserve">Terminal> doconce format pandoc mydoc
Terminal> pandoc -t html -o mydoc.html -s --mathjax
mydoc.mkd</literal_block><paragraph>The <literal>-s</literal> option adds a
proper header and footer to the <literal>mydoc.html</literal> file.
-This recipe is a quick way of makeing HTML notes with (some)
mathematics.</paragraph></section><section ids="latex"
names="latex"><title>LaTeX</title><paragraph>Making a LaTeX file
<literal>mydoc.tex</literal> from <literal>mydoc.do.txt</literal> is done
in two steps:</paragraph><comment xml:space="preserve">Note: putting code
blocks inside a list is not successful in many</comment><comment
xml:space="preserve">formats - the text may be messed up. A better choice
is a paragraph</comment><comment xml:space="preserve">environment, as used
here.</comment><paragraph><emphasis>Step 1.</emphasis> Filter the doconce
text to a pre-LaTeX form <literal>mydoc.p.tex</literal> for
+This recipe is a quick way of makeing HTML notes with (some)
mathematics.</paragraph><section ids="github-flavored-markdown"
names="github-flavored\ markdown"><title>GitHub-flavored
Markdown</title><paragraph>Adding the command-line option
<literal>github-md</literal> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <reference
name="GitHub" refuri="http://github.com">GitHub</reference><target
ids="github" names="github" refuri="http://github.com"/>. A special feature
is the support of task lists:
+unnumbered lists with <literal>[x]</literal> (task done) or <literal>[
]</literal> (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an
example:</paragraph><literal_block xml:space="preserve">!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
</literal_block><paragraph>Say this text is stored in a file
<literal>mycomments.do.txt</literal>. Running:</paragraph><literal_block
xml:space="preserve">Terminal> doconce format pandoc mycomments
--github_md</literal_block><paragraph>produces
<literal>mycomments.md</literal> which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</paragraph></section></section><section ids="latex"
names="latex"><title>LaTeX</title><paragraph>Making a LaTeX file
<literal>mydoc.tex</literal> from <literal>mydoc.do.txt</literal> is done
in two steps:</paragraph><comment xml:space="preserve">Note: putting code
blocks inside a list is not successful in many</comment><comment
xml:space="preserve">formats - the text may be messed up. A better choice
is a paragraph</comment><comment xml:space="preserve">environment, as used
here.</comment><paragraph><emphasis>Step 1.</emphasis> Filter the doconce
text to a pre-LaTeX form <literal>mydoc.p.tex</literal> for
the <literal>ptex2tex</literal> program (or <literal>doconce
ptex2tex</literal>):</paragraph><literal_block
xml:space="preserve">Terminal> doconce format latex
mydoc</literal_block><paragraph>LaTeX-specific commands
("newcommands") in math formulas and similar
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>-DDEVICE=paper</literal> makes some adjustments for documents
+so that your commands are defined.</paragraph><paragraph>An option
<literal>--device=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).
-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> 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>
doconce ptex2tex mydoc</literal_block><paragraph>Note that Doconce
generates a <literal>.p.tex</literal> file with some preprocessor macros
+The default, <literal>--device=screen</literal>, creates a PDF file for
reading
+on a screen where links are just
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> 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>
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> ptex2tex -DHELVETICA mydoc
@@ -864,7 +904,11 @@
before the address enclosed in double quotes:</paragraph><literal_block
xml:space="preserve">Click on this link:
URL:"http://code.google.com/p/doconce".</literal_block><paragraph>which
gets rendered as
Click on this link: <reference name="http://code.google.com/p/doconce"
refuri="http://code.google.com/p/doconce">http://code.google.com/p/doconce</reference><target
dupnames="http://code.google.com/p/doconce" ids="id5"
refuri="http://code.google.com/p/doconce"/>.</paragraph><paragraph>(There
is also support for lazy writing of URLs: any http or https web address
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.)</paragraph></section><section ids="links-to-local-files"
names="links\ to\ local\ files"><title>Links to Local
Files</title><paragraph>Links to files ending in <literal>.txt</literal>,
<literal>.html</literal>, <literal>.pdf</literal>, <literal>.py</literal>,
<literal>.f</literal>,
+mark (but not period!) becomes a link with the web address as link
text.)</paragraph></section><section ids="mail-addresses" names="mail\
addresses"><title>Mail Addresses</title><paragraph>Links that launches a
mail to a specified address is written as
+ordinary URLs, typically as:</paragraph><literal_block
xml:space="preserve">Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`":
"mailto:h...@simula.no".</literal_block><paragraph>which appears
as Send <reference name="mail"
refuri="mailto:h...@simula.no">mail</reference><target ids="mail"
names="mail" refuri="mailto:h...@simula.no"/> to
+<reference name="h...@simula.no"
refuri="mailto:h...@simula.no">h...@simula.no</reference><target
ids="hpl-simula-no" names="h...@simula.no"
refuri="mailto:h...@simula.no"/>.</paragraph></section><section
ids="links-to-local-files" names="links\ to\ local\ files"><title>Links to
Local Files</title><paragraph>Links to files ending in
<literal>.txt</literal>, <literal>.html</literal>, <literal>.pdf</literal>,
<literal>.py</literal>, <literal>.f</literal>,
<literal>.f77</literal>, <literal>.f90</literal>, <literal>.f95</literal>,
<literal>.sh</literal>, <literal>.csh</literal>, <literal>.ksh</literal>,
<literal>.zsh</literal>,
<literal>.c</literal>, <literal>.cpp</literal>, <literal>.cxx</literal>,
<literal>.pl</literal>, and <literal>.java</literal> follows the same
setup:</paragraph><literal_block xml:space="preserve">see the
"Doconce Manual":
"manual.do.txt".</literal_block><paragraph>which appears as see
the <reference name="Doconce Manual" refuri="manual.do.txt">Doconce
Manual</reference><target ids="doconce-manual" names="doconce\ manual"
refuri="manual.do.txt"/>.
@@ -1500,7 +1544,7 @@
and <literal>--html_admon=apricot</literal>
works as the <literal>gray</literal> style, but the color is different.
With <literal>--html_admon=colors</literal> one gets quite bright colors
-as backgrounds for the different admonitions.</paragraph><paragraph>Some
recommended combinations for admonitions in HTML
are</paragraph><block_quote><bullet_list
bullet="*"><list_item><paragraph><literal>--html_admon=apricot</literal>,
<literal>--html_style=solarized</literal></paragraph></list_item><list_item><paragraph><literal>--html_admon=yellow</literal>,
<literal>--html_style=bluish2</literal>,
<literal>--no_pygments_html</literal></paragraph></list_item><list_item><paragraph><literal>--html_admon=yellow</literal>,
<literal>--html_style=blueish2</literal>,
<literal>--pygments_html_style=default</literal></paragraph></list_item><list_item><paragraph><literal>--html_admon=gray</literal>,
<literal>--html_style=bloodish</literal>,
<literal>--no_pygments_html</literal></paragraph></list_item><list_item><paragraph><literal>--html_admon=gray</literal>,
<literal>--html_style=bloodish</literal>,
<literal>--pygments_html_style=default</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=vagrant</literal>,
<literal>--pygments_html_style=default</literal>,
<literal>--html_template=...</literal></paragraph></list_item></bullet_list></block_quote><paragraph>The
<literal>vagrant</literal> HTML style has CSS files that override the
definition
+as backgrounds for the different admonitions.</paragraph><paragraph>Some
recommended combinations for admonitions in HTML
are</paragraph><block_quote><bullet_list
bullet="*"><list_item><paragraph><literal>--html_style=solarized</literal>,
<literal>--html_admon=apricot</literal>,
<literal>--pygments_html_style=perldoc</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=blueish2</literal>,
<literal>--html_admon=yellow</literal>,
<literal>--no_pygments_html</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=blueish2</literal>,
<literal>--html_admon=yellow</literal>,
<literal>--pygments_html_style=default</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=bloodish</literal>,
<literal>--html_admon=gray</literal>,
<literal>--no_pygments_html</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=bloodish</literal>,
<literal>--html_admon=gray</literal>,
<literal>--pygments_html_style=default</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=vagrant</literal>,
<literal>--pygments_html_style=default</literal>,
<literal>--html_template=...</literal></paragraph></list_item></bullet_list></block_quote><paragraph>The
<literal>vagrant</literal> HTML style has CSS files that override the
definition
how the admons are typset. The <literal>notice</literal> environment is
gray with an
icon (defined in <literal>vagrant.css</literal>), while the others are
yellow (defined
in <literal>twitter_bootstrap.css</literal>). The
<literal>--html_admon</literal> color has no effect
@@ -1675,7 +1719,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="3586"
source="manual.rst" type="WARNING"><paragraph>Duplicate explicit target
name: "mako".</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="3655"
source="manual.rst" type="WARNING"><paragraph>Duplicate explicit target
name: "mako".</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
"filename"</literal>. Preprocess is also
sufficient for if-else tests to steer which parts of the text that
=======================================
--- /doc/demos/manual/manual_pdflatex.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual_pdflatex.pdf Sat Aug 10 23:22:34 2013
File is too large to display a diff.
=======================================
--- /doc/demos/tutorial/html/_sources/tutorial.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/html/_sources/tutorial.txt Sat Aug 10 23:22:34 2013
@@ -6,7 +6,7 @@
========================================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -674,8 +674,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -815,6 +815,66 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+.. code-block:: text
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running
+
+
+.. code-block:: console
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -841,11 +901,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,
=======================================
--- /doc/demos/tutorial/html/searchindex.js Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/html/searchindex.js Sat Aug 10 23:22:34 2013
@@ -1,1 +1,1 @@
-Search.setIndex({objects:{},terms:{mydoc2:1,all:1,code:[0,1],partial:1,illustr:1,hint:1,linebreak:1,totem:1,fig2:1,fig3:1,html_output:1,fig1:1,makeidx:1,follow:1,colon:1,mwlib:1,row:1,footnot:1,depend:[0,1],unnumb:1,flask:1,impati:1,elsewher:1,readabl:1,specif:1,send:1,articl:1,ecollin:1,program:1,those:1,preprocess:[0,1],aris:1,texmf:1,fenics_minim:1,introduc:1,suitabl:1,"case":1,yourdoc:1,sourc:1,everi:1,ubuntu_vers:1,titlepag:1,wrapper_tech:1,none:1,util:1,verb:1,volum:1,texconv:1,miller_2000:1,veri:1,word:1,syntax:[0,1],relev:1,gwiki:1,pygments_html_lineno:1,recip:1,baselinestretch:1,nileshbans:1,button:1,relbarbgcolor:1,list:1,upload:1,ryan:1,"try":1,item:1,adjust:1,combine_imag:1,larg:1,team:1,quick:[0,1],sidebarlinkcolor:1,relsiz:1,larsen_et_al_2002:1,dir:1,dirnam:1,impli:1,johnson_friedman_2010a:1,monospac:1,subsubsect:1,dxelatex:1,natur:1,newcommands_replac:1,odt:1,direct:1,tex:1,video:1,pass:1,download:1,further:1,dmath:1,click:1,folk:1,blue:1,index:[0,1],what:[0,1],appear:1,compar:1,unfinish:1,section:[0,1],multimedia:1,netpbm:1,find:1,current:1,delet:1,extra_sect:1,version:1,theme_dir:1,remove_inline_com:1,mathjax:1,mydoc_vagr:1,net:1,deduc:1,xml:1,full:1,deriv:1,autogener:1,gener:[0,1],never:1,bibitem:1,here:1,html_fenic:1,bodi:1,modif:1,ubuntu:[0,1],spellcheck:1,along:1,vertic:1,modifi:1,sinc:1,valu:1,showthread:1,invis:1,search:0,evinc:1,convers:1,forum:1,rst2html:1,larger:1,step:1,ptex2tex:1,precis:1,loop:1,pick:1,action:1,chang:1,head:[0,1],wikibook:1,via:1,firefox:1,rightsidebar:1,extra:1,tweak:[0,1],modul:[0,1],"while":1,apt:1,filenam:1,unix:1,href:1,visibl:1,home:1,instal:[0,1],txt:1,shcod:1,post:[0,1],cloud:1,quickstart:1,dvipdf:1,tailor:1,from:[0,1],describ:1,would:1,doubl:1,helvetica:1,two:1,next:1,creol:1,few:1,doconc:[0,1],call:1,recommend:1,calc:1,type:1,dudt:1,more:1,sudo:1,desir:1,minim:1,pdfcrop:1,relat:1,footerbgcolor:1,dnote:1,newcommand:[0,1],warn:1,phone:1,flag:1,indic:0,examin:1,particular:1,automake_sphinx:1,shkumagai:1,must:1,blue_section_head:1,springer:1,dhelvetica:1,slogan:1,idx:1,setup:1,work:1,focu:1,other:[0,1],paragraph:1,obvious:1,can:[0,1],meet:1,purpos:1,root:1,scatter:1,def:1,control:1,encapsul:1,give:1,bloodish:1,slim:1,backslash:1,templat:1,dpalatino:1,topic:1,tag:1,doconce_install_al:1,want:1,tarbal:1,standard:1,ddevic:1,attract:1,occur:1,prece:1,mycommand:1,alwai:1,cours:1,end:1,straightforward:1,quot:1,recogni:1,anoth:1,ordinari:1,vagrant:1,length:1,openoffic:1,snippet:1,how:1,da6pap:1,subdirectori:1,answer:1,instead:1,veloc:1,parameter:1,sin:1,css:1,updat:1,agogo:1,yellowish:1,express:1,recogn:1,clone:1,after:1,variant:1,them:1,codetermin:1,befor:1,wrong:1,notebook:1,mai:1,multipl:1,underscor:1,associ:1,demonstr:1,man:1,basicstrap:1,drop:1,md2latex:1,footer:1,read:1,pdfnup:1,bootstrap:1,favorit:1,made:1,produc:1,myeq1:1,inform:1,"switch":1,movie_control:1,environ:1,epstopdf:1,allow:1,first:[0,1],egg:1,order:1,springer_collect:1,epydoc:1,dmint:1,elif:1,theme:1,help:1,portion:1,deck:1,over:1,move:1,html_admon:1,becaus:1,jpeg:1,apricot:1,guarante:1,paper:1,through:1,myfig:1,libav:1,still:1,vari:1,myfil:1,paramet:1,write:1,style:1,group:1,render:1,fit:1,latex_head:1,fix:1,ptext2tex:1,clickabl:1,better:1,carri:1,window:1,html:[0,1],fig:1,doconce_head:1,blogger:1,comprehens:1,html_style:1,might:1,easier:1,miiton:1,non:1,good:1,"return":1,pure:1,thei:1,handl:1,sentenc:1,sphinxfix_localurl:1,handi:1,initi:1,"break":1,mention:1,automat:1,own:1,resourc:1,petter:1,now:1,textopc:1,discuss:1,platform:1,introduct:1,choic:1,eventu:1,somewher:1,name:1,epsfig:1,edit:1,simpl:1,level:1,instruct:1,separ:1,easili:1,slide:1,ispel:1,fpro:1,found:1,difficult:1,pygment:1,compil:1,dir2:1,pdflatex:[0,1],maketitl:1,sidebarbgcolor:1,transform:1,citat:1,replac:1,individu:1,idea:1,procedur:1,realli:1,each:1,logg:1,"__hyperlink":1,backport:1,frac:1,happen:1,beyond:1,extract:1,special:1,out:1,variabl:1,reportlab:1,space:1,goe:1,publish:1,content:[0,1],texliv:1,preprocesor:1,sphinx_dir:1,lineno:1,rel:1,reader:1,print:1,formula:1,md2html:1,ref:1,correct:1,math:1,integr:1,insid:1,advanc:1,migrat:1,mkd:1,differ:[0,1],pub:1,parenthesi:1,standalon:1,doconce2format:1,base:1,put:1,org:1,bash:1,sampl:[0,1],indent:1,offic:1,could:1,pandoc:[0,1],movie15:1,keep:1,filter:1,thing:1,perhap:1,mako:1,fcod:1,principl:1,no_pygments_html:1,frequent:1,ubuntuforum:1,origin:1,softwar:1,rang:1,html_theme_opt:1,directli:1,feel:1,famou:1,misc:1,number:1,unovonv:1,bluish:1,texshop:1,date:1,lsb_releas:1,done:1,"long":1,open:1,predefin:1,fanci:1,size:1,mercuri:1,given:1,xunicod:1,script:1,cpp_an:1,interact:1,mkdir:1,system:1,least:1,latexdiff:1,master:1,too:1,accept:1,cfg:1,show:1,termin:1,conveni:1,cite:1,store:1,includ:[0,1],shell:1,includemedia:1,option:1,tool:1,copi:1,xkeyval:1,specifi:1,part:1,enclos:1,conserv:1,rst:1,than:1,png:1,just:1,past:1,ffmpeg:1,keyword:1,whenev:1,provid:1,remov:[0,1],onc:[0,1],see:1,charact:1,project:1,reus:1,sens:1,macro:[0,1],"5mm":1,design:1,admonit:1,sty:1,steer:1,seri:1,pre:1,unoconv:1,sai:1,yoursec:1,comput:[0,1],nicer:1,dvar1:1,pro:1,haiku:1,svnroot:1,ani:1,raw:1,pylon:1,have:1,tabl:[0,1],need:1,turn:1,mint:1,well:1,minted_cpp:1,built:1,checkout:1,latter:1,sandbox:1,note:[0,1],minted_python:1,ideal:1,exampl:1,take:1,which:1,combin:1,when:1,trail:1,mwiki:1,singl:1,simplifi:1,begin:1,sure:1,unless:1,distribut:1,normal:1,track:1,who:1,reach:1,toc:1,most:1,awl:1,mplayer:1,"20435c":1,mysec:1,epub:1,"_build":1,tradit:1,latex:[0,1],wish:1,renam:1,mytempl:1,url:1,doc:1,later:1,doe:[0,1],pipe:1,bracket:1,bibtex:1,place:1,determin:1,file1:1,occasion:1,usual:1,preambl:1,microsoft:1,smpeg:1,main_myproj:1,rtf:1,srclib:1,text:[0,1],scitool:1,pygments_html_styl:1,blognam:1,mediawiki:1,diffpdf:1,session:1,particularli:1,font:1,fine:1,anywai:1,auctex:1,slot:1,access:1,onli:1,textual:1,layout:1,titlesec:1,rst2xml:1,explain:1,movi:1,solut:1,written:1,should:1,configur:1,skip_inline_com:1,rich:1,filestem:1,smtplib:1,microtyp:1,local:1,mythem:1,devhelp:1,variou:1,get:1,convert:1,agni:1,stop:1,encourg:1,autom:1,cloud_spthem:1,cannot:1,ssh:1,"new":1,report:1,youtub:1,requir:1,mydoc_solar:1,perl:1,reveal:1,tikz:1,enabl:1,emb:1,cppcod:1,email:1,gif:1,grai:1,blogspot:1,common:1,contain:1,where:1,summari:1,wiki:[0,1],set:1,creator:1,googlecod:1,frame:1,pdftool:1,emac:1,sed:1,sec:1,result:1,close:1,best:1,flexibl:1,kei:1,xetex:1,someth:1,wikipedia:1,below:1,no_preprocess:1,figur:1,languag:1,between:1,"import":1,experi:1,inputenc:1,birkenfeld:1,wide:1,altern:1,accord:1,impressj:1,imagemagick:1,extend:1,numer:1,screen:1,javascript:1,extens:1,entir:1,html5:1,extent:1,trapezoid:1,ipython:1,roemer:1,come:1,basename_html_file_collect:1,addit:1,both:1,last:1,delimit:1,hyperlink:1,howev:1,nabla:1,equal:1,etc:1,instanc:1,equat:1,context:1,logic:1,makeindex:1,let:1,browser:1,whole:1,setspac:1,preprocessor:1,comment:[0,1],among:1,acceler:1,markdown:[0,1],simpli:1,point:1,color:1,pressbook:1,address:1,form:1,pop:1,distinguish:1,featur:[0,1],stylefil:1,littl:1,path:1,typic:1,ifthen:1,throughout:1,assum:1,duplic:1,quit:1,becom:1,mjpegtool:1,amsfont:1,union:1,nosidebar:1,three:1,blueish2:1,github:1,m2html:1,json:1,much:1,interest:1,thereaft:1,tug:1,quickli:1,encapusl:1,modern:1,hyperref:1,emphas:1,imag:1,remark:1,epytext:1,argument:1,media9:1,togeth:1,demand:1,graphicx:1,former:1,present:1,emploi:1,helvet:1,main:1,thesi:1,look:[0,1],packag:1,plain:[0,1],servic:1,properti:1,sourceforg:1,aim:1,defin:1,invok:1,abrupt:1,abov:1,aid:1,ppa:1,dextra_sect:1,region:1,vlinux:1,pack:1,subsect:[0,1],css3:1,pyramid:1,advantag:1,almost:1,demo:[0,1],docx:1,a6pap:1,archiv:1,inlin:[0,1],conf:1,mwk:1,var1:1,revis:1,mani:1,ascii:[0,1],curl:1,sever:1,pdftk:1,decor:1,anslist:1,fignam:1,author:1,perform:1,make:1,format:[0,1],satisfi:1,cross:[0,1],same:1,python:1,html_pyramid:1,tutori:1,split:1,backslah:1,mydoc:1,texinfo:1,document:[0,1],start:1,file3:1,complet:1,a2p:1,http:1,denot:1,assist:1,effect:1,a4pap:1,capabl:1,redcloud:1,user:1,pdf:1,extern:1,php:1,cwiki:1,tune:1,recent:1,appropri:1,off:1,openofficeword:1,choos:1,com:1,caption:1,itself:1,difflib:1,python_an:1,without:1,command:1,thi:1,endif:1,undefin:1,everyth:1,moreov:1,giftran:1,left:1,load:1,construct:1,execut:1,mydoc_bloodish:1,obtain:1,rest:1,pygments_html:1,align:1,tcl:1,xelatex:[0,1],human:1,ifdef:1,cod:1,kdiff3:1,yet:1,fenic:1,web:1,langtangen:1,easi:1,also:1,restructuredtext:[0,1],makefil:[0,1],except:1,shortcut:1,blog:[0,1],fortran:1,add:1,book:1,bibliographi:[0,1],treatment:1,exercis:1,appli:1,cp2texmf:1,save:1,vimeo:1,real:1,inspir:1,around:1,mayb:1,mynot:1,shoutwiki:1,boldfac:1,dark:1,realiz:1,know:1,background:1,denser:1,world:1,shadow:1,wrapfig:1,linux:1,insert:1,like:[0,1],success:1,header:1,cdot:1,docutil:1,xxdiff:1,manual:1,collect:1,necessari:1,either:1,"_static":1,popular:1,pycod:1,dlatex_head:1,page:[0,1],wdiff:1,old:1,often:1,html_theme:1,some:[0,1],back:1,meld:1,understood:1,python_anst:1,enumer:1,scipy_lectur:1,respect:1,proper:1,small:1,successfulli:1,constitut:1,rst2latex:1,diff:1,mdframe:1,montag:1,avoid:1,though:1,definit:1,ddt:1,pdiff:1,substitut:1,mathemat:[0,1],exit:1,prog:1,speak:1,studi:1,trunk:1,refer:[0,1],process:1,jal:1,run:1,ooxml:1,view:1,usag:1,fancyvrb:1,host:1,encourav:1,repositori:1,output:[0,1],qthelp:1,major:1,inclus:1,simpler:1,chapter:1,about:1,conv:1,linenumb:1,materi:1,label:1,surround:1,split_html:1,regular:1,stand:1,act:1,fals:1,mean:1,disabl:1,block:1,dtodonot:1,libreoffic:1,file2:1,"_boldface_":1,mac:1,effici:1,"final":1,amsmath:1,includemovi:1,basenam:1,profession:1,dir1:1,terminolog:1,right:1,subvers:1,your:1,websit:1,accordingli:1,git:1,institut:1,f2f2f2:1,wai:1,pictur:1,style_vagr:1,support:1,question:1,stylesheet:1,haskel:1,custom:1,avail:1,width:1,subst:1,rst2odt:1,editor:1,strong:1,suit:1,palatino:1,stage:1,"function":1,myfunc:1,creation:1,sphinxdir:1,verbatim:1,offer:1,bundl:1,basic:[0,1],jul:1,corss:1,navig:1,diffus:1,link:1,translat:1,solar:1,todonot:1,line:1,blueish:1,"true":1,bug:1,untag:1,longer:1,suppli:1,pull:1,perldoc:1,latex_preambl:1,wise:1,input:1,han:1,possibl:1,"default":1,plaympeg:1,smooth:1,displai:1,envir:1,directori:1,someus:1,limit:1,site:1,otherwis:1,problem:1,strategi:1,similar:1,xcolor:1,creat:1,classic:1,certain:1,"abstract":1,toctre:1,uio:1,repres:1,strongli:1,postscript:1,implement:1,file:1,our:1,pip:1,exist:1,typeset:1,sphinxjp:1,check:1,again:1,subexercis:1,googl:1,tkdiff:1,titl:1,documentclass:1,detail:1,invalid:1,bibfil:1,valid:1,futur:1,rememb:1,varieti:1,test:1,you:1,newcommands_keep:1,fontspec:1,nice:1,suppert:1,area:1,clean:1,mathpazo:1,fulli:1,symbol:1,asterisk:1,shown:1,colored_table_row:1,idl:1,no_mako:1,embed:1,sidebartextcolor:1,hpl:1,debian:[0,1],wordpress:1,svn:1,bitbucket:1,sphinx:[0,1],eof:1,bullet:1,scientif:1,anywher:[0,1],lot:1,rst2pdf:1,rootdir:1,html_templat:1,depth:1,ignor:1,maxdepth:1,potenti:1,time:1,far:1,escap:1,beamer:1,my_adapted_vagrant_templ:1},objtypes:{},titles:["Doconce:
Document
Once, Include Anywhere","Doconce: Document Once, Include
Anywhere"],objnames:{},filenames:["index","tutorial"]})
+Search.setIndex({objects:{},terms:{mydoc2:1,all:1,code:[0,1],partial:1,illustr:1,hint:1,linebreak:1,totem:1,var1:1,fig2:1,fig3:1,html_output:1,fig1:1,makeidx:1,follow:1,colon:1,mwlib:1,row:1,footnot:1,depend:[0,1],unnumb:1,aug:1,flask:1,impati:1,elsewher:1,readabl:1,specif:1,send:1,articl:1,ecollin:1,program:1,those:1,preview:1,preprocess:[0,1],aris:1,texmf:1,fenics_minim:1,introduc:1,suitabl:1,"case":1,yourdoc:1,sourc:1,everi:1,titlepag:1,wrapper_tech:1,none:1,util:1,verb:1,volum:1,texconv:1,miller_2000:1,veri:1,word:1,syntax:[0,1],relev:1,gwiki:1,pygments_html_lineno:1,recip:1,baselinestretch:1,nileshbans:1,button:1,relbarbgcolor:1,list:1,upload:1,ryan:1,"try":1,item:1,adjust:1,combine_imag:1,larg:1,team:1,quick:[0,1],sidebarlinkcolor:1,relsiz:1,larsen_et_al_2002:1,dir:1,dirnam:1,impli:1,johnson_friedman_2010a:1,monospac:1,subsubsect:1,dxelatex:1,natur:1,newcommands_replac:1,odt:1,direct:1,tex:1,video:1,pass:1,download:1,further:1,dmath:1,click:1,folk:1,blue:1,index:[0,1],what:[0,1],appear:1,compar:1,unfinish:1,section:[0,1],multimedia:1,netpbm:1,find:1,current:1,delet:1,extra_sect:1,version:1,theme_dir:1,remove_inline_com:1,mathjax:1,mydoc_vagr:1,net:1,deduc:1,xml:1,full:1,deriv:1,autogener:1,gener:[0,1],never:1,coeffici:1,bibitem:1,here:1,html_fenic:1,bodi:1,modif:1,ubuntu:[0,1],spellcheck:1,along:1,vertic:1,modifi:1,sinc:1,valu:1,showthread:1,invis:1,search:0,evinc:1,convers:1,forum:1,rst2html:1,larger:1,step:1,ptex2tex:1,precis:1,loop:1,pick:1,action:1,chang:1,head:[0,1],wikibook:1,via:1,firefox:1,rightsidebar:1,extra:1,tweak:[0,1],modul:[0,1],"while":1,apt:1,filenam:1,unix:1,href:1,visibl:1,home:1,instal:[0,1],txt:1,shcod:1,post:[0,1],cloud:1,quickstart:1,dvipdf:1,tailor:1,from:[0,1],describ:1,would:1,doubl:1,helvetica:1,two:1,next:1,creol:1,few:1,doconc:[0,1],call:1,recommend:1,calc:1,type:1,dudt:1,more:1,almost:1,slim:1,desir:1,minim:1,pdfcrop:1,relat:1,footerbgcolor:1,dnote:1,newcommand:[0,1],warn:1,phone:1,flag:1,indic:[0,1],examin:1,particular:1,automake_sphinx:1,shkumagai:1,must:1,blue_section_head:1,springer:1,dhelvetica:1,slogan:1,idx:1,setup:1,work:1,focu:1,other:[0,1],remain:1,paragraph:1,obvious:1,can:[0,1],meet:1,purpos:1,root:1,scatter:1,def:1,control:1,encapsul:1,give:1,bloodish:1,gif:1,backslash:1,templat:1,dpalatino:1,topic:1,tag:1,doconce_install_al:1,want:1,tarbal:1,denot:1,standard:1,made:1,attract:1,occur:1,prece:1,mycommand:1,alwai:1,cours:1,end:1,straightforward:1,quot:1,recogni:1,anoth:1,ordinari:1,vagrant:1,length:1,snippet:1,how:1,da6pap:1,subdirectori:1,answer:1,instead:1,veloc:1,parameter:1,sin:1,css:1,updat:1,agogo:1,yellowish:1,corss:1,express:1,recogn:1,clone:1,after:1,variant:1,openoffic:1,codetermin:1,befor:1,wrong:1,notebook:1,mai:1,multipl:1,underscor:1,associ:1,demonstr:1,man:1,basicstrap:1,drop:1,md2latex:1,footer:1,read:1,pdfnup:1,bootstrap:1,favorit:1,produc:1,myeq1:1,inform:1,"switch":1,movie_control:1,environ:1,epstopdf:1,allow:1,first:[0,1],egg:1,order:1,springer_collect:1,epydoc:1,dmint:1,elif:1,theme:1,help:1,portion:1,deck:1,over:1,move:1,html_admon:1,becaus:1,jpeg:1,apricot:1,guarante:1,paper:1,through:1,myfig:1,libav:1,still:1,vari:1,myfil:1,paramet:1,write:1,style:1,group:1,render:1,fit:1,latex_head:1,fix:1,ptext2tex:1,clickabl:1,better:1,carri:1,window:1,html:[0,1],fig:1,doconce_head:1,blogger:1,comprehens:1,html_style:1,might:1,easier:1,miiton:1,docx:1,good:1,"return":1,pure:1,thei:1,handl:1,sentenc:1,sphinxfix_localurl:1,handi:1,initi:1,"break":1,mention:1,automat:1,own:1,resourc:1,petter:1,now:1,textopc:1,discuss:1,platform:1,introduct:1,choic:1,eventu:1,somewher:1,name:1,epsfig:1,edit:1,simpl:1,level:1,instruct:1,separ:1,easili:1,slide:1,trapezoid:1,ispel:1,fpro:1,found:1,difficult:1,pygment:1,compil:1,dir2:1,pdflatex:[0,1],maketitl:1,sidebarbgcolor:1,transform:1,citat:1,dialect:1,replac:1,individu:1,gaussian:1,procedur:1,realli:1,each:1,logg:1,"__hyperlink":1,backport:1,frac:1,happen:1,beyond:1,extract:1,special:1,out:1,variabl:1,reportlab:1,space:1,goe:1,publish:1,content:[0,1],texliv:1,preprocesor:1,sphinx_dir:1,lineno:1,rel:1,reader:1,print:1,formula:1,md2html:1,ref:1,correct:1,math:1,integr:1,heavisid:1,insid:1,advanc:1,migrat:1,mkd:1,differ:[0,1],pub:1,parenthesi:1,standalon:1,doconce2format:1,base:1,put:1,org:1,bash:1,sampl:[0,1],indent:1,offic:1,could:1,pandoc:[0,1],movie15:1,keep:1,filter:1,thing:1,perhap:1,mako:1,fcod:1,principl:1,no_pygments_html:1,frequent:1,ubuntuforum:1,origin:1,softwar:1,rang:1,html_theme_opt:1,directli:1,feel:1,famou:1,sudo:1,misc:1,number:1,unovonv:1,bluish:1,texshop:1,date:1,lsb_releas:1,done:1,"long":1,open:1,predefin:1,fanci:1,size:1,mercuri:1,given:1,xunicod:1,script:1,cpp_an:1,interact:1,mkdir:1,system:1,least:1,latexdiff:1,master:1,too:1,accept:1,cfg:1,show:1,termin:1,conveni:1,cite:1,store:1,includ:[0,1],shell:1,includemedia:1,option:1,tool:1,copi:1,xkeyval:1,specifi:1,part:1,enclos:1,conserv:1,rst:1,than:1,png:1,just:1,past:1,ffmpeg:1,keyword:1,whenev:1,provid:1,remov:[0,1],onc:[0,1],see:1,charact:1,project:1,reus:1,sens:1,macro:[0,1],"5mm":1,design:1,admonit:1,sty:1,steer:1,seri:1,pre:1,unoconv:1,sai:1,yoursec:1,comput:[0,1],nicer:1,mwiki:1,pro:1,haiku:1,svnroot:1,ani:1,raw:1,pylon:1,have:1,tabl:[0,1],need:1,turn:1,mint:1,well:1,guthub:1,issu:1,minted_cpp:1,built:1,checkout:1,latter:1,sandbox:1,note:[0,1],minted_python:1,ideal:1,exampl:1,take:1,which:1,combin:1,when:1,trail:1,noth:1,singl:1,simplifi:1,begin:1,sure:1,unless:1,distribut:1,normal:1,track:1,who:1,reach:1,toc:1,most:1,awl:1,mplayer:1,"20435c":1,mysec:1,epub:1,"_build":1,tradit:1,latex:[0,1],wish:1,renam:1,mytempl:1,url:1,doc:1,later:1,doe:[0,1],pipe:1,bracket:1,bibtex:1,place:1,determin:1,file1:1,ubuntu_vers:1,usual:1,preambl:1,microsoft:1,smpeg:1,main_myproj:1,rtf:1,srclib:1,text:[0,1],scitool:1,pygments_html_styl:1,blognam:1,mediawiki:1,diffpdf:1,session:1,particularli:1,font:1,fine:1,anywai:1,auctex:1,slot:1,access:1,onli:1,textual:1,layout:1,titlesec:1,rst2xml:1,explain:1,movi:1,solut:1,written:1,should:1,configur:1,skip_inline_com:1,rich:1,filestem:1,smtplib:1,microtyp:1,local:1,mythem:1,devhelp:1,variou:1,get:1,convert:1,agni:1,stop:1,encourg:1,autom:1,cloud_spthem:1,cannot:1,ssh:1,"new":1,report:1,youtub:1,requir:1,mydoc_solar:1,perl:1,reveal:1,tikz:1,enabl:1,emb:1,cppcod:1,mwk:1,state:1,email:1,grai:1,blogspot:1,common:1,contain:1,where:1,summari:1,wiki:[0,1],set:1,creator:1,googlecod:1,frame:1,pdftool:1,emac:1,sed:1,sec:1,result:1,close:1,best:1,flexibl:1,kei:1,xetex:1,someth:1,wikipedia:1,below:1,no_preprocess:1,figur:1,languag:1,between:1,"import":1,experi:1,inputenc:1,birkenfeld:1,wide:1,altern:1,accord:1,impressj:1,imagemagick:1,extend:1,numer:1,screen:1,javascript:1,bquot:1,extens:1,entir:1,html5:1,extent:1,highlight:1,ipython:1,roemer:1,github_md:1,come:1,basename_html_file_collect:1,addit:1,both:1,last:1,delimit:1,hyperlink:1,howev:1,nabla:1,equal:1,thereaft:1,etc:1,instanc:1,equat:1,context:1,logic:1,makeindex:1,let:1,browser:1,whole:1,setspac:1,preprocessor:1,comment:[0,1],among:1,acceler:1,markdown:[0,1],simpli:1,pycod:1,point:1,color:1,pressbook:1,address:1,form:1,pop:1,distinguish:1,featur:[0,1],non:1,littl:1,path:1,typic:1,ifthen:1,throughout:1,assum:1,duplic:1,quit:1,becom:1,mjpegtool:1,amsfont:1,union:1,nosidebar:1,devic:1,three:1,blueish2:1,github:1,m2html:1,json:1,much:1,interest:1,dvar1:1,futur:1,tug:1,quickli:1,encapusl:1,modern:1,hyperref:1,emphas:1,imag:1,remark:1,epytext:1,argument:1,media9:1,togeth:1,demand:1,graphicx:1,former:1,present:1,emploi:1,helvet:1,main:1,thesi:1,look:[0,1],packag:1,plain:[0,1],servic:1,properti:1,sourceforg:1,aim:1,defin:1,invok:1,abrupt:1,abov:1,aid:1,ppa:1,dextra_sect:1,region:1,vlinux:1,pack:1,subsect:[0,1],css3:1,pyramid:1,advantag:1,readi:1,demo:[0,1],them:1,a6pap:1,archiv:1,inlin:[0,1],conf:1,equot:1,quadrat:1,revis:1,mani:1,ascii:[0,1],curl:1,sever:1,pdftk:1,decor:1,anslist:1,fignam:1,author:1,perform:1,make:1,format:[0,1],satisfi:1,cross:[0,1],same:1,python:1,html_pyramid:1,tutori:1,split:1,backslah:1,mydoc:1,texinfo:1,document:[0,1],start:1,file3:1,complet:1,a2p:1,http:1,cubic:1,assist:1,effect:1,a4pap:1,capabl:1,redcloud:1,user:1,pdf:1,extern:1,php:1,cwiki:1,tune:1,recent:1,task:1,off:1,openofficeword:1,choos:1,com:1,caption:1,itself:1,difflib:1,python_an:1,without:1,command:1,thi:1,endif:1,undefin:1,everyth:1,moreov:1,giftran:1,left:1,load:1,construct:1,execut:1,mydoc_bloodish:1,obtain:1,rest:1,align:1,tcl:1,xelatex:[0,1],human:1,ifdef:1,cod:1,flavor:1,kdiff3:1,yet:1,fenic:1,web:1,langtangen:1,easi:1,also:1,restructuredtext:[0,1],makefil:[0,1],except:1,shortcut:1,blog:[0,1],fortran:1,add:1,book:1,bibliographi:[0,1],treatment:1,exercis:1,appli:1,cp2texmf:1,save:1,vimeo:1,real:1,inspir:1,around:1,mayb:1,mynot:1,shoutwiki:1,boldfac:1,dark:1,realiz:1,know:1,background:1,denser:1,world:1,shadow:1,wrapfig:1,linux:1,insert:1,like:[0,1],success:1,header:1,cdot:1,docutil:1,xxdiff:1,manual:1,collect:1,necessari:1,either:1,"_static":1,popular:1,stylefil:1,dlatex_head:1,page:[0,1],wdiff:1,old:1,often:1,html_theme:1,some:[0,1],back:1,meld:1,understood:1,python_anst:1,enumer:1,scipy_lectur:1,respect:1,proper:1,small:1,successfulli:1,constitut:1,rst2latex:1,diff:1,mdframe:1,montag:1,avoid:1,though:1,definit:1,ddt:1,pdiff:1,substitut:1,tracker:1,exit:1,prog:1,speak:1,studi:1,trunk:1,refer:[0,1],process:1,jal:1,run:1,ooxml:1,view:1,usag:1,fancyvrb:1,host:1,encourav:1,repositori:1,output:[0,1],qthelp:1,major:1,inclus:1,simpler:1,chapter:1,about:1,conv:1,linenumb:1,materi:1,label:1,surround:1,split_html:1,regular:1,stand:1,act:1,fals:1,mean:1,disabl:1,block:1,dtodonot:1,libreoffic:1,file2:1,"_boldface_":1,mac:1,effici:1,"final":1,amsmath:1,includemovi:1,basenam:1,profession:1,dir1:1,terminolog:1,appropri:1,right:1,subvers:1,your:1,websit:1,accordingli:1,git:1,institut:1,f2f2f2:1,wai:1,pictur:1,style_vagr:1,support:1,question:1,stylesheet:1,haskel:1,custom:1,avail:1,width:1,subst:1,rst2odt:1,editor:1,strong:1,suit:1,palatino:1,hpl:1,stage:1,"function":1,myfunc:1,creation:1,mycom:1,sphinxdir:1,verbatim:1,offer:1,bundl:1,basic:[0,1],idea:1,navig:1,diffus:1,link:1,translat:1,solar:1,todonot:1,line:1,blueish:1,"true":1,bug:1,untag:1,longer:1,suppli:1,pull:1,perldoc:1,latex_preambl:1,wise:1,input:1,han:1,possibl:1,"default":1,plaympeg:1,smooth:1,displai:1,envir:1,directori:1,someus:1,limit:1,site:1,otherwis:1,problem:1,strategi:1,similar:1,xcolor:1,creat:1,classic:1,certain:1,"abstract":1,toctre:1,uio:1,repres:1,strongli:1,postscript:1,implement:1,file:1,our:1,pip:1,exist:1,typeset:1,sphinxjp:1,check:1,again:1,subexercis:1,googl:1,tkdiff:1,titl:1,documentclass:1,detail:1,invalid:1,field:1,bibfil:1,valid:1,mathemat:[0,1],rememb:1,varieti:1,test:1,you:1,newcommands_keep:1,fontspec:1,nice:1,suppert:1,area:1,clean:1,mathpazo:1,fulli:1,symbol:1,asterisk:1,shown:1,colored_table_row:1,idl:1,no_mako:1,embed:1,sidebartextcolor:1,occasion:1,debian:[0,1],wordpress:1,svn:1,bitbucket:1,sphinx:[0,1],eof:1,bullet:1,scientif:1,anywher:[0,1],lot:1,rst2pdf:1,rootdir:1,html_templat:1,depth:1,ignor:1,maxdepth:1,potenti:1,time:1,far:1,escap:1,beamer:1,my_adapted_vagrant_templ:1},objtypes:{},titles:["Doconce:
Document
Once, Include Anywhere","Doconce: Document Once, Include
Anywhere"],objnames:{},filenames:["index","tutorial"]})
=======================================
--- /doc/demos/tutorial/html/tutorial.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/html/tutorial.html Sat Aug 10 23:22:34 2013
@@ -57,7 +57,7 @@
<tr class="field-odd field"><th class="field-name">Author:</th><td
class="field-body"><p class="first">Hans Petter Langtangen</p>
</td>
</tr>
-<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body"><p class="first">Jul 13, 2013</p>
+<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body"><p class="first">Aug 11, 2013</p>
<ul class="last simple">
<li>When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -618,8 +618,8 @@
<span class="go"> --html_output=mydoc_bloodish</span>
<span class="go">Terminal> doconce split_html mydoc_bloodish.html</span>
<span class="go">Terminal> 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"> --html_output=mydoc_solarized \</span>
+<span class="go"> --pygments_html_style=perldoc
--html_admon=apricot</span>
<span class="go">Terminal> 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>
@@ -736,6 +736,58 @@
</div>
<p>The <tt class="docutils literal"><span class="pre">-s</span></tt>
option adds a proper header and footer to the <tt class="docutils
literal"><span class="pre">mydoc.html</span></tt> file.
This recipe is a quick way of makeing HTML notes with (some)
mathematics.</p>
+<div class="section" id="github-flavored-markdown">
+<h3>GitHub-flavored Markdown<a class="headerlink"
href="#github-flavored-markdown" title="Permalink to this
headline">¶</a></h3>
+<p>Adding the command-line option <tt class="docutils literal"><span
class="pre">github-md</span></tt> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
class="reference external" href="http://github.com">GitHub</a>. A special
feature is the support of task lists:
+unnumbered lists with <tt class="docutils literal"><span
class="pre">[x]</span></tt> (task done) or <tt class="docutils
literal"><span class="pre">[</span> <span class="pre">]</span></tt> (task
not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:</p>
+<div class="highlight-text"><div class="highlight"><pre>!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</pre></div>
+</div>
+<p>Say this text is stored in a file <tt class="docutils literal"><span
class="pre">mycomments.do.txt</span></tt>. Running</p>
+<div class="highlight-console"><div class="highlight"><pre><span
class="go">Terminal> doconce format pandoc mycomments --github_md</span>
+</pre></div>
+</div>
+<p>produces <tt class="docutils literal"><span
class="pre">mycomments.md</span></tt> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</p>
+</div>
</div>
<div class="section" id="id4">
<h2>LaTeX<a class="headerlink" href="#id4" title="Permalink to this
headline">¶</a></h2>
@@ -750,11 +802,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),
Cross-References, Index, and Bibliography</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">-DDEVICE=paper</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">--device=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).
-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>
+The default, <tt class="docutils literal"><span
class="pre">--device=screen</span></tt>, creates a PDF file for reading
+on a screen where links are just 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> ptex2tex mydoc</span>
</pre></div>
@@ -1719,7 +1771,10 @@
</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="#pandoc-and-markdown">Pandoc and
Markdown</a><ul>
+<li><a class="reference internal"
href="#github-flavored-markdown">GitHub-flavored Markdown</a></li>
+</ul>
+</li>
<li><a class="reference internal" href="#id4">LaTeX</a></li>
<li><a class="reference internal" href="#pdflatex">PDFLaTeX</a></li>
<li><a class="reference internal" href="#xelatex">XeLaTeX</a></li>
=======================================
--- /doc/demos/tutorial/tutorial.cwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.cwiki Sat Aug 10 23:22:34 2013
@@ -2,7 +2,7 @@
#summary Doconce: Document Once, Include Anywhere
<wiki:toc max_depth="2" />
By **Hans Petter Langtangen**
-=== Jul 13, 2013 ===
+=== Aug 11, 2013 ===
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML, reStructuredText,
Sphinx, XML, etc. Would it be convenient to start with some very simple
text-like format that easily converts to the formats listed above, and
then at some later stage eventually go with a particular format?
* Do you need to write documents in varying formats but find it
difficult to remember all the typesetting details of various formats like
[[http://refcards.com/docs/silvermanj/amslatex/LaTeXRefCard.v2.0.pdf|
LaTeX]], [[http://www.htmlcodetutorial.com/|HTML]],
[[http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html|
reStructuredText]], [[http://sphinx.pocoo.org/contents.html|Sphinx]], and
[[http://code.google.com/p/support/wiki/WikiSyntax|wiki]]? Would it be
convenient to generate the typesetting details of a particular format
from a very simple text-like format with minimal tagging?
@@ -526,8 +526,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -647,6 +647,60 @@
The {{{-s}}} option adds a proper header and footer to the
{{{mydoc.html}}} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+=== GitHub-flavored Markdown ===
+
+Adding the command-line option {{{github-md}}} turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[[http://github.com|GitHub]]. A special feature is the support of task
lists:
+unnumbered lists with {{{[x]}}} (task done) or {{{[ ]}}} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+{{{
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+}}}
+Say this text is stored in a file {{{mycomments.do.txt}}}. Running
+
+{{{
+Terminal> doconce format pandoc mycomments --github_md
+}}}
+produces {{{mycomments.md}}} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
== LaTeX ==
@@ -666,11 +720,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option {{{-DDEVICE=paper}}} makes some adjustments for documents
+An option {{{--device=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.
+The default, {{{--device=screen}}}, creates a PDF file for reading
+on a screen where links are just clickable.
//Step 2.// Run {{{ptex2tex}}} (if you have it) to make a standard LaTeX
file,
{{{
=======================================
--- /doc/demos/tutorial/tutorial.epytext Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.epytext Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
TITLE: Doconce: Document Once, Include Anywhere
BY: Hans Petter Langtangen (Center for Biomedical Computing, Simula
Research Laboratory, and Department of Informatics, University of Oslo)
-DATE: Jul 13, 2013
+DATE: Aug 11, 2013
- When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML,
@@ -588,8 +588,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -716,6 +716,61 @@
The C{-s} option adds a proper header and footer to the C{mydoc.html} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option C{github-md} turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
U{GitHub<http://github.com>}. A special feature is the support of task
lists:
+unnumbered lists with C{[x]} (task done) or C{[ ]} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file C{mycomments.do.txt}. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces C{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -734,11 +789,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option C{-DDEVICE=paper} makes some adjustments for documents
+An option C{--device=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.
+The default, C{--device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
I{Step 2.} Run C{ptex2tex} (if you have it) to make a standard LaTeX file::
=======================================
--- /doc/demos/tutorial/tutorial.gwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.gwiki Sat Aug 10 23:22:34 2013
@@ -2,7 +2,7 @@
#summary Doconce: Document Once, Include Anywhere
By *Hans Petter Langtangen*
-==== Jul 13, 2013 ====
+==== Aug 11, 2013 ====
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML, reStructuredText,
Sphinx, XML, etc. Would it be convenient to start with some very simple
text-like format that easily converts to the formats listed above, and
then at some later stage eventually go with a particular format?
* Do you need to write documents in varying formats but find it
difficult to remember all the typesetting details of various formats like
[http://refcards.com/docs/silvermanj/amslatex/LaTeXRefCard.v2.0.pdf LaTeX],
[http://www.htmlcodetutorial.com/ HTML],
[http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
reStructuredText], [http://sphinx.pocoo.org/contents.html Sphinx], and
[http://code.google.com/p/support/wiki/WikiSyntax wiki]? Would it be
convenient to generate the typesetting details of a particular format
from a very simple text-like format with minimal tagging?
@@ -524,8 +524,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -645,6 +645,60 @@
The `-s` option adds a proper header and footer to the `mydoc.html` file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+==== GitHub-flavored Markdown ====
+
+Adding the command-line option `github-md` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[http://github.com GitHub]. A special feature is the support of task lists:
+unnumbered lists with `[x]` (task done) or `[ ]` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+{{{
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+}}}
+Say this text is stored in a file `mycomments.do.txt`. Running
+
+{{{
+Terminal> doconce format pandoc mycomments --github_md
+}}}
+produces `mycomments.md` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
==== LaTeX ====
@@ -664,11 +718,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,
{{{
=======================================
--- /doc/demos/tutorial/tutorial.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.html Sat Aug 10 23:22:34 2013
@@ -96,34 +96,35 @@
(' Filenames ', 3, None, '___sec20'),
(' Blog Posts ', 2, None, '___sec21'),
(' Pandoc and Markdown ', 2, None, '___sec22'),
- (' LaTeX ', 2, None, '___sec23'),
- (' PDFLaTeX ', 2, None, '___sec24'),
- (' XeLaTeX ', 2, None, '___sec25'),
- (' Plain ASCII Text ', 2, None, '___sec26'),
- (' reStructuredText ', 2, None, '___sec27'),
- (' Sphinx ', 2, None, '___sec28'),
- (' The manual Sphinx procedure ', 3, None, '___sec29'),
- (' Wiki Formats ', 2, None, '___sec30'),
- (' Tweaking the Doconce Output ', 2, None, '___sec31'),
- (' Demos ', 2, None, '___sec32'),
+ (' GitHub-flavored Markdown ', 3, None, '___sec23'),
+ (' LaTeX ', 2, None, '___sec24'),
+ (' PDFLaTeX ', 2, None, '___sec25'),
+ (' XeLaTeX ', 2, None, '___sec26'),
+ (' Plain ASCII Text ', 2, None, '___sec27'),
+ (' reStructuredText ', 2, None, '___sec28'),
+ (' Sphinx ', 2, None, '___sec29'),
+ (' The manual Sphinx procedure ', 3, None, '___sec30'),
+ (' Wiki Formats ', 2, None, '___sec31'),
+ (' Tweaking the Doconce Output ', 2, None, '___sec32'),
+ (' Demos ', 2, None, '___sec33'),
(' Installation of Doconce and its Dependencies ',
1,
None,
- '___sec33'),
- (' Doconce ', 2, None, '___sec34'),
- (' Dependencies ', 2, None, '___sec35'),
- (' Preprocessors ', 3, None, '___sec36'),
- (' Image file handling ', 3, None, '___sec37'),
- (' Spellcheck ', 3, None, '___sec38'),
- (' Bibliography ', 3, None, '___sec39'),
- (' Ptex2tex for LaTeX Output ', 3, None, '___sec40'),
- (' LaTeX packages ', 3, None, '___sec41'),
- (' reStructuredText (reST) Output ', 3, None, '___sec42'),
- (' Sphinx Output ', 3, None, '___sec43'),
- (' Markdown and Pandoc Output ', 3, None, '___sec44'),
- (' Epydoc Output ', 3, None, '___sec45'),
- (' The `doconce diff` command ', 3, None, '___sec46'),
- (' Quick Debian/Ubuntu Install ', 2, None, '___sec47')]}
+ '___sec34'),
+ (' Doconce ', 2, None, '___sec35'),
+ (' Dependencies ', 2, None, '___sec36'),
+ (' Preprocessors ', 3, None, '___sec37'),
+ (' Image file handling ', 3, None, '___sec38'),
+ (' Spellcheck ', 3, None, '___sec39'),
+ (' Bibliography ', 3, None, '___sec40'),
+ (' Ptex2tex for LaTeX Output ', 3, None, '___sec41'),
+ (' LaTeX packages ', 3, None, '___sec42'),
+ (' reStructuredText (reST) Output ', 3, None, '___sec43'),
+ (' Sphinx Output ', 3, None, '___sec44'),
+ (' Markdown and Pandoc Output ', 3, None, '___sec45'),
+ (' Epydoc Output ', 3, None, '___sec46'),
+ (' The `doconce diff` command ', 3, None, '___sec47'),
+ (' Quick Debian/Ubuntu Install ', 2, None, '___sec48')]}
end of tocinfo -->
<body>
@@ -171,7 +172,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>Jul 13, 2013</h4></center> <!-- date -->
+<center><h4>Aug 11, 2013</h4></center> <!-- date -->
<p>
<ul>
@@ -808,8 +809,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -954,7 +955,66 @@
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="___sec23"></a></h3>
+<h4>GitHub-flavored Markdown <a name="___sec23"></a></h4>
+
+<p>
+Adding the command-line option <code>github-md</code> turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
href="http://github.com">GitHub</a>. A special feature is the support of
task lists:
+unnumbered lists with <code>[x]</code> (task done) or <code>[ ]</code>
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+<p>
+<!-- begin verbatim block -->
+<pre><code>!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</code></pre>
+<!-- end verbatim block -->
+Say this text is stored in a file <code>mycomments.do.txt</code>. Running
+
+<p>
+<!-- begin verbatim block sys-->
+<pre><code>Terminal> doconce format pandoc mycomments --github_md
+</code></pre>
+<!-- end verbatim block -->
+produces <code>mycomments.md</code> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
+<h3>LaTeX <a name="___sec24"></a></h3>
<p>
Making a LaTeX file <code>mydoc.tex</code> from <code>mydoc.do.txt</code>
is done in two steps:
@@ -977,11 +1037,11 @@
so that your commands are defined.
<p>
-An option <code>-DDEVICE=paper</code> makes some adjustments for documents
+An option <code>--device=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.
+The default, <code>--device=screen</code>, creates a PDF file for reading
+on a screen where links are just clickable.
<p>
<b>Step 2.</b>
@@ -1172,7 +1232,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="___sec24"></a></h3>
+<h3>PDFLaTeX <a name="___sec25"></a></h3>
<p>
Running <code>pdflatex</code> instead of <code>latex</code> follows almost
the same steps,
@@ -1190,7 +1250,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>XeLaTeX <a name="___sec25"></a></h3>
+<h3>XeLaTeX <a name="___sec26"></a></h3>
<p>
XeLaTeX is an alternative to pdfLaTeX and is run in almost the
@@ -1205,7 +1265,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Plain ASCII Text <a name="___sec26"></a></h3>
+<h3>Plain ASCII Text <a name="___sec27"></a></h3>
<p>
We can go from Doconce "back to" plain untagged text suitable for viewing
@@ -1216,7 +1276,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>reStructuredText <a name="___sec27"></a></h3>
+<h3>reStructuredText <a name="___sec28"></a></h3>
<p>
Going from Doconce to reStructuredText gives a lot of possibilities to
@@ -1272,7 +1332,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="___sec28"></a></h3>
+<h3>Sphinx <a name="___sec29"></a></h3>
<p>
Sphinx documents demand quite some steps in their creation. We have
automated
@@ -1434,7 +1494,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>The manual Sphinx procedure <a name="___sec29"></a></h4>
+<h4>The manual Sphinx procedure <a name="___sec30"></a></h4>
<p>
If it is not desirable to use the autogenerated scripts explained
@@ -1544,7 +1604,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="___sec30"></a></h3>
+<h3>Wiki Formats <a name="___sec31"></a></h3>
<p>
There are many different wiki formats, but Doconce only supports three:
@@ -1591,7 +1651,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="___sec31"></a></h3>
+<h3>Tweaking the Doconce Output <a name="___sec32"></a></h3>
<p>
Occasionally, one would like to tweak the output in a certain format
@@ -1606,7 +1666,7 @@
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.
-<h3>Demos <a name="___sec32"></a></h3>
+<h3>Demos <a name="___sec33"></a></h3>
<p>
The current text is generated from a Doconce format stored in the file
@@ -1628,7 +1688,7 @@
translates the more comprehensive documentation,
<code>manual.do.txt</code>, to
various formats. The <code>make.sh</code> script runs a set of
translations.
-<h2>Installation of Doconce and its Dependencies <a
name="___sec33"></a></h2>
+<h2>Installation of Doconce and its Dependencies <a
name="___sec34"></a></h2>
<p>
Below, we explain the manual installation of all software that may be
@@ -1636,7 +1696,7 @@
The impatient way to install what is needed is to run the
<a href="doconce_install_all.sh"><tt>doconce_install_all.sh</tt></a>
script.
-<h3>Doconce <a name="___sec34"></a></h3>
+<h3>Doconce <a name="___sec35"></a></h3>
<p>
Doconce itself is pure Python code hosted at <a
href="http://code.google.com/p/doconce"><tt>http://code.google.com/p/doconce</tt></a>.
Its installation from the
@@ -1660,7 +1720,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Dependencies <a name="___sec35"></a></h3>
+<h3>Dependencies <a name="___sec36"></a></h3>
<p>
Producing HTML documents, plain text, pandoc-extended Markdown,
@@ -1673,7 +1733,7 @@
<p>
<!-- Make a debpkg_doconce.txt file with everything that is needed on
Debian -->
-<h4>Preprocessors <a name="___sec36"></a></h4>
+<h4>Preprocessors <a name="___sec37"></a></h4>
<p>
If you make use of the <a
href="http://code.google.com/p/preprocess">Preprocess</a>
@@ -1715,7 +1775,7 @@
tarball, pack it out, go to the directory and run
the usual <code>sudo python setup.py install</code>.
-<h4>Image file handling <a name="___sec37"></a></h4>
+<h4>Image file handling <a name="___sec38"></a></h4>
<p>
Different output formats require different formats of image files.
@@ -1753,7 +1813,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Spellcheck <a name="___sec38"></a></h4>
+<h4>Spellcheck <a name="___sec39"></a></h4>
<p>
The utility <code>doconce spellcheck</code> applies the
<code>ispell</code> program for
@@ -1765,7 +1825,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Bibliography <a name="___sec39"></a></h4>
+<h4>Bibliography <a name="___sec40"></a></h4>
<p>
The Python package <a
href="https://bitbucket.org/logg/publish">Publish</a> is needed if you use
a bibliography
@@ -1787,7 +1847,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Ptex2tex for LaTeX Output <a name="___sec40"></a></h4>
+<h4>Ptex2tex for LaTeX Output <a name="___sec41"></a></h4>
<p>
To make LaTeX documents with very flexible choice of typesetting of
@@ -1871,7 +1931,7 @@
<code>ifthen</code>, <code>xkeyval</code>, <code>tikz</code>,
<code>calc</code>, <code>graphicx</code>, and <code>setspace</code>. The
relevant Debian packages for installing all this are listed below.
-<h4>LaTeX packages <a name="___sec41"></a></h4>
+<h4>LaTeX packages <a name="___sec42"></a></h4>
<p>
Many LaTeX packages are potentially needed (depending on various
@@ -1921,7 +1981,7 @@
the <a
href="https://code.google.com/p/ptex2tex/source/browse/trunk/latex/styles/with_license/anslistings.sty">ptex2tex
source</a>. It should get installed
by the <code>cp2texmf.sh</code> script executed above.
-<h4>reStructuredText (reST) Output <a name="___sec42"></a></h4>
+<h4>reStructuredText (reST) Output <a name="___sec43"></a></h4>
<p>
The <code>rst</code> output from Doconce allows further transformation to
LaTeX,
@@ -1960,7 +2020,7 @@
or clone the svn repository, go to the <code>rst2pdf</code> directory and
run the usual <code>sudo python setup.py install</code>.
-<h4>Sphinx Output <a name="___sec43"></a></h4>
+<h4>Sphinx Output <a name="___sec44"></a></h4>
<p>
Output to <code>sphinx</code> requires of course the
@@ -2000,7 +2060,7 @@
These must be downloaded or cloned, and <code>setup.py</code> must be run
as shown
above.
-<h4>Markdown and Pandoc Output <a name="___sec44"></a></h4>
+<h4>Markdown and Pandoc Output <a name="___sec45"></a></h4>
<p>
The Doconce format <code>pandoc</code> outputs the document in the Pandoc
@@ -2015,7 +2075,7 @@
<!-- end verbatim block -->
on Debian (Ubuntu) systems.
-<h4>Epydoc Output <a name="___sec45"></a></h4>
+<h4>Epydoc Output <a name="___sec46"></a></h4>
<p>
When the output format is <code>epydoc</code> one needs that program too,
installed
@@ -2039,7 +2099,7 @@
Mercurial (<code>hg</code>) directories, go to the directory, run
<code>hg pull; hg update</code>, and then <code>sudo python setup.py
install</code>.
-<h4>The <code>doconce diff</code> command <a name="___sec46"></a></h4>
+<h4>The <code>doconce diff</code> command <a name="___sec47"></a></h4>
<p>
The <code>doconce diff file1 file prog</code> command for illustrating
differences between
@@ -2062,7 +2122,7 @@
<tr><td align="left">
<code>tkdiff.tcl</code>
</td> <td align="left"> <a
href="https://sourceforge.net/projects/tkdiff/">tkdiff</a>
</td> <td align="left"> not in
Debian
</td> </tr>
</table>
-<h3>Quick Debian/Ubuntu Install <a name="___sec47"></a></h3>
+<h3>Quick Debian/Ubuntu Install <a name="___sec48"></a></h3>
<p>
On Debian (including Ubuntu) systems, it is straightforward to install the
=======================================
--- /doc/demos/tutorial/tutorial.md Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.md Sat Aug 10 23:22:34 2013
@@ -1,6 +1,6 @@
% Doconce: Document Once, Include Anywhere
% Hans Petter Langtangen at Center for Biomedical Computing, Simula
Research Laboratory and Department of Informatics, University of Oslo
-% Jul 13, 2013
+% Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -628,8 +628,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -764,6 +764,64 @@
The `-s` option adds a proper header and footer to the `mydoc.html` file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+#### GitHub-flavored Markdown
+
+Adding the command-line option `github-md` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[GitHub](http://github.com). A special feature is the support of task lists:
+unnumbered lists with `[x]` (task done) or `[ ]` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Say this text is stored in a file `mycomments.do.txt`. Running
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.Bash}
+Terminal> doconce format pandoc mycomments --github_md
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+produces `mycomments.md` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
### LaTeX
@@ -785,11 +843,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,
=======================================
--- /doc/demos/tutorial/tutorial.mwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.mwiki Sat Aug 10 23:22:34 2013
@@ -2,7 +2,7 @@
#TITLE (actually governed by the filename): Doconce: Document Once,
Include Anywhere
By '''Hans Petter Langtangen'''
-==== Jul 13, 2013 ====
+==== Aug 11, 2013 ====
<ul>
<li> When writing a note, report, manual, etc., do you find it difficult
@@ -578,8 +578,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -711,6 +711,60 @@
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.
+==== GitHub-flavored Markdown ====
+
+Adding the command-line option <code>github-md</code> turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[http://github.com GitHub]. A special feature is the support of task lists:
+unnumbered lists with <code>[x]</code> (task done) or <code>[ ]</code>
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+<syntaxhighlight lang="text">
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</syntaxhighlight>
+Say this text is stored in a file <code>mycomments.do.txt</code>. Running
+
+<syntaxhighlight lang="bash">
+Terminal> doconce format pandoc mycomments --github_md
+</syntaxhighlight>
+produces <code>mycomments.md</code> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
==== LaTeX ====
@@ -731,11 +785,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option <code>-DDEVICE=paper</code> makes some adjustments for documents
+An option <code>--device=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.
+The default, <code>--device=screen</code>, creates a PDF file for reading
+on a screen where links are just clickable.
''Step 2.''
Run <code>ptex2tex</code> (if you have it) to make a standard LaTeX file,
=======================================
--- /doc/demos/tutorial/tutorial.p.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.p.tex Sat Aug 10 23:22:34 2013
@@ -295,16 +295,16 @@
% #if LATEX_HEADING == "traditional"
-\date{Jul 13, 2013}
+\date{Aug 11, 2013}
\maketitle
% #elif LATEX_HEADING == "beamer"
-\date{Jul 13, 2013
+\date{Aug 11, 2013
% <titlepage figure>
}
% #elif LATEX_HEADING == "titlepage"
\ \\ [10mm]
-{\large\textsf{Jul 13, 2013}}
+{\large\textsf{Aug 11, 2013}}
\end{center}
\vfill
@@ -312,7 +312,7 @@
% #else
\begin{center}
-Jul 13, 2013
+Aug 11, 2013
\end{center}
\vspace{1cm}
@@ -933,8 +933,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1064,6 +1064,59 @@
The \code{-s} option adds a proper header and footer to the
\code{mydoc.html} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+\paragraph{GitHub-flavored Markdown.}
+Adding the command-line option \code{github-md} turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{{http://github.com}}{GitHub}. A special feature is the support of
task lists:
+unnumbered lists with \code{[x]} (task done) or \code{[ ]} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+\bccq
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+\eccq
+Say this text is stored in a file \code{mycomments.do.txt}. Running
+
+\bsys
+Terminal> doconce format pandoc mycomments --github_md
+\esys
+produces \code{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
\subsection{{\LaTeX}}
@@ -1084,11 +1137,11 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.
-An option \code{-DDEVICE=paper} makes some adjustments for documents
+An option \code{--device=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.
+The default, \code{--device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
\paragraph{Step 2.}
Run \code{ptex2tex} (if you have it) to make a standard {\LaTeX} file,
=======================================
--- /doc/demos/tutorial/tutorial.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.pdf Sat Aug 10 23:22:34 2013
Binary file, no diff available.
=======================================
--- /doc/demos/tutorial/tutorial.rst Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.rst Sat Aug 10 23:22:34 2013
@@ -6,7 +6,7 @@
========================================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -634,8 +634,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -767,6 +767,61 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -792,11 +847,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file::
=======================================
--- /doc/demos/tutorial/tutorial.rst.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.rst.html Sat Aug 10 23:22:34 2013
@@ -328,7 +328,7 @@
<tr class="field"><th class="field-name">Author:</th><td
class="field-body"><p class="first">Hans Petter Langtangen</p>
</td>
</tr>
-<tr class="field"><th class="field-name">Date:</th><td
class="field-body"><p class="first">Jul 13, 2013</p>
+<tr class="field"><th class="field-name">Date:</th><td
class="field-body"><p class="first">Aug 11, 2013</p>
<ul class="last simple">
<li>When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -900,8 +900,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1020,6 +1020,58 @@
</pre>
<p>The <tt class="docutils literal"><span class="pre">-s</span></tt>
option adds a proper header and footer to the <tt class="docutils
literal">mydoc.html</tt> file.
This recipe is a quick way of makeing HTML notes with (some)
mathematics.</p>
+<div class="section" id="github-flavored-markdown">
+<h3>GitHub-flavored Markdown</h3>
+<p>Adding the command-line option <tt class="docutils literal"><span
class="pre">github-md</span></tt> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
class="reference external" href="http://github.com">GitHub</a>. A special
feature is the support of task lists:
+unnumbered lists with <tt class="docutils literal">[x]</tt> (task done) or
<tt class="docutils literal">[ ]</tt> (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:</p>
+<pre class="literal-block">
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</pre>
+<p>Say this text is stored in a file <tt class="docutils
literal">mycomments.do.txt</tt>. Running:</p>
+<pre class="literal-block">
+Terminal> doconce format pandoc mycomments --github_md
+</pre>
+<p>produces <tt class="docutils literal">mycomments.md</tt> which can be
pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</p>
+</div>
</div>
<div class="section" id="id4">
<h2>LaTeX</h2>
@@ -1037,11 +1089,11 @@
<tt class="docutils literal">newcommands_replace.tex</tt> (see the section
<a class="reference internal"
href="#macros-newcommands-cross-references-index-and-bibliography">Macros
(Newcommands), Cross-References, Index, and Bibliography</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">-DDEVICE=paper</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">--device=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).
-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>
+The default, <tt class="docutils literal"><span
class="pre">--device=screen</span></tt>, creates a PDF file for reading
+on a screen where links are just 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> ptex2tex mydoc
=======================================
--- /doc/demos/tutorial/tutorial.rst.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.rst.pdf Sat Aug 10 23:22:34 2013
Binary file, no diff available.
=======================================
--- /doc/demos/tutorial/tutorial.rst.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.rst.tex Sat Aug 10 23:22:34 2013
@@ -79,7 +79,7 @@
Hans Petter Langtangen
\item[{Date:}]
-Jul 13, 2013
+Aug 11, 2013
%
\begin{itemize}
@@ -974,8 +974,8 @@
~~~~~~~~~~-{}-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\\
+~~~~~~~~~~-{}-html\_output=mydoc\_solarized~\textbackslash{}\\
+~~~~~~~~~~-{}-pygments\_html\_style=perldoc~-{}-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\\
@@ -1153,6 +1153,71 @@
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ GitHub-flavored Markdown%
+ \addcontentsline{toc}{subsubsection}{GitHub-flavored Markdown}%
+ \label{github-flavored-markdown}%
+}
+
+Adding the command-line option \texttt{github-md} turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{http://github.com}{GitHub}. A special feature is the support of task
lists:
+unnumbered lists with \texttt{{[}x{]}} (task done) or \texttt{{[} {]}}
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+!bquote\\
+=====~Problems~with~a~function~=====\\
+~\\
+There~is~a~problem~with~the~`f(x)`~function\\
+~\\
+!bc~pycod\\
+def~f(x):\\
+~~~~return~1~+~x\\
+!ec\\
+This~function~should~be~quadratic.\\
+!equote\\
+~\\
+OK,~this~is~fixed:\\
+~\\
+!bc~pycod\\
+def~f(x,~a=1,~b=1,~c=1):\\
+~~~~return~a*x**2~+~b*x~+~c\\
+!ec\\
+~\\
+=====~Updated~task~list~=====\\
+~\\
+~~~*~{[}x{]}~Offer~an~`f(x)`~function\\
+~~~*~{[}~{]}~Extension~to~cubic~functions\\
+~~~*~{[}x{]}~Allowing~general~coefficient~in~the~quadratic~function\\
+~\\
+===~Remaining~functionality~===\\
+~\\
+|
-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
\\
+|~function~|~purpose~~~~~~~~~~~~~~~~~~~~~~~~|~state~|\\
+|
-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
\\
+|~~`g(x)`~~|~Compute~the~Gaussian~function.~|~Formula~ready.~|\\
+|~~`h(x)`~~|~Heaviside~function.~~~~~~~~~~~~|~Formula~ready.~|\\
+|~~`I(x)`~~|~Indicator~function.~~~~~~~~~~~~|~Nothing~done~yet.~|\\
+|
-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
+}
+\end{quote}
+
+Say this text is stored in a file \texttt{mycomments.do.txt}. Running:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+Terminal>~doconce~format~pandoc~mycomments~-{}-github\_md
+}
+\end{quote}
+
+produces \texttt{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
+
%___________________________________________________________________________
\subsection*{\phantomsection%
@@ -1183,11 +1248,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option \texttt{-DDEVICE=paper} makes some adjustments for documents
+An option \texttt{-{}-device=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.
+The default, \texttt{-{}-device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
\emph{Step 2.} Run \texttt{ptex2tex} (if you have it) to make a standard
LaTeX file:
%
=======================================
--- /doc/demos/tutorial/tutorial.sphinx.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.sphinx.pdf Sat Aug 10 23:22:34 2013
Binary file, no diff available.
=======================================
--- /doc/demos/tutorial/tutorial.sphinx.rst Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.sphinx.rst Sat Aug 10 23:22:34 2013
@@ -6,7 +6,7 @@
========================================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -674,8 +674,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -815,6 +815,66 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+.. code-block:: text
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running
+
+
+.. code-block:: console
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -841,11 +901,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,
=======================================
--- /doc/demos/tutorial/tutorial.st Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.st Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
TITLE: Doconce: Document Once, Include Anywhere
BY: Hans Petter Langtangen (Center for Biomedical Computing, Simula
Research Laboratory, and Department of Informatics, University of Oslo)
-DATE: Jul 13, 2013
+DATE: Aug 11, 2013
- When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML,
@@ -562,8 +562,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -688,6 +688,60 @@
The '-s' option adds a proper header and footer to the 'mydoc.html' file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+
+Adding the command-line option 'github-md' turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker
on "http://github.com":GitHub. A special feature is the support of task
lists:
+unnumbered lists with '[x]' (task done) or '[ ]' (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file 'mycomments.do.txt'. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces 'mycomments.md' which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
@@ -705,11 +759,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option '-DDEVICE=paper' makes some adjustments for documents
+An option '--device=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.
+The default, '--device=screen', creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run 'ptex2tex' (if you have it) to make a standard LaTeX file::
=======================================
--- /doc/demos/tutorial/tutorial.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.tex Sat Aug 10 23:22:34 2013
@@ -136,7 +136,7 @@
\begin{center}
-Jul 13, 2013
+Aug 11, 2013
\end{center}
\vspace{1cm}
@@ -772,8 +772,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -907,6 +907,61 @@
The {\fontsize{10pt}{10pt}\Verb!-s!} option adds a proper header and
footer to the {\fontsize{10pt}{10pt}\Verb!mydoc.html!} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+\paragraph{GitHub-flavored Markdown.}
+Adding the command-line option {\fontsize{10pt}{10pt}\Verb!github-md!}
turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{{http://github.com}}{GitHub}. A special feature is the support of
task lists:
+unnumbered lists with {\fontsize{10pt}{10pt}\Verb![x]!} (task done) or
{\fontsize{10pt}{10pt}\Verb![ ]!} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+\begin{Verbatim}[fontsize=\fontsize{9pt}{9pt},tabsize=8,baselinestretch=0.85,fontfamily=tt,xleftmargin=7mm]
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+\end{Verbatim}
+\noindent
+Say this text is stored in a file
{\fontsize{10pt}{10pt}\Verb!mycomments.do.txt!}. Running
+
+\vspace{4pt}
+\begin{Verbatim}[numbers=none,frame=lines,fontsize=\fontsize{9pt}{9pt},labelposition=topline,framesep=2.5mm,framerule=0.7pt]
+Terminal> doconce format pandoc mycomments --github_md
+\end{Verbatim}
+produces {\fontsize{10pt}{10pt}\Verb!mycomments.md!} which can be pasted
into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
\subsection{{\LaTeX}}
@@ -928,11 +983,11 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.
-An option {\fontsize{10pt}{10pt}\Verb!-DDEVICE=paper!} makes some
adjustments for documents
+An option {\fontsize{10pt}{10pt}\Verb!--device=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, {\fontsize{10pt}{10pt}\Verb!-DDEVICE=screen!}, creates a PDF
file for reading
-on a screen where links are clickable.
+The default, {\fontsize{10pt}{10pt}\Verb!--device=screen!}, creates a PDF
file for reading
+on a screen where links are just clickable.
\paragraph{Step 2.}
Run {\fontsize{10pt}{10pt}\Verb!ptex2tex!} (if you have it) to make a
standard {\LaTeX} file,
=======================================
--- /doc/demos/tutorial/tutorial.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.txt Sat Aug 10 23:22:34 2013
@@ -7,7 +7,7 @@
[1] Center for Biomedical Computing, Simula Research Laboratory
[2] Department of Informatics, University of Oslo
-Date: Jul 13, 2013
+Date: Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -629,8 +629,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -759,6 +759,61 @@
The -s option adds a proper header and footer to the mydoc.html file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option github-md turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on GitHub
(http://github.com). A special feature is the support of task lists:
+unnumbered lists with [x] (task done) or [ ] (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file mycomments.do.txt. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces mycomments.md which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -777,11 +832,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option -DDEVICE=paper makes some adjustments for documents
+An option --device=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.
+The default, --device=screen, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ptex2tex (if you have it) to make a standard LaTeX file::
=======================================
--- /doc/demos/tutorial/tutorial.xml Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.xml Sat Aug 10 23:22:34 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="tutorial.rst"><comment
xml:space="preserve">Automatically generated reST file from Doconce source
-(http://code.google.com/p/doconce/)</comment><section
ids="doconce-document-once-include-anywhere" names="doconce:\ document\
once,\ include\ anywhere"><title>Doconce: Document Once, Include
Anywhere</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><bullet_list bullet="*"><list_item><paragraph>When
writing a note, report, manual, etc., do you find it difficult
+(http://code.google.com/p/doconce/)</comment><section
ids="doconce-document-once-include-anywhere" names="doconce:\ document\
once,\ include\ anywhere"><title>Doconce: Document Once, Include
Anywhere</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>Aug
11, 2013</paragraph><bullet_list bullet="*"><list_item><paragraph>When
writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML,
reStructuredText, Sphinx, XML, etc. Would it be convenient to
@@ -298,8 +298,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -361,16 +361,56 @@
and date), maybe with some unnumbered equations, and quickly generate
HTML with mathematics displayed my MathJax:</paragraph><literal_block
xml:space="preserve">Terminal> doconce format pandoc mydoc
Terminal> pandoc -t html -o mydoc.html -s --mathjax
mydoc.mkd</literal_block><paragraph>The <literal>-s</literal> option adds a
proper header and footer to the <literal>mydoc.html</literal> file.
-This recipe is a quick way of makeing HTML notes with (some)
mathematics.</paragraph></section><section dupnames="latex"
ids="id4"><title>LaTeX</title><paragraph>Making a LaTeX file
<literal>mydoc.tex</literal> from <literal>mydoc.do.txt</literal> is done
in two steps:</paragraph><comment xml:space="preserve">Note: putting code
blocks inside a list is not successful in many</comment><comment
xml:space="preserve">formats - the text may be messed up. A better choice
is a paragraph</comment><comment xml:space="preserve">environment, as used
here.</comment><paragraph><emphasis>Step 1.</emphasis> Filter the doconce
text to a pre-LaTeX form <literal>mydoc.p.tex</literal> for
+This recipe is a quick way of makeing HTML notes with (some)
mathematics.</paragraph><section ids="github-flavored-markdown"
names="github-flavored\ markdown"><title>GitHub-flavored
Markdown</title><paragraph>Adding the command-line option
<literal>github-md</literal> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <reference
name="GitHub" refuri="http://github.com">GitHub</reference><target
ids="github" names="github" refuri="http://github.com"/>. A special feature
is the support of task lists:
+unnumbered lists with <literal>[x]</literal> (task done) or <literal>[
]</literal> (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an
example:</paragraph><literal_block xml:space="preserve">!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
</literal_block><paragraph>Say this text is stored in a file
<literal>mycomments.do.txt</literal>. Running:</paragraph><literal_block
xml:space="preserve">Terminal> doconce format pandoc mycomments
--github_md</literal_block><paragraph>produces
<literal>mycomments.md</literal> which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</paragraph></section></section><section dupnames="latex"
ids="id4"><title>LaTeX</title><paragraph>Making a LaTeX file
<literal>mydoc.tex</literal> from <literal>mydoc.do.txt</literal> is done
in two steps:</paragraph><comment xml:space="preserve">Note: putting code
blocks inside a list is not successful in many</comment><comment
xml:space="preserve">formats - the text may be messed up. A better choice
is a paragraph</comment><comment xml:space="preserve">environment, as used
here.</comment><paragraph><emphasis>Step 1.</emphasis> Filter the doconce
text to a pre-LaTeX form <literal>mydoc.p.tex</literal> for
the <literal>ptex2tex</literal> program (or <literal>doconce
ptex2tex</literal>):</paragraph><literal_block
xml:space="preserve">Terminal> doconce format latex
mydoc</literal_block><paragraph>LaTeX-specific commands
("newcommands") in math formulas and similar
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), Cross-References, Index, and Bibliography"
refid="macros-newcommands-cross-references-index-and-bibliography">Macros
(Newcommands), Cross-References, Index, and Bibliography</reference>).
If these files are present, they are included in the LaTeX document
-so that your commands are defined.</paragraph><paragraph>An option
<literal>-DDEVICE=paper</literal> makes some adjustments for documents
+so that your commands are defined.</paragraph><paragraph>An option
<literal>--device=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).
-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> 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>
doconce ptex2tex mydoc</literal_block><paragraph>Note that Doconce
generates a <literal>.p.tex</literal> file with some preprocessor macros
+The default, <literal>--device=screen</literal>, creates a PDF file for
reading
+on a screen where links are just
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> 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>
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> ptex2tex -DHELVETICA mydoc
=======================================
--- /doc/tutorial/doconce2anything.do.txt Sat Aug 10 23:04:17 2013
+++ /doc/tutorial/doconce2anything.do.txt Sat Aug 10 23:22:34 2013
@@ -328,10 +328,10 @@
There is a problem with the `f(x)` function
-!bc pycod
+|bc pycod
def f(x):
return 1 + x
-!ec
+|ec
This function should be quadratic.
|equote
@@ -387,11 +387,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
__Step 2.__ Run `ptex2tex` (if you have it) to make a standard LaTeX file,
!bc sys
Revision: 7a29362f2eb1
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 08:53:54 2013
Log: HTML5 slides now insert the original body and head contents in
the new...
http://code.google.com/p/doconce/source/detail?r=7a29362f2eb1
Revision: 5402f8455327
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 23:04:17 2013
Log: Intelligent defaults for html_admon and pygments_html_style.
http://code.google.com/p/doconce/source/detail?r=5402f8455327
Revision: a59a054f9d99
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 23:22:34 2013
Log: Regenerated docs with corrections.
http://code.google.com/p/doconce/source/detail?r=a59a054f9d99
==============================================================================
Revision: 7a29362f2eb1
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 08:53:54 2013
Log: HTML5 slides now insert the original body and head contents in
the new header.
http://code.google.com/p/doconce/source/detail?r=7a29362f2eb1
Modified:
/lib/doconce/common.py
/lib/doconce/doconce_config_default.py
/lib/doconce/misc.py
=======================================
--- /lib/doconce/common.py Thu Jul 18 20:58:04 2013
+++ /lib/doconce/common.py Sat Aug 10 08:53:54 2013
@@ -396,15 +396,25 @@
# Consistency check
n = filestr.count(_CODE_BLOCK)
if len(code_blocks) != n:
- print '*** BUG: found %d code block markers for %d initial code
blocks' % (n, len(code_blocks))
- print 'Possible cause: !bc and !ec inside code blocks - replace by
|bc and |ec'
- print 'or mismatch of !bt and !et across files in multi-file
documents'
- print '(run doconce on each file to locate the problem)'
+ print '*** error: found %d code block markers for %d initial code
blocks' % (n, len(code_blocks))
+ print """Possible causes:
+ - mismatch of !bt and !et within one file, such that a !bt
+ swallows code
+ - mismatch of !bt and !et across files in multi-file documents
+ - !bc and !ec inside code blocks - replace by |bc and |ec
+ (run doconce on each file to locate the problem, then on
+ smaller and smaller parts of each file)"""
_abort()
n = filestr.count(_MATH_BLOCK)
if len(tex_blocks) != n:
- print '*** BUG: found %d tex block markers for %d initial tex
blocks\nAbort!' % (n, len(tex_blocks))
- print 'Possible cause: !bt and !et inside code blocks - replace by
|bt and |ec'
+ print '*** error: found %d tex block markers for %d initial tex
blocks\nAbort!' % (n, len(tex_blocks))
+ print """Possible causes:
+ - mismatch of !bc and !ec within one file, such that a !bc
+ swallows tex blocks
+ - mismatch of !bc and !ec across files in multi-file documents
+ - !bt and !et inside code blocks - replace by |bt and |et
+ (run doconce on each file to locate the problem, then on
+ smaller and smaller parts of each file)"""
_abort()
lines = filestr.splitlines()
=======================================
--- /lib/doconce/doconce_config_default.py Sun Jul 21 01:24:05 2013
+++ /lib/doconce/doconce_config_default.py Sat Aug 10 08:53:54 2013
@@ -47,3 +47,5 @@
wordpress = False
tables2csv = False
github_md = False
+sections_up = False
+sections_down = False
=======================================
--- /lib/doconce/misc.py Sun Aug 4 11:57:04 2013
+++ /lib/doconce/misc.py Sat Aug 10 08:53:54 2013
@@ -3168,12 +3168,12 @@
print 'known
themes:', ', '.join(list(all_combinations[slide_tp].keys()))
_abort()
- m = re.search(r'<title>(.*?)</title>', ''.join(parts[0]))
- if m:
- title = m.group(1).strip()
- else:
- title = ''
- slide_syntax[slide_tp]['title'] = title
+ #m = re.search(r'<title>(.*?)</title>', ''.join(parts[0]))
+ #if m:
+ # title = m.group(1).strip()
+ #else:
+ # title = ''
+ #slide_syntax[slide_tp]['title'] = title
slide_syntax[slide_tp]['theme'] = \
slide_syntax[slide_tp]['default_theme'] if (theme == 'default' or
theme.endswith('_default')) else theme
@@ -3183,19 +3183,47 @@
slide_syntax[slide_tp]['body_header'] = \
slide_syntax[slide_tp]['body_header'] % slide_syntax[slide_tp]
+ # Grab the relevant lines in the <head> and <body> parts of
+ # the original header
+ head_lines = []
+ body_lines = []
+ inside_style = False
+ inside_head = False
+ inside_body = False
+ for line in header:
+ if '<head>' in line:
+ inside_head = True
+ continue
+ elif '</head>' in line:
+ inside_head = False
+ continue
+ elif line.strip().startswith('<body'):
+ inside_body = True
+ continue
+ elif '</body>' in line:
+ inside_body = False
+ continue
+ elif line.strip().startswith('<style'):
+ inside_style = True
+ continue
+ elif '</style>' in line:
+ inside_style = False
+ continue
+ if inside_style:
+ continue # skip style lines
+ elif inside_body:
+ body_lines.append(line)
+ elif inside_head:
+ head_lines.append(line)
+ slide_syntax[slide_tp]['head_lines'] = ''.join(head_lines)
+ slide_syntax[slide_tp]['body_lines'] = ''.join(body_lines)
+
+ #<title>%(title)s</title>
slides = """\
<!DOCTYPE html>
-<html lang="en">
-
-<!--
- Automatically translated from Doconce source.
- http://code.google.com/p/doconce
--->
-<head>
-<meta charset="utf-8">
+%(head_lines)s
-<title>%(title)s</title>
%(head_header)s
<!-- Styles for table layout of slides -->
@@ -3208,24 +3236,12 @@
}
</style>
-<!-- Use MathJax to render mathematics -->
-<script type="text/x-mathjax-config">
-MathJax.Hub.Config({
- TeX: {
- equationNumbers: { autoNumber: "AMS" },
- extensions: ["AMSmath.js", "AMSsymbols.js", "autobold.js"]
- }
-});
-</script>
-<script type="text/javascript"
-
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
-</script>
-<!-- Fix slow MathJax rendering in IE8 -->
-<meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7">
-
</head>
%(body_header)s
+
+%(body_lines)s
+
""" % slide_syntax[slide_tp]
for part_no, part in enumerate(parts):
==============================================================================
Revision: 5402f8455327
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 23:04:17 2013
Log: Intelligent defaults for html_admon and pygments_html_style.
http://code.google.com/p/doconce/source/detail?r=5402f8455327
Modified:
/doc/manual/manual.do.txt
/doc/tutorial/doconce2anything.do.txt
/lib/doconce/html.py
/lib/doconce/misc.py
=======================================
--- /doc/manual/manual.do.txt Thu Jul 18 20:58:04 2013
+++ /doc/manual/manual.do.txt Sat Aug 10 23:04:17 2013
@@ -1592,11 +1592,11 @@
Some recommended combinations for admonitions in HTML are
- * `--html_admon=apricot`, `--html_style=solarized`
- * `--html_admon=yellow`, `--html_style=bluish2`, `--no_pygments_html`
- * `--html_admon=yellow`, `--html_style=blueish2`,
`--pygments_html_style=default`
- * `--html_admon=gray`, `--html_style=bloodish`, `--no_pygments_html`
- * `--html_admon=gray`, `--html_style=bloodish`,
`--pygments_html_style=default`
+ * `--html_style=solarized`, `--html_admon=apricot`,
`--pygments_html_style=perldoc`
+ * `--html_style=blueish2`, `--html_admon=yellow`, `--no_pygments_html`
+ * `--html_style=blueish2`, `--html_admon=yellow`,
`--pygments_html_style=default`
+ * `--html_style=bloodish`, `--html_admon=gray`, `--no_pygments_html`
+ * `--html_style=bloodish`, `--html_admon=gray`,
`--pygments_html_style=default`
* `--html_style=vagrant`, `--pygments_html_style=default`,
`--html_template=...`
The `vagrant` HTML style has CSS files that override the definition
=======================================
--- /doc/tutorial/doconce2anything.do.txt Sun Jul 21 01:24:05 2013
+++ /doc/tutorial/doconce2anything.do.txt Sat Aug 10 23:04:17 2013
@@ -187,8 +187,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
=======================================
--- /lib/doconce/html.py Thu Jul 18 20:58:04 2013
+++ /lib/doconce/html.py Sat Aug 10 23:04:17 2013
@@ -246,7 +246,14 @@
if option('no_pygments_html'):
pygm = None
if pygm is not None:
- pygm_style = option('pygments_html_style=', default='default')
+ pygm_style = option('pygments_html_style=', default=None)
+ if pygm_style is None:
+ # Set sensible default values
+ if option('html_style=') == 'solarized':
+ pygm_style = 'perldoc'
+ else:
+ pygm_style = 'default'
+
legal_styles = list(get_all_styles())
legal_styles += ['no', 'none']
if pygm_style not in legal_styles:
@@ -1069,7 +1076,15 @@
keep_pygm_bg = option('keep_pygments_html_bg')
pygments_pattern = r'"background: .+?">'
- html_admon = option('html_admon=', 'gray')
+ html_admon = option('html_admon=', None)
+ if html_admon is None:
+ # Set sensible default value
+ if option('html_style=') == 'solarized':
+ html_admon = 'apricot'
+ elif option('html_style=') == 'blueish2':
+ html_admon = 'yellow'
+ else:
+ html_admon = 'gray'
if html_admon == 'colors':
if not keep_pygm_bg:
block = re.sub(pygments_pattern, r'"background: %%s">' %%
=======================================
--- /lib/doconce/misc.py Sat Aug 10 08:53:54 2013
+++ /lib/doconce/misc.py Sat Aug 10 23:04:17 2013
@@ -6114,6 +6114,9 @@
filename_html = prefix_diff_files + tofile + '.html'
f = open(filename_plain, 'w')
+ # Need to add newlines despite doc saying that trailing newlines
are
+ # inserted...
+ diff_plain = [line + '\n' for line in diff_plain]
f.writelines(diff_plain)
f.close()
==============================================================================
Revision: a59a054f9d99
Branch: default
Author: "Hans Petter Langtangen <h...@simula.no>"
Date: Sat Aug 10 23:22:34 2013
Log: Regenerated docs with corrections.
http://code.google.com/p/doconce/source/detail?r=a59a054f9d99
Modified:
/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/tutorial/html/_sources/tutorial.txt
/doc/demos/tutorial/html/searchindex.js
/doc/demos/tutorial/html/tutorial.html
/doc/demos/tutorial/tutorial.cwiki
/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/tutorial/doconce2anything.do.txt
=======================================
--- /doc/demos/manual/html/_sources/manual.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/html/_sources/manual.txt Sat Aug 10 23:22:34 2013
@@ -5,7 +5,7 @@
===================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
.. lines beginning with # are doconce comment lines
@@ -82,11 +82,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -875,8 +875,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1016,6 +1016,66 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+.. code-block:: text
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running
+
+
+.. code-block:: console
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -1042,11 +1102,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,
@@ -2196,6 +2256,23 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+
+.. code-block:: text
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send `mail <mailto:h...@simula.no>`_ to
+`h...@simula.no <mailto:h...@simula.no>`_.
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -3489,15 +3566,15 @@
Some recommended combinations for admonitions in HTML are
- * ``--html_admon=apricot``, ``--html_style=solarized``
+ * ``--html_style=solarized``, ``--html_admon=apricot``,
``--pygments_html_style=perldoc``
- * ``--html_admon=yellow``, ``--html_style=bluish2``,
``--no_pygments_html``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--no_pygments_html``
- * ``--html_admon=yellow``, ``--html_style=blueish2``,
``--pygments_html_style=default``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--pygments_html_style=default``
- * ``--html_admon=gray``, ``--html_style=bloodish``, ``--no_pygments_html``
+ * ``--html_style=bloodish``, ``--html_admon=gray``, ``--no_pygments_html``
- * ``--html_admon=gray``, ``--html_style=bloodish``,
``--pygments_html_style=default``
+ * ``--html_style=bloodish``, ``--html_admon=gray``,
``--pygments_html_style=default``
* ``--html_style=vagrant``, ``--pygments_html_style=default``,
``--html_template=...``
=======================================
--- /doc/demos/manual/html/manual.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/html/manual.html Sat Aug 10 23:22:34 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">Jul 13, 2013</td>
+<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body">Aug 11, 2013</td>
</tr>
</tbody>
</table>
@@ -116,11 +116,11 @@
</div></blockquote>
<p><em>History.</em> Doconce was developed in 2006 at a time when most
popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.</p>
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.</p>
<p><em>Disclaimer.</em> Doconce is a simple tool, largely based on
interpreting
and handling text through regular expressions. The possibility for
tweaking the layout is obviously limited since the text can go to
@@ -737,8 +737,8 @@
<span class="go"> --html_output=mydoc_bloodish</span>
<span class="go">Terminal> doconce split_html mydoc_bloodish.html</span>
<span class="go">Terminal> 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"> --html_output=mydoc_solarized \</span>
+<span class="go"> --pygments_html_style=perldoc
--html_admon=apricot</span>
<span class="go">Terminal> 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>
@@ -855,6 +855,58 @@
</div>
<p>The <tt class="docutils literal"><span class="pre">-s</span></tt>
option adds a proper header and footer to the <tt class="docutils
literal"><span class="pre">mydoc.html</span></tt> file.
This recipe is a quick way of makeing HTML notes with (some)
mathematics.</p>
+<div class="section" id="github-flavored-markdown">
+<h3>GitHub-flavored Markdown<a class="headerlink"
href="#github-flavored-markdown" title="Permalink to this
headline">¶</a></h3>
+<p>Adding the command-line option <tt class="docutils literal"><span
class="pre">github-md</span></tt> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
class="reference external" href="http://github.com">GitHub</a>. A special
feature is the support of task lists:
+unnumbered lists with <tt class="docutils literal"><span
class="pre">[x]</span></tt> (task done) or <tt class="docutils
literal"><span class="pre">[</span> <span class="pre">]</span></tt> (task
not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:</p>
+<div class="highlight-text"><div class="highlight"><pre>!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</pre></div>
+</div>
+<p>Say this text is stored in a file <tt class="docutils literal"><span
class="pre">mycomments.do.txt</span></tt>. Running</p>
+<div class="highlight-console"><div class="highlight"><pre><span
class="go">Terminal> doconce format pandoc mycomments --github_md</span>
+</pre></div>
+</div>
+<p>produces <tt class="docutils literal"><span
class="pre">mycomments.md</span></tt> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</p>
+</div>
</div>
<div class="section" id="latex">
<h2>LaTeX<a class="headerlink" href="#latex" title="Permalink to this
headline">¶</a></h2>
@@ -869,11 +921,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">-DDEVICE=paper</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">--device=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).
-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>
+The default, <tt class="docutils literal"><span
class="pre">--device=screen</span></tt>, creates a PDF file for reading
+on a screen where links are just 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> ptex2tex mydoc</span>
</pre></div>
@@ -1725,6 +1777,18 @@
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.)</p>
</div>
+<div class="section" id="mail-addresses">
+<h3>Mail Addresses<a class="headerlink" href="#mail-addresses"
title="Permalink to this headline">¶</a></h3>
+<p>Links that launches a mail to a specified address is written as
+ordinary URLs, typically as</p>
+<div class="highlight-text"><div class="highlight"><pre>Send
"mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+</pre></div>
+</div>
+<p>which appears as Send <a class="reference external"
href="mailto:hpl%40simula.no">mail</a> to
+<a class="reference external"
href="mailto:hpl%40simula.no">hpl<span>@</span>simula<span>.</span>no</a>.</p>
+</div>
<div class="section" id="links-to-local-files">
<h3>Links to Local Files<a class="headerlink" href="#links-to-local-files"
title="Permalink to this headline">¶</a></h3>
<p>Links to files ending in <tt class="docutils literal"><span
class="pre">.txt</span></tt>, <tt class="docutils literal"><span
class="pre">.html</span></tt>, <tt class="docutils literal"><span
class="pre">.pdf</span></tt>, <tt class="docutils literal"><span
class="pre">.py</span></tt>, <tt class="docutils literal"><span
class="pre">.f</span></tt>,
@@ -2744,11 +2808,11 @@
<p>Some recommended combinations for admonitions in HTML are</p>
<blockquote>
<div><ul class="simple">
-<li><tt class="docutils literal"><span
class="pre">--html_admon=apricot</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=solarized</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=yellow</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bluish2</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=yellow</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=blueish2</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=gray</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bloodish</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=gray</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bloodish</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=solarized</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=apricot</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=perldoc</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=blueish2</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=yellow</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=blueish2</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=yellow</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=bloodish</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=gray</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=bloodish</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=gray</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
<li><tt class="docutils literal"><span
class="pre">--html_style=vagrant</span></tt>, <tt class="docutils
literal"><span class="pre">--pygments_html_style=default</span></tt>, <tt
class="docutils literal"><span
class="pre">--html_template=...</span></tt></li>
</ul>
</div></blockquote>
@@ -3972,7 +4036,10 @@
</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="#pandoc-and-markdown">Pandoc and
Markdown</a><ul>
+<li><a class="reference internal"
href="#github-flavored-markdown">GitHub-flavored Markdown</a></li>
+</ul>
+</li>
<li><a class="reference internal" href="#latex">LaTeX</a></li>
<li><a class="reference internal" href="#pdflatex">PDFLaTeX</a></li>
<li><a class="reference internal" href="#xelatex">XeLaTeX</a></li>
@@ -3999,6 +4066,7 @@
<li><a class="reference internal" href="#emphasized-words">Emphasized
Words</a></li>
<li><a class="reference internal" href="#inline-verbatim-text">Inline
Verbatim Text</a></li>
<li><a class="reference internal" href="#links-to-web-addresses">Links to
Web Addresses</a></li>
+<li><a class="reference internal" href="#mail-addresses">Mail
Addresses</a></li>
<li><a class="reference internal" href="#links-to-local-files">Links to
Local Files</a></li>
<li><a class="reference internal" href="#inline-comments">Inline
Comments</a></li>
<li><a class="reference internal" href="#inline-mathematics">Inline
Mathematics</a></li>
=======================================
--- /doc/demos/manual/html/searchindex.js Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/html/searchindex.js Sat Aug 10 23:22:34 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,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"]})
+Search.setIndex({objects:{},terms:{mydoc2:1,linebreak:1,yellow:1,four:1,fig2:1,fig3:1,fig1:1,consider:1,spellcheck:1,aug: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,preview: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,attract:1,end:1,quot:1,ordinari:1,vagrant:1,how:1,answer:1,perspect:1,updat:1,dialect: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,equot: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,scipy_lectur: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,tracker: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,mycom:1,satisfactorili:1,form:1,offer:1,solar:1,"true":1,calc: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],backward: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],coeffici: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,mail: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,gaussian: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,noth: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,state: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,bquot: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,github_md: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,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,field: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,nxn: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,remain: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,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,quadrat:1,rid:1,minim:1,shorter: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,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,highlight: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,change_encod: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,heavisid: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,guthub: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,mailto: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,archiv: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,cubic: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],aris: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,"export":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,continu: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 Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.cwiki Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
#summary Doconce Description
<wiki:toc max_depth="2" />
By **Hans Petter Langtangen**
-=== Jul 13, 2013 ===
+=== Aug 11, 2013 ===
<wiki:comment> lines beginning with # are doconce comment lines
</wiki:comment>
<wiki:comment> (documents can also have mako comment lines) </wiki:comment>
@@ -39,11 +39,11 @@
//History.// Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
//Disclaimer.// Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -702,8 +702,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -823,6 +823,60 @@
The {{{-s}}} option adds a proper header and footer to the
{{{mydoc.html}}} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+=== GitHub-flavored Markdown ===
+
+Adding the command-line option {{{github-md}}} turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[[http://github.com|GitHub]]. A special feature is the support of task
lists:
+unnumbered lists with {{{[x]}}} (task done) or {{{[ ]}}} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+{{{
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+}}}
+Say this text is stored in a file {{{mycomments.do.txt}}}. Running
+
+{{{
+Terminal> doconce format pandoc mycomments --github_md
+}}}
+produces {{{mycomments.md}}} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
== LaTeX ==
@@ -842,11 +896,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option {{{-DDEVICE=paper}}} makes some adjustments for documents
+An option {{{--device=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.
+The default, {{{--device=screen}}}, creates a PDF file for reading
+on a screen where links are just clickable.
//Step 2.// Run {{{ptex2tex}}} (if you have it) to make a standard LaTeX
file,
{{{
@@ -1758,6 +1812,19 @@
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.)
+=== Mail Addresses ===
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+{{{
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+}}}
+which appears as Send [[mailto:h...@simula.no|mail]] to
+[[mailto:h...@simula.no|{{{h...@simula.no}}}]].
+
=== Links to Local Files ===
Links to files ending in {{{.txt}}}, {{{.html}}}, {{{.pdf}}}, {{{.py}}},
{{{.f}}},
@@ -2826,11 +2893,11 @@
Some recommended combinations for admonitions in HTML are
- * {{{--html_admon=apricot}}}, {{{--html_style=solarized}}}
- * {{{--html_admon=yellow}}}, {{{--html_style=bluish2}}},
{{{--no_pygments_html}}}
- * {{{--html_admon=yellow}}}, {{{--html_style=blueish2}}},
{{{--pygments_html_style=default}}}
- * {{{--html_admon=gray}}}, {{{--html_style=bloodish}}},
{{{--no_pygments_html}}}
- * {{{--html_admon=gray}}}, {{{--html_style=bloodish}}},
{{{--pygments_html_style=default}}}
+ * {{{--html_style=solarized}}}, {{{--html_admon=apricot}}},
{{{--pygments_html_style=perldoc}}}
+ * {{{--html_style=blueish2}}}, {{{--html_admon=yellow}}},
{{{--no_pygments_html}}}
+ * {{{--html_style=blueish2}}}, {{{--html_admon=yellow}}},
{{{--pygments_html_style=default}}}
+ * {{{--html_style=bloodish}}}, {{{--html_admon=gray}}},
{{{--no_pygments_html}}}
+ * {{{--html_style=bloodish}}}, {{{--html_admon=gray}}},
{{{--pygments_html_style=default}}}
* {{{--html_style=vagrant}}}, {{{--pygments_html_style=default}}},
{{{--html_template=...}}}
The {{{vagrant}}} HTML style has CSS files that override the definition
=======================================
--- /doc/demos/manual/manual.do.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.do.txt Sat Aug 10 23:22:34 2013
@@ -471,6 +471,19 @@
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.)
+=== Mail Addresses ===
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+!bc
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+!ec
+which appears as Send "mail": "mailto:h...@simula.no" to
+"`h...@simula.no`": "mailto:h...@simula.no".
+
=== Links to Local Files ===
Links to files ending in `.txt`, `.html`, `.pdf`, `.py`, `.f`,
@@ -1579,11 +1592,11 @@
Some recommended combinations for admonitions in HTML are
- * `--html_admon=apricot`, `--html_style=solarized`
- * `--html_admon=yellow`, `--html_style=bluish2`, `--no_pygments_html`
- * `--html_admon=yellow`, `--html_style=blueish2`,
`--pygments_html_style=default`
- * `--html_admon=gray`, `--html_style=bloodish`, `--no_pygments_html`
- * `--html_admon=gray`, `--html_style=bloodish`,
`--pygments_html_style=default`
+ * `--html_style=solarized`, `--html_admon=apricot`,
`--pygments_html_style=perldoc`
+ * `--html_style=blueish2`, `--html_admon=yellow`, `--no_pygments_html`
+ * `--html_style=blueish2`, `--html_admon=yellow`,
`--pygments_html_style=default`
+ * `--html_style=bloodish`, `--html_admon=gray`, `--no_pygments_html`
+ * `--html_style=bloodish`, `--html_admon=gray`,
`--pygments_html_style=default`
* `--html_style=vagrant`, `--pygments_html_style=default`,
`--html_template=...`
The `vagrant` HTML style has CSS files that override the definition
=======================================
--- /doc/demos/manual/manual.epytext Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.epytext Sat Aug 10 23:22:34 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: Jul 13, 2013
+DATE: Aug 11, 2013
What Is Doconce?
================
@@ -58,11 +58,11 @@
I{History.} Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
I{Disclaimer.} Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -750,8 +750,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -878,6 +878,61 @@
The C{-s} option adds a proper header and footer to the C{mydoc.html} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option C{github-md} turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
U{GitHub<http://github.com>}. A special feature is the support of task
lists:
+unnumbered lists with C{[x]} (task done) or C{[ ]} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file C{mycomments.do.txt}. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces C{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -896,11 +951,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option C{-DDEVICE=paper} makes some adjustments for documents
+An option C{--device=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.
+The default, C{--device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
I{Step 2.} Run C{ptex2tex} (if you have it) to make a standard LaTeX file::
@@ -1877,6 +1932,20 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as::
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send U{mail<mailto:h...@simula.no>} to
+U{C{h...@simula.no}<mailto:h...@simula.no>}.
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -2986,11 +3055,11 @@
Some recommended combinations for admonitions in HTML are
- - C{--html_admon=apricot}, C{--html_style=solarized}
- - C{--html_admon=yellow}, C{--html_style=bluish2}, C{--no_pygments_html}
- - C{--html_admon=yellow}, C{--html_style=blueish2},
C{--pygments_html_style=default}
- - C{--html_admon=gray}, C{--html_style=bloodish}, C{--no_pygments_html}
- - C{--html_admon=gray}, C{--html_style=bloodish},
C{--pygments_html_style=default}
+ - C{--html_style=solarized}, C{--html_admon=apricot},
C{--pygments_html_style=perldoc}
+ - C{--html_style=blueish2}, C{--html_admon=yellow}, C{--no_pygments_html}
+ - C{--html_style=blueish2}, C{--html_admon=yellow},
C{--pygments_html_style=default}
+ - C{--html_style=bloodish}, C{--html_admon=gray}, C{--no_pygments_html}
+ - C{--html_style=bloodish}, C{--html_admon=gray},
C{--pygments_html_style=default}
- C{--html_style=vagrant}, C{--pygments_html_style=default},
C{--html_template=...}
The C{vagrant} HTML style has CSS files that override the definition
=======================================
--- /doc/demos/manual/manual.gwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.gwiki Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
#summary Doconce Description
By *Hans Petter Langtangen*
-==== Jul 13, 2013 ====
+==== Aug 11, 2013 ====
<wiki:comment> lines beginning with # are doconce comment lines
</wiki:comment>
<wiki:comment> (documents can also have mako comment lines) </wiki:comment>
@@ -39,11 +39,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -701,8 +701,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -822,6 +822,60 @@
The `-s` option adds a proper header and footer to the `mydoc.html` file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+==== GitHub-flavored Markdown ====
+
+Adding the command-line option `github-md` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[http://github.com GitHub]. A special feature is the support of task lists:
+unnumbered lists with `[x]` (task done) or `[ ]` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+{{{
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+}}}
+Say this text is stored in a file `mycomments.do.txt`. Running
+
+{{{
+Terminal> doconce format pandoc mycomments --github_md
+}}}
+produces `mycomments.md` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
==== LaTeX ====
@@ -841,11 +895,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,
{{{
@@ -1776,6 +1830,19 @@
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.)
+==== Mail Addresses ====
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+{{{
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+}}}
+which appears as Send [mailto:h...@simula.no mail] to
+[mailto:h...@simula.no `h...@simula.no`].
+
==== Links to Local Files ====
Links to files ending in `.txt`, `.html`, `.pdf`, `.py`, `.f`,
@@ -2840,11 +2907,11 @@
Some recommended combinations for admonitions in HTML are
- * `--html_admon=apricot`, `--html_style=solarized`
- * `--html_admon=yellow`, `--html_style=bluish2`, `--no_pygments_html`
- * `--html_admon=yellow`, `--html_style=blueish2`,
`--pygments_html_style=default`
- * `--html_admon=gray`, `--html_style=bloodish`, `--no_pygments_html`
- * `--html_admon=gray`, `--html_style=bloodish`,
`--pygments_html_style=default`
+ * `--html_style=solarized`, `--html_admon=apricot`,
`--pygments_html_style=perldoc`
+ * `--html_style=blueish2`, `--html_admon=yellow`, `--no_pygments_html`
+ * `--html_style=blueish2`, `--html_admon=yellow`,
`--pygments_html_style=default`
+ * `--html_style=bloodish`, `--html_admon=gray`, `--no_pygments_html`
+ * `--html_style=bloodish`, `--html_admon=gray`,
`--pygments_html_style=default`
* `--html_style=vagrant`, `--pygments_html_style=default`,
`--html_template=...`
The `vagrant` HTML style has CSS files that override the definition
=======================================
--- /doc/demos/manual/manual.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.html Sat Aug 10 23:22:34 2013
@@ -102,58 +102,60 @@
(' 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'),
+ (' GitHub-flavored Markdown ', 3, None, '___sec32'),
+ (' LaTeX ', 2, None, '___sec33'),
+ (' PDFLaTeX ', 2, None, '___sec34'),
+ (' XeLaTeX ', 2, None, '___sec35'),
+ (' Plain ASCII Text ', 2, None, '___sec36'),
+ (' reStructuredText ', 2, None, '___sec37'),
+ (' Sphinx ', 2, None, '___sec38'),
+ (' The manual Sphinx procedure ', 3, None, '___sec39'),
+ (' Wiki Formats ', 2, None, '___sec40'),
+ (' Tweaking the Doconce Output ', 2, None, '___sec41'),
+ (' The Doconce Markup Language ', 1, None, '___sec42'),
+ (' Lists ', 2, None, '___sec43'),
+ (' Special Lines ', 2, None, '___sec44'),
+ (' Special Lines ', 1, None, '___sec45'),
+ (' Figures ', 2, None, '___sec46'),
+ (' Movies ', 2, None, '___sec47'),
(' Copying Computer Code from Source Files ',
2,
None,
- '___sec47'),
+ '___sec48'),
(' Inline Tagging ', 2, 'inline:tagging', 'inline:tagging'),
- (' 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'),
+ (' Emphasized Words ', 3, None, '___sec50'),
+ (' Inline Verbatim Text ', 3, None, '___sec51'),
+ (' Links to Web Addresses ', 3, None, '___sec52'),
+ (' Mail Addresses ', 3, None, '___sec53'),
+ (' Links to Local Files ', 3, None, '___sec54'),
+ (' Inline Comments ', 3, None, '___sec55'),
+ (' Inline Mathematics ', 3, None, '___sec56'),
+ (' Comments ', 2, None, '___sec57'),
+ (' Cross-Referencing ', 2, None, '___sec58'),
(' Generalized Cross-Referencing ',
2,
'manual:genrefs',
'manual:genrefs'),
- (' Index ', 2, None, '___sec58'),
- (' Bibliography ', 2, None, '___sec59'),
+ (' Index ', 2, None, '___sec60'),
+ (' Bibliography ', 2, None, '___sec61'),
(' Importing your data to the Publish database ',
3,
None,
- '___sec60'),
- (' Requirements to input data ', 3, None, '___sec61'),
+ '___sec62'),
+ (' Requirements to input data ', 3, None, '___sec63'),
(' Adding new references to the database ',
3,
None,
- '___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'),
+ '___sec64'),
+ (' Exporting the database ', 3, None, '___sec65'),
+ (' Referring to publications ', 3, None, '___sec66'),
+ (' Specifying the Publish database ', 3, None, '___sec67'),
+ (' LaTeX bibliography style ', 3, None, '___sec68'),
+ (' Tables ', 2, None, '___sec69'),
(' Exercises, Problems, Projects, and Examples ',
2,
None,
- '___sec68'),
+ '___sec70'),
(' Blocks of Verbatim Computer Code ',
2,
'sec:verbatim:blocks',
@@ -165,183 +167,186 @@
(' Mathematics for PowerPoint/OpenOffice ',
3,
None,
- '___sec71'),
+ '___sec73'),
(' Macros (Newcommands) ', 2, 'newcommands', 'newcommands'),
- (' Admonitions ', 2, None, '___sec73'),
- (' Preprocessing Steps ', 2, None, '___sec74'),
+ (' Admonitions ', 2, None, '___sec75'),
+ (' Preprocessing Steps ', 2, None, '___sec76'),
(' Splitting Documents into Smaller Pieces ',
2,
None,
- '___sec75'),
- (' Missing Features ', 2, None, '___sec76'),
- (' Header and Footer ', 2, None, '___sec77'),
+ '___sec77'),
+ (' Missing Features ', 2, None, '___sec78'),
+ (' Header and Footer ', 2, None, '___sec79'),
(' Emacs Doconce Formatter ',
2,
'emacs:doconce',
'emacs:doconce'),
- (' 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'),
+ (' Writing Slides ', 1, None, '___sec81'),
+ (' Overview ', 2, None, '___sec82'),
+ (' HTML5 Slides ', 2, None, '___sec83'),
+ (' Potential Problems ', 3, None, '___sec84'),
+ (' LaTeX Beamer Slides ', 2, None, '___sec85'),
+ (' Themes ', 3, None, '___sec86'),
+ (' Mako Programming ', 1, None, '___sec87'),
+ (' The Basics of Mako ', 2, None, '___sec88'),
(' Example: Defining a Theorem Environment ',
2,
'manual:theorem:envir',
'manual:theorem:envir'),
- (' Troubleshooting ', 1, None, '___sec88'),
- (' Disclaimer ', 2, None, '___sec89'),
- (' General Problems ', 2, None, '___sec90'),
+ (' Troubleshooting ', 1, None, '___sec90'),
+ (' Disclaimer ', 2, None, '___sec91'),
+ (' General Problems ', 2, None, '___sec92'),
(' Spellcheck reports a lot of mistakes related LaTeX math ',
3,
None,
- '___sec91'),
+ '___sec93'),
(' Doconce aborts because of a syntax error that is not an
error ',
3,
None,
- '___sec92'),
+ '___sec94'),
(' The Mako preprocessor is seemingly not run ',
3,
None,
- '___sec93'),
+ '___sec95'),
(' The Mako preprocessor is fooled by Doconce text ',
3,
None,
- '___sec94'),
+ '___sec96'),
(' The Mako preprocessor claims a variable is undefined ',
3,
None,
- '___sec95'),
+ '___sec97'),
(' Something goes wrong in the preprocessing step ',
3,
+ None,
+ '___sec98'),
+ (' Figure captions are incomplete ', 3, None, '___sec99'),
+ (' Preprocessor directives do not work ', 3,
None, '___sec100'),
+ (' Problems with boldface and emphasize ',
+ 3,
None,
- '___sec96'),
- (' Figure captions are incomplete ', 3, None, '___sec97'),
- (' Preprocessor directives do not work ', 3,
None, '___sec98'),
- (' Problems with boldface and emphasize ', 3,
None, '___sec99'),
+ '___sec101'),
(' Links to local directories do not work ',
3,
None,
- '___sec100'),
- (' Links are not typeset correctly ', 3, None, '___sec101'),
+ '___sec102'),
+ (' Links are not typeset correctly ', 3, None, '___sec103'),
(' Inline verbatim code is not detected ',
3,
None,
- '___sec102'),
+ '___sec104'),
(' Inline verbatim text is not formatted correctly ',
3,
None,
- '___sec103'),
- (' Strange non-English characters ', 3, None, '___sec104'),
- (' Wrong Norwegian charcters ', 3, None, '___sec105'),
+ '___sec105'),
+ (' Strange non-English characters ', 3, None, '___sec106'),
+ (' Wrong Norwegian charcters ', 3, None, '___sec107'),
(' Too short underlining of reST headlines ',
3,
None,
- '___sec106'),
+ '___sec108'),
(' Found !bt but no tex blocks extracted (BUG) ',
3,
None,
- '___sec107'),
+ '___sec109'),
(' Examples are typset with environment delimiters visible ',
3,
None,
- '___sec108'),
+ '___sec110'),
(' Emacs editing does not work properly because of "regexp
overflow" ',
3,
None,
- '___sec109'),
- (' Problems with code or Tex Blocks ', 2, None, '___sec110'),
- (' Code or math block errors in reST ', 3,
None, '___sec111'),
+ '___sec111'),
+ (' Problems with code or Tex Blocks ', 2, None, '___sec112'),
+ (' Code or math block errors in reST ', 3,
None, '___sec113'),
(' Strange errors around code or TeX blocks in reST ',
3,
None,
- '___sec112'),
+ '___sec114'),
(' Something is wrong with a verbatim code block ',
3,
None,
- '___sec113'),
+ '___sec115'),
(' Code/TeX block is not shown in reST format ',
3,
None,
- '___sec114'),
+ '___sec116'),
(' Verbatim code blocks inside lists look ugly ',
3,
None,
- '___sec115'),
+ '___sec117'),
(' LaTeX code blocks inside lists look ugly ',
3,
None,
- '___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'),
+ '___sec118'),
+ (' Problems with reST/Sphinx Output ', 2, None, '___sec119'),
+ (' Title level inconsistent ', 3, None, '___sec120'),
+ (' Lists do not appear in .rst files ', 3,
None, '___sec121'),
(' Error message "Undefined substitution..." from reST ',
3,
None,
- '___sec120'),
- (' Warning about duplicate link names ', 3,
None, '___sec121'),
- (' Inconsistent headings in reST ', 3, None, '___sec122'),
+ '___sec122'),
+ (' Warning about duplicate link names ', 3,
None, '___sec123'),
+ (' Inconsistent headings in reST ', 3, None, '___sec124'),
(' No code environment appears before "bc ipy" blocks ',
3,
None,
- '___sec123'),
- (' Problems with LaTeX Output ', 2, None, '___sec124'),
+ '___sec125'),
+ (' Problems with LaTeX Output ', 2, None, '___sec126'),
(' LaTeX does not like underscores in URLs ',
3,
None,
- '___sec125'),
+ '___sec127'),
(" Error when running latex: You must have 'pygmentize'
installed ",
3,
None,
- '___sec126'),
+ '___sec128'),
(' Why are the LaTeX section headings smaller than normal? ',
3,
None,
- '___sec127'),
+ '___sec129'),
(' Can I have LaTeX figures with shadows? ',
3,
None,
- '___sec128'),
+ '___sec130'),
(' How can I use my fancy LaTeX environments? ',
3,
None,
- '___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'),
+ '___sec131'),
+ (' The LaTeX file does not compile ', 3, None, '___sec132'),
+ (' Inline verbatim gives error ', 3, None, '___sec133'),
+ (' Errors in figure captions ', 3, None, '___sec134'),
+ (' Chapters are ignored ', 3, None, '___sec135'),
(' I want to tune the top of the LaTeX file ',
3,
None,
- '___sec134'),
- (' Problems with gwiki Output ', 2, None, '___sec135'),
- (' Strange nested lists in gwiki ', 3, None, '___sec136'),
+ '___sec136'),
+ (' Problems with gwiki Output ', 2, None, '___sec137'),
+ (' Strange nested lists in gwiki ', 3, None, '___sec138'),
(' Lists in gwiki look ugly in the gwiki source ',
3,
None,
- '___sec137'),
- (' Problems with HTML Output ', 2, None, '___sec138'),
+ '___sec139'),
+ (' Problems with HTML Output ', 2, None, '___sec140'),
(' MathJax formulas are not properly rendered ',
3,
None,
- '___sec139'),
+ '___sec141'),
(' How can I change the layout of the HTML page? ',
3,
None,
- '___sec140'),
+ '___sec142'),
(' Why do figures look ugly when using HTML templates? ',
3,
None,
- '___sec141'),
- (' Debugging ', 2, None, '___sec142'),
- (' Basic Parsing Ideas ', 1, None, '___sec143'),
+ '___sec143'),
+ (' Debugging ', 2, None, '___sec144'),
+ (' Basic Parsing Ideas ', 1, None, '___sec145'),
(' Typesetting of Function Arguments, Return Values, and
Variables ',
2,
None,
- '___sec144'),
- (' References ', 1, None, '___sec145')]}
+ '___sec146'),
+ (' References ', 1, None, '___sec147')]}
end of tocinfo -->
<body>
@@ -393,7 +398,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>Jul 13, 2013</h4></center> <!-- date -->
+<center><h4>Aug 11, 2013</h4></center> <!-- date -->
<p>
<!-- lines beginning with # are doconce comment lines -->
<!-- (documents can also have mako comment lines) -->
@@ -461,11 +466,11 @@
<b>History.</b>
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
<p>
<b>Disclaimer.</b>
@@ -1232,8 +1237,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1378,7 +1383,66 @@
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="___sec32"></a></h3>
+<h4>GitHub-flavored Markdown <a name="___sec32"></a></h4>
+
+<p>
+Adding the command-line option <code>github-md</code> turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
href="http://github.com">GitHub</a>. A special feature is the support of
task lists:
+unnumbered lists with <code>[x]</code> (task done) or <code>[ ]</code>
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+<p>
+<!-- begin verbatim block -->
+<pre><code>!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</code></pre>
+<!-- end verbatim block -->
+Say this text is stored in a file <code>mycomments.do.txt</code>. Running
+
+<p>
+<!-- begin verbatim block sys-->
+<pre><code>Terminal> doconce format pandoc mycomments --github_md
+</code></pre>
+<!-- end verbatim block -->
+produces <code>mycomments.md</code> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
+<h3>LaTeX <a name="___sec33"></a></h3>
<p>
Making a LaTeX file <code>mydoc.tex</code> from <code>mydoc.do.txt</code>
is done in two steps:
@@ -1401,11 +1465,11 @@
so that your commands are defined.
<p>
-An option <code>-DDEVICE=paper</code> makes some adjustments for documents
+An option <code>--device=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.
+The default, <code>--device=screen</code>, creates a PDF file for reading
+on a screen where links are just clickable.
<p>
<b>Step 2.</b>
@@ -1596,7 +1660,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="___sec33"></a></h3>
+<h3>PDFLaTeX <a name="___sec34"></a></h3>
<p>
Running <code>pdflatex</code> instead of <code>latex</code> follows almost
the same steps,
@@ -1614,7 +1678,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>XeLaTeX <a name="___sec34"></a></h3>
+<h3>XeLaTeX <a name="___sec35"></a></h3>
<p>
XeLaTeX is an alternative to pdfLaTeX and is run in almost the
@@ -1629,7 +1693,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Plain ASCII Text <a name="___sec35"></a></h3>
+<h3>Plain ASCII Text <a name="___sec36"></a></h3>
<p>
We can go from Doconce "back to" plain untagged text suitable for viewing
@@ -1640,7 +1704,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>reStructuredText <a name="___sec36"></a></h3>
+<h3>reStructuredText <a name="___sec37"></a></h3>
<p>
Going from Doconce to reStructuredText gives a lot of possibilities to
@@ -1696,7 +1760,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="___sec37"></a></h3>
+<h3>Sphinx <a name="___sec38"></a></h3>
<p>
Sphinx documents demand quite some steps in their creation. We have
automated
@@ -1858,7 +1922,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>The manual Sphinx procedure <a name="___sec38"></a></h4>
+<h4>The manual Sphinx procedure <a name="___sec39"></a></h4>
<p>
If it is not desirable to use the autogenerated scripts explained
@@ -1968,7 +2032,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="___sec39"></a></h3>
+<h3>Wiki Formats <a name="___sec40"></a></h3>
<p>
There are many different wiki formats, but Doconce only supports three:
@@ -2015,7 +2079,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="___sec40"></a></h3>
+<h3>Tweaking the Doconce Output <a name="___sec41"></a></h3>
<p>
Occasionally, one would like to tweak the output in a certain format
@@ -2030,13 +2094,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="___sec41"></a></h2>
+<h2>The Doconce Markup Language <a name="___sec42"></a></h2>
<p>
The Doconce format introduces four constructs to markup text:
lists, special lines, inline tags, and environments.
-<h3>Lists <a name="___sec42"></a></h3>
+<h3>Lists <a name="___sec43"></a></h3>
<p>
An unordered bullet list makes use of the <code>*</code> as bullet sign
@@ -2142,7 +2206,7 @@
lines)
</dl>
-<h3>Special Lines <a name="___sec43"></a></h3>
+<h3>Special Lines <a name="___sec44"></a></h3>
<p>
The Doconce markup language has a concept called <em>special lines</em>.
@@ -2266,9 +2330,9 @@
</code></pre>
<!-- end verbatim block -->
-<h2>Special Lines <a name="___sec44"></a></h2>
+<h2>Special Lines <a name="___sec45"></a></h2>
-<h3>Figures <a name="___sec45"></a></h3>
+<h3>Figures <a name="___sec46"></a></h3>
<p>
<!-- Note: need extra blank after FIGURE and MOVIE in !bc environments -->
@@ -2333,7 +2397,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="___sec46"></a></h3>
+<h3>Movies <a name="___sec47"></a></h3>
<p>
Here is an example on the <code>MOVIE:</code> keyword for embedding
movies. This
@@ -2428,7 +2492,7 @@
<em>CFD.</em>
-<h3>Copying Computer Code from Source Files <a name="___sec47"></a></h3>
+<h3>Copying Computer Code from Source Files <a name="___sec48"></a></h3>
<p>
Another type of special lines starts with <code>@@@CODE</code> and enables
copying
@@ -2443,7 +2507,7 @@
<font color="blue">colored words</font>,
plus LaTeX/TeX inline mathematics, such as \( \nu = \sin(x) \).
-<h4>Emphasized Words <a name="___sec49"></a></h4>
+<h4>Emphasized Words <a name="___sec50"></a></h4>
<p>
Emphasized text is typeset inside a pair of asterisk, and there should
@@ -2462,7 +2526,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="___sec50"></a></h4>
+<h4>Inline Verbatim Text <a name="___sec51"></a></h4>
<p>
Verbatim text, typically used for short inline code,
@@ -2490,7 +2554,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="___sec51"></a></h4>
+<h4>Links to Web Addresses <a name="___sec52"></a></h4>
<p>
Web addresses with links are typeset as
@@ -2517,7 +2581,23 @@
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="___sec52"></a></h4>
+<h4>Mail Addresses <a name="___sec53"></a></h4>
+
+<p>
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+<p>
+<!-- begin verbatim block -->
+<pre><code>Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+</code></pre>
+<!-- end verbatim block -->
+which appears as Send <a href="mailto:h...@simula.no">mail</a> to
+<a href="mailto:h...@simula.no"><tt>h...@simula.no</tt></a>.
+
+<h4>Links to Local Files <a name="___sec54"></a></h4>
<p>
Links to files ending in <code>.txt</code>, <code>.html</code>,
<code>.pdf</code>, <code>.py</code>, <code>.f</code>,
@@ -2595,7 +2675,7 @@
<!-- <code>_static</code> directory - links in the <code>.rst</code> files
are automatically -->
<!-- adjusted.) -->
-<h4>Inline Comments <a name="___sec53"></a></h4>
+<h4>Inline Comments <a name="___sec55"></a></h4>
<p>
Doconce also supports inline comments in the text:
@@ -2628,7 +2708,7 @@
comment in parenthesis), but in LaTeX very visible color boxes
are used (via the <code>todonotes</code> package).
-<h4>Inline Mathematics <a name="___sec54"></a></h4>
+<h4>Inline Mathematics <a name="___sec56"></a></h4>
<p>
Inline mathematics is written as in LaTeX, i.e., inside dollar signs.
@@ -2658,7 +2738,7 @@
is an \( n\times n \) matrix, and \( \bf x \) and \( \bf b \)
are vectors of length \( n \)."
-<h3>Comments <a name="___sec55"></a></h3>
+<h3>Comments <a name="___sec57"></a></h3>
<p>
Comments intended to be (sometimes) visible in the output document and
@@ -2698,7 +2778,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="___sec56"></a></h3>
+<h3>Cross-Referencing <a name="___sec58"></a></h3>
<p>
References and labels are supported. The syntax is simple:
@@ -2829,7 +2909,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Index <a name="___sec58"></a></h3>
+<h3>Index <a name="___sec60"></a></h3>
<p>
An index can be created for the <code>latex</code>, <code>rst</code>, and
<code>sphinx</code> formats
@@ -2862,7 +2942,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="___sec59"></a></h3>
+<h3>Bibliography <a name="___sec61"></a></h3>
<p>
Doconce applies the software tool <a
href="https://bitbucket.org/logg/publish">Publish</a> to handle the
bibliography in a
@@ -2877,7 +2957,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="___sec60"></a></h4>
+<h4>Importing your data to the Publish database <a
name="___sec62"></a></h4>
<p>
Many scientists have their bibliographic data in the BibTex format. Here we
@@ -2899,7 +2979,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="___sec61"></a></h4>
+<h4>Requirements to input data <a name="___sec63"></a></h4>
<p>
<div class="alert alert-block alert-notice
alert-text-normal"><b>Notice.</b>
@@ -2930,7 +3010,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="___sec62"></a></h4>
+<h4>Adding new references to the database <a name="___sec64"></a></h4>
<p>
When you get some new BibTeX references you simply put them in
@@ -2938,7 +3018,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="___sec63"></a></h4>
+<h4>Exporting the database <a name="___sec65"></a></h4>
<p>
Export of everything in the database to
@@ -2954,7 +3034,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="___sec64"></a></h4>
+<h4>Referring to publications <a name="___sec66"></a></h4>
<p>
We use the command
@@ -2986,7 +3066,7 @@
brackets and the corresponding references are listed in the order they
are cited.
-<h4>Specifying the Publish database <a name="___sec65"></a></h4>
+<h4>Specifying the Publish database <a name="___sec67"></a></h4>
<p>
The specification of the Publish database file in the Doconce document
@@ -3009,7 +3089,7 @@
and included in the document, while in all other formats, suitable
text is produced from the database.
-<h4>LaTeX bibliography style <a name="___sec66"></a></h4>
+<h4>LaTeX bibliography style <a name="___sec68"></a></h4>
<p>
The bibliography style is "plain" in LaTeX output. To change this, just
@@ -3022,7 +3102,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Tables <a name="___sec67"></a></h3>
+<h3>Tables <a name="___sec69"></a></h3>
<p>
A table like
@@ -3116,7 +3196,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Exercises, Problems, Projects, and Examples <a
name="___sec68"></a></h3>
+<h3>Exercises, Problems, Projects, and Examples <a
name="___sec70"></a></h3>
<p>
Doconce has special support for four types of "exercises", named
@@ -3603,7 +3683,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Mathematics for PowerPoint/OpenOffice <a name="___sec71"></a></h4>
+<h4>Mathematics for PowerPoint/OpenOffice <a name="___sec73"></a></h4>
<p>
If you have LaTeX mathematics written in Doconce, it is fairly easy
@@ -3656,7 +3736,7 @@
line (multi-line newcommands are too hard to parse with regular
expressions).
-<h3>Admonitions <a name="___sec73"></a></h3>
+<h3>Admonitions <a name="___sec75"></a></h3>
<p>
Doconce offers strong support for admonition environments, such
@@ -3749,11 +3829,11 @@
<p>
<ul>
- <li> <code>--html_admon=apricot</code>,
<code>--html_style=solarized</code></li>
- <li> <code>--html_admon=yellow</code>, <code>--html_style=bluish2</code>,
<code>--no_pygments_html</code></li>
- <li> <code>--html_admon=yellow</code>,
<code>--html_style=blueish2</code>,
<code>--pygments_html_style=default</code></li>
- <li> <code>--html_admon=gray</code>, <code>--html_style=bloodish</code>,
<code>--no_pygments_html</code></li>
- <li> <code>--html_admon=gray</code>, <code>--html_style=bloodish</code>,
<code>--pygments_html_style=default</code></li>
+ <li> <code>--html_style=solarized</code>,
<code>--html_admon=apricot</code>,
<code>--pygments_html_style=perldoc</code></li>
+ <li> <code>--html_style=blueish2</code>,
<code>--html_admon=yellow</code>, <code>--no_pygments_html</code></li>
+ <li> <code>--html_style=blueish2</code>,
<code>--html_admon=yellow</code>,
<code>--pygments_html_style=default</code></li>
+ <li> <code>--html_style=bloodish</code>, <code>--html_admon=gray</code>,
<code>--no_pygments_html</code></li>
+ <li> <code>--html_style=bloodish</code>, <code>--html_admon=gray</code>,
<code>--pygments_html_style=default</code></li>
<li> <code>--html_style=vagrant</code>,
<code>--pygments_html_style=default</code>,
<code>--html_template=...</code></li>
</ul>
@@ -3790,7 +3870,7 @@
<li> <code>yellowbox</code> has icons and a light yellow background.</li>
</ul>
-<h3>Preprocessing Steps <a name="___sec74"></a></h3>
+<h3>Preprocessing Steps <a name="___sec76"></a></h3>
<p>
Doconce allows preprocessor commands for, e.g., including files,
@@ -3869,7 +3949,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="___sec75"></a></h3>
+<h3>Splitting Documents into Smaller Pieces <a name="___sec77"></a></h3>
<p>
Long documents are conveniently split into smaller Doconce files.
@@ -3965,7 +4045,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="___sec76"></a></h3>
+<h3>Missing Features <a name="___sec78"></a></h3>
<p>
Doconce does not aim to support sophisticated typesetting, simply because
@@ -3999,7 +4079,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="___sec77"></a></h3>
+<h3>Header and Footer <a name="___sec79"></a></h3>
<p>
Some formats use a header and footer in the document. LaTeX and
@@ -4055,7 +4135,7 @@
the different shortcuts and see how handy they are in learning
Doconce and saving much typing!
-<h2>Writing Slides <a name="___sec79"></a></h2>
+<h2>Writing Slides <a name="___sec81"></a></h2>
<p>
It is a fast procedure to make slides from large amounts of Doconce
@@ -4079,7 +4159,7 @@
color for code</li>
</ul>
-<h3>Overview <a name="___sec80"></a></h3>
+<h3>Overview <a name="___sec82"></a></h3>
<p>
Basically, Doconce slides are ordinary Doconce text with
<code>!split</code>
@@ -4109,7 +4189,7 @@
slides to be presented through a web browser, and classical
LaTeX Beamer slides.
-<h3>HTML5 Slides <a name="___sec81"></a></h3>
+<h3>HTML5 Slides <a name="___sec83"></a></h3>
<p>
<!-- doconce-adjusted styles: easy to switch between styles since -->
@@ -4128,7 +4208,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Potential Problems <a name="___sec82"></a></h4>
+<h4>Potential Problems <a name="___sec84"></a></h4>
<p>
@@ -4139,12 +4219,12 @@
equations. More edits (automate with <code>doconce subst</code>) might
be needed.</li>
</ul>
-<h3>LaTeX Beamer Slides <a name="___sec83"></a></h3>
+<h3>LaTeX Beamer Slides <a name="___sec85"></a></h3>
<p>
Not yet written...
-<h4>Themes <a name="___sec84"></a></h4>
+<h4>Themes <a name="___sec86"></a></h4>
<p>
Four themes come with Doconce: <code>X_Y</code>, where <code>X</code> is
<code>blue</code> or <code>red</code>
@@ -4153,7 +4233,7 @@
<a
href="http://hplgit.github.io/teamods/doconce/demo/demo_blue_shadow.pdf"><tt>shadow</tt></a>
for shadowed boxes and more visual structure in the slides.
-<h2>Mako Programming <a name="___sec85"></a></h2>
+<h2>Mako Programming <a name="___sec87"></a></h2>
<p>
The <a href="http://docs.makotemplates.org/">Mako</a> templating engine is
used
@@ -4172,7 +4252,7 @@
Mako function call. This problem can give rise to strange error
messages from Mako, usually that a variable is not defined.
</div>
-<h3>The Basics of Mako <a name="___sec86"></a></h3>
+<h3>The Basics of Mako <a name="___sec88"></a></h3>
<p>
Just a preliminary sketch of some Mako code (next example is better!):
@@ -4341,9 +4421,9 @@
the <code>ptex2tex</code> program with all its flexibility for choosing
environments.
Also <code>doconce ptex2tex</code> has some flexibility for typesetting
computer code.
-<h2>Troubleshooting <a name="___sec88"></a></h2>
+<h2>Troubleshooting <a name="___sec90"></a></h2>
-<h3>Disclaimer <a name="___sec89"></a></h3>
+<h3>Disclaimer <a name="___sec91"></a></h3>
<p>
Doconce has some support for syntax checking. If you encounter Python
@@ -4354,9 +4434,9 @@
regular expressions may sometimes fail. Therefore, there is a chance that
legal
Doconce syntax is not treated properly.
-<h3>General Problems <a name="___sec90"></a></h3>
+<h3>General Problems <a name="___sec92"></a></h3>
-<h4>Spellcheck reports a lot of mistakes related LaTeX math <a
name="___sec91"></a></h4>
+<h4>Spellcheck reports a lot of mistakes related LaTeX math <a
name="___sec93"></a></h4>
<p>
The <code>doconce spellcheck</code> command should ignore LaTeX math, but
if
@@ -4366,7 +4446,7 @@
are reported as misspellings. This will fortunately give you hint of
what is wrong with the math typesetting.
-<h4>Doconce aborts because of a syntax error that is not an error <a
name="___sec92"></a></h4>
+<h4>Doconce aborts because of a syntax error that is not an error <a
name="___sec94"></a></h4>
<p>
Doconce searches for typical syntax errors and usually aborts the
@@ -4376,7 +4456,7 @@
<code>--no_abort</code> option on the command line. You may send an email
to the Doconce author at <code>h...@simula.no</code> and report the problem.
-<h4>The Mako preprocessor is seemingly not run <a
name="___sec93"></a></h4>
+<h4>The Mako preprocessor is seemingly not run <a
name="___sec95"></a></h4>
<p>
If you have lines starting with <code>%</code> inside code segments (for
example,
@@ -4385,7 +4465,7 @@
this problem and avoids running Mako. Examine the output from
Doconce: warnings are issued if Mako is not run.
-<h4>The Mako preprocessor is fooled by Doconce text <a
name="___sec94"></a></h4>
+<h4>The Mako preprocessor is fooled by Doconce text <a
name="___sec96"></a></h4>
<p>
Here are possible problems for Mako:
@@ -4397,7 +4477,7 @@
to <code>'T < %.1f'</code> to avoid this confusion.</li>
</ul>
-<h4>The Mako preprocessor claims a variable is undefined <a
name="___sec95"></a></h4>
+<h4>The Mako preprocessor claims a variable is undefined <a
name="___sec97"></a></h4>
<p>
Very often such errors are related to typos when using Mako
@@ -4419,7 +4499,7 @@
the text and apply a "bisection" procedure to locate where
the Mako problem is (without <code>--mako_strict_undefined</code>).
-<h4>Something goes wrong in the preprocessing step <a
name="___sec96"></a></h4>
+<h4>Something goes wrong in the preprocessing step <a
name="___sec98"></a></h4>
<p>
You can examine <code>tmp_preprocess__filename</code> and
<code>tmp_mako__filename</code>,
@@ -4430,7 +4510,7 @@
***The diff for this file has been truncated for email.***
=======================================
--- /doc/demos/manual/manual.md Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.md Sat Aug 10 23:22:34 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
-% Jul 13, 2013
+% Aug 11, 2013
<!-- lines beginning with # are doconce comment lines -->
<!-- (documents can also have mako comment lines) -->
@@ -69,11 +69,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -798,8 +798,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -934,6 +934,64 @@
The `-s` option adds a proper header and footer to the `mydoc.html` file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+#### GitHub-flavored Markdown
+
+Adding the command-line option `github-md` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[GitHub](http://github.com). A special feature is the support of task lists:
+unnumbered lists with `[x]` (task done) or `[ ]` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Say this text is stored in a file `mycomments.do.txt`. Running
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.Bash}
+Terminal> doconce format pandoc mycomments --github_md
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+produces `mycomments.md` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
### LaTeX
@@ -955,11 +1013,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,
@@ -2002,6 +2060,21 @@
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.)
+#### Mail Addresses
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+which appears as Send [mail](mailto:h...@simula.no) to
+[`h...@simula.no`](mailto:h...@simula.no).
+
#### Links to Local Files
Links to files ending in `.txt`, `.html`, `.pdf`, `.py`, `.f`,
@@ -3172,15 +3245,15 @@
Some recommended combinations for admonitions in HTML are
- * `--html_admon=apricot`, `--html_style=solarized`
+ * `--html_style=solarized`, `--html_admon=apricot`,
`--pygments_html_style=perldoc`
- * `--html_admon=yellow`, `--html_style=bluish2`, `--no_pygments_html`
+ * `--html_style=blueish2`, `--html_admon=yellow`, `--no_pygments_html`
- * `--html_admon=yellow`, `--html_style=blueish2`,
`--pygments_html_style=default`
+ * `--html_style=blueish2`, `--html_admon=yellow`,
`--pygments_html_style=default`
- * `--html_admon=gray`, `--html_style=bloodish`, `--no_pygments_html`
+ * `--html_style=bloodish`, `--html_admon=gray`, `--no_pygments_html`
- * `--html_admon=gray`, `--html_style=bloodish`,
`--pygments_html_style=default`
+ * `--html_style=bloodish`, `--html_admon=gray`,
`--pygments_html_style=default`
* `--html_style=vagrant`, `--pygments_html_style=default`,
`--html_template=...`
=======================================
--- /doc/demos/manual/manual.mwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.mwiki Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
#TITLE (actually governed by the filename): Doconce Description
By '''Hans Petter Langtangen'''
-==== Jul 13, 2013 ====
+==== Aug 11, 2013 ====
<!-- lines beginning with # are doconce comment lines -->
<!-- (documents can also have mako comment lines) -->
@@ -67,11 +67,11 @@
''History.''
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
''Disclaimer.''
Doconce is a simple tool, largely based on interpreting
@@ -735,8 +735,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -868,6 +868,60 @@
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.
+==== GitHub-flavored Markdown ====
+
+Adding the command-line option <code>github-md</code> turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[http://github.com GitHub]. A special feature is the support of task lists:
+unnumbered lists with <code>[x]</code> (task done) or <code>[ ]</code>
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+<syntaxhighlight lang="text">
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</syntaxhighlight>
+Say this text is stored in a file <code>mycomments.do.txt</code>. Running
+
+<syntaxhighlight lang="bash">
+Terminal> doconce format pandoc mycomments --github_md
+</syntaxhighlight>
+produces <code>mycomments.md</code> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
==== LaTeX ====
@@ -888,11 +942,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option <code>-DDEVICE=paper</code> makes some adjustments for documents
+An option <code>--device=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.
+The default, <code>--device=screen</code>, creates a PDF file for reading
+on a screen where links are just clickable.
''Step 2.''
Run <code>ptex2tex</code> (if you have it) to make a standard LaTeX file,
@@ -1869,6 +1923,19 @@
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.)
+==== Mail Addresses ====
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+<syntaxhighlight lang="text">
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+</syntaxhighlight>
+which appears as Send [mailto:h...@simula.no mail] to
+[mailto:h...@simula.no <code>h...@simula.no</code>].
+
==== Links to Local Files ====
Links to files ending in <code>.txt</code>, <code>.html</code>,
<code>.pdf</code>, <code>.py</code>, <code>.f</code>,
@@ -2979,11 +3046,11 @@
<ul>
- <li> <code>--html_admon=apricot</code>,
<code>--html_style=solarized</code>
- <li> <code>--html_admon=yellow</code>, <code>--html_style=bluish2</code>,
<code>--no_pygments_html</code>
- <li> <code>--html_admon=yellow</code>,
<code>--html_style=blueish2</code>,
<code>--pygments_html_style=default</code>
- <li> <code>--html_admon=gray</code>, <code>--html_style=bloodish</code>,
<code>--no_pygments_html</code>
- <li> <code>--html_admon=gray</code>, <code>--html_style=bloodish</code>,
<code>--pygments_html_style=default</code>
+ <li> <code>--html_style=solarized</code>,
<code>--html_admon=apricot</code>,
<code>--pygments_html_style=perldoc</code>
+ <li> <code>--html_style=blueish2</code>,
<code>--html_admon=yellow</code>, <code>--no_pygments_html</code>
+ <li> <code>--html_style=blueish2</code>,
<code>--html_admon=yellow</code>, <code>--pygments_html_style=default</code>
+ <li> <code>--html_style=bloodish</code>, <code>--html_admon=gray</code>,
<code>--no_pygments_html</code>
+ <li> <code>--html_style=bloodish</code>, <code>--html_admon=gray</code>,
<code>--pygments_html_style=default</code>
<li> <code>--html_style=vagrant</code>,
<code>--pygments_html_style=default</code>, <code>--html_template=...</code>
</ul>
=======================================
--- /doc/demos/manual/manual.p.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.p.tex Sat Aug 10 23:22:34 2013
@@ -316,16 +316,16 @@
% #if LATEX_HEADING == "traditional"
-\date{Jul 13, 2013}
+\date{Aug 11, 2013}
\maketitle
% #elif LATEX_HEADING == "beamer"
-\date{Jul 13, 2013
+\date{Aug 11, 2013
% <titlepage figure>
}
% #elif LATEX_HEADING == "titlepage"
\ \\ [10mm]
-{\large\textsf{Jul 13, 2013}}
+{\large\textsf{Aug 11, 2013}}
\end{center}
\vfill
@@ -333,7 +333,7 @@
% #else
\begin{center}
-Jul 13, 2013
+Aug 11, 2013
\end{center}
\vspace{1cm}
@@ -413,11 +413,11 @@
\paragraph{History.}
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
\paragraph{Disclaimer.}
Doconce is a simple tool, largely based on interpreting
@@ -1078,8 +1078,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1209,6 +1209,59 @@
The \code{-s} option adds a proper header and footer to the
\code{mydoc.html} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+\paragraph{GitHub-flavored Markdown.}
+Adding the command-line option \code{github-md} turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{{http://github.com}}{GitHub}. A special feature is the support of
task lists:
+unnumbered lists with \code{[x]} (task done) or \code{[ ]} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+\bccq
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+\eccq
+Say this text is stored in a file \code{mycomments.do.txt}. Running
+
+\bsys
+Terminal> doconce format pandoc mycomments --github_md
+\esys
+produces \code{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
\subsection{{\LaTeX}}
@@ -1229,11 +1282,11 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.
-An option \code{-DDEVICE=paper} makes some adjustments for documents
+An option \code{--device=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.
+The default, \code{--device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
\paragraph{Step 2.}
Run \code{ptex2tex} (if you have it) to make a standard {\LaTeX} file,
@@ -2234,7 +2287,7 @@
Doconce supports tags for \emph{emphasized phrases}, \textbf{boldface
phrases},
and \code{verbatim text} (also called type writer text, for inline code),
\textcolor{blue}{colored words},
-plus {\LaTeX}/TeX inline mathematics, such as $\nu = \sin(x)$.
+plus LaTeX/TeX inline mathematics, such as $\nu = \sin(x)$.
\paragraph{Emphasized Words.}
Emphasized text is typeset inside a pair of asterisk, and there should
@@ -2296,6 +2349,18 @@
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.)
+\paragraph{Mail Addresses.}
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+\bccq
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+\eccq
+which appears as Send \href{{mailto:h...@simula.no}}{mail} to
+\href{{mailto:h...@simula.no}}{\nolinkurl{h...@simula.no}}.
+
\paragraph{Links to Local Files.}
Links to files ending in \code{.txt}, \code{.html}, \code{.pdf},
\code{.py}, \code{.f},
\code{.f77}, \code{.f90}, \code{.f95}, \code{.sh}, \code{.csh},
\code{.ksh}, \code{.zsh},
@@ -3043,7 +3108,7 @@
does not introduce any environment in \code{sphinx} output, as interactive
sessions are automatically recognized and handled). All these
definitions of the arguments after \code{!bc} can be redefined in the
-\code{.ptex2tex.cfg} configuration file for ptex2tex/{\LaTeX} and in the
+\code{.ptex2tex.cfg} configuration file for ptex2tex/LaTeX and in the
\code{sphinx code-blocks} comments for Sphinx. Support for other languages
is easily added.
@@ -3408,15 +3473,15 @@
Some recommended combinations for admonitions in HTML are
\begin{itemize}
- \item \code{--html_admon=apricot}, \code{--html_style=solarized}
+ \item \code{--html_style=solarized}, \code{--html_admon=apricot},
\code{--pygments_html_style=perldoc}
- \item \code{--html_admon=yellow}, \code{--html_style=bluish2},
\code{--no_pygments_html}
+ \item \code{--html_style=blueish2}, \code{--html_admon=yellow},
\code{--no_pygments_html}
- \item \code{--html_admon=yellow}, \code{--html_style=blueish2},
\code{--pygments_html_style=default}
+ \item \code{--html_style=blueish2}, \code{--html_admon=yellow},
\code{--pygments_html_style=default}
- \item \code{--html_admon=gray}, \code{--html_style=bloodish},
\code{--no_pygments_html}
+ \item \code{--html_style=bloodish}, \code{--html_admon=gray},
\code{--no_pygments_html}
- \item \code{--html_admon=gray}, \code{--html_style=bloodish},
\code{--pygments_html_style=default}
+ \item \code{--html_style=bloodish}, \code{--html_admon=gray},
\code{--pygments_html_style=default}
\item \code{--html_style=vagrant}, \code{--pygments_html_style=default},
\code{--html_template=...}
\end{itemize}
=======================================
--- /doc/demos/manual/manual.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.pdf Sat Aug 10 23:22:34 2013
File is too large to display a diff.
=======================================
--- /doc/demos/manual/manual.rst Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.rst Sat Aug 10 23:22:34 2013
@@ -5,7 +5,7 @@
===================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
.. lines beginning with # are doconce comment lines
@@ -78,11 +78,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -803,8 +803,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -936,6 +936,61 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -961,11 +1016,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file::
@@ -2012,6 +2067,20 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as::
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send `mail <mailto:h...@simula.no>`_ to
+`h...@simula.no <mailto:h...@simula.no>`_.
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -3193,15 +3262,15 @@
Some recommended combinations for admonitions in HTML are
- * ``--html_admon=apricot``, ``--html_style=solarized``
+ * ``--html_style=solarized``, ``--html_admon=apricot``,
``--pygments_html_style=perldoc``
- * ``--html_admon=yellow``, ``--html_style=bluish2``,
``--no_pygments_html``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--no_pygments_html``
- * ``--html_admon=yellow``, ``--html_style=blueish2``,
``--pygments_html_style=default``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--pygments_html_style=default``
- * ``--html_admon=gray``, ``--html_style=bloodish``, ``--no_pygments_html``
+ * ``--html_style=bloodish``, ``--html_admon=gray``, ``--no_pygments_html``
- * ``--html_admon=gray``, ``--html_style=bloodish``,
``--pygments_html_style=default``
+ * ``--html_style=bloodish``, ``--html_admon=gray``,
``--pygments_html_style=default``
* ``--html_style=vagrant``, ``--pygments_html_style=default``,
``--html_template=...``
=======================================
--- /doc/demos/manual/manual.rst.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.rst.html Sat Aug 10 23:22:34 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">Jul 13, 2013</td>
+<tr class="field"><th class="field-name">Date:</th><td
class="field-body">Aug 11, 2013</td>
</tr>
</tbody>
</table>
@@ -389,11 +389,11 @@
</blockquote>
<p><em>History.</em> Doconce was developed in 2006 at a time when most
popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.</p>
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.</p>
<p><em>Disclaimer.</em> Doconce is a simple tool, largely based on
interpreting
and handling text through regular expressions. The possibility for
tweaking the layout is obviously limited since the text can go to
@@ -1022,8 +1022,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1142,6 +1142,58 @@
</pre>
<p>The <tt class="docutils literal"><span class="pre">-s</span></tt>
option adds a proper header and footer to the <tt class="docutils
literal">mydoc.html</tt> file.
This recipe is a quick way of makeing HTML notes with (some)
mathematics.</p>
+<div class="section" id="github-flavored-markdown">
+<h3>GitHub-flavored Markdown</h3>
+<p>Adding the command-line option <tt class="docutils literal"><span
class="pre">github-md</span></tt> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
class="reference external" href="http://github.com">GitHub</a>. A special
feature is the support of task lists:
+unnumbered lists with <tt class="docutils literal">[x]</tt> (task done) or
<tt class="docutils literal">[ ]</tt> (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:</p>
+<pre class="literal-block">
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</pre>
+<p>Say this text is stored in a file <tt class="docutils
literal">mycomments.do.txt</tt>. Running:</p>
+<pre class="literal-block">
+Terminal> doconce format pandoc mycomments --github_md
+</pre>
+<p>produces <tt class="docutils literal">mycomments.md</tt> which can be
pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</p>
+</div>
</div>
<div class="section" id="latex">
<h2>LaTeX</h2>
@@ -1159,11 +1211,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">-DDEVICE=paper</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">--device=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).
-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>
+The default, <tt class="docutils literal"><span
class="pre">--device=screen</span></tt>, creates a PDF file for reading
+on a screen where links are just 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> ptex2tex mydoc
@@ -2022,6 +2074,18 @@
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.)</p>
</div>
+<div class="section" id="mail-addresses">
+<h3>Mail Addresses</h3>
+<p>Links that launches a mail to a specified address is written as
+ordinary URLs, typically as:</p>
+<pre class="literal-block">
+Send "mail": "mailto:hpl@simula.no"
+# Alternative:
+to "`hpl@simula.no`": "mailto:hpl@simula.no".
+</pre>
+<p>which appears as Send <a class="reference external"
href="mailto:hpl@simula.no">mail</a> to
+<a class="reference external"
href="mailto:hpl@simula.no">hpl@simula.no</a>.</p>
+</div>
<div class="section" id="links-to-local-files">
<h3>Links to Local Files</h3>
<p>Links to files ending in <tt class="docutils literal">.txt</tt>, <tt
class="docutils literal">.html</tt>, <tt class="docutils
literal">.pdf</tt>, <tt class="docutils literal">.py</tt>, <tt
class="docutils literal">.f</tt>,
@@ -3060,11 +3124,11 @@
<p>Some recommended combinations for admonitions in HTML are</p>
<blockquote>
<ul class="simple">
-<li><tt class="docutils literal"><span
class="pre">--html_admon=apricot</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=solarized</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=yellow</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bluish2</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=yellow</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=blueish2</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=gray</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bloodish</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
-<li><tt class="docutils literal"><span
class="pre">--html_admon=gray</span></tt>, <tt class="docutils
literal"><span class="pre">--html_style=bloodish</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=solarized</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=apricot</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=perldoc</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=blueish2</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=yellow</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=blueish2</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=yellow</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=bloodish</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=gray</span></tt>, <tt
class="docutils literal"><span
class="pre">--no_pygments_html</span></tt></li>
+<li><tt class="docutils literal"><span
class="pre">--html_style=bloodish</span></tt>, <tt class="docutils
literal"><span class="pre">--html_admon=gray</span></tt>, <tt
class="docutils literal"><span
class="pre">--pygments_html_style=default</span></tt></li>
<li><tt class="docutils literal"><span
class="pre">--html_style=vagrant</span></tt>, <tt class="docutils
literal"><span class="pre">--pygments_html_style=default</span></tt>, <tt
class="docutils literal"><span
class="pre">--html_template=...</span></tt></li>
</ul>
</blockquote>
@@ -3434,7 +3498,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 3586); <em><a
href="#id15">backlink</a></em></p>
+<p class="system-message-title">System Message: WARNING/2 (<tt
class="docutils">manual.rst</tt>, line 3655); <em><a
href="#id15">backlink</a></em></p>
Duplicate explicit target name: "mako".</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 Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.rst.pdf Sat Aug 10 23:22:34 2013
Binary file, no diff available.
=======================================
--- /doc/demos/manual/manual.rst.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.rst.tex Sat Aug 10 23:22:34 2013
@@ -82,7 +82,7 @@
Hans Petter Langtangen
\item[{Date:}]
-Jul 13, 2013
+Aug 11, 2013
\end{DUfieldlist}
@@ -168,11 +168,11 @@
\emph{History.} Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
\emph{Disclaimer.} Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -1197,8 +1197,8 @@
~~~~~~~~~~-{}-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\\
+~~~~~~~~~~-{}-html\_output=mydoc\_solarized~\textbackslash{}\\
+~~~~~~~~~~-{}-pygments\_html\_style=perldoc~-{}-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\\
@@ -1376,6 +1376,71 @@
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ GitHub-flavored Markdown%
+ \addcontentsline{toc}{subsubsection}{GitHub-flavored Markdown}%
+ \label{github-flavored-markdown}%
+}
+
+Adding the command-line option \texttt{github-md} turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{http://github.com}{GitHub}. A special feature is the support of task
lists:
+unnumbered lists with \texttt{{[}x{]}} (task done) or \texttt{{[} {]}}
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+!bquote\\
+=====~Problems~with~a~function~=====\\
+~\\
+There~is~a~problem~with~the~`f(x)`~function\\
+~\\
+!bc~pycod\\
+def~f(x):\\
+~~~~return~1~+~x\\
+!ec\\
+This~function~should~be~quadratic.\\
+!equote\\
+~\\
+OK,~this~is~fixed:\\
+~\\
+!bc~pycod\\
+def~f(x,~a=1,~b=1,~c=1):\\
+~~~~return~a*x**2~+~b*x~+~c\\
+!ec\\
+~\\
+=====~Updated~task~list~=====\\
+~\\
+~~~*~{[}x{]}~Offer~an~`f(x)`~function\\
+~~~*~{[}~{]}~Extension~to~cubic~functions\\
+~~~*~{[}x{]}~Allowing~general~coefficient~in~the~quadratic~function\\
+~\\
+===~Remaining~functionality~===\\
+~\\
+|
-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
\\
+|~function~|~purpose~~~~~~~~~~~~~~~~~~~~~~~~|~state~|\\
+|
-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
\\
+|~~`g(x)`~~|~Compute~the~Gaussian~function.~|~Formula~ready.~|\\
+|~~`h(x)`~~|~Heaviside~function.~~~~~~~~~~~~|~Formula~ready.~|\\
+|~~`I(x)`~~|~Indicator~function.~~~~~~~~~~~~|~Nothing~done~yet.~|\\
+|
-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
+}
+\end{quote}
+
+Say this text is stored in a file \texttt{mycomments.do.txt}. Running:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+Terminal>~doconce~format~pandoc~mycomments~-{}-github\_md
+}
+\end{quote}
+
+produces \texttt{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
+
%___________________________________________________________________________
\subsection*{\phantomsection%
@@ -1406,11 +1471,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option \texttt{-DDEVICE=paper} makes some adjustments for documents
+An option \texttt{-{}-device=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.
+The default, \texttt{-{}-device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
\emph{Step 2.} Run \texttt{ptex2tex} (if you have it) to make a standard
LaTeX file:
%
@@ -2668,6 +2733,28 @@
mark (but not period!) becomes a link with the web address as link text.)
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ Mail Addresses%
+ \addcontentsline{toc}{subsubsection}{Mail Addresses}%
+ \label{mail-addresses}%
+}
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+Send~"mail":~"mailto:h...@simula.no"\\
+\#~Alternative:\\
+to~"`h...@simula.no`":~"mailto:h...@simula.no".
+}
+\end{quote}
+
+which appears as Send \href{mailto:h...@simula.no}{mail} to
+\href{mailto:h...@simula.no}{h...@simula.no}.
+
+
%___________________________________________________________________________
\subsubsection*{\phantomsection%
@@ -4120,15 +4207,15 @@
%
\begin{itemize}
-\item \texttt{-{}-html\_admon=apricot}, \texttt{-{}-html\_style=solarized}
+\item \texttt{-{}-html\_style=solarized},
\texttt{-{}-html\_admon=apricot}, \texttt{-{}-pygments\_html\_style=perldoc}
-\item \texttt{-{}-html\_admon=yellow}, \texttt{-{}-html\_style=bluish2},
\texttt{-{}-no\_pygments\_html}
+\item \texttt{-{}-html\_style=blueish2}, \texttt{-{}-html\_admon=yellow},
\texttt{-{}-no\_pygments\_html}
-\item \texttt{-{}-html\_admon=yellow}, \texttt{-{}-html\_style=blueish2},
\texttt{-{}-pygments\_html\_style=default}
+\item \texttt{-{}-html\_style=blueish2}, \texttt{-{}-html\_admon=yellow},
\texttt{-{}-pygments\_html\_style=default}
-\item \texttt{-{}-html\_admon=gray}, \texttt{-{}-html\_style=bloodish},
\texttt{-{}-no\_pygments\_html}
+\item \texttt{-{}-html\_style=bloodish}, \texttt{-{}-html\_admon=gray},
\texttt{-{}-no\_pygments\_html}
-\item \texttt{-{}-html\_admon=gray}, \texttt{-{}-html\_style=bloodish},
\texttt{-{}-pygments\_html\_style=default}
+\item \texttt{-{}-html\_style=bloodish}, \texttt{-{}-html\_admon=gray},
\texttt{-{}-pygments\_html\_style=default}
\item \texttt{-{}-html\_style=vagrant},
\texttt{-{}-pygments\_html\_style=default}, \texttt{-{}-html\_template=...}
@@ -4720,7 +4807,7 @@
\DUtitle[system-message]{system-message}
-{\color{red}WARNING/2} in \texttt{manual.rst}, line~3586
+{\color{red}WARNING/2} in \texttt{manual.rst}, line~3655
\hyperlink{id15}{
Duplicate explicit target name: ``mako''.
=======================================
--- /doc/demos/manual/manual.sphinx.rst Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.sphinx.rst Sat Aug 10 23:22:34 2013
@@ -5,7 +5,7 @@
===================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
.. lines beginning with # are doconce comment lines
@@ -82,11 +82,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -875,8 +875,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1016,6 +1016,66 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+.. code-block:: text
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running
+
+
+.. code-block:: console
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -1042,11 +1102,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,
@@ -2196,6 +2256,23 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+
+.. code-block:: text
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send `mail <mailto:h...@simula.no>`_ to
+`h...@simula.no <mailto:h...@simula.no>`_.
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -3489,15 +3566,15 @@
Some recommended combinations for admonitions in HTML are
- * ``--html_admon=apricot``, ``--html_style=solarized``
+ * ``--html_style=solarized``, ``--html_admon=apricot``,
``--pygments_html_style=perldoc``
- * ``--html_admon=yellow``, ``--html_style=bluish2``,
``--no_pygments_html``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--no_pygments_html``
- * ``--html_admon=yellow``, ``--html_style=blueish2``,
``--pygments_html_style=default``
+ * ``--html_style=blueish2``, ``--html_admon=yellow``,
``--pygments_html_style=default``
- * ``--html_admon=gray``, ``--html_style=bloodish``, ``--no_pygments_html``
+ * ``--html_style=bloodish``, ``--html_admon=gray``, ``--no_pygments_html``
- * ``--html_admon=gray``, ``--html_style=bloodish``,
``--pygments_html_style=default``
+ * ``--html_style=bloodish``, ``--html_admon=gray``,
``--pygments_html_style=default``
* ``--html_style=vagrant``, ``--pygments_html_style=default``,
``--html_template=...``
=======================================
--- /doc/demos/manual/manual.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.tex Sat Aug 10 23:22:34 2013
@@ -144,7 +144,7 @@
\begin{center}
-Jul 13, 2013
+Aug 11, 2013
\end{center}
\vspace{1cm}
@@ -223,11 +223,11 @@
\paragraph{History.}
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
\paragraph{Disclaimer.}
Doconce is a simple tool, largely based on interpreting
@@ -887,8 +887,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1016,6 +1016,59 @@
The \Verb!-s! option adds a proper header and footer to the
\Verb!mydoc.html! file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+\paragraph{GitHub-flavored Markdown.}
+Adding the command-line option \Verb!github-md! turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{{http://github.com}}{GitHub}. A special feature is the support of
task lists:
+unnumbered lists with \Verb![x]! (task done) or \Verb![ ]! (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+\end{Verbatim}
+Say this text is stored in a file \Verb!mycomments.do.txt!. Running
+
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
+Terminal> doconce format pandoc mycomments --github_md
+\end{Verbatim}
+produces \Verb!mycomments.md! which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
\subsection{{\LaTeX}}
@@ -1036,11 +1089,11 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.
-An option \Verb!-DDEVICE=paper! makes some adjustments for documents
+An option \Verb!--device=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.
+The default, \Verb!--device=screen!, creates a PDF file for reading
+on a screen where links are just clickable.
\paragraph{Step 2.}
Run \Verb!ptex2tex! (if you have it) to make a standard {\LaTeX} file,
@@ -2002,7 +2055,7 @@
Doconce supports tags for \emph{emphasized phrases}, \textbf{boldface
phrases},
and \Verb!verbatim text! (also called type writer text, for inline code),
\textcolor{blue}{colored words},
-plus {\LaTeX}/TeX inline mathematics, such as $\nu = \sin(x)$.
+plus LaTeX/TeX inline mathematics, such as $\nu = \sin(x)$.
\paragraph{Emphasized Words.}
Emphasized text is typeset inside a pair of asterisk, and there should
@@ -2064,6 +2117,18 @@
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.)
+\paragraph{Mail Addresses.}
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as
+
+\begin{Verbatim}[numbers=none,fontsize=\fontsize{9pt}{9pt},baselinestretch=0.95,xleftmargin=0mm]
+Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`": "mailto:h...@simula.no".
+\end{Verbatim}
+which appears as Send \href{{mailto:h...@simula.no}}{mail} to
+\href{{mailto:h...@simula.no}}{\nolinkurl{h...@simula.no}}.
+
\paragraph{Links to Local Files.}
Links to files ending in \Verb!.txt!, \Verb!.html!, \Verb!.pdf!,
\Verb!.py!, \Verb!.f!,
\Verb!.f77!, \Verb!.f90!, \Verb!.f95!, \Verb!.sh!, \Verb!.csh!,
\Verb!.ksh!, \Verb!.zsh!,
@@ -2810,7 +2875,7 @@
does not introduce any environment in \Verb!sphinx! output, as interactive
sessions are automatically recognized and handled). All these
definitions of the arguments after \Verb!!bc! can be redefined in the
-\Verb!.ptex2tex.cfg! configuration file for ptex2tex/{\LaTeX} and in the
+\Verb!.ptex2tex.cfg! configuration file for ptex2tex/LaTeX and in the
\Verb!sphinx code-blocks! comments for Sphinx. Support for other languages
is easily added.
@@ -3174,15 +3239,15 @@
Some recommended combinations for admonitions in HTML are
\begin{itemize}
- \item \Verb!--html_admon=apricot!, \Verb!--html_style=solarized!
+ \item \Verb!--html_style=solarized!, \Verb!--html_admon=apricot!,
\Verb!--pygments_html_style=perldoc!
- \item \Verb!--html_admon=yellow!, \Verb!--html_style=bluish2!,
\Verb!--no_pygments_html!
+ \item \Verb!--html_style=blueish2!, \Verb!--html_admon=yellow!,
\Verb!--no_pygments_html!
- \item \Verb!--html_admon=yellow!, \Verb!--html_style=blueish2!,
\Verb!--pygments_html_style=default!
+ \item \Verb!--html_style=blueish2!, \Verb!--html_admon=yellow!,
\Verb!--pygments_html_style=default!
- \item \Verb!--html_admon=gray!, \Verb!--html_style=bloodish!,
\Verb!--no_pygments_html!
+ \item \Verb!--html_style=bloodish!, \Verb!--html_admon=gray!,
\Verb!--no_pygments_html!
- \item \Verb!--html_admon=gray!, \Verb!--html_style=bloodish!,
\Verb!--pygments_html_style=default!
+ \item \Verb!--html_style=bloodish!, \Verb!--html_admon=gray!,
\Verb!--pygments_html_style=default!
\item \Verb!--html_style=vagrant!, \Verb!--pygments_html_style=default!,
\Verb!--html_template=...!
\end{itemize}
=======================================
--- /doc/demos/manual/manual.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.txt Sat Aug 10 23:22:34 2013
@@ -6,7 +6,7 @@
[1] Center for Biomedical Computing, Simula Research Laboratory
[2] Department of Informatics, University of Oslo
-Date: Jul 13, 2013
+Date: Aug 11, 2013
What Is Doconce?
================
@@ -72,11 +72,11 @@
*History.* Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer code.
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer code.
*Disclaimer.* Doconce is a simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
@@ -770,8 +770,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -900,6 +900,61 @@
The -s option adds a proper header and footer to the mydoc.html file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option github-md turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on GitHub
(http://github.com). A special feature is the support of task lists:
+unnumbered lists with [x] (task done) or [ ] (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file mycomments.do.txt. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces mycomments.md which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -918,11 +973,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option -DDEVICE=paper makes some adjustments for documents
+An option --device=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.
+The default, --device=screen, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ptex2tex (if you have it) to make a standard LaTeX file::
@@ -1927,6 +1982,20 @@
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.)
+Mail Addresses
+~~~~~~~~~~~~~~
+
+Links that launches a mail to a specified address is written as
+ordinary URLs, typically as::
+
+
+ Send "mail": "mailto:h...@simula.no"
+ # Alternative:
+ to "`h...@simula.no`": "mailto:h...@simula.no".
+
+which appears as Send mail (mailto:h...@simula.no) to
+h...@simula.no (mailto:h...@simula.no).
+
Links to Local Files
~~~~~~~~~~~~~~~~~~~~
@@ -3042,15 +3111,15 @@
Some recommended combinations for admonitions in HTML are
- * --html_admon=apricot, --html_style=solarized
+ * --html_style=solarized, --html_admon=apricot,
--pygments_html_style=perldoc
- * --html_admon=yellow, --html_style=bluish2, --no_pygments_html
+ * --html_style=blueish2, --html_admon=yellow, --no_pygments_html
- * --html_admon=yellow, --html_style=blueish2,
--pygments_html_style=default
+ * --html_style=blueish2, --html_admon=yellow,
--pygments_html_style=default
- * --html_admon=gray, --html_style=bloodish, --no_pygments_html
+ * --html_style=bloodish, --html_admon=gray, --no_pygments_html
- * --html_admon=gray, --html_style=bloodish, --pygments_html_style=default
+ * --html_style=bloodish, --html_admon=gray, --pygments_html_style=default
* --html_style=vagrant, --pygments_html_style=default, --html_template=...
=======================================
--- /doc/demos/manual/manual.xml Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual.xml Sat Aug 10 23:22:34 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>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
+(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>Aug
11, 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,
@@ -40,11 +40,11 @@
special support for exercises, and produces
cleaner LaTeX and HTML
output.</paragraph></list_item></bullet_list></block_quote><paragraph><emphasis>History.</emphasis>
Doconce was developed in 2006 at a time when most popular
markup languages used quite some tagging. Later, almost untagged
-markup languages like Markdown and Pandoc became popular. Doconce is
-not a replacement of Pandoc, which is a considerably more
-sophisticated project. Moreover, Doconce was developed mainly to
-fulfill the needs for a flexible source code base for books with much
-mathematics and computer
code.</paragraph><paragraph><emphasis>Disclaimer.</emphasis> Doconce is a
simple tool, largely based on interpreting
+markup languages like Markdown and the Pandoc translator became
+popular. Doconce is not a replacement of Pandoc, which is a
+considerably more sophisticated project. Moreover, Doconce was
+developed mainly to fulfill the needs for a flexible source code base
+for books with much mathematics and computer
code.</paragraph><paragraph><emphasis>Disclaimer.</emphasis> Doconce is a
simple tool, largely based on interpreting
and handling text through regular expressions. The possibility for
tweaking the layout is obviously limited since the text can go to
all sorts of sophisticated markup languages. Moreover, because of
@@ -328,8 +328,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -391,16 +391,56 @@
and date), maybe with some unnumbered equations, and quickly generate
HTML with mathematics displayed my MathJax:</paragraph><literal_block
xml:space="preserve">Terminal> doconce format pandoc mydoc
Terminal> pandoc -t html -o mydoc.html -s --mathjax
mydoc.mkd</literal_block><paragraph>The <literal>-s</literal> option adds a
proper header and footer to the <literal>mydoc.html</literal> file.
-This recipe is a quick way of makeing HTML notes with (some)
mathematics.</paragraph></section><section ids="latex"
names="latex"><title>LaTeX</title><paragraph>Making a LaTeX file
<literal>mydoc.tex</literal> from <literal>mydoc.do.txt</literal> is done
in two steps:</paragraph><comment xml:space="preserve">Note: putting code
blocks inside a list is not successful in many</comment><comment
xml:space="preserve">formats - the text may be messed up. A better choice
is a paragraph</comment><comment xml:space="preserve">environment, as used
here.</comment><paragraph><emphasis>Step 1.</emphasis> Filter the doconce
text to a pre-LaTeX form <literal>mydoc.p.tex</literal> for
+This recipe is a quick way of makeing HTML notes with (some)
mathematics.</paragraph><section ids="github-flavored-markdown"
names="github-flavored\ markdown"><title>GitHub-flavored
Markdown</title><paragraph>Adding the command-line option
<literal>github-md</literal> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <reference
name="GitHub" refuri="http://github.com">GitHub</reference><target
ids="github" names="github" refuri="http://github.com"/>. A special feature
is the support of task lists:
+unnumbered lists with <literal>[x]</literal> (task done) or <literal>[
]</literal> (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an
example:</paragraph><literal_block xml:space="preserve">!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
</literal_block><paragraph>Say this text is stored in a file
<literal>mycomments.do.txt</literal>. Running:</paragraph><literal_block
xml:space="preserve">Terminal> doconce format pandoc mycomments
--github_md</literal_block><paragraph>produces
<literal>mycomments.md</literal> which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</paragraph></section></section><section ids="latex"
names="latex"><title>LaTeX</title><paragraph>Making a LaTeX file
<literal>mydoc.tex</literal> from <literal>mydoc.do.txt</literal> is done
in two steps:</paragraph><comment xml:space="preserve">Note: putting code
blocks inside a list is not successful in many</comment><comment
xml:space="preserve">formats - the text may be messed up. A better choice
is a paragraph</comment><comment xml:space="preserve">environment, as used
here.</comment><paragraph><emphasis>Step 1.</emphasis> Filter the doconce
text to a pre-LaTeX form <literal>mydoc.p.tex</literal> for
the <literal>ptex2tex</literal> program (or <literal>doconce
ptex2tex</literal>):</paragraph><literal_block
xml:space="preserve">Terminal> doconce format latex
mydoc</literal_block><paragraph>LaTeX-specific commands
("newcommands") in math formulas and similar
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>-DDEVICE=paper</literal> makes some adjustments for documents
+so that your commands are defined.</paragraph><paragraph>An option
<literal>--device=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).
-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> 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>
doconce ptex2tex mydoc</literal_block><paragraph>Note that Doconce
generates a <literal>.p.tex</literal> file with some preprocessor macros
+The default, <literal>--device=screen</literal>, creates a PDF file for
reading
+on a screen where links are just
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> 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>
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> ptex2tex -DHELVETICA mydoc
@@ -864,7 +904,11 @@
before the address enclosed in double quotes:</paragraph><literal_block
xml:space="preserve">Click on this link:
URL:"http://code.google.com/p/doconce".</literal_block><paragraph>which
gets rendered as
Click on this link: <reference name="http://code.google.com/p/doconce"
refuri="http://code.google.com/p/doconce">http://code.google.com/p/doconce</reference><target
dupnames="http://code.google.com/p/doconce" ids="id5"
refuri="http://code.google.com/p/doconce"/>.</paragraph><paragraph>(There
is also support for lazy writing of URLs: any http or https web address
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.)</paragraph></section><section ids="links-to-local-files"
names="links\ to\ local\ files"><title>Links to Local
Files</title><paragraph>Links to files ending in <literal>.txt</literal>,
<literal>.html</literal>, <literal>.pdf</literal>, <literal>.py</literal>,
<literal>.f</literal>,
+mark (but not period!) becomes a link with the web address as link
text.)</paragraph></section><section ids="mail-addresses" names="mail\
addresses"><title>Mail Addresses</title><paragraph>Links that launches a
mail to a specified address is written as
+ordinary URLs, typically as:</paragraph><literal_block
xml:space="preserve">Send "mail": "mailto:h...@simula.no"
+# Alternative:
+to "`h...@simula.no`":
"mailto:h...@simula.no".</literal_block><paragraph>which appears
as Send <reference name="mail"
refuri="mailto:h...@simula.no">mail</reference><target ids="mail"
names="mail" refuri="mailto:h...@simula.no"/> to
+<reference name="h...@simula.no"
refuri="mailto:h...@simula.no">h...@simula.no</reference><target
ids="hpl-simula-no" names="h...@simula.no"
refuri="mailto:h...@simula.no"/>.</paragraph></section><section
ids="links-to-local-files" names="links\ to\ local\ files"><title>Links to
Local Files</title><paragraph>Links to files ending in
<literal>.txt</literal>, <literal>.html</literal>, <literal>.pdf</literal>,
<literal>.py</literal>, <literal>.f</literal>,
<literal>.f77</literal>, <literal>.f90</literal>, <literal>.f95</literal>,
<literal>.sh</literal>, <literal>.csh</literal>, <literal>.ksh</literal>,
<literal>.zsh</literal>,
<literal>.c</literal>, <literal>.cpp</literal>, <literal>.cxx</literal>,
<literal>.pl</literal>, and <literal>.java</literal> follows the same
setup:</paragraph><literal_block xml:space="preserve">see the
"Doconce Manual":
"manual.do.txt".</literal_block><paragraph>which appears as see
the <reference name="Doconce Manual" refuri="manual.do.txt">Doconce
Manual</reference><target ids="doconce-manual" names="doconce\ manual"
refuri="manual.do.txt"/>.
@@ -1500,7 +1544,7 @@
and <literal>--html_admon=apricot</literal>
works as the <literal>gray</literal> style, but the color is different.
With <literal>--html_admon=colors</literal> one gets quite bright colors
-as backgrounds for the different admonitions.</paragraph><paragraph>Some
recommended combinations for admonitions in HTML
are</paragraph><block_quote><bullet_list
bullet="*"><list_item><paragraph><literal>--html_admon=apricot</literal>,
<literal>--html_style=solarized</literal></paragraph></list_item><list_item><paragraph><literal>--html_admon=yellow</literal>,
<literal>--html_style=bluish2</literal>,
<literal>--no_pygments_html</literal></paragraph></list_item><list_item><paragraph><literal>--html_admon=yellow</literal>,
<literal>--html_style=blueish2</literal>,
<literal>--pygments_html_style=default</literal></paragraph></list_item><list_item><paragraph><literal>--html_admon=gray</literal>,
<literal>--html_style=bloodish</literal>,
<literal>--no_pygments_html</literal></paragraph></list_item><list_item><paragraph><literal>--html_admon=gray</literal>,
<literal>--html_style=bloodish</literal>,
<literal>--pygments_html_style=default</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=vagrant</literal>,
<literal>--pygments_html_style=default</literal>,
<literal>--html_template=...</literal></paragraph></list_item></bullet_list></block_quote><paragraph>The
<literal>vagrant</literal> HTML style has CSS files that override the
definition
+as backgrounds for the different admonitions.</paragraph><paragraph>Some
recommended combinations for admonitions in HTML
are</paragraph><block_quote><bullet_list
bullet="*"><list_item><paragraph><literal>--html_style=solarized</literal>,
<literal>--html_admon=apricot</literal>,
<literal>--pygments_html_style=perldoc</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=blueish2</literal>,
<literal>--html_admon=yellow</literal>,
<literal>--no_pygments_html</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=blueish2</literal>,
<literal>--html_admon=yellow</literal>,
<literal>--pygments_html_style=default</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=bloodish</literal>,
<literal>--html_admon=gray</literal>,
<literal>--no_pygments_html</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=bloodish</literal>,
<literal>--html_admon=gray</literal>,
<literal>--pygments_html_style=default</literal></paragraph></list_item><list_item><paragraph><literal>--html_style=vagrant</literal>,
<literal>--pygments_html_style=default</literal>,
<literal>--html_template=...</literal></paragraph></list_item></bullet_list></block_quote><paragraph>The
<literal>vagrant</literal> HTML style has CSS files that override the
definition
how the admons are typset. The <literal>notice</literal> environment is
gray with an
icon (defined in <literal>vagrant.css</literal>), while the others are
yellow (defined
in <literal>twitter_bootstrap.css</literal>). The
<literal>--html_admon</literal> color has no effect
@@ -1675,7 +1719,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="3586"
source="manual.rst" type="WARNING"><paragraph>Duplicate explicit target
name: "mako".</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="3655"
source="manual.rst" type="WARNING"><paragraph>Duplicate explicit target
name: "mako".</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
"filename"</literal>. Preprocess is also
sufficient for if-else tests to steer which parts of the text that
=======================================
--- /doc/demos/manual/manual_pdflatex.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/manual/manual_pdflatex.pdf Sat Aug 10 23:22:34 2013
File is too large to display a diff.
=======================================
--- /doc/demos/tutorial/html/_sources/tutorial.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/html/_sources/tutorial.txt Sat Aug 10 23:22:34 2013
@@ -6,7 +6,7 @@
========================================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -674,8 +674,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -815,6 +815,66 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+.. code-block:: text
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running
+
+
+.. code-block:: console
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -841,11 +901,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,
=======================================
--- /doc/demos/tutorial/html/searchindex.js Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/html/searchindex.js Sat Aug 10 23:22:34 2013
@@ -1,1 +1,1 @@
-Search.setIndex({objects:{},terms:{mydoc2:1,all:1,code:[0,1],partial:1,illustr:1,hint:1,linebreak:1,totem:1,fig2:1,fig3:1,html_output:1,fig1:1,makeidx:1,follow:1,colon:1,mwlib:1,row:1,footnot:1,depend:[0,1],unnumb:1,flask:1,impati:1,elsewher:1,readabl:1,specif:1,send:1,articl:1,ecollin:1,program:1,those:1,preprocess:[0,1],aris:1,texmf:1,fenics_minim:1,introduc:1,suitabl:1,"case":1,yourdoc:1,sourc:1,everi:1,ubuntu_vers:1,titlepag:1,wrapper_tech:1,none:1,util:1,verb:1,volum:1,texconv:1,miller_2000:1,veri:1,word:1,syntax:[0,1],relev:1,gwiki:1,pygments_html_lineno:1,recip:1,baselinestretch:1,nileshbans:1,button:1,relbarbgcolor:1,list:1,upload:1,ryan:1,"try":1,item:1,adjust:1,combine_imag:1,larg:1,team:1,quick:[0,1],sidebarlinkcolor:1,relsiz:1,larsen_et_al_2002:1,dir:1,dirnam:1,impli:1,johnson_friedman_2010a:1,monospac:1,subsubsect:1,dxelatex:1,natur:1,newcommands_replac:1,odt:1,direct:1,tex:1,video:1,pass:1,download:1,further:1,dmath:1,click:1,folk:1,blue:1,index:[0,1],what:[0,1],appear:1,compar:1,unfinish:1,section:[0,1],multimedia:1,netpbm:1,find:1,current:1,delet:1,extra_sect:1,version:1,theme_dir:1,remove_inline_com:1,mathjax:1,mydoc_vagr:1,net:1,deduc:1,xml:1,full:1,deriv:1,autogener:1,gener:[0,1],never:1,bibitem:1,here:1,html_fenic:1,bodi:1,modif:1,ubuntu:[0,1],spellcheck:1,along:1,vertic:1,modifi:1,sinc:1,valu:1,showthread:1,invis:1,search:0,evinc:1,convers:1,forum:1,rst2html:1,larger:1,step:1,ptex2tex:1,precis:1,loop:1,pick:1,action:1,chang:1,head:[0,1],wikibook:1,via:1,firefox:1,rightsidebar:1,extra:1,tweak:[0,1],modul:[0,1],"while":1,apt:1,filenam:1,unix:1,href:1,visibl:1,home:1,instal:[0,1],txt:1,shcod:1,post:[0,1],cloud:1,quickstart:1,dvipdf:1,tailor:1,from:[0,1],describ:1,would:1,doubl:1,helvetica:1,two:1,next:1,creol:1,few:1,doconc:[0,1],call:1,recommend:1,calc:1,type:1,dudt:1,more:1,sudo:1,desir:1,minim:1,pdfcrop:1,relat:1,footerbgcolor:1,dnote:1,newcommand:[0,1],warn:1,phone:1,flag:1,indic:0,examin:1,particular:1,automake_sphinx:1,shkumagai:1,must:1,blue_section_head:1,springer:1,dhelvetica:1,slogan:1,idx:1,setup:1,work:1,focu:1,other:[0,1],paragraph:1,obvious:1,can:[0,1],meet:1,purpos:1,root:1,scatter:1,def:1,control:1,encapsul:1,give:1,bloodish:1,slim:1,backslash:1,templat:1,dpalatino:1,topic:1,tag:1,doconce_install_al:1,want:1,tarbal:1,standard:1,ddevic:1,attract:1,occur:1,prece:1,mycommand:1,alwai:1,cours:1,end:1,straightforward:1,quot:1,recogni:1,anoth:1,ordinari:1,vagrant:1,length:1,openoffic:1,snippet:1,how:1,da6pap:1,subdirectori:1,answer:1,instead:1,veloc:1,parameter:1,sin:1,css:1,updat:1,agogo:1,yellowish:1,express:1,recogn:1,clone:1,after:1,variant:1,them:1,codetermin:1,befor:1,wrong:1,notebook:1,mai:1,multipl:1,underscor:1,associ:1,demonstr:1,man:1,basicstrap:1,drop:1,md2latex:1,footer:1,read:1,pdfnup:1,bootstrap:1,favorit:1,made:1,produc:1,myeq1:1,inform:1,"switch":1,movie_control:1,environ:1,epstopdf:1,allow:1,first:[0,1],egg:1,order:1,springer_collect:1,epydoc:1,dmint:1,elif:1,theme:1,help:1,portion:1,deck:1,over:1,move:1,html_admon:1,becaus:1,jpeg:1,apricot:1,guarante:1,paper:1,through:1,myfig:1,libav:1,still:1,vari:1,myfil:1,paramet:1,write:1,style:1,group:1,render:1,fit:1,latex_head:1,fix:1,ptext2tex:1,clickabl:1,better:1,carri:1,window:1,html:[0,1],fig:1,doconce_head:1,blogger:1,comprehens:1,html_style:1,might:1,easier:1,miiton:1,non:1,good:1,"return":1,pure:1,thei:1,handl:1,sentenc:1,sphinxfix_localurl:1,handi:1,initi:1,"break":1,mention:1,automat:1,own:1,resourc:1,petter:1,now:1,textopc:1,discuss:1,platform:1,introduct:1,choic:1,eventu:1,somewher:1,name:1,epsfig:1,edit:1,simpl:1,level:1,instruct:1,separ:1,easili:1,slide:1,ispel:1,fpro:1,found:1,difficult:1,pygment:1,compil:1,dir2:1,pdflatex:[0,1],maketitl:1,sidebarbgcolor:1,transform:1,citat:1,replac:1,individu:1,idea:1,procedur:1,realli:1,each:1,logg:1,"__hyperlink":1,backport:1,frac:1,happen:1,beyond:1,extract:1,special:1,out:1,variabl:1,reportlab:1,space:1,goe:1,publish:1,content:[0,1],texliv:1,preprocesor:1,sphinx_dir:1,lineno:1,rel:1,reader:1,print:1,formula:1,md2html:1,ref:1,correct:1,math:1,integr:1,insid:1,advanc:1,migrat:1,mkd:1,differ:[0,1],pub:1,parenthesi:1,standalon:1,doconce2format:1,base:1,put:1,org:1,bash:1,sampl:[0,1],indent:1,offic:1,could:1,pandoc:[0,1],movie15:1,keep:1,filter:1,thing:1,perhap:1,mako:1,fcod:1,principl:1,no_pygments_html:1,frequent:1,ubuntuforum:1,origin:1,softwar:1,rang:1,html_theme_opt:1,directli:1,feel:1,famou:1,misc:1,number:1,unovonv:1,bluish:1,texshop:1,date:1,lsb_releas:1,done:1,"long":1,open:1,predefin:1,fanci:1,size:1,mercuri:1,given:1,xunicod:1,script:1,cpp_an:1,interact:1,mkdir:1,system:1,least:1,latexdiff:1,master:1,too:1,accept:1,cfg:1,show:1,termin:1,conveni:1,cite:1,store:1,includ:[0,1],shell:1,includemedia:1,option:1,tool:1,copi:1,xkeyval:1,specifi:1,part:1,enclos:1,conserv:1,rst:1,than:1,png:1,just:1,past:1,ffmpeg:1,keyword:1,whenev:1,provid:1,remov:[0,1],onc:[0,1],see:1,charact:1,project:1,reus:1,sens:1,macro:[0,1],"5mm":1,design:1,admonit:1,sty:1,steer:1,seri:1,pre:1,unoconv:1,sai:1,yoursec:1,comput:[0,1],nicer:1,dvar1:1,pro:1,haiku:1,svnroot:1,ani:1,raw:1,pylon:1,have:1,tabl:[0,1],need:1,turn:1,mint:1,well:1,minted_cpp:1,built:1,checkout:1,latter:1,sandbox:1,note:[0,1],minted_python:1,ideal:1,exampl:1,take:1,which:1,combin:1,when:1,trail:1,mwiki:1,singl:1,simplifi:1,begin:1,sure:1,unless:1,distribut:1,normal:1,track:1,who:1,reach:1,toc:1,most:1,awl:1,mplayer:1,"20435c":1,mysec:1,epub:1,"_build":1,tradit:1,latex:[0,1],wish:1,renam:1,mytempl:1,url:1,doc:1,later:1,doe:[0,1],pipe:1,bracket:1,bibtex:1,place:1,determin:1,file1:1,occasion:1,usual:1,preambl:1,microsoft:1,smpeg:1,main_myproj:1,rtf:1,srclib:1,text:[0,1],scitool:1,pygments_html_styl:1,blognam:1,mediawiki:1,diffpdf:1,session:1,particularli:1,font:1,fine:1,anywai:1,auctex:1,slot:1,access:1,onli:1,textual:1,layout:1,titlesec:1,rst2xml:1,explain:1,movi:1,solut:1,written:1,should:1,configur:1,skip_inline_com:1,rich:1,filestem:1,smtplib:1,microtyp:1,local:1,mythem:1,devhelp:1,variou:1,get:1,convert:1,agni:1,stop:1,encourg:1,autom:1,cloud_spthem:1,cannot:1,ssh:1,"new":1,report:1,youtub:1,requir:1,mydoc_solar:1,perl:1,reveal:1,tikz:1,enabl:1,emb:1,cppcod:1,email:1,gif:1,grai:1,blogspot:1,common:1,contain:1,where:1,summari:1,wiki:[0,1],set:1,creator:1,googlecod:1,frame:1,pdftool:1,emac:1,sed:1,sec:1,result:1,close:1,best:1,flexibl:1,kei:1,xetex:1,someth:1,wikipedia:1,below:1,no_preprocess:1,figur:1,languag:1,between:1,"import":1,experi:1,inputenc:1,birkenfeld:1,wide:1,altern:1,accord:1,impressj:1,imagemagick:1,extend:1,numer:1,screen:1,javascript:1,extens:1,entir:1,html5:1,extent:1,trapezoid:1,ipython:1,roemer:1,come:1,basename_html_file_collect:1,addit:1,both:1,last:1,delimit:1,hyperlink:1,howev:1,nabla:1,equal:1,etc:1,instanc:1,equat:1,context:1,logic:1,makeindex:1,let:1,browser:1,whole:1,setspac:1,preprocessor:1,comment:[0,1],among:1,acceler:1,markdown:[0,1],simpli:1,point:1,color:1,pressbook:1,address:1,form:1,pop:1,distinguish:1,featur:[0,1],stylefil:1,littl:1,path:1,typic:1,ifthen:1,throughout:1,assum:1,duplic:1,quit:1,becom:1,mjpegtool:1,amsfont:1,union:1,nosidebar:1,three:1,blueish2:1,github:1,m2html:1,json:1,much:1,interest:1,thereaft:1,tug:1,quickli:1,encapusl:1,modern:1,hyperref:1,emphas:1,imag:1,remark:1,epytext:1,argument:1,media9:1,togeth:1,demand:1,graphicx:1,former:1,present:1,emploi:1,helvet:1,main:1,thesi:1,look:[0,1],packag:1,plain:[0,1],servic:1,properti:1,sourceforg:1,aim:1,defin:1,invok:1,abrupt:1,abov:1,aid:1,ppa:1,dextra_sect:1,region:1,vlinux:1,pack:1,subsect:[0,1],css3:1,pyramid:1,advantag:1,almost:1,demo:[0,1],docx:1,a6pap:1,archiv:1,inlin:[0,1],conf:1,mwk:1,var1:1,revis:1,mani:1,ascii:[0,1],curl:1,sever:1,pdftk:1,decor:1,anslist:1,fignam:1,author:1,perform:1,make:1,format:[0,1],satisfi:1,cross:[0,1],same:1,python:1,html_pyramid:1,tutori:1,split:1,backslah:1,mydoc:1,texinfo:1,document:[0,1],start:1,file3:1,complet:1,a2p:1,http:1,denot:1,assist:1,effect:1,a4pap:1,capabl:1,redcloud:1,user:1,pdf:1,extern:1,php:1,cwiki:1,tune:1,recent:1,appropri:1,off:1,openofficeword:1,choos:1,com:1,caption:1,itself:1,difflib:1,python_an:1,without:1,command:1,thi:1,endif:1,undefin:1,everyth:1,moreov:1,giftran:1,left:1,load:1,construct:1,execut:1,mydoc_bloodish:1,obtain:1,rest:1,pygments_html:1,align:1,tcl:1,xelatex:[0,1],human:1,ifdef:1,cod:1,kdiff3:1,yet:1,fenic:1,web:1,langtangen:1,easi:1,also:1,restructuredtext:[0,1],makefil:[0,1],except:1,shortcut:1,blog:[0,1],fortran:1,add:1,book:1,bibliographi:[0,1],treatment:1,exercis:1,appli:1,cp2texmf:1,save:1,vimeo:1,real:1,inspir:1,around:1,mayb:1,mynot:1,shoutwiki:1,boldfac:1,dark:1,realiz:1,know:1,background:1,denser:1,world:1,shadow:1,wrapfig:1,linux:1,insert:1,like:[0,1],success:1,header:1,cdot:1,docutil:1,xxdiff:1,manual:1,collect:1,necessari:1,either:1,"_static":1,popular:1,pycod:1,dlatex_head:1,page:[0,1],wdiff:1,old:1,often:1,html_theme:1,some:[0,1],back:1,meld:1,understood:1,python_anst:1,enumer:1,scipy_lectur:1,respect:1,proper:1,small:1,successfulli:1,constitut:1,rst2latex:1,diff:1,mdframe:1,montag:1,avoid:1,though:1,definit:1,ddt:1,pdiff:1,substitut:1,mathemat:[0,1],exit:1,prog:1,speak:1,studi:1,trunk:1,refer:[0,1],process:1,jal:1,run:1,ooxml:1,view:1,usag:1,fancyvrb:1,host:1,encourav:1,repositori:1,output:[0,1],qthelp:1,major:1,inclus:1,simpler:1,chapter:1,about:1,conv:1,linenumb:1,materi:1,label:1,surround:1,split_html:1,regular:1,stand:1,act:1,fals:1,mean:1,disabl:1,block:1,dtodonot:1,libreoffic:1,file2:1,"_boldface_":1,mac:1,effici:1,"final":1,amsmath:1,includemovi:1,basenam:1,profession:1,dir1:1,terminolog:1,right:1,subvers:1,your:1,websit:1,accordingli:1,git:1,institut:1,f2f2f2:1,wai:1,pictur:1,style_vagr:1,support:1,question:1,stylesheet:1,haskel:1,custom:1,avail:1,width:1,subst:1,rst2odt:1,editor:1,strong:1,suit:1,palatino:1,stage:1,"function":1,myfunc:1,creation:1,sphinxdir:1,verbatim:1,offer:1,bundl:1,basic:[0,1],jul:1,corss:1,navig:1,diffus:1,link:1,translat:1,solar:1,todonot:1,line:1,blueish:1,"true":1,bug:1,untag:1,longer:1,suppli:1,pull:1,perldoc:1,latex_preambl:1,wise:1,input:1,han:1,possibl:1,"default":1,plaympeg:1,smooth:1,displai:1,envir:1,directori:1,someus:1,limit:1,site:1,otherwis:1,problem:1,strategi:1,similar:1,xcolor:1,creat:1,classic:1,certain:1,"abstract":1,toctre:1,uio:1,repres:1,strongli:1,postscript:1,implement:1,file:1,our:1,pip:1,exist:1,typeset:1,sphinxjp:1,check:1,again:1,subexercis:1,googl:1,tkdiff:1,titl:1,documentclass:1,detail:1,invalid:1,bibfil:1,valid:1,futur:1,rememb:1,varieti:1,test:1,you:1,newcommands_keep:1,fontspec:1,nice:1,suppert:1,area:1,clean:1,mathpazo:1,fulli:1,symbol:1,asterisk:1,shown:1,colored_table_row:1,idl:1,no_mako:1,embed:1,sidebartextcolor:1,hpl:1,debian:[0,1],wordpress:1,svn:1,bitbucket:1,sphinx:[0,1],eof:1,bullet:1,scientif:1,anywher:[0,1],lot:1,rst2pdf:1,rootdir:1,html_templat:1,depth:1,ignor:1,maxdepth:1,potenti:1,time:1,far:1,escap:1,beamer:1,my_adapted_vagrant_templ:1},objtypes:{},titles:["Doconce:
Document
Once, Include Anywhere","Doconce: Document Once, Include
Anywhere"],objnames:{},filenames:["index","tutorial"]})
+Search.setIndex({objects:{},terms:{mydoc2:1,all:1,code:[0,1],partial:1,illustr:1,hint:1,linebreak:1,totem:1,var1:1,fig2:1,fig3:1,html_output:1,fig1:1,makeidx:1,follow:1,colon:1,mwlib:1,row:1,footnot:1,depend:[0,1],unnumb:1,aug:1,flask:1,impati:1,elsewher:1,readabl:1,specif:1,send:1,articl:1,ecollin:1,program:1,those:1,preview:1,preprocess:[0,1],aris:1,texmf:1,fenics_minim:1,introduc:1,suitabl:1,"case":1,yourdoc:1,sourc:1,everi:1,titlepag:1,wrapper_tech:1,none:1,util:1,verb:1,volum:1,texconv:1,miller_2000:1,veri:1,word:1,syntax:[0,1],relev:1,gwiki:1,pygments_html_lineno:1,recip:1,baselinestretch:1,nileshbans:1,button:1,relbarbgcolor:1,list:1,upload:1,ryan:1,"try":1,item:1,adjust:1,combine_imag:1,larg:1,team:1,quick:[0,1],sidebarlinkcolor:1,relsiz:1,larsen_et_al_2002:1,dir:1,dirnam:1,impli:1,johnson_friedman_2010a:1,monospac:1,subsubsect:1,dxelatex:1,natur:1,newcommands_replac:1,odt:1,direct:1,tex:1,video:1,pass:1,download:1,further:1,dmath:1,click:1,folk:1,blue:1,index:[0,1],what:[0,1],appear:1,compar:1,unfinish:1,section:[0,1],multimedia:1,netpbm:1,find:1,current:1,delet:1,extra_sect:1,version:1,theme_dir:1,remove_inline_com:1,mathjax:1,mydoc_vagr:1,net:1,deduc:1,xml:1,full:1,deriv:1,autogener:1,gener:[0,1],never:1,coeffici:1,bibitem:1,here:1,html_fenic:1,bodi:1,modif:1,ubuntu:[0,1],spellcheck:1,along:1,vertic:1,modifi:1,sinc:1,valu:1,showthread:1,invis:1,search:0,evinc:1,convers:1,forum:1,rst2html:1,larger:1,step:1,ptex2tex:1,precis:1,loop:1,pick:1,action:1,chang:1,head:[0,1],wikibook:1,via:1,firefox:1,rightsidebar:1,extra:1,tweak:[0,1],modul:[0,1],"while":1,apt:1,filenam:1,unix:1,href:1,visibl:1,home:1,instal:[0,1],txt:1,shcod:1,post:[0,1],cloud:1,quickstart:1,dvipdf:1,tailor:1,from:[0,1],describ:1,would:1,doubl:1,helvetica:1,two:1,next:1,creol:1,few:1,doconc:[0,1],call:1,recommend:1,calc:1,type:1,dudt:1,more:1,almost:1,slim:1,desir:1,minim:1,pdfcrop:1,relat:1,footerbgcolor:1,dnote:1,newcommand:[0,1],warn:1,phone:1,flag:1,indic:[0,1],examin:1,particular:1,automake_sphinx:1,shkumagai:1,must:1,blue_section_head:1,springer:1,dhelvetica:1,slogan:1,idx:1,setup:1,work:1,focu:1,other:[0,1],remain:1,paragraph:1,obvious:1,can:[0,1],meet:1,purpos:1,root:1,scatter:1,def:1,control:1,encapsul:1,give:1,bloodish:1,gif:1,backslash:1,templat:1,dpalatino:1,topic:1,tag:1,doconce_install_al:1,want:1,tarbal:1,denot:1,standard:1,made:1,attract:1,occur:1,prece:1,mycommand:1,alwai:1,cours:1,end:1,straightforward:1,quot:1,recogni:1,anoth:1,ordinari:1,vagrant:1,length:1,snippet:1,how:1,da6pap:1,subdirectori:1,answer:1,instead:1,veloc:1,parameter:1,sin:1,css:1,updat:1,agogo:1,yellowish:1,corss:1,express:1,recogn:1,clone:1,after:1,variant:1,openoffic:1,codetermin:1,befor:1,wrong:1,notebook:1,mai:1,multipl:1,underscor:1,associ:1,demonstr:1,man:1,basicstrap:1,drop:1,md2latex:1,footer:1,read:1,pdfnup:1,bootstrap:1,favorit:1,produc:1,myeq1:1,inform:1,"switch":1,movie_control:1,environ:1,epstopdf:1,allow:1,first:[0,1],egg:1,order:1,springer_collect:1,epydoc:1,dmint:1,elif:1,theme:1,help:1,portion:1,deck:1,over:1,move:1,html_admon:1,becaus:1,jpeg:1,apricot:1,guarante:1,paper:1,through:1,myfig:1,libav:1,still:1,vari:1,myfil:1,paramet:1,write:1,style:1,group:1,render:1,fit:1,latex_head:1,fix:1,ptext2tex:1,clickabl:1,better:1,carri:1,window:1,html:[0,1],fig:1,doconce_head:1,blogger:1,comprehens:1,html_style:1,might:1,easier:1,miiton:1,docx:1,good:1,"return":1,pure:1,thei:1,handl:1,sentenc:1,sphinxfix_localurl:1,handi:1,initi:1,"break":1,mention:1,automat:1,own:1,resourc:1,petter:1,now:1,textopc:1,discuss:1,platform:1,introduct:1,choic:1,eventu:1,somewher:1,name:1,epsfig:1,edit:1,simpl:1,level:1,instruct:1,separ:1,easili:1,slide:1,trapezoid:1,ispel:1,fpro:1,found:1,difficult:1,pygment:1,compil:1,dir2:1,pdflatex:[0,1],maketitl:1,sidebarbgcolor:1,transform:1,citat:1,dialect:1,replac:1,individu:1,gaussian:1,procedur:1,realli:1,each:1,logg:1,"__hyperlink":1,backport:1,frac:1,happen:1,beyond:1,extract:1,special:1,out:1,variabl:1,reportlab:1,space:1,goe:1,publish:1,content:[0,1],texliv:1,preprocesor:1,sphinx_dir:1,lineno:1,rel:1,reader:1,print:1,formula:1,md2html:1,ref:1,correct:1,math:1,integr:1,heavisid:1,insid:1,advanc:1,migrat:1,mkd:1,differ:[0,1],pub:1,parenthesi:1,standalon:1,doconce2format:1,base:1,put:1,org:1,bash:1,sampl:[0,1],indent:1,offic:1,could:1,pandoc:[0,1],movie15:1,keep:1,filter:1,thing:1,perhap:1,mako:1,fcod:1,principl:1,no_pygments_html:1,frequent:1,ubuntuforum:1,origin:1,softwar:1,rang:1,html_theme_opt:1,directli:1,feel:1,famou:1,sudo:1,misc:1,number:1,unovonv:1,bluish:1,texshop:1,date:1,lsb_releas:1,done:1,"long":1,open:1,predefin:1,fanci:1,size:1,mercuri:1,given:1,xunicod:1,script:1,cpp_an:1,interact:1,mkdir:1,system:1,least:1,latexdiff:1,master:1,too:1,accept:1,cfg:1,show:1,termin:1,conveni:1,cite:1,store:1,includ:[0,1],shell:1,includemedia:1,option:1,tool:1,copi:1,xkeyval:1,specifi:1,part:1,enclos:1,conserv:1,rst:1,than:1,png:1,just:1,past:1,ffmpeg:1,keyword:1,whenev:1,provid:1,remov:[0,1],onc:[0,1],see:1,charact:1,project:1,reus:1,sens:1,macro:[0,1],"5mm":1,design:1,admonit:1,sty:1,steer:1,seri:1,pre:1,unoconv:1,sai:1,yoursec:1,comput:[0,1],nicer:1,mwiki:1,pro:1,haiku:1,svnroot:1,ani:1,raw:1,pylon:1,have:1,tabl:[0,1],need:1,turn:1,mint:1,well:1,guthub:1,issu:1,minted_cpp:1,built:1,checkout:1,latter:1,sandbox:1,note:[0,1],minted_python:1,ideal:1,exampl:1,take:1,which:1,combin:1,when:1,trail:1,noth:1,singl:1,simplifi:1,begin:1,sure:1,unless:1,distribut:1,normal:1,track:1,who:1,reach:1,toc:1,most:1,awl:1,mplayer:1,"20435c":1,mysec:1,epub:1,"_build":1,tradit:1,latex:[0,1],wish:1,renam:1,mytempl:1,url:1,doc:1,later:1,doe:[0,1],pipe:1,bracket:1,bibtex:1,place:1,determin:1,file1:1,ubuntu_vers:1,usual:1,preambl:1,microsoft:1,smpeg:1,main_myproj:1,rtf:1,srclib:1,text:[0,1],scitool:1,pygments_html_styl:1,blognam:1,mediawiki:1,diffpdf:1,session:1,particularli:1,font:1,fine:1,anywai:1,auctex:1,slot:1,access:1,onli:1,textual:1,layout:1,titlesec:1,rst2xml:1,explain:1,movi:1,solut:1,written:1,should:1,configur:1,skip_inline_com:1,rich:1,filestem:1,smtplib:1,microtyp:1,local:1,mythem:1,devhelp:1,variou:1,get:1,convert:1,agni:1,stop:1,encourg:1,autom:1,cloud_spthem:1,cannot:1,ssh:1,"new":1,report:1,youtub:1,requir:1,mydoc_solar:1,perl:1,reveal:1,tikz:1,enabl:1,emb:1,cppcod:1,mwk:1,state:1,email:1,grai:1,blogspot:1,common:1,contain:1,where:1,summari:1,wiki:[0,1],set:1,creator:1,googlecod:1,frame:1,pdftool:1,emac:1,sed:1,sec:1,result:1,close:1,best:1,flexibl:1,kei:1,xetex:1,someth:1,wikipedia:1,below:1,no_preprocess:1,figur:1,languag:1,between:1,"import":1,experi:1,inputenc:1,birkenfeld:1,wide:1,altern:1,accord:1,impressj:1,imagemagick:1,extend:1,numer:1,screen:1,javascript:1,bquot:1,extens:1,entir:1,html5:1,extent:1,highlight:1,ipython:1,roemer:1,github_md:1,come:1,basename_html_file_collect:1,addit:1,both:1,last:1,delimit:1,hyperlink:1,howev:1,nabla:1,equal:1,thereaft:1,etc:1,instanc:1,equat:1,context:1,logic:1,makeindex:1,let:1,browser:1,whole:1,setspac:1,preprocessor:1,comment:[0,1],among:1,acceler:1,markdown:[0,1],simpli:1,pycod:1,point:1,color:1,pressbook:1,address:1,form:1,pop:1,distinguish:1,featur:[0,1],non:1,littl:1,path:1,typic:1,ifthen:1,throughout:1,assum:1,duplic:1,quit:1,becom:1,mjpegtool:1,amsfont:1,union:1,nosidebar:1,devic:1,three:1,blueish2:1,github:1,m2html:1,json:1,much:1,interest:1,dvar1:1,futur:1,tug:1,quickli:1,encapusl:1,modern:1,hyperref:1,emphas:1,imag:1,remark:1,epytext:1,argument:1,media9:1,togeth:1,demand:1,graphicx:1,former:1,present:1,emploi:1,helvet:1,main:1,thesi:1,look:[0,1],packag:1,plain:[0,1],servic:1,properti:1,sourceforg:1,aim:1,defin:1,invok:1,abrupt:1,abov:1,aid:1,ppa:1,dextra_sect:1,region:1,vlinux:1,pack:1,subsect:[0,1],css3:1,pyramid:1,advantag:1,readi:1,demo:[0,1],them:1,a6pap:1,archiv:1,inlin:[0,1],conf:1,equot:1,quadrat:1,revis:1,mani:1,ascii:[0,1],curl:1,sever:1,pdftk:1,decor:1,anslist:1,fignam:1,author:1,perform:1,make:1,format:[0,1],satisfi:1,cross:[0,1],same:1,python:1,html_pyramid:1,tutori:1,split:1,backslah:1,mydoc:1,texinfo:1,document:[0,1],start:1,file3:1,complet:1,a2p:1,http:1,cubic:1,assist:1,effect:1,a4pap:1,capabl:1,redcloud:1,user:1,pdf:1,extern:1,php:1,cwiki:1,tune:1,recent:1,task:1,off:1,openofficeword:1,choos:1,com:1,caption:1,itself:1,difflib:1,python_an:1,without:1,command:1,thi:1,endif:1,undefin:1,everyth:1,moreov:1,giftran:1,left:1,load:1,construct:1,execut:1,mydoc_bloodish:1,obtain:1,rest:1,align:1,tcl:1,xelatex:[0,1],human:1,ifdef:1,cod:1,flavor:1,kdiff3:1,yet:1,fenic:1,web:1,langtangen:1,easi:1,also:1,restructuredtext:[0,1],makefil:[0,1],except:1,shortcut:1,blog:[0,1],fortran:1,add:1,book:1,bibliographi:[0,1],treatment:1,exercis:1,appli:1,cp2texmf:1,save:1,vimeo:1,real:1,inspir:1,around:1,mayb:1,mynot:1,shoutwiki:1,boldfac:1,dark:1,realiz:1,know:1,background:1,denser:1,world:1,shadow:1,wrapfig:1,linux:1,insert:1,like:[0,1],success:1,header:1,cdot:1,docutil:1,xxdiff:1,manual:1,collect:1,necessari:1,either:1,"_static":1,popular:1,stylefil:1,dlatex_head:1,page:[0,1],wdiff:1,old:1,often:1,html_theme:1,some:[0,1],back:1,meld:1,understood:1,python_anst:1,enumer:1,scipy_lectur:1,respect:1,proper:1,small:1,successfulli:1,constitut:1,rst2latex:1,diff:1,mdframe:1,montag:1,avoid:1,though:1,definit:1,ddt:1,pdiff:1,substitut:1,tracker:1,exit:1,prog:1,speak:1,studi:1,trunk:1,refer:[0,1],process:1,jal:1,run:1,ooxml:1,view:1,usag:1,fancyvrb:1,host:1,encourav:1,repositori:1,output:[0,1],qthelp:1,major:1,inclus:1,simpler:1,chapter:1,about:1,conv:1,linenumb:1,materi:1,label:1,surround:1,split_html:1,regular:1,stand:1,act:1,fals:1,mean:1,disabl:1,block:1,dtodonot:1,libreoffic:1,file2:1,"_boldface_":1,mac:1,effici:1,"final":1,amsmath:1,includemovi:1,basenam:1,profession:1,dir1:1,terminolog:1,appropri:1,right:1,subvers:1,your:1,websit:1,accordingli:1,git:1,institut:1,f2f2f2:1,wai:1,pictur:1,style_vagr:1,support:1,question:1,stylesheet:1,haskel:1,custom:1,avail:1,width:1,subst:1,rst2odt:1,editor:1,strong:1,suit:1,palatino:1,hpl:1,stage:1,"function":1,myfunc:1,creation:1,mycom:1,sphinxdir:1,verbatim:1,offer:1,bundl:1,basic:[0,1],idea:1,navig:1,diffus:1,link:1,translat:1,solar:1,todonot:1,line:1,blueish:1,"true":1,bug:1,untag:1,longer:1,suppli:1,pull:1,perldoc:1,latex_preambl:1,wise:1,input:1,han:1,possibl:1,"default":1,plaympeg:1,smooth:1,displai:1,envir:1,directori:1,someus:1,limit:1,site:1,otherwis:1,problem:1,strategi:1,similar:1,xcolor:1,creat:1,classic:1,certain:1,"abstract":1,toctre:1,uio:1,repres:1,strongli:1,postscript:1,implement:1,file:1,our:1,pip:1,exist:1,typeset:1,sphinxjp:1,check:1,again:1,subexercis:1,googl:1,tkdiff:1,titl:1,documentclass:1,detail:1,invalid:1,field:1,bibfil:1,valid:1,mathemat:[0,1],rememb:1,varieti:1,test:1,you:1,newcommands_keep:1,fontspec:1,nice:1,suppert:1,area:1,clean:1,mathpazo:1,fulli:1,symbol:1,asterisk:1,shown:1,colored_table_row:1,idl:1,no_mako:1,embed:1,sidebartextcolor:1,occasion:1,debian:[0,1],wordpress:1,svn:1,bitbucket:1,sphinx:[0,1],eof:1,bullet:1,scientif:1,anywher:[0,1],lot:1,rst2pdf:1,rootdir:1,html_templat:1,depth:1,ignor:1,maxdepth:1,potenti:1,time:1,far:1,escap:1,beamer:1,my_adapted_vagrant_templ:1},objtypes:{},titles:["Doconce:
Document
Once, Include Anywhere","Doconce: Document Once, Include
Anywhere"],objnames:{},filenames:["index","tutorial"]})
=======================================
--- /doc/demos/tutorial/html/tutorial.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/html/tutorial.html Sat Aug 10 23:22:34 2013
@@ -57,7 +57,7 @@
<tr class="field-odd field"><th class="field-name">Author:</th><td
class="field-body"><p class="first">Hans Petter Langtangen</p>
</td>
</tr>
-<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body"><p class="first">Jul 13, 2013</p>
+<tr class="field-even field"><th class="field-name">Date:</th><td
class="field-body"><p class="first">Aug 11, 2013</p>
<ul class="last simple">
<li>When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -618,8 +618,8 @@
<span class="go"> --html_output=mydoc_bloodish</span>
<span class="go">Terminal> doconce split_html mydoc_bloodish.html</span>
<span class="go">Terminal> 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"> --html_output=mydoc_solarized \</span>
+<span class="go"> --pygments_html_style=perldoc
--html_admon=apricot</span>
<span class="go">Terminal> 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>
@@ -736,6 +736,58 @@
</div>
<p>The <tt class="docutils literal"><span class="pre">-s</span></tt>
option adds a proper header and footer to the <tt class="docutils
literal"><span class="pre">mydoc.html</span></tt> file.
This recipe is a quick way of makeing HTML notes with (some)
mathematics.</p>
+<div class="section" id="github-flavored-markdown">
+<h3>GitHub-flavored Markdown<a class="headerlink"
href="#github-flavored-markdown" title="Permalink to this
headline">¶</a></h3>
+<p>Adding the command-line option <tt class="docutils literal"><span
class="pre">github-md</span></tt> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
class="reference external" href="http://github.com">GitHub</a>. A special
feature is the support of task lists:
+unnumbered lists with <tt class="docutils literal"><span
class="pre">[x]</span></tt> (task done) or <tt class="docutils
literal"><span class="pre">[</span> <span class="pre">]</span></tt> (task
not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:</p>
+<div class="highlight-text"><div class="highlight"><pre>!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</pre></div>
+</div>
+<p>Say this text is stored in a file <tt class="docutils literal"><span
class="pre">mycomments.do.txt</span></tt>. Running</p>
+<div class="highlight-console"><div class="highlight"><pre><span
class="go">Terminal> doconce format pandoc mycomments --github_md</span>
+</pre></div>
+</div>
+<p>produces <tt class="docutils literal"><span
class="pre">mycomments.md</span></tt> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</p>
+</div>
</div>
<div class="section" id="id4">
<h2>LaTeX<a class="headerlink" href="#id4" title="Permalink to this
headline">¶</a></h2>
@@ -750,11 +802,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),
Cross-References, Index, and Bibliography</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">-DDEVICE=paper</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">--device=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).
-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>
+The default, <tt class="docutils literal"><span
class="pre">--device=screen</span></tt>, creates a PDF file for reading
+on a screen where links are just 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> ptex2tex mydoc</span>
</pre></div>
@@ -1719,7 +1771,10 @@
</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="#pandoc-and-markdown">Pandoc and
Markdown</a><ul>
+<li><a class="reference internal"
href="#github-flavored-markdown">GitHub-flavored Markdown</a></li>
+</ul>
+</li>
<li><a class="reference internal" href="#id4">LaTeX</a></li>
<li><a class="reference internal" href="#pdflatex">PDFLaTeX</a></li>
<li><a class="reference internal" href="#xelatex">XeLaTeX</a></li>
=======================================
--- /doc/demos/tutorial/tutorial.cwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.cwiki Sat Aug 10 23:22:34 2013
@@ -2,7 +2,7 @@
#summary Doconce: Document Once, Include Anywhere
<wiki:toc max_depth="2" />
By **Hans Petter Langtangen**
-=== Jul 13, 2013 ===
+=== Aug 11, 2013 ===
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML, reStructuredText,
Sphinx, XML, etc. Would it be convenient to start with some very simple
text-like format that easily converts to the formats listed above, and
then at some later stage eventually go with a particular format?
* Do you need to write documents in varying formats but find it
difficult to remember all the typesetting details of various formats like
[[http://refcards.com/docs/silvermanj/amslatex/LaTeXRefCard.v2.0.pdf|
LaTeX]], [[http://www.htmlcodetutorial.com/|HTML]],
[[http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html|
reStructuredText]], [[http://sphinx.pocoo.org/contents.html|Sphinx]], and
[[http://code.google.com/p/support/wiki/WikiSyntax|wiki]]? Would it be
convenient to generate the typesetting details of a particular format
from a very simple text-like format with minimal tagging?
@@ -526,8 +526,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -647,6 +647,60 @@
The {{{-s}}} option adds a proper header and footer to the
{{{mydoc.html}}} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+=== GitHub-flavored Markdown ===
+
+Adding the command-line option {{{github-md}}} turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[[http://github.com|GitHub]]. A special feature is the support of task
lists:
+unnumbered lists with {{{[x]}}} (task done) or {{{[ ]}}} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+{{{
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+}}}
+Say this text is stored in a file {{{mycomments.do.txt}}}. Running
+
+{{{
+Terminal> doconce format pandoc mycomments --github_md
+}}}
+produces {{{mycomments.md}}} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
== LaTeX ==
@@ -666,11 +720,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option {{{-DDEVICE=paper}}} makes some adjustments for documents
+An option {{{--device=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.
+The default, {{{--device=screen}}}, creates a PDF file for reading
+on a screen where links are just clickable.
//Step 2.// Run {{{ptex2tex}}} (if you have it) to make a standard LaTeX
file,
{{{
=======================================
--- /doc/demos/tutorial/tutorial.epytext Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.epytext Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
TITLE: Doconce: Document Once, Include Anywhere
BY: Hans Petter Langtangen (Center for Biomedical Computing, Simula
Research Laboratory, and Department of Informatics, University of Oslo)
-DATE: Jul 13, 2013
+DATE: Aug 11, 2013
- When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML,
@@ -588,8 +588,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -716,6 +716,61 @@
The C{-s} option adds a proper header and footer to the C{mydoc.html} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option C{github-md} turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
U{GitHub<http://github.com>}. A special feature is the support of task
lists:
+unnumbered lists with C{[x]} (task done) or C{[ ]} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file C{mycomments.do.txt}. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces C{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -734,11 +789,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option C{-DDEVICE=paper} makes some adjustments for documents
+An option C{--device=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.
+The default, C{--device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
I{Step 2.} Run C{ptex2tex} (if you have it) to make a standard LaTeX file::
=======================================
--- /doc/demos/tutorial/tutorial.gwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.gwiki Sat Aug 10 23:22:34 2013
@@ -2,7 +2,7 @@
#summary Doconce: Document Once, Include Anywhere
By *Hans Petter Langtangen*
-==== Jul 13, 2013 ====
+==== Aug 11, 2013 ====
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML, reStructuredText,
Sphinx, XML, etc. Would it be convenient to start with some very simple
text-like format that easily converts to the formats listed above, and
then at some later stage eventually go with a particular format?
* Do you need to write documents in varying formats but find it
difficult to remember all the typesetting details of various formats like
[http://refcards.com/docs/silvermanj/amslatex/LaTeXRefCard.v2.0.pdf LaTeX],
[http://www.htmlcodetutorial.com/ HTML],
[http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
reStructuredText], [http://sphinx.pocoo.org/contents.html Sphinx], and
[http://code.google.com/p/support/wiki/WikiSyntax wiki]? Would it be
convenient to generate the typesetting details of a particular format
from a very simple text-like format with minimal tagging?
@@ -524,8 +524,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -645,6 +645,60 @@
The `-s` option adds a proper header and footer to the `mydoc.html` file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+==== GitHub-flavored Markdown ====
+
+Adding the command-line option `github-md` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[http://github.com GitHub]. A special feature is the support of task lists:
+unnumbered lists with `[x]` (task done) or `[ ]` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+{{{
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+}}}
+Say this text is stored in a file `mycomments.do.txt`. Running
+
+{{{
+Terminal> doconce format pandoc mycomments --github_md
+}}}
+produces `mycomments.md` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
==== LaTeX ====
@@ -664,11 +718,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,
{{{
=======================================
--- /doc/demos/tutorial/tutorial.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.html Sat Aug 10 23:22:34 2013
@@ -96,34 +96,35 @@
(' Filenames ', 3, None, '___sec20'),
(' Blog Posts ', 2, None, '___sec21'),
(' Pandoc and Markdown ', 2, None, '___sec22'),
- (' LaTeX ', 2, None, '___sec23'),
- (' PDFLaTeX ', 2, None, '___sec24'),
- (' XeLaTeX ', 2, None, '___sec25'),
- (' Plain ASCII Text ', 2, None, '___sec26'),
- (' reStructuredText ', 2, None, '___sec27'),
- (' Sphinx ', 2, None, '___sec28'),
- (' The manual Sphinx procedure ', 3, None, '___sec29'),
- (' Wiki Formats ', 2, None, '___sec30'),
- (' Tweaking the Doconce Output ', 2, None, '___sec31'),
- (' Demos ', 2, None, '___sec32'),
+ (' GitHub-flavored Markdown ', 3, None, '___sec23'),
+ (' LaTeX ', 2, None, '___sec24'),
+ (' PDFLaTeX ', 2, None, '___sec25'),
+ (' XeLaTeX ', 2, None, '___sec26'),
+ (' Plain ASCII Text ', 2, None, '___sec27'),
+ (' reStructuredText ', 2, None, '___sec28'),
+ (' Sphinx ', 2, None, '___sec29'),
+ (' The manual Sphinx procedure ', 3, None, '___sec30'),
+ (' Wiki Formats ', 2, None, '___sec31'),
+ (' Tweaking the Doconce Output ', 2, None, '___sec32'),
+ (' Demos ', 2, None, '___sec33'),
(' Installation of Doconce and its Dependencies ',
1,
None,
- '___sec33'),
- (' Doconce ', 2, None, '___sec34'),
- (' Dependencies ', 2, None, '___sec35'),
- (' Preprocessors ', 3, None, '___sec36'),
- (' Image file handling ', 3, None, '___sec37'),
- (' Spellcheck ', 3, None, '___sec38'),
- (' Bibliography ', 3, None, '___sec39'),
- (' Ptex2tex for LaTeX Output ', 3, None, '___sec40'),
- (' LaTeX packages ', 3, None, '___sec41'),
- (' reStructuredText (reST) Output ', 3, None, '___sec42'),
- (' Sphinx Output ', 3, None, '___sec43'),
- (' Markdown and Pandoc Output ', 3, None, '___sec44'),
- (' Epydoc Output ', 3, None, '___sec45'),
- (' The `doconce diff` command ', 3, None, '___sec46'),
- (' Quick Debian/Ubuntu Install ', 2, None, '___sec47')]}
+ '___sec34'),
+ (' Doconce ', 2, None, '___sec35'),
+ (' Dependencies ', 2, None, '___sec36'),
+ (' Preprocessors ', 3, None, '___sec37'),
+ (' Image file handling ', 3, None, '___sec38'),
+ (' Spellcheck ', 3, None, '___sec39'),
+ (' Bibliography ', 3, None, '___sec40'),
+ (' Ptex2tex for LaTeX Output ', 3, None, '___sec41'),
+ (' LaTeX packages ', 3, None, '___sec42'),
+ (' reStructuredText (reST) Output ', 3, None, '___sec43'),
+ (' Sphinx Output ', 3, None, '___sec44'),
+ (' Markdown and Pandoc Output ', 3, None, '___sec45'),
+ (' Epydoc Output ', 3, None, '___sec46'),
+ (' The `doconce diff` command ', 3, None, '___sec47'),
+ (' Quick Debian/Ubuntu Install ', 2, None, '___sec48')]}
end of tocinfo -->
<body>
@@ -171,7 +172,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>Jul 13, 2013</h4></center> <!-- date -->
+<center><h4>Aug 11, 2013</h4></center> <!-- date -->
<p>
<ul>
@@ -808,8 +809,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -954,7 +955,66 @@
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="___sec23"></a></h3>
+<h4>GitHub-flavored Markdown <a name="___sec23"></a></h4>
+
+<p>
+Adding the command-line option <code>github-md</code> turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
href="http://github.com">GitHub</a>. A special feature is the support of
task lists:
+unnumbered lists with <code>[x]</code> (task done) or <code>[ ]</code>
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+<p>
+<!-- begin verbatim block -->
+<pre><code>!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</code></pre>
+<!-- end verbatim block -->
+Say this text is stored in a file <code>mycomments.do.txt</code>. Running
+
+<p>
+<!-- begin verbatim block sys-->
+<pre><code>Terminal> doconce format pandoc mycomments --github_md
+</code></pre>
+<!-- end verbatim block -->
+produces <code>mycomments.md</code> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
+<h3>LaTeX <a name="___sec24"></a></h3>
<p>
Making a LaTeX file <code>mydoc.tex</code> from <code>mydoc.do.txt</code>
is done in two steps:
@@ -977,11 +1037,11 @@
so that your commands are defined.
<p>
-An option <code>-DDEVICE=paper</code> makes some adjustments for documents
+An option <code>--device=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.
+The default, <code>--device=screen</code>, creates a PDF file for reading
+on a screen where links are just clickable.
<p>
<b>Step 2.</b>
@@ -1172,7 +1232,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="___sec24"></a></h3>
+<h3>PDFLaTeX <a name="___sec25"></a></h3>
<p>
Running <code>pdflatex</code> instead of <code>latex</code> follows almost
the same steps,
@@ -1190,7 +1250,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>XeLaTeX <a name="___sec25"></a></h3>
+<h3>XeLaTeX <a name="___sec26"></a></h3>
<p>
XeLaTeX is an alternative to pdfLaTeX and is run in almost the
@@ -1205,7 +1265,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Plain ASCII Text <a name="___sec26"></a></h3>
+<h3>Plain ASCII Text <a name="___sec27"></a></h3>
<p>
We can go from Doconce "back to" plain untagged text suitable for viewing
@@ -1216,7 +1276,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>reStructuredText <a name="___sec27"></a></h3>
+<h3>reStructuredText <a name="___sec28"></a></h3>
<p>
Going from Doconce to reStructuredText gives a lot of possibilities to
@@ -1272,7 +1332,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="___sec28"></a></h3>
+<h3>Sphinx <a name="___sec29"></a></h3>
<p>
Sphinx documents demand quite some steps in their creation. We have
automated
@@ -1434,7 +1494,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>The manual Sphinx procedure <a name="___sec29"></a></h4>
+<h4>The manual Sphinx procedure <a name="___sec30"></a></h4>
<p>
If it is not desirable to use the autogenerated scripts explained
@@ -1544,7 +1604,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="___sec30"></a></h3>
+<h3>Wiki Formats <a name="___sec31"></a></h3>
<p>
There are many different wiki formats, but Doconce only supports three:
@@ -1591,7 +1651,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="___sec31"></a></h3>
+<h3>Tweaking the Doconce Output <a name="___sec32"></a></h3>
<p>
Occasionally, one would like to tweak the output in a certain format
@@ -1606,7 +1666,7 @@
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.
-<h3>Demos <a name="___sec32"></a></h3>
+<h3>Demos <a name="___sec33"></a></h3>
<p>
The current text is generated from a Doconce format stored in the file
@@ -1628,7 +1688,7 @@
translates the more comprehensive documentation,
<code>manual.do.txt</code>, to
various formats. The <code>make.sh</code> script runs a set of
translations.
-<h2>Installation of Doconce and its Dependencies <a
name="___sec33"></a></h2>
+<h2>Installation of Doconce and its Dependencies <a
name="___sec34"></a></h2>
<p>
Below, we explain the manual installation of all software that may be
@@ -1636,7 +1696,7 @@
The impatient way to install what is needed is to run the
<a href="doconce_install_all.sh"><tt>doconce_install_all.sh</tt></a>
script.
-<h3>Doconce <a name="___sec34"></a></h3>
+<h3>Doconce <a name="___sec35"></a></h3>
<p>
Doconce itself is pure Python code hosted at <a
href="http://code.google.com/p/doconce"><tt>http://code.google.com/p/doconce</tt></a>.
Its installation from the
@@ -1660,7 +1720,7 @@
</code></pre>
<!-- end verbatim block -->
-<h3>Dependencies <a name="___sec35"></a></h3>
+<h3>Dependencies <a name="___sec36"></a></h3>
<p>
Producing HTML documents, plain text, pandoc-extended Markdown,
@@ -1673,7 +1733,7 @@
<p>
<!-- Make a debpkg_doconce.txt file with everything that is needed on
Debian -->
-<h4>Preprocessors <a name="___sec36"></a></h4>
+<h4>Preprocessors <a name="___sec37"></a></h4>
<p>
If you make use of the <a
href="http://code.google.com/p/preprocess">Preprocess</a>
@@ -1715,7 +1775,7 @@
tarball, pack it out, go to the directory and run
the usual <code>sudo python setup.py install</code>.
-<h4>Image file handling <a name="___sec37"></a></h4>
+<h4>Image file handling <a name="___sec38"></a></h4>
<p>
Different output formats require different formats of image files.
@@ -1753,7 +1813,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Spellcheck <a name="___sec38"></a></h4>
+<h4>Spellcheck <a name="___sec39"></a></h4>
<p>
The utility <code>doconce spellcheck</code> applies the
<code>ispell</code> program for
@@ -1765,7 +1825,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Bibliography <a name="___sec39"></a></h4>
+<h4>Bibliography <a name="___sec40"></a></h4>
<p>
The Python package <a
href="https://bitbucket.org/logg/publish">Publish</a> is needed if you use
a bibliography
@@ -1787,7 +1847,7 @@
</code></pre>
<!-- end verbatim block -->
-<h4>Ptex2tex for LaTeX Output <a name="___sec40"></a></h4>
+<h4>Ptex2tex for LaTeX Output <a name="___sec41"></a></h4>
<p>
To make LaTeX documents with very flexible choice of typesetting of
@@ -1871,7 +1931,7 @@
<code>ifthen</code>, <code>xkeyval</code>, <code>tikz</code>,
<code>calc</code>, <code>graphicx</code>, and <code>setspace</code>. The
relevant Debian packages for installing all this are listed below.
-<h4>LaTeX packages <a name="___sec41"></a></h4>
+<h4>LaTeX packages <a name="___sec42"></a></h4>
<p>
Many LaTeX packages are potentially needed (depending on various
@@ -1921,7 +1981,7 @@
the <a
href="https://code.google.com/p/ptex2tex/source/browse/trunk/latex/styles/with_license/anslistings.sty">ptex2tex
source</a>. It should get installed
by the <code>cp2texmf.sh</code> script executed above.
-<h4>reStructuredText (reST) Output <a name="___sec42"></a></h4>
+<h4>reStructuredText (reST) Output <a name="___sec43"></a></h4>
<p>
The <code>rst</code> output from Doconce allows further transformation to
LaTeX,
@@ -1960,7 +2020,7 @@
or clone the svn repository, go to the <code>rst2pdf</code> directory and
run the usual <code>sudo python setup.py install</code>.
-<h4>Sphinx Output <a name="___sec43"></a></h4>
+<h4>Sphinx Output <a name="___sec44"></a></h4>
<p>
Output to <code>sphinx</code> requires of course the
@@ -2000,7 +2060,7 @@
These must be downloaded or cloned, and <code>setup.py</code> must be run
as shown
above.
-<h4>Markdown and Pandoc Output <a name="___sec44"></a></h4>
+<h4>Markdown and Pandoc Output <a name="___sec45"></a></h4>
<p>
The Doconce format <code>pandoc</code> outputs the document in the Pandoc
@@ -2015,7 +2075,7 @@
<!-- end verbatim block -->
on Debian (Ubuntu) systems.
-<h4>Epydoc Output <a name="___sec45"></a></h4>
+<h4>Epydoc Output <a name="___sec46"></a></h4>
<p>
When the output format is <code>epydoc</code> one needs that program too,
installed
@@ -2039,7 +2099,7 @@
Mercurial (<code>hg</code>) directories, go to the directory, run
<code>hg pull; hg update</code>, and then <code>sudo python setup.py
install</code>.
-<h4>The <code>doconce diff</code> command <a name="___sec46"></a></h4>
+<h4>The <code>doconce diff</code> command <a name="___sec47"></a></h4>
<p>
The <code>doconce diff file1 file prog</code> command for illustrating
differences between
@@ -2062,7 +2122,7 @@
<tr><td align="left">
<code>tkdiff.tcl</code>
</td> <td align="left"> <a
href="https://sourceforge.net/projects/tkdiff/">tkdiff</a>
</td> <td align="left"> not in
Debian
</td> </tr>
</table>
-<h3>Quick Debian/Ubuntu Install <a name="___sec47"></a></h3>
+<h3>Quick Debian/Ubuntu Install <a name="___sec48"></a></h3>
<p>
On Debian (including Ubuntu) systems, it is straightforward to install the
=======================================
--- /doc/demos/tutorial/tutorial.md Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.md Sat Aug 10 23:22:34 2013
@@ -1,6 +1,6 @@
% Doconce: Document Once, Include Anywhere
% Hans Petter Langtangen at Center for Biomedical Computing, Simula
Research Laboratory and Department of Informatics, University of Oslo
-% Jul 13, 2013
+% Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -628,8 +628,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -764,6 +764,64 @@
The `-s` option adds a proper header and footer to the `mydoc.html` file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+#### GitHub-flavored Markdown
+
+Adding the command-line option `github-md` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[GitHub](http://github.com). A special feature is the support of task lists:
+unnumbered lists with `[x]` (task done) or `[ ]` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Say this text is stored in a file `mycomments.do.txt`. Running
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.Bash}
+Terminal> doconce format pandoc mycomments --github_md
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+produces `mycomments.md` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
### LaTeX
@@ -785,11 +843,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run `ptex2tex` (if you have it) to make a standard LaTeX file,
=======================================
--- /doc/demos/tutorial/tutorial.mwiki Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.mwiki Sat Aug 10 23:22:34 2013
@@ -2,7 +2,7 @@
#TITLE (actually governed by the filename): Doconce: Document Once,
Include Anywhere
By '''Hans Petter Langtangen'''
-==== Jul 13, 2013 ====
+==== Aug 11, 2013 ====
<ul>
<li> When writing a note, report, manual, etc., do you find it difficult
@@ -578,8 +578,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -711,6 +711,60 @@
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.
+==== GitHub-flavored Markdown ====
+
+Adding the command-line option <code>github-md</code> turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
[http://github.com GitHub]. A special feature is the support of task lists:
+unnumbered lists with <code>[x]</code> (task done) or <code>[ ]</code>
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+<syntaxhighlight lang="text">
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</syntaxhighlight>
+Say this text is stored in a file <code>mycomments.do.txt</code>. Running
+
+<syntaxhighlight lang="bash">
+Terminal> doconce format pandoc mycomments --github_md
+</syntaxhighlight>
+produces <code>mycomments.md</code> which can be pasted into the Write
field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
==== LaTeX ====
@@ -731,11 +785,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option <code>-DDEVICE=paper</code> makes some adjustments for documents
+An option <code>--device=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.
+The default, <code>--device=screen</code>, creates a PDF file for reading
+on a screen where links are just clickable.
''Step 2.''
Run <code>ptex2tex</code> (if you have it) to make a standard LaTeX file,
=======================================
--- /doc/demos/tutorial/tutorial.p.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.p.tex Sat Aug 10 23:22:34 2013
@@ -295,16 +295,16 @@
% #if LATEX_HEADING == "traditional"
-\date{Jul 13, 2013}
+\date{Aug 11, 2013}
\maketitle
% #elif LATEX_HEADING == "beamer"
-\date{Jul 13, 2013
+\date{Aug 11, 2013
% <titlepage figure>
}
% #elif LATEX_HEADING == "titlepage"
\ \\ [10mm]
-{\large\textsf{Jul 13, 2013}}
+{\large\textsf{Aug 11, 2013}}
\end{center}
\vfill
@@ -312,7 +312,7 @@
% #else
\begin{center}
-Jul 13, 2013
+Aug 11, 2013
\end{center}
\vspace{1cm}
@@ -933,8 +933,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1064,6 +1064,59 @@
The \code{-s} option adds a proper header and footer to the
\code{mydoc.html} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+\paragraph{GitHub-flavored Markdown.}
+Adding the command-line option \code{github-md} turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{{http://github.com}}{GitHub}. A special feature is the support of
task lists:
+unnumbered lists with \code{[x]} (task done) or \code{[ ]} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+\bccq
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+\eccq
+Say this text is stored in a file \code{mycomments.do.txt}. Running
+
+\bsys
+Terminal> doconce format pandoc mycomments --github_md
+\esys
+produces \code{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
\subsection{{\LaTeX}}
@@ -1084,11 +1137,11 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.
-An option \code{-DDEVICE=paper} makes some adjustments for documents
+An option \code{--device=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.
+The default, \code{--device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
\paragraph{Step 2.}
Run \code{ptex2tex} (if you have it) to make a standard {\LaTeX} file,
=======================================
--- /doc/demos/tutorial/tutorial.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.pdf Sat Aug 10 23:22:34 2013
Binary file, no diff available.
=======================================
--- /doc/demos/tutorial/tutorial.rst Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.rst Sat Aug 10 23:22:34 2013
@@ -6,7 +6,7 @@
========================================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -634,8 +634,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -767,6 +767,61 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -792,11 +847,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file::
=======================================
--- /doc/demos/tutorial/tutorial.rst.html Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.rst.html Sat Aug 10 23:22:34 2013
@@ -328,7 +328,7 @@
<tr class="field"><th class="field-name">Author:</th><td
class="field-body"><p class="first">Hans Petter Langtangen</p>
</td>
</tr>
-<tr class="field"><th class="field-name">Date:</th><td
class="field-body"><p class="first">Jul 13, 2013</p>
+<tr class="field"><th class="field-name">Date:</th><td
class="field-body"><p class="first">Aug 11, 2013</p>
<ul class="last simple">
<li>When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -900,8 +900,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -1020,6 +1020,58 @@
</pre>
<p>The <tt class="docutils literal"><span class="pre">-s</span></tt>
option adds a proper header and footer to the <tt class="docutils
literal">mydoc.html</tt> file.
This recipe is a quick way of makeing HTML notes with (some)
mathematics.</p>
+<div class="section" id="github-flavored-markdown">
+<h3>GitHub-flavored Markdown</h3>
+<p>Adding the command-line option <tt class="docutils literal"><span
class="pre">github-md</span></tt> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <a
class="reference external" href="http://github.com">GitHub</a>. A special
feature is the support of task lists:
+unnumbered lists with <tt class="docutils literal">[x]</tt> (task done) or
<tt class="docutils literal">[ ]</tt> (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:</p>
+<pre class="literal-block">
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+</pre>
+<p>Say this text is stored in a file <tt class="docutils
literal">mycomments.do.txt</tt>. Running:</p>
+<pre class="literal-block">
+Terminal> doconce format pandoc mycomments --github_md
+</pre>
+<p>produces <tt class="docutils literal">mycomments.md</tt> which can be
pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</p>
+</div>
</div>
<div class="section" id="id4">
<h2>LaTeX</h2>
@@ -1037,11 +1089,11 @@
<tt class="docutils literal">newcommands_replace.tex</tt> (see the section
<a class="reference internal"
href="#macros-newcommands-cross-references-index-and-bibliography">Macros
(Newcommands), Cross-References, Index, and Bibliography</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">-DDEVICE=paper</span></tt> makes some adjustments for documents
+<p>An option <tt class="docutils literal"><span
class="pre">--device=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).
-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>
+The default, <tt class="docutils literal"><span
class="pre">--device=screen</span></tt>, creates a PDF file for reading
+on a screen where links are just 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> ptex2tex mydoc
=======================================
--- /doc/demos/tutorial/tutorial.rst.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.rst.pdf Sat Aug 10 23:22:34 2013
Binary file, no diff available.
=======================================
--- /doc/demos/tutorial/tutorial.rst.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.rst.tex Sat Aug 10 23:22:34 2013
@@ -79,7 +79,7 @@
Hans Petter Langtangen
\item[{Date:}]
-Jul 13, 2013
+Aug 11, 2013
%
\begin{itemize}
@@ -974,8 +974,8 @@
~~~~~~~~~~-{}-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\\
+~~~~~~~~~~-{}-html\_output=mydoc\_solarized~\textbackslash{}\\
+~~~~~~~~~~-{}-pygments\_html\_style=perldoc~-{}-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\\
@@ -1153,6 +1153,71 @@
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+%___________________________________________________________________________
+
+\subsubsection*{\phantomsection%
+ GitHub-flavored Markdown%
+ \addcontentsline{toc}{subsubsection}{GitHub-flavored Markdown}%
+ \label{github-flavored-markdown}%
+}
+
+Adding the command-line option \texttt{github-md} turns on the
GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{http://github.com}{GitHub}. A special feature is the support of task
lists:
+unnumbered lists with \texttt{{[}x{]}} (task done) or \texttt{{[} {]}}
(task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+!bquote\\
+=====~Problems~with~a~function~=====\\
+~\\
+There~is~a~problem~with~the~`f(x)`~function\\
+~\\
+!bc~pycod\\
+def~f(x):\\
+~~~~return~1~+~x\\
+!ec\\
+This~function~should~be~quadratic.\\
+!equote\\
+~\\
+OK,~this~is~fixed:\\
+~\\
+!bc~pycod\\
+def~f(x,~a=1,~b=1,~c=1):\\
+~~~~return~a*x**2~+~b*x~+~c\\
+!ec\\
+~\\
+=====~Updated~task~list~=====\\
+~\\
+~~~*~{[}x{]}~Offer~an~`f(x)`~function\\
+~~~*~{[}~{]}~Extension~to~cubic~functions\\
+~~~*~{[}x{]}~Allowing~general~coefficient~in~the~quadratic~function\\
+~\\
+===~Remaining~functionality~===\\
+~\\
+|
-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
\\
+|~function~|~purpose~~~~~~~~~~~~~~~~~~~~~~~~|~state~|\\
+|
-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-l-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
\\
+|~~`g(x)`~~|~Compute~the~Gaussian~function.~|~Formula~ready.~|\\
+|~~`h(x)`~~|~Heaviside~function.~~~~~~~~~~~~|~Formula~ready.~|\\
+|~~`I(x)`~~|~Indicator~function.~~~~~~~~~~~~|~Nothing~done~yet.~|\\
+|
-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-{}-|
+}
+\end{quote}
+
+Say this text is stored in a file \texttt{mycomments.do.txt}. Running:
+%
+\begin{quote}{\ttfamily \raggedright \noindent
+Terminal>~doconce~format~pandoc~mycomments~-{}-github\_md
+}
+\end{quote}
+
+produces \texttt{mycomments.md} which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
+
%___________________________________________________________________________
\subsection*{\phantomsection%
@@ -1183,11 +1248,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option \texttt{-DDEVICE=paper} makes some adjustments for documents
+An option \texttt{-{}-device=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.
+The default, \texttt{-{}-device=screen}, creates a PDF file for reading
+on a screen where links are just clickable.
\emph{Step 2.} Run \texttt{ptex2tex} (if you have it) to make a standard
LaTeX file:
%
=======================================
--- /doc/demos/tutorial/tutorial.sphinx.pdf Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.sphinx.pdf Sat Aug 10 23:22:34 2013
Binary file, no diff available.
=======================================
--- /doc/demos/tutorial/tutorial.sphinx.rst Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.sphinx.rst Sat Aug 10 23:22:34 2013
@@ -6,7 +6,7 @@
========================================
:Author: Hans Petter Langtangen
-:Date: Jul 13, 2013
+:Date: Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -674,8 +674,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -815,6 +815,66 @@
The ``-s`` option adds a proper header and footer to the ``mydoc.html``
file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option ``github-md`` turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on `GitHub
<http://github.com>`_. A special feature is the support of task lists:
+unnumbered lists with ``[x]`` (task done) or ``[ ]`` (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+
+.. code-block:: text
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file ``mycomments.do.txt``. Running
+
+
+.. code-block:: console
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces ``mycomments.md`` which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -841,11 +901,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option ``-DDEVICE=paper`` makes some adjustments for documents
+An option ``--device=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.
+The default, ``--device=screen``, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ``ptex2tex`` (if you have it) to make a standard LaTeX file,
=======================================
--- /doc/demos/tutorial/tutorial.st Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.st Sat Aug 10 23:22:34 2013
@@ -1,7 +1,7 @@
TITLE: Doconce: Document Once, Include Anywhere
BY: Hans Petter Langtangen (Center for Biomedical Computing, Simula
Research Laboratory, and Department of Informatics, University of Oslo)
-DATE: Jul 13, 2013
+DATE: Aug 11, 2013
- When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML,
@@ -562,8 +562,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -688,6 +688,60 @@
The '-s' option adds a proper header and footer to the 'mydoc.html' file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+
+Adding the command-line option 'github-md' turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker
on "http://github.com":GitHub. A special feature is the support of task
lists:
+unnumbered lists with '[x]' (task done) or '[ ]' (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file 'mycomments.do.txt'. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces 'mycomments.md' which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
@@ -705,11 +759,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option '-DDEVICE=paper' makes some adjustments for documents
+An option '--device=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.
+The default, '--device=screen', creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run 'ptex2tex' (if you have it) to make a standard LaTeX file::
=======================================
--- /doc/demos/tutorial/tutorial.tex Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.tex Sat Aug 10 23:22:34 2013
@@ -136,7 +136,7 @@
\begin{center}
-Jul 13, 2013
+Aug 11, 2013
\end{center}
\vspace{1cm}
@@ -772,8 +772,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -907,6 +907,61 @@
The {\fontsize{10pt}{10pt}\Verb!-s!} option adds a proper header and
footer to the {\fontsize{10pt}{10pt}\Verb!mydoc.html!} file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+\paragraph{GitHub-flavored Markdown.}
+Adding the command-line option {\fontsize{10pt}{10pt}\Verb!github-md!}
turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on
\href{{http://github.com}}{GitHub}. A special feature is the support of
task lists:
+unnumbered lists with {\fontsize{10pt}{10pt}\Verb![x]!} (task done) or
{\fontsize{10pt}{10pt}\Verb![ ]!} (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example:
+
+\begin{Verbatim}[fontsize=\fontsize{9pt}{9pt},tabsize=8,baselinestretch=0.85,fontfamily=tt,xleftmargin=7mm]
+!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
+\end{Verbatim}
+\noindent
+Say this text is stored in a file
{\fontsize{10pt}{10pt}\Verb!mycomments.do.txt!}. Running
+
+\vspace{4pt}
+\begin{Verbatim}[numbers=none,frame=lines,fontsize=\fontsize{9pt}{9pt},labelposition=topline,framesep=2.5mm,framerule=0.7pt]
+Terminal> doconce format pandoc mycomments --github_md
+\end{Verbatim}
+produces {\fontsize{10pt}{10pt}\Verb!mycomments.md!} which can be pasted
into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
\subsection{{\LaTeX}}
@@ -928,11 +983,11 @@
If these files are present, they are included in the {\LaTeX} document
so that your commands are defined.
-An option {\fontsize{10pt}{10pt}\Verb!-DDEVICE=paper!} makes some
adjustments for documents
+An option {\fontsize{10pt}{10pt}\Verb!--device=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, {\fontsize{10pt}{10pt}\Verb!-DDEVICE=screen!}, creates a PDF
file for reading
-on a screen where links are clickable.
+The default, {\fontsize{10pt}{10pt}\Verb!--device=screen!}, creates a PDF
file for reading
+on a screen where links are just clickable.
\paragraph{Step 2.}
Run {\fontsize{10pt}{10pt}\Verb!ptex2tex!} (if you have it) to make a
standard {\LaTeX} file,
=======================================
--- /doc/demos/tutorial/tutorial.txt Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.txt Sat Aug 10 23:22:34 2013
@@ -7,7 +7,7 @@
[1] Center for Biomedical Computing, Simula Research Laboratory
[2] Department of Informatics, University of Oslo
-Date: Jul 13, 2013
+Date: Aug 11, 2013
* When writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
@@ -629,8 +629,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -759,6 +759,61 @@
The -s option adds a proper header and footer to the mydoc.html file.
This recipe is a quick way of makeing HTML notes with (some) mathematics.
+GitHub-flavored Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Adding the command-line option github-md turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on GitHub
(http://github.com). A special feature is the support of task lists:
+unnumbered lists with [x] (task done) or [ ] (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an example::
+
+
+ !bquote
+ ===== Problems with a function =====
+
+ There is a problem with the `f(x)` function
+
+ !bc pycod
+ def f(x):
+ return 1 + x
+ !ec
+ This function should be quadratic.
+ !equote
+
+ OK, this is fixed:
+
+ !bc pycod
+ def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+ !ec
+
+ ===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+ === Remaining functionality ===
+
+ |---------------------------------------------------------------|
+ | function | purpose | state |
+ |----l-----------l------------------------------l---------------|
+ | `g(x)` | Compute the Gaussian function. | Formula ready. |
+ | `h(x)` | Heaviside function. | Formula ready. |
+ | `I(x)` | Indicator function. | Nothing done yet. |
+ |---------------------------------------------------------------|
+
+Say this text is stored in a file mycomments.do.txt. Running::
+
+
+ Terminal> doconce format pandoc mycomments --github_md
+
+produces mycomments.md which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.
+
LaTeX
-----
@@ -777,11 +832,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option -DDEVICE=paper makes some adjustments for documents
+An option --device=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.
+The default, --device=screen, creates a PDF file for reading
+on a screen where links are just clickable.
*Step 2.* Run ptex2tex (if you have it) to make a standard LaTeX file::
=======================================
--- /doc/demos/tutorial/tutorial.xml Sat Jul 13 00:16:44 2013
+++ /doc/demos/tutorial/tutorial.xml Sat Aug 10 23:22:34 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="tutorial.rst"><comment
xml:space="preserve">Automatically generated reST file from Doconce source
-(http://code.google.com/p/doconce/)</comment><section
ids="doconce-document-once-include-anywhere" names="doconce:\ document\
once,\ include\ anywhere"><title>Doconce: Document Once, Include
Anywhere</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><bullet_list bullet="*"><list_item><paragraph>When
writing a note, report, manual, etc., do you find it difficult
+(http://code.google.com/p/doconce/)</comment><section
ids="doconce-document-once-include-anywhere" names="doconce:\ document\
once,\ include\ anywhere"><title>Doconce: Document Once, Include
Anywhere</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>Aug
11, 2013</paragraph><bullet_list bullet="*"><list_item><paragraph>When
writing a note, report, manual, etc., do you find it difficult
to choose the typesetting format? That is, to choose between plain
(email-like) text, wiki, Word/OpenOffice, LaTeX, HTML,
reStructuredText, Sphinx, XML, etc. Would it be convenient to
@@ -298,8 +298,8 @@
--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
+ --html_output=mydoc_solarized \
+ --pygments_html_style=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
@@ -361,16 +361,56 @@
and date), maybe with some unnumbered equations, and quickly generate
HTML with mathematics displayed my MathJax:</paragraph><literal_block
xml:space="preserve">Terminal> doconce format pandoc mydoc
Terminal> pandoc -t html -o mydoc.html -s --mathjax
mydoc.mkd</literal_block><paragraph>The <literal>-s</literal> option adds a
proper header and footer to the <literal>mydoc.html</literal> file.
-This recipe is a quick way of makeing HTML notes with (some)
mathematics.</paragraph></section><section dupnames="latex"
ids="id4"><title>LaTeX</title><paragraph>Making a LaTeX file
<literal>mydoc.tex</literal> from <literal>mydoc.do.txt</literal> is done
in two steps:</paragraph><comment xml:space="preserve">Note: putting code
blocks inside a list is not successful in many</comment><comment
xml:space="preserve">formats - the text may be messed up. A better choice
is a paragraph</comment><comment xml:space="preserve">environment, as used
here.</comment><paragraph><emphasis>Step 1.</emphasis> Filter the doconce
text to a pre-LaTeX form <literal>mydoc.p.tex</literal> for
+This recipe is a quick way of makeing HTML notes with (some)
mathematics.</paragraph><section ids="github-flavored-markdown"
names="github-flavored\ markdown"><title>GitHub-flavored
Markdown</title><paragraph>Adding the command-line option
<literal>github-md</literal> turns on the GutHub-flavored
+Markdown dialect, which is used for the issue tracker on <reference
name="GitHub" refuri="http://github.com">GitHub</reference><target
ids="github" names="github" refuri="http://github.com"/>. A special feature
is the support of task lists:
+unnumbered lists with <literal>[x]</literal> (task done) or <literal>[
]</literal> (task not done).
+(Tables get typeset directly as HTML and the syntax for code highlighting
+is different from Pandoc extended Markdown.) Here is an
example:</paragraph><literal_block xml:space="preserve">!bquote
+===== Problems with a function =====
+
+There is a problem with the `f(x)` function
+
+!bc pycod
+def f(x):
+ return 1 + x
+!ec
+This function should be quadratic.
+!equote
+
+OK, this is fixed:
+
+!bc pycod
+def f(x, a=1, b=1, c=1):
+ return a*x**2 + b*x + c
+!ec
+
+===== Updated task list =====
+
+ * [x] Offer an `f(x)` function
+ * [ ] Extension to cubic functions
+ * [x] Allowing general coefficient in the quadratic function
+
+=== Remaining functionality ===
+
+|---------------------------------------------------------------|
+| function | purpose | state |
+|----l-----------l------------------------------l---------------|
+| `g(x)` | Compute the Gaussian function. | Formula ready. |
+| `h(x)` | Heaviside function. | Formula ready. |
+| `I(x)` | Indicator function. | Nothing done yet. |
+|---------------------------------------------------------------|
</literal_block><paragraph>Say this text is stored in a file
<literal>mycomments.do.txt</literal>. Running:</paragraph><literal_block
xml:space="preserve">Terminal> doconce format pandoc mycomments
--github_md</literal_block><paragraph>produces
<literal>mycomments.md</literal> which can be pasted into the Write field of
+the GitHub issue tracker. Turning on Preview shows the typesetting of
+the quote, compute code, inline verbatim, headings, the task list, and
+the table.</paragraph></section></section><section dupnames="latex"
ids="id4"><title>LaTeX</title><paragraph>Making a LaTeX file
<literal>mydoc.tex</literal> from <literal>mydoc.do.txt</literal> is done
in two steps:</paragraph><comment xml:space="preserve">Note: putting code
blocks inside a list is not successful in many</comment><comment
xml:space="preserve">formats - the text may be messed up. A better choice
is a paragraph</comment><comment xml:space="preserve">environment, as used
here.</comment><paragraph><emphasis>Step 1.</emphasis> Filter the doconce
text to a pre-LaTeX form <literal>mydoc.p.tex</literal> for
the <literal>ptex2tex</literal> program (or <literal>doconce
ptex2tex</literal>):</paragraph><literal_block
xml:space="preserve">Terminal> doconce format latex
mydoc</literal_block><paragraph>LaTeX-specific commands
("newcommands") in math formulas and similar
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), Cross-References, Index, and Bibliography"
refid="macros-newcommands-cross-references-index-and-bibliography">Macros
(Newcommands), Cross-References, Index, and Bibliography</reference>).
If these files are present, they are included in the LaTeX document
-so that your commands are defined.</paragraph><paragraph>An option
<literal>-DDEVICE=paper</literal> makes some adjustments for documents
+so that your commands are defined.</paragraph><paragraph>An option
<literal>--device=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).
-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> 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>
doconce ptex2tex mydoc</literal_block><paragraph>Note that Doconce
generates a <literal>.p.tex</literal> file with some preprocessor macros
+The default, <literal>--device=screen</literal>, creates a PDF file for
reading
+on a screen where links are just
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> 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>
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> ptex2tex -DHELVETICA mydoc
=======================================
--- /doc/tutorial/doconce2anything.do.txt Sat Aug 10 23:04:17 2013
+++ /doc/tutorial/doconce2anything.do.txt Sat Aug 10 23:22:34 2013
@@ -328,10 +328,10 @@
There is a problem with the `f(x)` function
-!bc pycod
+|bc pycod
def f(x):
return 1 + x
-!ec
+|ec
This function should be quadratic.
|equote
@@ -387,11 +387,11 @@
If these files are present, they are included in the LaTeX document
so that your commands are defined.
-An option `-DDEVICE=paper` makes some adjustments for documents
+An option `--device=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.
+The default, `--device=screen`, creates a PDF file for reading
+on a screen where links are just clickable.
__Step 2.__ Run `ptex2tex` (if you have it) to make a standard LaTeX file,
!bc sys
Reply all
Reply to author
Forward
0 new messages