summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/easy-todo
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/easy-todo
Initial commit
Diffstat (limited to 'macros/latex/contrib/easy-todo')
-rw-r--r--macros/latex/contrib/easy-todo/LICENSE201
-rw-r--r--macros/latex/contrib/easy-todo/README3
-rw-r--r--macros/latex/contrib/easy-todo/easy-todo.pdfbin0 -> 135147 bytes
-rw-r--r--macros/latex/contrib/easy-todo/easy-todo.sty94
-rw-r--r--macros/latex/contrib/easy-todo/easy-todo.tex57
5 files changed, 355 insertions, 0 deletions
diff --git a/macros/latex/contrib/easy-todo/LICENSE b/macros/latex/contrib/easy-todo/LICENSE
new file mode 100644
index 0000000000..11069edd79
--- /dev/null
+++ b/macros/latex/contrib/easy-todo/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/macros/latex/contrib/easy-todo/README b/macros/latex/contrib/easy-todo/README
new file mode 100644
index 0000000000..178c5fdff4
--- /dev/null
+++ b/macros/latex/contrib/easy-todo/README
@@ -0,0 +1,3 @@
+README
+
+The easy-todo package allows you to create, track, show and hide notes in a document.
diff --git a/macros/latex/contrib/easy-todo/easy-todo.pdf b/macros/latex/contrib/easy-todo/easy-todo.pdf
new file mode 100644
index 0000000000..5913aee6d9
--- /dev/null
+++ b/macros/latex/contrib/easy-todo/easy-todo.pdf
Binary files differ
diff --git a/macros/latex/contrib/easy-todo/easy-todo.sty b/macros/latex/contrib/easy-todo/easy-todo.sty
new file mode 100644
index 0000000000..359475fe23
--- /dev/null
+++ b/macros/latex/contrib/easy-todo/easy-todo.sty
@@ -0,0 +1,94 @@
+% Created by Juan Rada-Vilela
+% jcrada@fuzzylite.com
+
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{easy-todo}[2014/01/01]
+
+\def\@todoindexas{section}
+\newcommand{\todoindexas}[1]{\def\@todoindexas{#1}}
+
+\def\@todoenable{true}
+\newcommand{\todoenable}[1]{\def\@todoenable{#1}}
+
+\def\@todoobeyfinal{false}
+\newcommand{\todoobeyfinal}[1]{\def\@todoobeyfinal{#1}}
+
+\DeclareOption{chapter}{\todoindexas{chapter}}
+\DeclareOption{section}{\todoindexas{section}}
+\DeclareOption{obeyFinal}{\todoobeyfinal{true}}
+\DeclareOption{enable}{\todoenable{true}}
+\DeclareOption{disable}{\todoenable{false}}
+
+
+\DeclareOption*{%
+ \PackageError{easy-todo}{What is \CurrentOption ?}{Options available: enable, disable, obeyFinal, chapter, section}%
+ \todoindexas{chapter}
+}
+
+\ProcessOptions
+
+\RequirePackage{color} %to add colour
+\RequirePackage{tocloft} %to create index
+\RequirePackage{ifthen} %to ifthenelse conditions
+\RequirePackage{ifdraft} %to detect draft/final options
+
+\newcommand{\todoindextitle}{ToDo}
+\newcommand{\todoindexpagetitle}{P.}
+\newcommand{\todocolor}{\color{red}}
+
+\newcommand{\listoftodosname}{\todoindextitle}
+\newlistof[part]{todos}{lod}{\listoftodosname}
+
+%Command: listoftodos
+%Description: Creates the todo list (Section or Chapter)
+\renewcommand{\listoftodos}{
+ {
+ \ifthenelse{\equal{\@todoenable}{true}}
+ {
+ \todocolor
+ \ifthenelse{\equal{\@todoindexas}{chapter}}
+ {\chapter*{\todoindextitle}}
+ {
+ \ifthenelse{\equal{\@todoindexas}{section}}
+ {\centering\section*{\todoindextitle}}
+ {\PackageError{easy-todo}{Index as \@todoindexas NOT valid}{Choose between chapter or section}}
+ }
+ \flushright{\textbf{\todoindexpagetitle}}
+ \@starttoc{lod}}
+ \newpage
+ }
+ {}
+}
+
+\renewcommand{\thetodos}{\@arabic\c@todos}
+%Command: todo
+%Description: Creates a todo note with the number and information
+%Parameter: TODO note
+\newcommand{\todo}[1]{%
+\todoii{#1}{#1}\unskip%
+}
+
+%Command: todoi
+%Description: Creates a todo note with just a number
+%Parameters: [1] the information to show at the list
+\newcommand{\todoi}[1]{%
+\todoii{}{#1}\unskip%
+}
+
+%Command: todoii
+%Description: Creates a todo note
+%Parameters: [1] the note to show, [2] the information to show at the list
+\newcommand{\todoii}[2]{%
+\ifthenelse{\equal{\@todoobeyfinal}{true}}{%
+ \ifoptionfinal{\todoenable{false}}{\todoenable{true}}%
+}{}%
+\ifthenelse{\equal{\@todoenable}{true}}{%
+\refstepcounter{todos}%
+\noindent{\todocolor\normalfont\scriptsize{\bfseries{\thetodos.#1}}}%
+\addcontentsline{lod}{todos}{\protect{\thetodos. }#2}%
+}{}%
+}
+
+
+
+
diff --git a/macros/latex/contrib/easy-todo/easy-todo.tex b/macros/latex/contrib/easy-todo/easy-todo.tex
new file mode 100644
index 0000000000..fbffc1020d
--- /dev/null
+++ b/macros/latex/contrib/easy-todo/easy-todo.tex
@@ -0,0 +1,57 @@
+\documentclass[a4paper]{article}
+\usepackage[obeyFinal]{easy-todo}
+
+\begin{document}
+ \title{The \texttt{easy-todo} package}
+ \author{by Juan Rada-Vilela (\texttt{jcrada@fuzzylite.com})}
+ \date{January, 2014}
+
+ \maketitle
+
+ \begin{abstract}
+ The \texttt{easy-todo} package allows you to create, track, show and hide notes in a document. In addition, the package allows you to create a summary of notes with their respective points of reference.
+ \end{abstract}
+
+ \section{Options}
+ The following options are available:
+
+ \begin{description}
+ \item [enable] Show the notes and the index.
+ \item [disable] Hide the notes and the index.
+ \item [obeyFinal] Hide the notes except when the documentclass is \textbf{final}. This option overrides the options \textbf{enable} and \textbf{disable}.
+ \item [chapter] Prints the list of TODOs as a chapter.
+ \item [section] Prints the list of TODOs as a section.
+ \end{description}
+
+
+ \section{Commands}
+ \begin{description}
+ \item [\textbackslash todo\{note\}] Creates a note that shows the text ``\texttt{note}''.
+ \item [\textbackslash todoi\{note\}] Creates a note that only shows an automatically generated number. The text ``\texttt{note}'' appears in the index.
+ \item [\textbackslash todoii\{note\}\{information\}] Creates a note that shows the text ``\texttt{note}''. The text ``\texttt{information}'' appears at the index.
+ \item [\textbackslash listoftodos] Creates the list of notes.
+ \end{description}
+
+ \section{Example}
+ \texttt{\textbackslash usepackage[obeyFinal]\{easy-todo\}}
+
+ This is a todo \todo{note} that appears in full everywhere. This is a todoi \todoi{note i} that appears as a number and the note at the index. This is a todoii \todoii{hint}{information} note that shows a hint in place and the information at the index. All these notes disappear when using \texttt{\textbackslash documentclass[final]...}, or when using instead \texttt{\textbackslash usepackage[disable]\{easy-todo\}}.
+
+ \section{Changelog}
+
+ \subsection{Version 3.0}
+ \begin{itemize}
+ \item Added option \textbf{obeyFinal}
+ \item Removed spaces caused by notes when hidden.
+ \item Option \textbf{section} is default.
+ \item Removed options \textbf{enabled}, \textbf{disabled} and \textbf{final}.
+ \end{itemize}
+
+ \subsection{Version 2.0}
+ \begin{itemize}
+ \item Added options \textbf{enable} and \textbf{disable}
+ \item Added commands \textbf{todoi}, \textbf{todoii}
+ \end{itemize}
+
+ \listoftodos
+\end{document}