Giter Club home page Giter Club logo

uscms-reports's Introduction

USCMS-Reports

These are the quarterly reports for the U.S. CMS Operations Program.

To create the pdf output just run make in the quarterly sub-trees.

You will need to have pandoc and latex installed.

To get pandoc on the mac, the easiest is to use homebrew to install it. This is really trivial, there's a one-liner on the homebrew web page to get homebrew up and running, then you are ready to install packages like pandoc:

brew install pandoc

that's it!

To get the full Latex installation for the mac go to MacTEX.

I'm currently using the font family Minion Pro, which can be easily installed in the mac system (it e.g. comes with the Adobe Reader App for free). If you don't have it and don't want to install it, just choose another font in the template.tex file.

Syntax Tips:

Markdown syntax is trivial, see intro here, which has everything you'll likely ever need (or the much more extensive documentation in the pandoc users guide). It also makes figures and tables really easy:

I'm using the markdown pandoc simple_tables, like this:

Date            Milestone  
--------------  -----------------------------------------------
Feb 2016        Firmware version 1.0 released
Mar 2016        Even better firmware 1.1 released

Table: Major milestones achieved this quarter

Figures can be inserted like this:

![Caption text goes here.\label{fig:no1}](figures/image.png) 

and referred to like ...see Figure \ref{fig:no1}..., as in Latex.

Update:

I'm now using a "better" way to deal with Figure and Table references instead of the raw Latex \ref and \label, that also works with other output formats like html, using a syntax like ...see Figure {@fig:id}... and

![Figure caption.](image.png){#fig:id}

This requires the pandoc filter pandoc-fignos. It's trivial to install once you have python pip -- which MacOS doesn't as a default. The safest option is to install your own python, easiest using homebrew, which comes with pip:

brew install python

Then it's trivial to install pandoc-fignos:

pip install pandoc-fignos

Now you can use pandoc-fignos in pandoc by adding --filter pandoc-fignos.

uscms-reports's People

Contributors

aronsoha avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.