LaTeX Commenting Package

Description

A LaTeX package for collaborative academic writing with sophisticated comment management and tracking features. Designed with accessibility in mind, featuring colorblind-safe colors for better collaboration.

Features

• Color-coded inline comments with author attribution
• Distinct footnote-style annotations
• Tracked text additions with author identification
• Author-specific colored environments
• Smart draft/final mode switching
• Colorblind-safe predefined colors

Installation

1. Place commenting.sty in your LaTeX project directory or in your local texmf tree
2. Add the package to your document:

   \usepackage[draft|final]{commenting}
       

Usage

Author Registration

Register authors with their assigned colors:

\registerauthor{<author>}{<color>}    % Register author with chosen color

Available Commands

Each registered author gets access to these commands:

Command	Description
\<author>inline{text}	Add an inline comment
\<author>footnote{text}	Add a footnote comment
\<author>add{text}	Add tracked text changes
\begin{<author>env}...	Create colored environment

Example Usage

This is a paragraph. \aliceinline{needs clarification}

Here's a statement\bobfootnote{Add citation}.

\begin{bobenv}
    This is \aliceadd{very} important.
\end{bobenv}

Full Example

\documentclass{article}
\usepackage[draft]{commenting}

\registerauthor{alice}{cbBlue}    % Register Alice with blue color
\registerauthor{bob}{cbOrange}    % Register Bob with orange color

\title{\texttt{commenting.sty} examples}
\date{}
\begin{document}

\maketitle

\section{Introduction}

This is a paragraph. \aliceinline{needs clarification}

Here's a statement\bobfootnote{Add citation}.

\begin{bobenv}
    This is \aliceadd{very} important.
\end{bobenv}

\end{document}

Color Documentation

Available colorblind-safe colors:

Color Name	Description	RGB Values
cbBlue	Strong blue	(51,114,189)
cbOrange	Vivid orange	(255,127,42)
cbTeal	Bright teal	(64,204,204)
cbRed	Clear red	(217,37,37)
cbPurple	Muted purple	(148,103,189)
cbGreen	Bright green	(0,158,115)
cbYellow	Vivid yellow	(240,228,66)
cbPink	Soft pink	(204,121,167)
cbBrown	Warm brown	(146,73,0)
cbGray	Neutral gray	(128,128,128)

Package Options

Two modes available:

\usepackage[draft]{commenting}  % Show all comments (default)
\usepackage[final]{commenting} % Hide all comments

Author Information

• Author: Jae Hee Lee
• Website: jaeheelee.de
• Version: 2024/11/20 v1.1

License

This package is distributed under the MIT License (MIT).