Plain-Text-2-PDF-tmbundle

About

A TextMate bundle to generate PDFs from source code and documentation. The layout of documentation output is possible to style with CSS. Markdown is currently the only supported plain text format but others would be easy to add.

Code to PDF.

The User works on a project in TextMate and wants to have a pdf of source code, she selects the Plain Text to PDF bundle and menu option: "Code to PDF" seconds later a PDF with line numbering and syntax highlighting exists open in Preview.

Plain to PDF

The User has created a README.md for a project and wants to share the contents of the README with a non-techy individual. He selects the Plain Text to PDF bundle and menu option: "Plain to PDF" seconds later a PDF is created at the project paths root, tailored with options from emac styled comment variables.

Usage

Plain to PDF allows you to supply meta-data to be inserted in the pdf, the meta-data string must be supplied on the first! line of a file and have the following syntax:

:::html
<!--Simple author:First Whatever Name;date:324bc;
title:What;toc:True/False;css:absolute/path;html:absolute/path -->

Defaults are set so only change the ones you must, there exists a correlation between meta-tags and the template for output.

:::python
html = Template(contentOfTemplateFile).substitute(references)

That makes a bunch of stuff possible but also forces meta to correspond when absolute/path! to a template is supplied. If need to change the css file I would recommend to read documentation for dependencies.

Markdown tables are currently not supported its on my to-do list, to have code syntax highlighting in documentation one must add language declaration: ex {:::python} prior to indented code block and have pygments installed.

Example output as pdf of this README

Installation

When dependencies (see below) are met, you have two option to install the bundle, I would prefer the first one install with git from the command line.

Install from git

$ mkdir -p ~/Library/Application\ Support/TextMate/Bundles
$ cd ~/Library/Application\ Support/TextMate/Bundles
$ git clone git://github.com/krusipo/Plain-Text-2-PDF-tmbundle.git
"Plain Text 2 PDF.tmbundle"
$ osascript -e 'tell app "TextMate" to reload bundles'

Install without git

$ mkdir -p ~/Library/Application\ Support/TextMate/Bundles
$ cd ~/Library/Application\ Support/TextMate/Bundles
$ wget --no-check-certificate 
https://github.com/krusipo/Plain-Text-2-PDF-tmbundle/tarball/master
$ tar -zxf krusipo-Plain-Text-2-PDF-tmbundle*.tar.gz
$ rm krusipo-Plain-Text-2-PDF-tmbundle*.tar.gz 
$ mv krusipo-Plain-Text-2-PDF-tmbundle* "Plain Text 2 PDF.tmbundle"
$ osascript -e 'tell app "TextMate" to reload bundles'

Dependencies

Plain to PDF: requires the following eggs the ones marked optional wont break functionality if not present, but stuff will behave strange.

• python-markdown2
  • pygments (optional)
• xhtml2pdf
  • Reportlab Toolkit 2.2+
  • html5lib 0.11.1+
  • pyPdf 1.11+ (optional)

Code to PDF: uses Vim do all the heavy lifting so .vimrc needs to be set up to support colorschemes, line-numbers, and other eye-candy.

In ~/.vimrc add
set printoptions=number:y "Show line-numbers on print
set printfont=courier:h9 "Use courier as font
set syntax on

Standalone Plain to PDF

The Plain to PDF functionality is available as a standalone CLI-based app, just download that file and use it as below after dependencies are met.

$ python markdown2pdf.py -h, --help
# print help, then exit.

$ python markdown2pdf.py -f, --file
# Create PDF with defaults or overidden from file.
			

TO-DO

* Write install script for eggs
* Add option output to html file
* Add support for tables to somewhere.