scholdoc: Converts ScholarlyMarkdown documents to HTML5/LaTeX/Docx format
This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.
Scholdoc is a command-line utility that converts ScholarlyMarkdown documents into the HTML5, LaTeX, and Docx (OOML) formats. It is intended to facilitate academic writing in a cross-platform, semantic-aware, plaintext format that can be quickly used in modern publishing pipelines.
Scholdoc is implemented as (rather crude) fork of pandoc,
and the command-line executable mostly retains the same user
interface (including the custom template and filter system).
It essentially understands a new input format
markdown_scholarly (implemented in the markdown reader a
superset of markdown_pandoc features), and limits itself to
HTML5, LaTeX, and Docx output.
Unfortunately, currently Scholdoc occupies the Pandoc
namespace. This is done to avoid problems when merging in
fixes and changes from the core Pandoc project, and to
potentially allow enhancements from Scholdoc to be contributed
back to Pandoc. It is thus not recommended to use the library
directly, as Scholdoc is not backwards-compatible with Pandoc,
to avoid confusion.
For descriptions of the original pandoc package, please
visit http://hackage.haskell.org/package/pandoc
[Skip to Readme]
Properties
| Versions | 0.1.3, 0.1.3 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=0.7.0.5 && <0.9), base (>=4.2 && <5), base64-bytestring (>=0.1 && <1.1), binary (>=0.5 && <0.8), blaze-html (>=0.5 && <0.8), blaze-markup (>=0.5.1 && <0.7), bytestring (>=0.9 && <0.11), containers (>=0.1 && <0.6), data-default (>=0.4 && <0.6), directory (>=1 && <1.3), extensible-exceptions (>=0.1 && <0.2), filepath (>=1.1 && <1.4), highlighting-kate (>=0.5.8.5 && <0.6), hslua (>=0.3 && <0.4), HTTP (>=4000.0.5 && <4000.3), http-client (>=0.3.2 && <0.5), http-client-tls (>=0.2 && <0.3), http-types, JuicyPixels (>=3.1.6.1 && <3.2), mtl (>=1.1 && <2.3), network (>=2), network-uri (>=2.6 && <2.7), old-locale (>=1 && <1.1), old-time, parsec (>=3.1 && <3.2), process (>=1 && <1.3), random (>=1 && <1.2), scholdoc, scholdoc-texmath (>=0.1 && <0.2), scholdoc-types (>=0.1.3 && <0.1.4), scientific (>=0.2 && <0.4), SHA (>=1.6 && <1.7), syb (>=0.1 && <0.5), tagsoup (>=0.13.1 && <0.14), temporary (>=1.1 && <1.3), text (>=0.11 && <1.3), time (>=1.2 && <1.5), unordered-containers (>=0.2 && <0.3), vector (>=0.10 && <0.11), wai (>=0.3), wai-extra, xml (>=1.3.12 && <1.4), yaml (>=0.8.8.2 && <0.9), zip-archive (>=0.2.3.4 && <0.3), zlib (>=0.5 && <0.6) [details] |
| License | LicenseRef-GPL |
| Copyright | (c) 2014 Tim T.Y. Lin, (c) 2006-2014 John MacFarlane |
| Author | Tim T.Y. Lin <timtylin@gmail.com> |
| Maintainer | Tim T.Y. Lin <timtylin@gmail.com> |
| Category | Text |
| Home page | http://scholarlymarkdown.com |
| Bug tracker | https://github.com/timtylin/scholdoc/issues |
| Source repo | head: git clone git://github.com/timtylin/scholdoc.git |
| Uploaded | by timtylin at 2014-10-17T00:51:28Z |
Modules
[Index]
Flags
Automatic Flags
| Name | Description | Default |
|---|---|---|
| embed_data_files | Embed data files in binary for relocatable executable. | Disabled |
| tryscholdoc | Build tryscholdoc cgi executable. | Disabled |
| https | Enable support for downloading of resources over https. | Enabled |
| make-pandoc-man-pages | Included to prevent errors, but currently useless for Scholdoc | Disabled |
| network-uri | Get Network.URI from the network-uri package | Enabled |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- scholdoc-0.1.3.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
Package maintainers
For package maintainers and hackage trustees
Readme for scholdoc-0.1.3
[back to package description]Scholdoc
Converts ScholarlyMarkdown documents into HTML5, LaTeX, or Docx
Current stable version: 0.1.3
Development build status 
Stable build status 
Scholdoc is a command-line utility that converts ScholarlyMarkdown documents into the HTML5, LaTeX, and Docx (OOML) formats. It is intended to facilitate academic writing in a cross-platform, semantic-aware, plaintext format that can be quickly used in modern publishing pipelines.
Scholdoc is implemented as fork of Pandoc, and mostly retains the
same user interface (including the custom template and
filter system). It essentially understands a new input format
markdown_scholarly (implemented in the markdown reader a superset of
markdown_pandoc features), and limits itself to HTML5/LaTeX/Docx output.
Scholdoc defaults to standalone output and has its own custom
templates to ensure output compatibility with
ScholarlyMarkdown.
See the Pandoc Guide for more about Pandoc, its usage, and the Markdown dialect that Pandoc (and hence Scholdoc) understands.
Scholdoc is currently up to date with Pandoc version 1.13.1 (commit 8b60d430)
HTML output
Important: A ScholarlyMarkdown core CSS is required for proper formatting of most HTML files output by Scholdoc.
Scholdoc's HTML output is strictly limited to HTML5 due to its enhanced
semantic capabilities (such as the figure and figcaption element), and
relies on some CSS3 features for layout (mostly for multi-image figures with
subcaptions). It adheres to a fairly straightforward schema. No
formatting information is written to the HTML by Scholdoc, so a
ScholarlyMarkdown core CSS is required for bare minimum proper
formatting. You can also write your own CSS that target the schema.
By default, the html output format generates a complete (but bare-bones)
HTML5 document that can be used immediately. To have Scholdoc generate just the
bare content (everything inside scholmd-content), use
the html_bodyonly output format. By default, Scholdoc will always include
proper MathJax settings for the way ScholarlyMarkdown prescribes
math content in HTML.
Docx output
The Docx writer currently isn't fully functional yet. It does not yet output structures specific to ScholarlyMarkdown (such as figures).