From 01b14a20f8942ab0c52aeb8abffa85b811c7a95a Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Fri, 16 Jul 2021 03:01:07 +0000 Subject: CTAN sync 202107160301 --- macros/latex/contrib/to-be-determined/DEPENDS.txt | 3 + macros/latex/contrib/to-be-determined/README.md | 28 ++++++++ .../contrib/to-be-determined/to-be-determined.pdf | Bin 0 -> 183512 bytes .../contrib/to-be-determined/to-be-determined.sty | 47 +++++++++++++ .../contrib/to-be-determined/to-be-determined.tex | 73 +++++++++++++++++++++ 5 files changed, 151 insertions(+) create mode 100644 macros/latex/contrib/to-be-determined/DEPENDS.txt create mode 100644 macros/latex/contrib/to-be-determined/README.md create mode 100644 macros/latex/contrib/to-be-determined/to-be-determined.pdf create mode 100644 macros/latex/contrib/to-be-determined/to-be-determined.sty create mode 100644 macros/latex/contrib/to-be-determined/to-be-determined.tex (limited to 'macros/latex/contrib/to-be-determined') diff --git a/macros/latex/contrib/to-be-determined/DEPENDS.txt b/macros/latex/contrib/to-be-determined/DEPENDS.txt new file mode 100644 index 0000000000..ba363a7c9f --- /dev/null +++ b/macros/latex/contrib/to-be-determined/DEPENDS.txt @@ -0,0 +1,3 @@ +hard xkeyval +hard xcolor +hard soul diff --git a/macros/latex/contrib/to-be-determined/README.md b/macros/latex/contrib/to-be-determined/README.md new file mode 100644 index 0000000000..26adf210da --- /dev/null +++ b/macros/latex/contrib/to-be-determined/README.md @@ -0,0 +1,28 @@ +[![make](https://github.com/yegor256/to-be-determined/actions/workflows/latexmk.yml/badge.svg)](https://github.com/yegor256/to-be-determined/actions/workflows/latexmk.yml) +[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/to-be-determined/blob/master/LICENSE.txt) + +This LaTeX package helps you highlight pieces of your code that needs +further work (TBD stands for "to be determined"). +The package uses [`xcolor`](https://ctan.org/pkg/minted) +and [`soul`](https://ctan.org/pkg/soul) packages. + +First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages) +from [CTAN](https://ctan.org/pkg/to-be-determined) +and then use in the preamble: + +```tex +\documentclass{article} +\usepackage{to-be-determined} +\begin{document} +The budget is \tbd{99.00 USD}. +\end{document} +``` + +The full example and all commands are available in the +[`to-be-determined.tex`](https://github.com/yegor256/to-be-determined/blob/master/to-be-determined.tex) file. + +If you want to contribute yourself, make a fork, then create a branch, +then run `make` in the root directory. +It should compile everything without errors. If not, submit an issue and wait. +Otherwise, make your changes and then run `make` again. If the build is +still clean, submit a pull request. diff --git a/macros/latex/contrib/to-be-determined/to-be-determined.pdf b/macros/latex/contrib/to-be-determined/to-be-determined.pdf new file mode 100644 index 0000000000..02529dfa3d Binary files /dev/null and b/macros/latex/contrib/to-be-determined/to-be-determined.pdf differ diff --git a/macros/latex/contrib/to-be-determined/to-be-determined.sty b/macros/latex/contrib/to-be-determined/to-be-determined.sty new file mode 100644 index 0000000000..7dcea97033 --- /dev/null +++ b/macros/latex/contrib/to-be-determined/to-be-determined.sty @@ -0,0 +1,47 @@ +% (The MIT License) +% +% Copyright (c) 2021 Yegor Bugayenko +% +% Permission is hereby granted, free of charge, to any person obtaining a copy +% of this software and associated documentation files (the 'Software'), to deal +% in the Software without restriction, including without limitation the rights +% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +% copies of the Software, and to permit persons to whom the Software is +% furnished to do so, subject to the following conditions: +% +% The above copyright notice and this permission notice shall be included in all +% copies or substantial portions of the Software. +% +% THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +% SOFTWARE. + +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{to-be-determined}[2021/07/15 0.1.0 Highlighting places requiring future work] + +\RequirePackage{xkeyval} +\newif\iftbdhide +\DeclareOptionX{hide}{\tbdhidetrue} +\newif\iftbdoff +\DeclareOptionX{off}{\tbdofftrue} +\ProcessOptionsX\relax + +\RequirePackage{xcolor} +\RequirePackage{soul} + +\newcommand\tbd[1]{{% + \iftbdoff\else% + \sethlcolor{yellow}% + \iftbdhide% + \hl{TBD} + \else% + \hl{#1} + \fi% + \fi% +}} + +\endinput diff --git a/macros/latex/contrib/to-be-determined/to-be-determined.tex b/macros/latex/contrib/to-be-determined/to-be-determined.tex new file mode 100644 index 0000000000..cdab462bd1 --- /dev/null +++ b/macros/latex/contrib/to-be-determined/to-be-determined.tex @@ -0,0 +1,73 @@ +% (The MIT License) +% +% Copyright (c) 2021 Yegor Bugayenko +% +% Permission is hereby granted, free of charge, to any person obtaining a copy +% of this software and associated documentation files (the 'Software'), to deal +% in the Software without restriction, including without limitation the rights +% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +% copies of the Software, and to permit persons to whom the Software is +% furnished to do so, subject to the following conditions: +% +% The above copyright notice and this permission notice shall be included in all +% copies or substantial portions of the Software. +% +% THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +% SOFTWARE. + +\documentclass[12pt]{article} +\usepackage[tt=false,type1=true]{libertine} +\usepackage{multicol} +\usepackage{to-be-determined} +\usepackage{ffcode} +\title{\ff{to-be-determined}: \LaTeX{} Package \\ for highlighting places that require more work} +\author{Yegor Bugayenko} +\date{0.1.0 2021/07/15} +\begin{document} +\pagenumbering{gobble} +\raggedbottom +\setlength{\parindent}{0pt} +\setlength{\columnsep}{32pt} +\setlength{\parskip}{6pt} +\maketitle + +This package helps you highlight places in your articles +and make sure it looks nice. Install it from CTAN and then +use like this: + +\begin{multicols}{2} +\setlength{\parskip}{0pt} +\scriptsize +\raggedcolumns +\begin{verbatim} +\documentclass{article} +\usepackage{to-be-determined} +\begin{document} +The budget is \tbd{99.00 USD}. +\end{document} +\end{verbatim} + +\columnbreak + +The budget is \tbd{99.00 USD}. + +\end{multicols} + +With this package it's also possible to highlight +\tbd{larger pieces of text that take \textbf{a few lines}} on the page. + +If you want to hide the content of what's inside \ff{\char`\\tbd}, +use \ff{hide} option of the package. They will all be replaced with +\tbd{TBD} placeholders. + +If you want them to disappear entirely, use the \ff{off} package option. + +More details about this package you find +in the \ff{yegor256/to-be-determined} GitHub repository. + +\end{document} \ No newline at end of file -- cgit v1.2.3