From 9e7d9e01534a2c0515c3d5ce32d9c485fd6b559e Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 16 Nov 2013 23:51:51 +0000 Subject: easy-todo (16nov13) git-svn-id: svn://tug.org/texlive/trunk@32164 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/easy-todo/README | 205 +-------------------- .../texmf-dist/doc/latex/easy-todo/easy-todo.pdf | Bin 38538 -> 130400 bytes .../texmf-dist/doc/latex/easy-todo/easy-todo.tex | 28 ++- .../texmf-dist/tex/latex/easy-todo/easy-todo.sty | 53 ++++-- 4 files changed, 55 insertions(+), 231 deletions(-) diff --git a/Master/texmf-dist/doc/latex/easy-todo/README b/Master/texmf-dist/doc/latex/easy-todo/README index d0146ca088d..f0bb918d4b7 100644 --- a/Master/texmf-dist/doc/latex/easy-todo/README +++ b/Master/texmf-dist/doc/latex/easy-todo/README @@ -1,208 +1,5 @@ README - The \texttt{easy-todo} package allows to add TODO notes all along the document and show the list of TODOs as an index with references. + The easy-todo package allows to create TODO notes in documents and show the list of TODOs as an index with references. -LICENCE - - 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/Master/texmf-dist/doc/latex/easy-todo/easy-todo.pdf b/Master/texmf-dist/doc/latex/easy-todo/easy-todo.pdf index 9076ab73290..8e7a098944b 100644 Binary files a/Master/texmf-dist/doc/latex/easy-todo/easy-todo.pdf and b/Master/texmf-dist/doc/latex/easy-todo/easy-todo.pdf differ diff --git a/Master/texmf-dist/doc/latex/easy-todo/easy-todo.tex b/Master/texmf-dist/doc/latex/easy-todo/easy-todo.tex index 440efb05d9b..dfeddbacffb 100644 --- a/Master/texmf-dist/doc/latex/easy-todo/easy-todo.tex +++ b/Master/texmf-dist/doc/latex/easy-todo/easy-todo.tex @@ -5,12 +5,12 @@ \begin{document} \title{The \texttt{easy-todo} package} \author{Juan Rada-Vilela} - \date{January, 2011} + \date{November, 2013} \maketitle \begin{abstract} - The \texttt{easy-todo} package allows to add TODO notes all along the document and show the list of TODOs as an index with references. + The \texttt{easy-todo} package allows to create TODO notes in a document and show the list of TODOs as an index with references. \end{abstract} \section{Options} @@ -18,7 +18,9 @@ \begin{description} \item [enabled] Shows the TODO notes as well as the index. - \item [disabled] Hides the TODO notes as well as the index. Useful for printing drafts without the TODO notes but keeping them in the document. + \item [enable] Same as before. + \item [disabled] Hides the TODO notes as well as the index. Useful for printing drafts without the TODO notes, but keeping them in the document. + \item [disable] Same as before. \item [final] Same as disabled. \item [chapter] Prints the list of TODOs as a chapter. \item [section] Prints the list of TODOs as a section. @@ -32,13 +34,19 @@ \section{Commands} \begin{description} - \item [\textbackslash todo\{note\}] Adds in the same location a TODO note with text \texttt{note}. - \item [\textbackslash listoftodos] Creates the list of TODOs in the same location as used. + \item [\textbackslash todo\{note\}] Creates a note with text ``\texttt{note}''. + \item [\textbackslash todoi\{note-i\}] Creates an empty note with information ``\texttt{note-i}'' appearing only at the index. + \item [\textbackslash todoii\{note-ii\}\{information\}] Creates a note with ``\texttt{note-ii}'' inplace and ``\texttt{information}'' at the index. + \item [\textbackslash listoftodos] Creates the list of TODOs. \end{description} + + \section{Changelog} + \begin{itemize} + \item Added options \textbf{enable} and \textbf{disable} + \item Added commands \textbf{todoi}, \textbf{todoii} + \end{itemize} - \todo{This is a TODO note} + 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 at the place and the information at the index. - \todo{I wish there was more to mention about this package, but it is so simple that it is straight-forward to understand the beginner's code} - - \listoftodos -\end{document} \ No newline at end of file + \listoftodos +\end{document} diff --git a/Master/texmf-dist/tex/latex/easy-todo/easy-todo.sty b/Master/texmf-dist/tex/latex/easy-todo/easy-todo.sty index ea07fbd0fe6..a4bbeec7d4f 100644 --- a/Master/texmf-dist/tex/latex/easy-todo/easy-todo.sty +++ b/Master/texmf-dist/tex/latex/easy-todo/easy-todo.sty @@ -1,7 +1,7 @@ % Created by Juan Rada-Vilela \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{easy-todo}[2011/01/01] +\ProvidesPackage{easy-todo}[2013/11/15] \def\@todoindexas{chapter} \newcommand{\todoindexas}[1]{\def\@todoindexas{#1}} @@ -14,29 +14,30 @@ \DeclareOption{section}{\todoindexas{section}} \DeclareOption{final}{\todoenable{false}} \DeclareOption{enabled}{\todoenable{true}} +\DeclareOption{enable}{\todoenable{true}} \DeclareOption{disabled}{\todoenable{false}} +\DeclareOption{disable}{\todoenable{false}} + \DeclareOption*{% - \PackageError{easy-todo}{What is \CurrentOption ?}{Options available: final, enabled, disabled, chapter, section}% + \PackageError{easy-todo}{What is \CurrentOption ?}{Options available: final, enable(d), disable(d), chapter, section}% \todoindexas{chapter} } \ProcessOptions -% \RequirePackage[colorlinks]{hyperref} %Para hipervínculos en el documento (ver \iniciar) -\RequirePackage{color} %Para poner color en notas y pendientes -\RequirePackage{tocloft} %Para configurar índice general, de figuras y cuadros +\RequirePackage{color} %to add colour +\RequirePackage{tocloft} %to create index \RequirePackage{ifthen} \newcommand{\todoindextitle}{ToDo} \newcommand{\todoindexpagetitle}{P.} \newcommand{\todocolor}{\color{red}} -%Índice de Pendientes \newcommand{\listoftodosname}{\todoindextitle} \newlistof[part]{todos}{lod}{\listoftodosname} -%Comando: listoftodos -%Descripción: Crea el índice de pendientes. +%Command: listoftodos +%Description: Creates the todo list (Section or Chapter) \renewcommand{\listoftodos}{ { \ifthenelse{\equal{\@todoenable}{true}} @@ -57,13 +58,31 @@ } \renewcommand{\thetodos}{\@arabic\c@todos} -%Comando: pendiente -%Descripción: Agrega una anotación al índice de pendientes y la muestra en el lugar donde fue agregada. Para mostrar los pendientes, ejecutar antes de \configurar \habilitarpendientes -%Parámetros: [1] Texto del pendiente (e.g. Mejorar redacción) -\newcommand{\todo}[1]{ - \ifthenelse{\equal{\@todoenable}{true}}{ - \refstepcounter{todos} - \noindent{\todocolor\normalfont\scriptsize{\bfseries{\thetodos. }#1}} - \addcontentsline{lod}{todos}{\protect{\thetodos. }#1} - }{} +%Command: todo +%Description: Creates a todo note with the number and information +%Parameter: TODO note +\newcommand{\todo}[1]{% +\todoii{#1}{#1}% +} + +%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} +} + +%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{\@todoenable}{true}}{% +\refstepcounter{todos}% +\noindent{\todocolor\normalfont\scriptsize{\bfseries{\thetodos.#1}}}% +\addcontentsline{lod}{todos}{\protect{\thetodos. }#2}% +}{} } + + + + -- cgit v1.2.3