Differences between revisions 5 and 25 (spanning 20 versions)
⇤ ← Revision 5 as of 2013-06-20 20:06:47 →
Size: 408
Editor: rbeezer
Comment:
← Revision 25 as of 2013-06-30 05:54:27 → ⇥
Size: 5255
Editor: rbeezer
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
  1. XSL transform to LaTeX [[attachment:article-latex.xsl]]
  1. XSL transform to XHTML [[attachment:article-html.xsl]]
  1. Example XML document [[attachment:calculus-article.xml]]		 A specification for XML tags and stylesheets to create usable output.
Line 7: Line 5:
To use, for example, put all files in the same directory and issue [[http://www.beezers.org/blog/bb/2013/06/shuttleworth-flash-grant/|{{attachment:Shuttleworth-Funded-Logo.jpg|Shuttleworth Funded|width=250px}}]]

Rob Beezer, [email protected]

=== Design Goals: ===

  1. Simple for authors to use - no more complicated logically than LaTeX
  1. Capture the structure of writing about mathematics and Sage
  1. Processing into a variety of formats
  1. A limited number of rational tags, with simple names
  1. Minimal use of external shell scripts
  1. XSLT 1.0 compatible: ideally the only required tool is xsltproc

=== Output Formats: ===

  1. HTML web pages, enhanced with !MathJax, Sage Cell server, knowls
  1. LaTeX input to create PDFs and print with {{{pdflatex}}}
  1. Doctesting of Sage code examples
  1. E-Books, once technically feasible
  1. Maybe a !DocBook representation for conversion to other outputs

=== Project Status: ===

  * Funding: Shuttleworth Foundation Flash Grant, National Science Foundation UTMOST Grant
  * Late-June 2013: Good basic functionality for HTML, LaTeX output
  * Mid-June 2013: initiated, not mature or stable

== Examples ==

  1. A short sample article: [[http://buzzard.ups.edu/mathbook/calculus-article.html|XML Source-Author Format]] [[http://buzzard.ups.edu/mathbook/calculus-article.html|HTML Output]] [[http://buzzard.ups.edu/mathbook/calculus-article.pdf|PDF Output]]
  1. A skeletal mock book: [[http://buzzard.ups.edu/mathbook/graph-theory-book.html|XML Source-Author Format]] [[http://buzzard.ups.edu/mathbook/graph-theory-book.html|HTML Output]] [[http://buzzard.ups.edu/mathbook/graph-theory-book.pdf|PDF Output]]

== Commentary ==

High-level commentary is recorded on my [[http://www.beezers.org/blog/bb|blog]].

== Implemented Features ==

 * Article structure with numbered sections and subsections
 * Book structure with numbered chapters, sections and subsections
 * Mathematics: normal LaTeX for PDF, !MathJax in HTML, macros in source '''only once'''
 * Numbered theorems and definitions (needs work, subject to changes)
 * Sage input/output: live Sage cells in HTML, styled in LaTeX
 * Bibliography + citations: as knowls in HTML version
 * Basic CSS for HTML version

== Files and Commands, the nitty-gritty ==

Updated: June 29, 2013

Prerequisites: {{{xsltproc}}} is in most Linux distributions and on Mac OS as a command-line executable. Information on Windows availablity would be helpful - please write. You'll need TeX to run {{{pdflatex}}}. You can author if you also have a text editor and a browser - that is all you need.
  
HTML output: !MathJax does the math, Sage Cell Server does the code, knowls do the citations. Use the following command and files below to create (X)HTML output and view in your browser by opening the output file.
{{{
xsltproc mathbook-html.xsl calculus-article.xml > calculus-article.html
}}}

PDF: Same XML source file. Use a different XSLT file to process. View PDF as you please. Issue the following to produce.
Line 10: Line 65:
xsltproc article-latex.xsl calculus-article.xml > calculus-article.tex xsltproc mathbook-latex.xsl calculus-article.xml > calculus-article.tex
Line 13: Line 68:

More: repeat above with the mock book, {{{graph-theory-book.xml}}}, linked above.

Advanced: create a [[https://cloud.sagemath.com|Sage Cloud]] worksheet from the same source. I have this working in the lab. Posted soon.

Files: Use your browser to save these files locally, do not simply click on them. The XSL files can be scary - not critical for an author to understand them. You'll want the CSS to render any HTML you produce.

  1. [[http://buzzard.ups.edu/mathbook/mathbook-html.xsl|XSL transform to HTML]]
  1. [[http://buzzard.ups.edu/mathbook/mathbook-latex.xsl|XSL transform to LaTeX]]
  1. [[http://buzzard.ups.edu/mathbook/freebsd-docbook|FreeBSD documentation CSS]]
  1. [[http://buzzard.ups.edu/mathbook/mathbook.css|MathBook CSS]]

== To Do (unprioritized)==

 * Cross-references
 * Table of Contents in HTML as sidebar
 * Index (for book structure)
 * Options for numbering sections, theorem-like structures (hard)
 * Improved CSS for HTML
 * Doctesting framework for Sage code (easy)
 * Sage notebook, Sage Math Cloud output formats
 * HTML chunking (one HTML file per section, chapter, etc)
 * Customization options (layers, HTML head insertions)
 * LaTeX spacing hints
 * Figures
 * Tables

== Other Projects ==

 * [[http://tbookdtd.sourceforge.net/|tbook]] looks very much like what I am imagining. I have hacked a bit of it to work with the {{{xsltproc}}} processor with mixed success. Only [[http://tbookdtd.sourceforge.net/dtd/index.html|80 elements]]. But for a very short article, I have found cross-references broken and manufacturing a bibliography begins with BibTeX, so that requires some research (and shell scripts). Maybe some examples later.

 * [[http://www.docbook.org/|DocBook]] is big, complicated and full of features. But the emphasis is on technical documentation and support for mathematics and academic publishing is very lacking. The extensive structure is intimidating if you just have small project.

MathBook: An XML Application

A specification for XML tags and stylesheets to create usable output.

Shuttleworth Funded

Rob Beezer, [email protected]

Design Goals:

  1. Simple for authors to use - no more complicated logically than LaTeX
  2. Capture the structure of writing about mathematics and Sage
  3. Processing into a variety of formats
  4. A limited number of rational tags, with simple names
  5. Minimal use of external shell scripts
  6. XSLT 1.0 compatible: ideally the only required tool is xsltproc

Output Formats:

  1. HTML web pages, enhanced with MathJax, Sage Cell server, knowls

  2. LaTeX input to create PDFs and print with pdflatex

  3. Doctesting of Sage code examples
  4. E-Books, once technically feasible

  5. Maybe a DocBook representation for conversion to other outputs

Project Status:

  • Funding: Shuttleworth Foundation Flash Grant, National Science Foundation UTMOST Grant
  • Late-June 2013: Good basic functionality for HTML, LaTeX output
  • Mid-June 2013: initiated, not mature or stable

Examples

  1. A short sample article: XML Source-Author Format HTML Output PDF Output

  2. A skeletal mock book: XML Source-Author Format HTML Output PDF Output

Commentary

High-level commentary is recorded on my blog.

Implemented Features

  • Article structure with numbered sections and subsections
  • Book structure with numbered chapters, sections and subsections

  • Mathematics: normal LaTeX for PDF, MathJax in HTML, macros in source only once

  • Numbered theorems and definitions (needs work, subject to changes)
  • Sage input/output: live Sage cells in HTML, styled in LaTeX
  • Bibliography + citations: as knowls in HTML version
  • Basic CSS for HTML version

Files and Commands, the nitty-gritty

Updated: June 29, 2013

Prerequisites: xsltproc is in most Linux distributions and on Mac OS as a command-line executable. Information on Windows availablity would be helpful - please write. You'll need TeX to run pdflatex. You can author if you also have a text editor and a browser - that is all you need.

HTML output: MathJax does the math, Sage Cell Server does the code, knowls do the citations. Use the following command and files below to create (X)HTML output and view in your browser by opening the output file. 

xsltproc mathbook-html.xsl calculus-article.xml > calculus-article.html

PDF: Same XML source file. Use a different XSLT file to process. View PDF as you please. Issue the following to produce. 

xsltproc mathbook-latex.xsl calculus-article.xml > calculus-article.tex
pdflatex calculus-article.tex

More: repeat above with the mock book, graph-theory-book.xml, linked above.

Advanced: create a Sage Cloud worksheet from the same source. I have this working in the lab. Posted soon.

Files: Use your browser to save these files locally, do not simply click on them. The XSL files can be scary - not critical for an author to understand them. You'll want the CSS to render any HTML you produce.

  1. XSL transform to HTML

  2. XSL transform to LaTeX

  3. FreeBSD documentation CSS

  4. MathBook CSS

== To Do (unprioritized)==

  • Cross-references
  • Table of Contents in HTML as sidebar
  • Index (for book structure)
  • Options for numbering sections, theorem-like structures (hard)
  • Improved CSS for HTML
  • Doctesting framework for Sage code (easy)
  • Sage notebook, Sage Math Cloud output formats
  • HTML chunking (one HTML file per section, chapter, etc)
  • Customization options (layers, HTML head insertions)
  • LaTeX spacing hints
  • Figures
  • Tables

Other Projects

  • tbook looks very much like what I am imagining. I have hacked a bit of it to work with the xsltproc processor with mixed success. Only 80 elements. But for a very short article, I have found cross-references broken and manufacturing a bibliography begins with BibTeX, so that requires some research (and shell scripts). Maybe some examples later.

  • DocBook is big, complicated and full of features. But the emphasis is on technical documentation and support for mathematics and academic publishing is very lacking. The extensive structure is intimidating if you just have small project.

mathbook (last edited 2014-04-30 17:24:35 by rbeezer)