Directory macros/latex/contrib/essaykit
essaykit - LaTeX Package
A comprehensive LaTeX 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 demonstrationadvanced-example.tex
- Advanced styling optionscomplete-document.tex
- Full academic document example
Dependencies
The package automatically loads:
tcolorbox
- Colored boxeshyperref
- PDF hyperlinksxkeyval
- Key-value optionsxcolor
- Color support- And several others for full functionality
Compatibility
- LaTeX Version: Requires LaTeX2ε (2005/12/01 or later)
- Engines: pdfLaTeX, XeLaTeX, LuaLaTeX
- 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 LaTeX Project Public License v1.3c or later. See LPPL 1.3 or later for details.
Support
- Documentation:
essaykit.pdf
- Examples: See
examples/
directory - Issues: Report on GitHub
- Contact: RKTuotanto@icloud.com
Contributing
Contributions are welcome! Please:
- Follow existing code style
- Add tests/examples for new features
- Update documentation
- 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Β LaTeX essays using some shortcuts and tools. The goal of theΒ package is to accelerate the learning curve for new LaTeX users.Β It is mainly for short STEM essays such as those made in high school.
Package | essaykit |
Repository | https://github.com/Swifterhtmler/Essaykit-LaTeX-package |
Version | 1.0 2025-08-30 |
Licenses | The LaTeX Project Public License 1.3 |
Maintainer | Swifterhtmler |
Contained in | TeX Live as essaykit |
Topics | Essay |
