diff options
Diffstat (limited to 'macros/latex/contrib/coloredtheorem')
| -rw-r--r-- | macros/latex/contrib/coloredtheorem/LICENSE | 415 | ||||
| -rw-r--r-- | macros/latex/contrib/coloredtheorem/README.md | 96 | ||||
| -rw-r--r-- | macros/latex/contrib/coloredtheorem/coloredtheorem-doc.pdf | bin | 0 -> 201428 bytes | |||
| -rw-r--r-- | macros/latex/contrib/coloredtheorem/coloredtheorem-doc.tex | 197 | ||||
| -rw-r--r-- | macros/latex/contrib/coloredtheorem/coloredtheorem.sty | 59 |
5 files changed, 767 insertions, 0 deletions
diff --git a/macros/latex/contrib/coloredtheorem/LICENSE b/macros/latex/contrib/coloredtheorem/LICENSE new file mode 100644 index 0000000000..f8b699e6eb --- /dev/null +++ b/macros/latex/contrib/coloredtheorem/LICENSE @@ -0,0 +1,415 @@ +The LaTeX Project Public License +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- + +LPPL Version 1.3c 2008-05-04 + +Copyright 1999 2002-2008 LaTeX3 Project + Everyone is allowed to distribute verbatim copies of this + license document, but modification of it is not allowed. + + +PREAMBLE +======== + +The LaTeX Project Public License (LPPL) is the primary license under +which the LaTeX kernel and the base LaTeX packages are distributed. + +You may use this license for any work of which you hold the copyright +and which you wish to distribute. This license may be particularly +suitable if your work is TeX-related (such as a LaTeX package), but +it is written in such a way that you can use it even if your work is +unrelated to TeX. + +The section `WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE', +below, gives instructions, examples, and recommendations for authors +who are considering distributing their works under this license. + +This license gives conditions under which a work may be distributed +and modified, as well as conditions under which modified versions of +that work may be distributed. + +We, the LaTeX3 Project, believe that the conditions below give you +the freedom to make and distribute modified versions of your work +that conform with whatever technical specifications you wish while +maintaining the availability, integrity, and reliability of +that work. If you do not see how to achieve your goal while +meeting these conditions, then read the document `cfgguide.tex' +and `modguide.tex' in the base LaTeX distribution for suggestions. + + +DEFINITIONS +=========== + +In this license document the following terms are used: + + `Work' + Any work being distributed under this License. + + `Derived Work' + Any work that under any applicable law is derived from the Work. + + `Modification' + Any procedure that produces a Derived Work under any applicable + law -- for example, the production of a file containing an + original file associated with the Work or a significant portion of + such a file, either verbatim or with modifications and/or + translated into another language. + + `Modify' + To apply any procedure that produces a Derived Work under any + applicable law. + + `Distribution' + Making copies of the Work available from one person to another, in + whole or in part. Distribution includes (but is not limited to) + making any electronic components of the Work accessible by + file transfer protocols such as FTP or HTTP or by shared file + systems such as Sun's Network File System (NFS). + + `Compiled Work' + A version of the Work that has been processed into a form where it + is directly usable on a computer system. This processing may + include using installation facilities provided by the Work, + transformations of the Work, copying of components of the Work, or + other activities. Note that modification of any installation + facilities provided by the Work constitutes modification of the Work. + + `Current Maintainer' + A person or persons nominated as such within the Work. If there is + no such explicit nomination then it is the `Copyright Holder' under + any applicable law. + + `Base Interpreter' + A program or process that is normally needed for running or + interpreting a part or the whole of the Work. + + A Base Interpreter may depend on external components but these + are not considered part of the Base Interpreter provided that each + external component clearly identifies itself whenever it is used + interactively. Unless explicitly specified when applying the + license to the Work, the only applicable Base Interpreter is a + `LaTeX-Format' or in the case of files belonging to the + `LaTeX-format' a program implementing the `TeX language'. + + + +CONDITIONS ON DISTRIBUTION AND MODIFICATION +=========================================== + +1. Activities other than distribution and/or modification of the Work +are not covered by this license; they are outside its scope. In +particular, the act of running the Work is not restricted and no +requirements are made concerning any offers of support for the Work. + +2. You may distribute a complete, unmodified copy of the Work as you +received it. Distribution of only part of the Work is considered +modification of the Work, and no right to distribute such a Derived +Work may be assumed under the terms of this clause. + +3. You may distribute a Compiled Work that has been generated from a +complete, unmodified copy of the Work as distributed under Clause 2 +above, as long as that Compiled Work is distributed in such a way that +the recipients may install the Compiled Work on their system exactly +as it would have been installed if they generated a Compiled Work +directly from the Work. + +4. If you are the Current Maintainer of the Work, you may, without +restriction, modify the Work, thus creating a Derived Work. You may +also distribute the Derived Work without restriction, including +Compiled Works generated from the Derived Work. Derived Works +distributed in this manner by the Current Maintainer are considered to +be updated versions of the Work. + +5. If you are not the Current Maintainer of the Work, you may modify +your copy of the Work, thus creating a Derived Work based on the Work, +and compile this Derived Work, thus creating a Compiled Work based on +the Derived Work. + +6. If you are not the Current Maintainer of the Work, you may +distribute a Derived Work provided the following conditions are met +for every component of the Work unless that component clearly states +in the copyright notice that it is exempt from that condition. Only +the Current Maintainer is allowed to add such statements of exemption +to a component of the Work. + + a. If a component of this Derived Work can be a direct replacement + for a component of the Work when that component is used with the + Base Interpreter, then, wherever this component of the Work + identifies itself to the user when used interactively with that + Base Interpreter, the replacement component of this Derived Work + clearly and unambiguously identifies itself as a modified version + of this component to the user when used interactively with that + Base Interpreter. + + b. Every component of the Derived Work contains prominent notices + detailing the nature of the changes to that component, or a + prominent reference to another file that is distributed as part + of the Derived Work and that contains a complete and accurate log + of the changes. + + c. No information in the Derived Work implies that any persons, + including (but not limited to) the authors of the original version + of the Work, provide any support, including (but not limited to) + the reporting and handling of errors, to recipients of the + Derived Work unless those persons have stated explicitly that + they do provide such support for the Derived Work. + + d. You distribute at least one of the following with the Derived Work: + + 1. A complete, unmodified copy of the Work; + if your distribution of a modified component is made by + offering access to copy the modified component from a + designated place, then offering equivalent access to copy + the Work from the same or some similar place meets this + condition, even though third parties are not compelled to + copy the Work along with the modified component; + + 2. Information that is sufficient to obtain a complete, + unmodified copy of the Work. + +7. If you are not the Current Maintainer of the Work, you may +distribute a Compiled Work generated from a Derived Work, as long as +the Derived Work is distributed to all recipients of the Compiled +Work, and as long as the conditions of Clause 6, above, are met with +regard to the Derived Work. + +8. The conditions above are not intended to prohibit, and hence do not +apply to, the modification, by any method, of any component so that it +becomes identical to an updated version of that component of the Work as +it is distributed by the Current Maintainer under Clause 4, above. + +9. Distribution of the Work or any Derived Work in an alternative +format, where the Work or that Derived Work (in whole or in part) is +then produced by applying some process to that format, does not relax or +nullify any sections of this license as they pertain to the results of +applying that process. + +10. a. A Derived Work may be distributed under a different license + provided that license itself honors the conditions listed in + Clause 6 above, in regard to the Work, though it does not have + to honor the rest of the conditions in this license. + + b. If a Derived Work is distributed under a different license, that + Derived Work must provide sufficient documentation as part of + itself to allow each recipient of that Derived Work to honor the + restrictions in Clause 6 above, concerning changes from the Work. + +11. This license places no restrictions on works that are unrelated to +the Work, nor does this license place any restrictions on aggregating +such works with the Work by any means. + +12. Nothing in this license is intended to, or may be used to, prevent +complete compliance by all parties with all applicable laws. + + +NO WARRANTY +=========== + +There is no warranty for the Work. Except when otherwise stated in +writing, the Copyright Holder provides the Work `as is', without +warranty of any kind, either expressed or implied, including, but not +limited to, the implied warranties of merchantability and fitness for a +particular purpose. The entire risk as to the quality and performance +of the Work is with you. Should the Work prove defective, you assume +the cost of all necessary servicing, repair, or correction. + +In no event unless required by applicable law or agreed to in writing +will The Copyright Holder, or any author named in the components of the +Work, or any other party who may distribute and/or modify the Work as +permitted above, be liable to you for damages, including any general, +special, incidental or consequential damages arising out of any use of +the Work or out of inability to use the Work (including, but not limited +to, loss of data, data being rendered inaccurate, or losses sustained by +anyone as a result of any failure of the Work to operate with any other +programs), even if the Copyright Holder or said author or said other +party has been advised of the possibility of such damages. + + +MAINTENANCE OF THE WORK +======================= + +The Work has the status `author-maintained' if the Copyright Holder +explicitly and prominently states near the primary copyright notice in +the Work that the Work can only be maintained by the Copyright Holder +or simply that it is `author-maintained'. + +The Work has the status `maintained' if there is a Current Maintainer +who has indicated in the Work that they are willing to receive error +reports for the Work (for example, by supplying a valid e-mail +address). It is not required for the Current Maintainer to acknowledge +or act upon these error reports. + +The Work changes from status `maintained' to `unmaintained' if there +is no Current Maintainer, or the person stated to be Current +Maintainer of the work cannot be reached through the indicated means +of communication for a period of six months, and there are no other +significant signs of active maintenance. + +You can become the Current Maintainer of the Work by agreement with +any existing Current Maintainer to take over this role. + +If the Work is unmaintained, you can become the Current Maintainer of +the Work through the following steps: + + 1. Make a reasonable attempt to trace the Current Maintainer (and + the Copyright Holder, if the two differ) through the means of + an Internet or similar search. + + 2. If this search is successful, then enquire whether the Work + is still maintained. + + a. If it is being maintained, then ask the Current Maintainer + to update their communication data within one month. + + b. If the search is unsuccessful or no action to resume active + maintenance is taken by the Current Maintainer, then announce + within the pertinent community your intention to take over + maintenance. (If the Work is a LaTeX work, this could be + done, for example, by posting to comp.text.tex.) + + 3a. If the Current Maintainer is reachable and agrees to pass + maintenance of the Work to you, then this takes effect + immediately upon announcement. + + b. If the Current Maintainer is not reachable and the Copyright + Holder agrees that maintenance of the Work be passed to you, + then this takes effect immediately upon announcement. + + 4. If you make an `intention announcement' as described in 2b. above + and after three months your intention is challenged neither by + the Current Maintainer nor by the Copyright Holder nor by other + people, then you may arrange for the Work to be changed so as + to name you as the (new) Current Maintainer. + + 5. If the previously unreachable Current Maintainer becomes + reachable once more within three months of a change completed + under the terms of 3b) or 4), then that Current Maintainer must + become or remain the Current Maintainer upon request provided + they then update their communication data within one month. + +A change in the Current Maintainer does not, of itself, alter the fact +that the Work is distributed under the LPPL license. + +If you become the Current Maintainer of the Work, you should +immediately provide, within the Work, a prominent and unambiguous +statement of your status as Current Maintainer. You should also +announce your new status to the same pertinent community as +in 2b) above. + + +WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE +====================================================== + +This section contains important instructions, examples, and +recommendations for authors who are considering distributing their +works under this license. These authors are addressed as `you' in +this section. + +Choosing This License or Another License +---------------------------------------- + +If for any part of your work you want or need to use *distribution* +conditions that differ significantly from those in this license, then +do not refer to this license anywhere in your work but, instead, +distribute your work under a different license. You may use the text +of this license as a model for your own license, but your license +should not refer to the LPPL or otherwise give the impression that +your work is distributed under the LPPL. + +The document `modguide.tex' in the base LaTeX distribution explains +the motivation behind the conditions of this license. It explains, +for example, why distributing LaTeX under the GNU General Public +License (GPL) was considered inappropriate. Even if your work is +unrelated to LaTeX, the discussion in `modguide.tex' may still be +relevant, and authors intending to distribute their works under any +license are encouraged to read it. + +A Recommendation on Modification Without Distribution +----------------------------------------------------- + +It is wise never to modify a component of the Work, even for your own +personal use, without also meeting the above conditions for +distributing the modified component. While you might intend that such +modifications will never be distributed, often this will happen by +accident -- you may forget that you have modified that component; or +it may not occur to you when allowing others to access the modified +version that you are thus distributing it and violating the conditions +of this license in ways that could have legal implications and, worse, +cause problems for the community. It is therefore usually in your +best interest to keep your copy of the Work identical with the public +one. Many works provide ways to control the behavior of that work +without altering any of its licensed components. + +How to Use This License +----------------------- + +To use this license, place in each of the components of your work both +an explicit copyright notice including your name and the year the work +was authored and/or last substantially modified. Include also a +statement that the distribution and/or modification of that +component is constrained by the conditions in this license. + +Here is an example of such a notice and statement: + + %% pig.dtx + %% Copyright 2005 M. Y. Name + % + % This work may be distributed and/or modified under the + % conditions of the LaTeX Project Public License, either version 1.3 + % of this license or (at your option) any later version. + % The latest version of this license is in + % http://www.latex-project.org/lppl.txt + % and version 1.3 or later is part of all distributions of LaTeX + % version 2005/12/01 or later. + % + % This work has the LPPL maintenance status `maintained'. + % + % The Current Maintainer of this work is M. Y. Name. + % + % This work consists of the files pig.dtx and pig.ins + % and the derived file pig.sty. + +Given such a notice and statement in a file, the conditions +given in this license document would apply, with the `Work' referring +to the three files `pig.dtx', `pig.ins', and `pig.sty' (the last being +generated from `pig.dtx' using `pig.ins'), the `Base Interpreter' +referring to any `LaTeX-Format', and both `Copyright Holder' and +`Current Maintainer' referring to the person `M. Y. Name'. + +If you do not want the Maintenance section of LPPL to apply to your +Work, change `maintained' above into `author-maintained'. +However, we recommend that you use `maintained', as the Maintenance +section was added in order to ensure that your Work remains useful to +the community even when you can no longer maintain and support it +yourself. + +Derived Works That Are Not Replacements +--------------------------------------- + +Several clauses of the LPPL specify means to provide reliability and +stability for the user community. They therefore concern themselves +with the case that a Derived Work is intended to be used as a +(compatible or incompatible) replacement of the original Work. If +this is not the case (e.g., if a few lines of code are reused for a +completely different task), then clauses 6b and 6d shall not apply. + + +Important Recommendations +------------------------- + + Defining What Constitutes the Work + + The LPPL requires that distributions of the Work contain all the + files of the Work. It is therefore important that you provide a + way for the licensee to determine which files constitute the Work. + This could, for example, be achieved by explicitly listing all the + files of the Work near the copyright notice of each file or by + using a line such as: + + % This work consists of all files listed in manifest.txt. + + in that place. In the absence of an unequivocal list it might be + impossible for the licensee to determine what is considered by you + to comprise the Work and, in such a case, the licensee would be + entitled to make reasonable conjectures as to which files comprise + the Work. diff --git a/macros/latex/contrib/coloredtheorem/README.md b/macros/latex/contrib/coloredtheorem/README.md new file mode 100644 index 0000000000..805393b738 --- /dev/null +++ b/macros/latex/contrib/coloredtheorem/README.md @@ -0,0 +1,96 @@ +# coloredtheorem + +A colourful boxed theorem environment, combining `tcolorbox` and breakable boxes. It supports full `tcolorbox` customization, automatic numbering, `\label{...}` and `\ref{…}`, and `\listof…` + +<!-- +-------- + +<picture> + <source + media="(prefers-color-scheme: dark)" + srcset=" + https://api.star-history.com/svg?repos=joaomlourenco/coloredtheorem&type=Date&theme=dark + " + /> + <source + media="(prefers-color-scheme: light)" + srcset=" + https://api.star-history.com/svg?repos=joaomlourenco/coloredtheorem&type=Date + " + /> + <img + width="500" + alt="Star History Chart" + src="https://api.star-history.com/svg?repos=joaomlourenco/coloredtheorem&type=Date" + /> +</picture> + +-------- +--> + +## Introduction + +The `coloredtheorem` package is a simple environment, which takes no options, and that allows to write stuff inside boxes from `tcolorbox`. So, this packages includes `tcolorbox` if necessary. You may include `tcolorbox` with your own favourite options prior to including this package. + +Akin to `\newtheorem` from the `amsmath` package, the user should start by defining a new theorem/box group and customize its aspect. Each new environment will have its own counter/numnering. Notice that `\label{...}` and `\ref{...}` work as expected. The is also a command to generate the corresponding `\listof...` + +## Usage + +* `\cthnewtheorem{<envname>}{<Name>}[<tcolorbox options>]` + * Load the tcbtheorem package. This package will load tcolorbox if not already loaded. +* `\cthnewtheorem{<envname>}{<Name>}[<tcolorbox options>]` + * `<envname>` is the environment name, e.g., theorem. + * `<Name>` is the name for new environment being defined, e.g., Theorem. + * `<tcolorbox options>` options to be passed to the `tcolorbox` environment to customize the boxes for the given environment (this argument is optional). +* `\begin{<envname>}{<Caption>}[<tcolorbox options>]<Contents>\end{<envname>}` + * `<envname>` is the environment name, e.g., theorem. + * `<Caption>` is the caption/title of the box. + * `<tcolorbox options>` options to be passed to the `tcolorbox` environment, which will override the defaults given in `\cthnewtheorem`. + * `<Contents>` the contents to by typeset inside the coulored environment. +* `\listof<envname>s` + * Where `<envname>` is the environment name, e.g., `\listoftheorems`. Please notice that there is a ‘s’ (plural) after `<envname>`. + +## Example + +Let’s start by creating two new environments, one for algorithms and another for examples, both defaulting to a gray frame, the former with a yellowish background and the latter with a lighter gray background. + + \cthnewtheorem{algorithm}{Algorithm}[coltitle=black, colback=yellow!10, + colframe=black!15] + \cthnewtheorem{example}{Example}[coltitle=black, colback=black!5, + colframe=black!30] + +An algorithm box will be created with: + + \begin{cthalgorithm}{Advance a counter to the next value in a domain + $\omega \in \mathbb{N}$.} + + Algorithm body here! + \end{cthalgorithm} + +<img width="491" alt="image" src="https://github.com/joaomlourenco/tcbtheorem/assets/2064643/54147631-3f5d-4ae0-a8b7-8b18b48d8db2"> + +Now, let's rewrite Algorithm 1, but now with a different customized visual, just for this entry! The customization (3rd) argument is passed straight to the `tcolorbox` environment, so anything valid for `tcolorbox` is also valid here. + +<img width="491" alt="image" src="https://github.com/joaomlourenco/tcbtheorem/assets/2064643/be180e78-bc59-48ff-9efa-a26af5dae0bd"> + +(page break here!) + +<img width="489" alt="image" src="https://github.com/joaomlourenco/tcbtheorem/assets/2064643/04c6fcaa-1a27-4550-8b17-2ae4d90809b0"> + +Now, let’s add an example here, this time using the default visual that was given when creating the environment with `\cthnewtheorem`… + +<img width="490" alt="image" src="https://github.com/joaomlourenco/tcbtheorem/assets/2064643/835c1537-5b18-48b6-8ac1-ba6a6cff7b1b"> + +And now and example with no caption and a different visual... this example will not go into the` \listofexamples` below! + +<img width="492" alt="image" src="https://github.com/joaomlourenco/tcbtheorem/assets/2064643/329e61a9-a12b-4cfe-9edf-1977f8158ee9"> + +Now let’s print the lists of algorithms and examples. Remember to add the prefix cthth to the listof, i.e., `\cthlistofalgorithms` and `\cthlistofexamples`! + +## List of Algorithms +<img width="492" alt="image" src="https://github.com/joaomlourenco/tcbtheorem/assets/2064643/f935bfcb-3387-426e-8511-c1f0efdcdd85"> + +## List of Examples +<img width="487" alt="image" src="https://github.com/joaomlourenco/tcbtheorem/assets/2064643/033f83d4-24c3-4e9d-8947-135f5765e3f3"> + + diff --git a/macros/latex/contrib/coloredtheorem/coloredtheorem-doc.pdf b/macros/latex/contrib/coloredtheorem/coloredtheorem-doc.pdf Binary files differnew file mode 100644 index 0000000000..046c79dcc6 --- /dev/null +++ b/macros/latex/contrib/coloredtheorem/coloredtheorem-doc.pdf diff --git a/macros/latex/contrib/coloredtheorem/coloredtheorem-doc.tex b/macros/latex/contrib/coloredtheorem/coloredtheorem-doc.tex new file mode 100644 index 0000000000..55ae3d3ae5 --- /dev/null +++ b/macros/latex/contrib/coloredtheorem/coloredtheorem-doc.tex @@ -0,0 +1,197 @@ +\documentclass{article} + +\usepackage[margin=1.6in]{geometry} +\usepackage{fancyvrb} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% AMSMATH stuff +% \usepackage{amsthm} +% \usepackage{thmtools} +% \usepackage{amsfonts} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% TCBTHEOREM stuff +\usepackage{coloredtheorem} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% EXAMPLE document +\usepackage{amsfonts} +\usepackage{kantlipsum} +\usepackage{tabularx} +\usepackage{xspace} +\newcommand\tcthrm{\texttt{coloredtheorem}\xspace} + +%% ALGPSEUDOCODEX stuff +\usepackage{algorithm} +\usepackage[ + noEnd=false, + beginComment={$\triangleright$~\scriptsize}, + beginLComment={$\triangleright$~}, + endLComment={}, +]{algpseudocodex} + +\algnewcommand\Input{\textbf{Input:~}} +\algrenewcommand\Output{\textbf{Output:~}} +\algrenewcommand\algorithmicforall{\textbf{for each}} +\algnewcommand\Vspace{% + {\setlength\itemsep{-1ex}\item[]~} +} +\algnewcommand\Let[2]{\State \ensuremath{#1 \gets #2}} +\algnewcommand\And{\ensuremath{\wedge}\xspace} +\algnewcommand\Or{\ensuremath{\vee}\xspace} +\algnewcommand\Not{\ensuremath{\neg}\xspace} + +\usepackage[colorlinks,linkcolor=blue!80]{hyperref} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% MAIN DOCUMENT +\begin{document} + \title{The \tcthrm package} + \author{João M. Lourenço\\\texttt{\small joao.lourenco@fct.unl.pt}} + \date{March 31, 2024} + + \maketitle + + +\section{Introduction} +\label{sec:introduction} + +The \tcthrm package is a simple environment, which takes no options, and that allows to write stuff inside boxes from \texttt{tcolorbox}. So, this packages includes \texttt{tcolorbox} if necessary. You may include \texttt{tcolorbox} with your own favourite options prior to including this package. + +Akin to \verb!\newtheorem! from the \verb!amsmath! package, the user should start by defining a new \emph{theorem/box} group and customize its aspect. Each new environment will have its own counter/numbering. Notice that \verb!\label{…}! and \verb!\ref{…}! work as expected. The is also a command to generate the corresponding \emph{list of …} + +\section{Usage} +\label{sec:usage} + +\begin{description} + \item[]{\bfseries\verb+\usepackage{coloredtheorem}+} + \begin{description} + \item[]Load the \texttt{coloredtheorem} package. This package will load \texttt{tcolorbox} if necessary. + \end{description} + \item[]{\bfseries\Verb[commandchars=!()]+\!tcbth()newtheorem{<envname>}{<Name>}[<tcolorbox options>]+} + \begin{description} + \item[]\verb+<envname>+ is the environment name, e.g., \verb!theorem!. + \item[]\verb+<Name>+ is the name for new environment being defined, e.g., \emph{Theorem}. + \item[]\verb+<tcolorbox options>+ options to be passed to the \verb+tcolorbox+ environment to customize the boxes for the given environment (this argument is optional). + \end{description} + \item[]{\bfseries\Verb[commandchars=!()]+\begin{!tcbth()<envname>}{<Caption>}[<tcolorbox options>]<Contents>\end{!tcbth()<envname>}+} + \begin{description} + \item[]\verb+<envname>+ is the environment name, e.g., \verb+theorem+. + \item[]\verb+<Caption>+ is the caption/title of the box. + \item[]\verb+<tcolorbox options>+ options to be passed to the \verb+tcolobox+ environment, which will override the defaults given in \verb+\cthnewtheorem+. + \item[]\verb+<Contents>+ the contents to by typeset inside the coulored environment. + \end{description} + \item[]{\bfseries\Verb[commandchars=!()]+\!tcbth()listof<envname>s+} + \begin{description} + \item[]\verb+<envname>+ is the environment name, e.g., e.g., \Verb[commandchars=!()]+\!tcbth()listoftheorems+. Please notice that there is a `s' (plural) after \verb+<envname>+. + \end{description} +\end{description} + +\section{Example} +\label{sec:examples} + +Let's start by creating two new environments, one for \emph{algorithms} and another for \emph{examples}, both defaulting to a gray frame, the former with a yellowish background and the latter with a lighter gray background. + +\begin{verbatim} +\cthnewtheorem{algorithm}{Algorithm}[coltitle=black, colback=yellow!10, + colframe=black!15] +\cthnewtheorem{example}{Example}[coltitle=black, colback=black!5, + colframe=black!30] +\end{verbatim} + +\cthnewtheorem{algorithm}{Algorithm}[coltitle=black, colback=yellow!10, colframe=black!15] +\cthnewtheorem{example}{Example}[coltitle=black, colback=black!5, colframe=black!30] + + +An algorithm box will be created with: +\begin{verbatim} +\begin{cthalgorithm}{Advance a counter to the next value in a domain + $\omega \in \mathbb{N}$.} + +Algorithm body here! +\end{cthalgorithm} +\end{verbatim} + +\newcommand{\bracesemptyset}{\ensuremath{\lbrace\,\rbrace}} + +\begin{cthalgorithm}{Advance a counter to the next value in a domain $\omega \in \mathbb{N}$.} + \label{alg:advance1} +\begin{algorithmic}[1] + \Statex \Input $\alpha$: The current value; and $\omega$: the domain. + \Statex \Output The next value of $\alpha$ within the domain $\omega$. + \LComment{\color{blue} + e.g., $\alpha = 3 \And \omega = \lbrace 8, 3, 2, 21, 5, 1 \rbrace \rightarrow 5$} + + \Vspace + + \Function{advance}{$\alpha$: int, $\omega$: set} $\rightarrow$ int \textbf{is} + % \Statex\Comment{As we are incrementing one by one on the operation IDs, the complexity of this function is linear in the value of the largest operation id.} + \Let {\alpha} {\alpha + 1} + \Comment{try the next value} + \While{$\alpha \not\in \omega \And \omega \neq \bracesemptyset$} + \Comment{if this value is not in the domain} + \Let {\alpha} {\alpha + 1} + \Comment{try the next value} + \EndWhile + \If{$\omega \neq \bracesemptyset$} + \Let {\omega} {\omega \,\backslash \lbrace \alpha \rbrace} + \Comment{remove the value from the domain} + \EndIf + \State \Return $\alpha$ + \Comment{\color{red} the next value (or the last value plus one if no more values)} + \EndFunction +\end{algorithmic} +\end{cthalgorithm} + +Now, let's rewrite \autoref{alg:advance1}, but now with a different customized visual, just for this entry! The customization (3rd) argument is passed straight to the \texttt{tcolorbox} environment, so anything valid for \texttt{tcolorbox} is also valid here. + +\begin{cthalgorithm}{Advance a counter to the next value in a domain $\omega \in \mathbb{N}$, but now with a customized visual. Also, notice that this algorithm breaks the page boundaries.}[coltitle=white, colback=green!10, colframe=green!70!black, fonttitle=\sffamily\bfseries\large, colbacktitle=red!50!white] + \label{alg:advance2} +\begin{algorithmic}[1] + \Statex \Input $\alpha$: The current value; and $\omega$: the domain. + \Statex \Output The next value of $\alpha$ within the domain $\omega$. + \LComment{\color{blue} + e.g., $\alpha = 3 \And \omega = \lbrace 8, 3, 2, 21, 5, 1 \rbrace \rightarrow 5$} + + \Vspace + + \Function{advance}{$\alpha$: int, $\omega$: set} $\rightarrow$ int \textbf{is} + % \Statex\Comment{As we are incrementing one by one on the operation IDs, the complexity of this function is linear in the value of the largest operation id.} + \Let {\alpha} {\alpha + 1} + \Comment{try the next value} + \While{$\alpha \not\in \omega \And \omega \neq \bracesemptyset$} + \Comment{if this value is not in the domain} + \Let {\alpha} {\alpha + 1} + \Comment{try the next value} + \EndWhile + \If{$\omega \neq \bracesemptyset$} + \Let {\omega} {\omega \,\backslash \lbrace \alpha \rbrace} + \Comment{remove the value from the domain} + \EndIf + \State \Return $\alpha$ + \Comment{\color{red} the next value (or the last value plus one if no more values)} + \EndFunction +\end{algorithmic} +\end{cthalgorithm} + +Now, let's add an example here, this time using the default visual that was given when creating the environment with \verb+\cthnewtheorem+… + +\begin{cthexample}{This is an example!} + \emph{\kant[3]} +\end{cthexample} + +And now an example with no caption and a different visual… this example will not go into the \verb+\listofexamples+ below! + +\begin{cthexample}{}[coltitle=yellow, colback=blue!30, colframe=blue!70] + \emph{\kant[4]} +\end{cthexample} + +Now let's print the lists of algorithms and examples. Remember to add the prefix \texttt{cthth} to the \texttt{listof}, i.e., \verb+\cthlistofalgorithms+ and \verb+\cthlistofexamples+! + +\cthlistofalgorithms + +\cthlistofexamples + +\end{document} diff --git a/macros/latex/contrib/coloredtheorem/coloredtheorem.sty b/macros/latex/contrib/coloredtheorem/coloredtheorem.sty new file mode 100644 index 0000000000..dd553ba75d --- /dev/null +++ b/macros/latex/contrib/coloredtheorem/coloredtheorem.sty @@ -0,0 +1,59 @@ +%% This is file `tcbtheorem.sty', +%% +%% Copyright (C) 2024 by João Lourenço <joao.lourenco@fct.unl.pt> +%% +%% This file may be distributed and/or modified under the conditions of +%% the LaTeX Project Public License, either version 1.3c of this license +%% or (at your option) any later version. The latest version of this +%% license is in: +%% +%% http://www.latex-project.org/lppl.txt +%% +%% and version 1.3c or later is part of all distributions of LaTeX +%% version 2006/05/20 or later. +%% +\NeedsTeXFormat{LaTeX2e}[2020/06/01] +\ProvidesPackage{coloredtheorem} + [2024/03/31 v1.0 - a theorem-like environment inside a tcolobox] + +\RequirePackage{tcolorbox} +\tcbuselibrary{breakable} + +\gdef\tcbth{cth} + +\expandafter\NewDocumentCommand\csname\tcbth newtheorem\endcsname { m m O{} }{% + \expandafter\newcounter\expandafter{\tcbth#1}% + \expandafter\gdef\csname\tcbth#1name\endcsname{#2}% + \expandafter\gdef\csname\tcbth list#1name\endcsname{List of #2s}% + \expandafter\gdef\csname#1autorefname\endcsname{#2}% + \AtEndPreamble{% + \ifdefined\crefname\expandafter\crefname\csname\tcbth#1\endcsname{#2}{#2s}\fi}% + \expandafter\gdef\csname\tcbth listof#1s\endcsname + {% + \section*{\csname\tcbth list#1name\endcsname}% + \expandafter\@starttoc\expandafter{lo#1}% + } + \expandafter\NewDocumentEnvironment\expandafter{\tcbth#1} {O{} m O{}}% + {% \begin{tcb<SOMETHING>} + \begin{center}% + \ifx\relax##1\relax + \ifx\relax##2\relax\else + \expandafter\refstepcounter\expandafter{\tcbth#1}% + \expandafter\addcontentsline\expandafter{lo#1}{subsection} + {\protect\numberline{\csname the\tcbth#1\endcsname}##2}% + \fi + \else + \expandafter\addcontentsline\expandafter{lo#1}{subsection} + {\protect\numberline{\csname the\tcbth#1\endcsname}##1}% + \fi + \begin{tcolorbox}[breakable, + title={\textbf{\csname\tcbth#1name\endcsname + \ifx\relax##2\relax\else + ~\csname the\tcbth#1\endcsname\fi}~~##2}, + #3, ##3, + ]% + }{% \end{tcb<SOMETHING>} + \end{tcolorbox}% + \end{center}% + }% +} |