chicago-style-guide-latex

Provides structured documentation, templates, and automation scripts for formatting LaTeX documents according to the Chicago Manual of Style (Notes and Bibliography). It includes setup instructions, citation guidelines using biblatex-chicago, and automated compilation scripts with logging.

https://github.com/kgruiz/chicago-style-guide-latex

Science Score: 31.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary

Keywords

academic-writing biber biblatex bibliography bibtex chicago-manual-of-style chicago-style citations formatting latex xelatex
Last synced: 6 months ago · JSON representation ·

Repository

Provides structured documentation, templates, and automation scripts for formatting LaTeX documents according to the Chicago Manual of Style (Notes and Bibliography). It includes setup instructions, citation guidelines using biblatex-chicago, and automated compilation scripts with logging.

Basic Info
  • Host: GitHub
  • Owner: kgruiz
  • Language: TeX
  • Default Branch: main
  • Homepage:
  • Size: 200 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
academic-writing biber biblatex bibliography bibtex chicago-manual-of-style chicago-style citations formatting latex xelatex
Created about 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme Citation

Docs/README.md

Chicago Style Guide in LaTeX

A comprehensive guide for formatting LaTeX documents using the Chicago Manual of Style (Notes and Bibliography).

This repository provides structured instructions, templates, and scripts to facilitate document preparation in LaTeX while adhering to Chicago-style formatting. The same content is available in three formats: - Markdown (.md) – Easier to read and edit as plain text. - LaTeX (.tex) – Best for generating PDFs with proper formatting. - XML (.xml) – Optimized for structured data processing and AI usage.

Table of Contents

Install

Prerequisites

Ensure you have a LaTeX distribution with XeLaTeX and Biber installed. The recommended distributions for various platforms:

  • macOS (via MacTeX): Download and install MacTeX, which includes XeLaTeX and Biber. bash brew install biber

  • Linux (Debian/Ubuntu): bash sudo apt-get update sudo apt-get install texlive-xetex texlive-bibtex-extra biber

  • Linux (Arch-based): bash sudo pacman -Syu texlive-core texlive-bibtexextra biber

  • Windows: Install TeX Live and ensure xelatex and biber are added to your system PATH.

Cloning the Repository

bash git clone https://github.com/kgruiz/Chicago-Style-Guide.git cd Chicago-Style-Guide

Usage

This repository contains structured guides for formatting LaTeX documents according to the Chicago Manual of Style. Choose the appropriate section based on your needs:

  • Overall Document Formatting (Overall/)

Provides guidelines for setting up LaTeX documents, including: - Document class selection - Page layout configuration - Font settings - Header and footer formatting - Enabling double-spacing

For compilation, refer to the Compile Script section.

  • Chicago-Style Citations (Citations/)

Contains detailed instructions for using the biblatex-chicago package to manage citations. Includes: - Configuration of Chicago-style footnotes and bibliography - Sample .bib file with references - Citation commands (\autocite, \footcite, etc.) - Example LaTeX document demonstrating correct formatting

For compilation, refer to the Compile Script section.

Compile Script

The repository includes an automation script (compile.zsh) that simplifies the compilation process by logging output and cleaning up auxiliary files if no errors occur. Customize the TEX_FILE and LOG_FILE variables at the top of the script as needed.

To run the script:

Run this once to make it executable: zsh chmod +x compile.zsh

Then execute it: bash ./compile.zsh

Alternatively, run without changing permissions: zsh zsh compile.zsh

Maintainers

Owner

  • Login: kgruiz
  • Kind: user

Citation (Citations/compile.zsh)

LOG_FILE="compile.log"
TEX_FILE="essay"

echo "------------------------------------------------" | tee "$LOG_FILE"
echo "xelatex $TEX_FILE.tex" | tee -a "$LOG_FILE"
echo "------------------------------------------------" | tee -a "$LOG_FILE"
xelatex -interaction=nonstopmode -file-line-error "$TEX_FILE.tex" 2>&1 | tee -a "$LOG_FILE"

echo "------------------------------------------------" | tee -a "$LOG_FILE"
echo "biber $TEX_FILE" | tee -a "$LOG_FILE"
echo "------------------------------------------------" | tee -a "$LOG_FILE"
biber "$TEX_FILE" 2>&1 | tee -a "$LOG_FILE"

echo "------------------------------------------------" | tee -a "$LOG_FILE"
echo "xelatex $TEX_FILE.tex" | tee -a "$LOG_FILE"
echo "------------------------------------------------" | tee -a "$LOG_FILE"
xelatex -interaction=nonstopmode -file-line-error "$TEX_FILE.tex" 2>&1 | tee -a "$LOG_FILE"

echo "------------------------------------------------" | tee -a "$LOG_FILE"
echo "xelatex $TEX_FILE.tex" | tee -a "$LOG_FILE"
echo "------------------------------------------------" | tee -a "$LOG_FILE"
xelatex -interaction=nonstopmode -file-line-error "$TEX_FILE.tex" 2>&1 | tee -a "$LOG_FILE"

# Check for errors
if ! grep -q "Error" "$LOG_FILE"; then
    echo "No errors detected. Deleting auxiliary files..."
    rm -f "$TEX_FILE.aux" "$TEX_FILE.bbl" "$TEX_FILE.bcf" "$TEX_FILE.blg" \
          "$TEX_FILE.log" "$TEX_FILE.out" "$TEX_FILE.run.xml" "$TEX_FILE.toc"
else
    echo "Errors detected. Auxiliary files not deleted."
fi

GitHub Events

Total
  • Push event: 5
Last Year
  • Push event: 5

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels