Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Automatically convert Latex documents into PDFs when uploading to JIRA.

Project Description

This plugin provides two latex features for Jirafs –

  • Automatically conversion of latex documents into PDF documents before uploading the PDF to JIRA.
  • A {latex} macro block you can use in comments and ticket descriptions for embedding inline images or PDFs into your text.

Installation

  1. Install from PIP:

    pip install jirafs-latex
    
  2. Enable for a ticket folder:

    jirafs plugins --enable=latex
    

Note that you can globally enable this (or any) plugin by adding the --global flag to the above command:

jirafs plugins --global --enable=latex

Requirements

  • Requires xelatex.

Using the Automatic Latex Compiler

Simply place a file with a .tex extension in your ticket folder. It’ll be compiled into a PDF automatically, and the PDF will be uploaded to JIRA (not the .tex file) next time you push changes to JIRA.

Using the {latex} Macro Block

Enter a latex block like so:

{latex:name=somefilename.pdf}
\documentclass{article}
\usepackage{graphicx}

\begin{document}

\title{Introduction to \LaTeX{}}
\author{Author's Name}

\maketitle

\begin{abstract}
The abstract text goes here.
\end{abstract}

\section{Introduction}
Here is the text of your introduction.

\begin{equation}
    \label{simple_equation}
    \alpha = \sqrt{ \beta }
\end{equation}

\subsection{Subsection Heading Here}
Write your subsection text here.

\begin{figure}
    \centering
    \includegraphics[width=3.0in]{myfigure}
    \caption{Simulation Results}
    \label{simulationfigure}
\end{figure}

\section{Conclusion}
Write your conclusion here.

\end{document}
{latex}

The above will be replaced with inline image JIRA markup (in this case, !somefilename.pdf!) when submitting these changes to JIRA.

You must specify a name parameter in your opening {latex} tag; that’s the filename that will be uploaded to JIRA next time you submit changes. Also, note that if you have the standalone latex plugin installed and use it to convert your latex documents into PNG images instead, you should specify a filename ending in png in your name parameter.

This is probably not important to you, but if you’re curious about how this works: what is happening here is the plugin writes your latex content to a file, then asks xelatex to compile your document, then once that process has completed, all files except the one matching the name you’ve submitted are deleted. After this point, everything works exactly as it does when you’re uploading a normal file.

Release History

Release History

This version
History Node

2.0

History Node

1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
jirafs-latex-2.0.tar.gz (4.0 kB) Copy SHA256 Checksum SHA256 Source Oct 12, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting