search

T-F-S / tcolorbox

A LaTeX package to create highly customizable colored boxes.
http://www.ctan.org/pkg/tcolorbox
LaTeX Project Public License v1.3c
213 stars 15 forks source link

Cite LaTeX `usrguide` as doc for `\NewDocumentCommand` and friends #263

Open muzimuzhi opened 6 months ago

muzimuzhi commented 6 months ago

Since v5.1.0, code in xparse library "was migrated to other parts of the tcolorbox package" (see #180), so users will see mentions to \NewDocumentCommand, \NewDocumentEnvironments, and their friends throughout the tcolorbox manual.

Before, these mentions appear only in doc section for xparse library, which cited the xparse package manual at its beginning.

As these commands are relatively young to the LaTeX kernel, I'm afraid that they are not covered by most introductory LaTeX resources. Maybe it worth citing LaTeX's usrguide in places where \NewDocumentCommand and \NewDocumentEnvironment are mentioned at first time (in docs for \NewTotalTColorBox and \NewTColorBox, respectively), and in xparse library doc.

@manual{latexproject:usrguide,
   author    = {The \LaTeX{} Project Team},
   title     = {{\LaTeX} for authors --- current version},
   url       = {https://mirrors.ctan.org/macros/latex/base/usrguide.pdf},
   date      = {2023-05-23},
}

PS: Came up with this idea when I was viewing changes to tcolorbox.doc.bib in commit 067f384 (6.2.0, 2024-01-10).

T-F-S commented 5 months ago

As these commands are relatively young to the LaTeX kernel, I'm afraid that they are not covered by most introductory LaTeX resources. Maybe it worth citing LaTeX's usrguide in places where \NewDocumentCommand and \NewDocumentEnvironment are mentioned at first time (in docs for \NewTotalTColorBox and \NewTColorBox, respectively), and in xparse library doc.

Yes, I think such a citation is useful. Thank you - I will add this to the documentation.