Giter Club home page Giter Club logo

jdf's Introduction

Joyner Document Format

Welcome to the 2022 update of the Joyner Document Format official LaTeX class.

TeX Installation

If you already have Tex installed and configured for your OS than you can likely skip to Quick Start section

MacOS

brew install text-live-utility
# Ensure required packages are installed
sudo tlmgr install collection-latexrecommended collection-latexextra collection-fontsrecommended collection-fontsextra collection-mathscience

Linux

# For Ubuntu (From https://github.com/iamjakewarner/jdf/pull/15/files)
sudo apt-get install texlive-full

Windows

Could possibly follow the Linux guide on WSL

CLI Quick start

You can clone this repo and try typesetting jdf-starter.tex with the following commands:

biber jdf-starter
pdflatex jdf-starter

The result should look like jdf-starter.pdf.

  • biber command generates used references from references.bib
  • pdflatex command generates the final pdf

Adding jdf.cls to Global TeX

The jdf.cls file can be referenced by updating the TEXINPUTS with the path to the git checkout

export TEXINPUTS=/path/to/the/checkout/jdf/

VSCode Quick Start

  1. Add the Latex Workshop Extension
    • Ensure that texlive for your OS is installed. See additional instructions in the extensions' README
  2. Use the preview icon (top left) or use the keyboard shortcut (Ctrl + Alt + V). This will open up a live preview.
  3. Once done, use the green play button, or use keyboard shortcut (Ctrl + Alt + B) to build the project and generate PDF.

License

Copyright 2019 by Jake Warner.

You have my permission to use JDF in whatever projects you wish, whether commercial, personal, or otherwise, in whatever way you like. Official license information can be found in LICENSE (spoiler: it's the MIT License πŸ™€).

jdf's People

Contributors

alexsanjoseph avatar devikirang avatar dzsquared avatar guava-mc avatar iamjakewarner avatar kyleking avatar ludwiktrammer avatar mrufrufin avatar torylawson avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

jdf's Issues

Error when running bibtex

Hi @iamjakewarner, thanks for making this repo.

I'm running the following:

pdflatex jdf-starter && bibtex jdf-starter and getting the following errors:

This is BibTeX, Version 0.99d (TeX Live 2019)
The top-level auxiliary file: jdf-starter.aux
I found no \citation commands---while reading file jdf-starter.aux
I found no \bibdata command---while reading file jdf-starter.aux
I found no \bibstyle command---while reading file jdf-starter.aux
(There were 3 error messages)

I was wondering if you've ever seen this before? Basically the citations and references aren't being generated properly.

The RMarkdown version doesn't seem to generate output in Palatino.

The version on the left is the output from the RMarkdown / Quarto template. The version on the right is the docx version.
image

The fonts are inconsistent across both versions. I suspect the font in the Word doc (on the right) is the right one.

I tried to play with the following commands in JDF.cls, by changing them to the suggestions listed here :
image

But I'm still unsuccessful. Perhaps something to do with my OS (Mac/ Sonoma) Any help?

Environment CSLReferences undefined error when compiling with pandoc

Problem

I'm using the jdf-template.pandoc file to compile my markdown files into a PDF that follows the JDF format. However, I experience a CSLReferences undefined error when compiling using pandoc here:

└─β–ͺ pandoc M1_Journal.md -o m1pdf.pdf --from markdown --template jdf-template.pandoc --bibliography=references.bib --csl=apa.csl --citeproc
Error producing PDF.
! LaTeX Error: Environment CSLReferences undefined.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...

l.70 \begin{CSLReferences}

For reference, here are my pandoc and pdflatex versions:

 pandoc --version

pandoc 2.19
Compiled with pandoc-types 1.22.2, texmath 0.12.5.2, skylighting 0.13,
citeproc 0.8.0.1, ipynb 0.2, hslua 2.2.1
Scripting engine: Lua 5.4
User data directory: /Users/nhi/.local/share/pandoc
Copyright (C) 2006-2022 John MacFarlane. Web:  https://pandoc.org
This is free software; see the source for copying conditions. There is no
warranty, not even for merchantability or fitness for a particular purpose.

pdflatex --version

pdfTeX 3.141592653-2.6-1.40.24 (TeX Live 2022)
kpathsea version 6.3.4
Copyright 2022 Han The Thanh (pdfTeX) et al.
There is NO warranty.  Redistribution of this software is
covered by the terms of both the pdfTeX copyright and
the Lesser GNU General Public License.
For more information about these matters, see the file
named COPYING and the pdfTeX source.
Primary author of pdfTeX: Han The Thanh (pdfTeX) et al.
Compiled with libpng 1.6.37; using libpng 1.6.37
Compiled with zlib 1.2.11; using zlib 1.2.11
Compiled with xpdf version 4.03

TeX was installed using MacTeX: https://tug.org/mactex/mactex-download.html .

Figure captions are not centered.

Taking a standard template and editing Figure 1 caption, it seems to shift the caption to the left.

According to JDF standard it seems this should be centered, or am I misunderstanding the requirement?

image

jdf.cls sorts references by year, then name

Per the text, JDF specifies references being organized alphabetically by first author’s last name, then by the date published. However, the jdf.cls specifies a sorting order of "ynt" (year, name, title), but to align with the text, it should be "nyt".

Optional System Installation Instructions

Not sure if this is helpful for anyone, but I was looking for a way to "install" this so I could use it for multiple classes instead of copy/pasting it places. Using Ubuntu 20.10 groovy with LatTeX workshop/VSCode. Ended up doing the following

  1. git clone jdf into /usr/share/texmf/tex/latex/jdf
  2. run "texhash"

Thanks for making this available, quite helpful for writing reports for my OMSCS classes

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.