CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/essaykit

README.md

essaykit - Package

A comprehensive package for creating styled boxes, titles, quotes, and bibliographic references, designed for academic and scientific documents.

Features

  • 🎨 Styled Boxes (\rbox) - Customizable colored boxes with titles
  • πŸ“ Main Titles (\maintitle) - Large, styled section titles
  • πŸ’¬ Quotes (\quoter) - Formatted quotations with author attribution
  • πŸ“ Rules (\rrule) - Clean horizontal separators
  • πŸ“š Sources (\sources) - Bibliography with hyperlink support

Quick Start

Installation

\usepackage{essaykit}

Basic Usage

% Styled box
\rbox[title=Important, color=softblue]{
    This is a highlighted box with a title.
}

% Main title
\maintitle[titlecolor=mybluecolour]{Chapter 1: Introduction}

% Quote
\quoter{Science is organized knowledge.}{Herbert Spencer}

% Horizontal rule
\rrule

% Sources with hyperlinks
\sources{
    \href{https://example.com}{Online Article},
    Book Title by Author,
    Journal Reference
}

Key Features

Customizable Options

All commands support extensive customization through key-value options:

  • Colors: color, textcolor, titlecolor, authorcolor
  • Sizing: width, titlesize, quotesize
  • Spacing: titlespacing, quotespacing

Predefined Colors

greycolour, sharelatexcolour, mybluecolour, lightgray, 
softgray, box-color, darkgray, softblue

Box Examples

% Basic box
\rbox{Simple content}

% Titled box with custom styling
\rbox[title=Warning, color=red, textcolor=white]{
    Important safety information
}

% Custom width box
\rbox[width=0.7\textwidth, color=lightgray]{
    Narrower box for specific layouts
}

Title Examples

% Large blue title
\maintitle[titlecolor=mybluecolour, titlesize=\LARGE]{
    Research Methodology
}

% Custom spacing
\maintitle[titlespacing=1cm]{Section Overview}

Quote Examples

% Styled quote
\quoter[authorcolor=darkgray, quotesize=\Large]{
    The important thing is not to stop questioning.
}{Albert Einstein}

File Structure

essaykit/
β”œβ”€β”€ essaykit.dtx          # Documented source code
β”œβ”€β”€ essaykit.ins          # Installation script
β”œβ”€β”€ essaykit.pdf          # Package documentation
β”œβ”€β”€ README.md           # This file
β”œβ”€β”€ Makefile            # Build automation
└── examples/
    β”œβ”€β”€ basic-example.tex
    β”œβ”€β”€ advanced-example.tex
    └── complete-document.tex

Building from Source

# Generate package file
latex essaykit.ins

# Build documentation  
pdflatex essaykit.dtx
makeindex -s gind.ist essaykit.idx
pdflatex essaykit.dtx
pdflatex essaykit.dtx

# Or use Makefile
make all

Examples

See the examples/ directory for complete working examples:

  • basic-example.tex - Simple usage demonstration
  • advanced-example.tex - Advanced styling options
  • complete-document.tex - Full academic document example

Dependencies

The package automatically loads:

  • tcolorbox - Colored boxes
  • hyperref - PDF hyperlinks
  • xkeyval - Key-value options
  • xcolor - Color support
  • And several others for full functionality

Compatibility

  • Version: Requires (2005/12/01 or later)
  • Engines: pdf, XeLaTeX, Lua
  • Package Conflicts: Handles hyperref conflicts automatically

Common Use Cases

Academic Papers

\maintitle{Abstract}
\rbox[color=lightgray]{
    This paper presents a novel approach to...
}

Laboratory Reports

\rbox[title=Objective, color=softblue]{
    To investigate the relationship between...
}

Presentations

\quoter{Imagination is more important than knowledge.}{Einstein}

Troubleshooting

Package Conflicts

Load conflicting packages before essaykit:

\usepackage{animate}
\usepackage{multimedia}
\usepackage{essaykit}  % Load last

Color Issues

Use predefined colors or define custom ones:

\definecolor{mycolor}{RGB}{100,150,200}
\rbox[color=mycolor]{Content}

License

This package is released under the Project Public License v1.3c or later. See LPPL 1.3 or later for details.

Support

Contributing

Contributions are welcome! Please:

  1. Follow existing code style
  2. Add tests/examples for new features
  3. Update documentation
  4. Submit via standard channels

Version History

  • v1.0 (2025/08/15) - Initial release
    • Core functionality: boxes, titles, quotes, rules, sources
    • Comprehensive key-value option system
    • Hyperref integration

For complete documentation, see essaykit.pdf

Download the contents of this package in one zip archive (193.4k).

essaykit – Get started with basic macros for essays

Essaykit is a simple but useful package to help writing simpleΒ  essays using some shortcuts and tools. The goal of theΒ package is to accelerate the learning curve for new users.Β It is mainly for short STEM essays such as those made in high school.

Packageessaykit
Repositoryhttps://github.com/Swifterhtmler/Essaykit-LaTeX-package
Version1.0 2025-08-30
LicensesThe Project Public License 1.3
MaintainerSwifterhtmler
Contained inTeX Live as essaykit
TopicsEssay
...
Guest Book Sitemap Contact Contact Author