From bd8c84d3086241f36de1b38eec9ca56b3672af31 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 21 Sep 2009 22:54:55 +0000 Subject: fixme 4.0 (21sep09) git-svn-id: svn://tug.org/texlive/trunk@15411 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/fixme/NEWS | 20 ++- Master/texmf-dist/doc/latex/fixme/README | 62 +++++++--- Master/texmf-dist/doc/latex/fixme/THANKS | 9 +- Master/texmf-dist/doc/latex/fixme/fixme.el | 179 ++++++++++++++++++--------- Master/texmf-dist/doc/latex/fixme/fixme.pdf | Bin 131710 -> 334003 bytes Master/texmf-dist/doc/latex/fixme/header.inc | 47 +++++++ 6 files changed, 238 insertions(+), 79 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/fixme/header.inc (limited to 'Master/texmf-dist/doc/latex/fixme') diff --git a/Master/texmf-dist/doc/latex/fixme/NEWS b/Master/texmf-dist/doc/latex/fixme/NEWS index 7138b341703..24a21531c22 100644 --- a/Master/texmf-dist/doc/latex/fixme/NEWS +++ b/Master/texmf-dist/doc/latex/fixme/NEWS @@ -18,6 +18,24 @@ version 1999/06/01 or later. FiXme consists of the files listed in the file `README'. +* Version 4.0 +============= +** Support for collaborative annotations +suggested by Michael Kubovy +** Support for "targeted" notes and environments +(highlighting a portion of text), suggested by Mark Edgington. +** Support for "floating" notes +(not specific to any portion of text), suggested by Rasmus Villemoes. +** Support for alternate layout autoswitch in TeX's inner mode +suggested by Will Robertson. +** Support for automatic language tracking in multilingual documents +** Support for themes +** Extended support for user-provided layouts +** Support for key=value argument syntax in the whole user interface +** New command \fxsetup +** Homogenize log and console messages +** Heavy internals refactoring + * Version 3.4 ============= ** \fixme, \fxerror, \fxwarning and \fxnote are now robust @@ -49,7 +67,7 @@ thanks to Marcel Maretic . ** Fix incompatibility with AMS-Book reported by Claude Lacoursičre: \@starttoc takes 2 arguments. ** Fix incompatibility with Beamer -reported by Akim Demaille: protect contents of lox file.ug in environments. +reported by Akim Demaille: protect contents of lox file in environments. * Version 3.1 ============= diff --git a/Master/texmf-dist/doc/latex/fixme/README b/Master/texmf-dist/doc/latex/fixme/README index e8563445c4e..1faff13b466 100644 --- a/Master/texmf-dist/doc/latex/fixme/README +++ b/Master/texmf-dist/doc/latex/fixme/README @@ -3,7 +3,7 @@ Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2005, 2006 Didier Verna -Copyright (C) 2007 Didier Verna +Copyright (C) 2007, 2009 Didier Verna This file is part of FiXme. @@ -28,34 +28,62 @@ FiXme consists of the following files: * Description ============= - This package provides you with a way of inserting fixme notes in your -documents. Such notes can appear inline, as marginal notes, footnotes, index -entries, in the log file and as warnings on stdout. It is also possible to -summarize them in a list. When you switch from draft to final mode, any -remaining fixme note will be logged, but removed from the document's body. -Additionally, critical notes will abort compilation with an informative -message. FiXme also comes with support for AUC-TeX. +FiXme is a collaborative annotation tool for LaTeX documents. Annotating a +document refers here to inserting meta-notes, that is, notes that do not +belong to the document itself, but rather to its development or reviewing +process. Such notes may involve things of different importance levels, ranging +from simple "fix the spelling" flags to critical "this paragraph is a lie" +mentions. Annotations like this should be visible during the development or +reviewing phase, but should normally disapear in the final version of the +document. + +FiXme is designed to ease and automate the process of managing collaborative +annotations, by offering a set of predefined note levels and layouts, the +possibility to register multiple note authors, to reference annotations by +listing and indexing etc. FiXme is extensible, giving you the possibility to +create new layouts or even complete "themes", and also comes with support for +AUC-TeX. + +FiXme homepage: http://www.lrde.epita.fr/~didier/software/latex.php#fixme * Installation ============== - To install the package, please follow these steps: +If you are building FiXme from the tarball you need to execute the following +steps in order to extract the necessary files. FiXme also requires the DoX +package (version 2.0, release date 2009/09/21 or later), to build. It is not +required to use the paclage. + +[pdf]latex fixme.ins +[pdf]latex fixme.dtx +[pdf]latex fixme.dtx +makeindex -s gind fixme.idx +[pdf]latex fixme.dtx +[pdf]latex fixme.dtx + +After that, you need to install the generated documentation and style files to +a location where LATEX can find them. For a TDS-compliant layout, the +following locations are suggested: + +[TEXMF]/tex/latex/fixme/fixme.sty +[TEXMF]/tex/latex/fixme/layouts/fxlayout*.sty +[TEXMF]/tex/latex/fixme/layouts/env/fxenvlayout*.sty +[TEXMF]/tex/latex/fixme/layouts/target/fxtargetlayout*.sty +[TEXMF]/tex/latex/fixme/themes/fxtheme*.sty +[TEXMF]/doc/latex/fixme/fixme.[pdf|dvi] -- Run LaTeX on the file `fixme.ins' to create the style file `fixme.sty'. -- Run LaTeX on the file `fixme.dtx' to create the doc file `fixme.dvi'. -- Install these files anywhere you see fit. +If you're an AUC-TeX user, you may also install the file 'fixme.el' in a +suitable AUC-TeX style directory. - If you're an AUC-TeX user, you can also install the file `fixme.el' in -a suitable AUC-TeX style directory. Have fun! -- -Didier Verna, didier@lrde.epita.fr, http://www.lrde.epita.fr/~didier +Didier Verna -EPITA / LRDE, 14-16 rue Voltaire Tel.+33 (0)1 44 08 01 85 -94276 Le Kremlin-Bicętre, France Fax.+33 (0)1 53 14 59 22 +Sientific site: http://www.lrde.epita.fr/~didier +Music (Jazz) site: http://www.didierverna.com diff --git a/Master/texmf-dist/doc/latex/fixme/THANKS b/Master/texmf-dist/doc/latex/fixme/THANKS index eb09c4d4326..6ed5ab551b3 100644 --- a/Master/texmf-dist/doc/latex/fixme/THANKS +++ b/Master/texmf-dist/doc/latex/fixme/THANKS @@ -22,10 +22,11 @@ FiXme consists of the files listed in the file `README'. ** The following persons have contributed code, bug reports, localization, ** suggestions etc: -Philipp Stephani, Will Robertson, Jochen Wuttke, Jens Remus, Brian van den -Broek, Lars Madsen, Stefan Mann, Marcel Maretic, Claude Lacoursičre, Arnold -Beckmann, Akim Demaille, Kim Rud Bille, Knut Lickert, Kasper B. Graversen, -Augustín Martín, Ulf Jaenicke-Roessler, Riccardo Murri, Harald Harders. +Michael Kubovy, Mark Edgington, Rasmus Villemoes, Philipp Stephani, Will +Robertson, Jochen Wuttke, Jens Remus, Brian van den Broek, Lars Madsen, Stefan +Mann, Marcel Maretic, Claude Lacoursičre, Arnold Beckmann, Akim Demaille, Kim +Rud Bille, Knut Lickert, Kasper B. Graversen, Augustín Martín, Ulf +Jaenicke-Roessler, Riccardo Murri, Harald Harders. diff --git a/Master/texmf-dist/doc/latex/fixme/fixme.el b/Master/texmf-dist/doc/latex/fixme/fixme.el index be652c66eb6..83692f111e5 100644 --- a/Master/texmf-dist/doc/latex/fixme/fixme.el +++ b/Master/texmf-dist/doc/latex/fixme/fixme.el @@ -1,13 +1,14 @@ ;;; fixme.el --- AUC-TeX style file for FiXme -;; Copyright (C) 2000, 2002, 2004, 2006 Didier Verna. +;; Copyright (C) 2000, 2002, 2004, 2006, 2009 Didier Verna. ;; Author: Didier Verna ;; Maintainer: Didier Verna ;; Created: Tue Apr 18 14:49:29 2000 -;; Last Revision: Tue Oct 19 18:07:27 2004 +;; Last Revision: Sat Sep 19 14:19:30 2009 ;; Keywords: tex abbrev data + ;; This file is part of FiXme. ;; FiXme may be distributed and/or modified under the @@ -23,7 +24,8 @@ ;;; Commentary: -;; Contents management by FCM version 0.1-b2. +;; Contents management by FCM version 0.1. + ;;; Code: @@ -32,61 +34,124 @@ (function (lambda () (TeX-add-symbols - '("fixmelogo") - - '("listoffixmes") - '("listfixmename") - - '("FXInline") - '("FXMargin") - '("FXMarginClue") - '("FXFootnote") - '("FXUser") - '("fixmeindexname") - '("FXIndex") - - '("FXNote") - '("FXWarning") - '("FXError") - '("FXFatal") - - '("fixmenoteprefix") - '("fixmenoteindexname") - '("fixmewarningprefix") - '("fixmewarningindexname") - '("fixmeerrorprefix") - '("fixmeerrorindexname") - '("fixmefatalprefix") - '("fixmefatalindexname") - - '("thefixmecount") - '("thefixmenotecount") - '("thefixmewarningcount") - '("thefixmeerrorcount") - '("thefixmefatalcount") - - '("fxnote" [ "Layout" ] "Note") - '("fxwarning" [ "Layout" ] "Warning") - '("fxerror" [ "Layout" ] "Error") - '("fixme" [ "Layout" ] "FiXme") - - ;; Obsolete stuff: - '("FiXmeInline") - '("FiXmeMargin") - '("FiXmeFootnote") - '("FiXmeIndex") - '("FiXmeInfo") - '("FiXmeWarning") - '("FiXmeUser") - ) - (LaTeX-add-environments - '("anfxnote") - '("anfxwarning") - '("anfxerror") - '("afixme") - ) - ))) + '("fxsetup") + + '("fxnote" ["Options"] "Annotation") + '("fxwarning" ["Options"] "Annotation") + '("fxerror" ["Options"] "Annotation") + '("fxfatal" ["Options"] "Annotation") + '("fixme" ["Options"] "Annotation") + + '("fxnote*" ["Options"] "Annotation" t) + '("fxwarning*" ["Options"] "Annotation" t) + '("fxerror*" ["Options"] "Annotation" t) + '("fxfatal*" ["Options"] "Annotation" t) + + '("listoffixmes" 0) + + '("fxuselayouts" t) + '("fxloadlayouts" t) + '("fxuseenvlayout" t) + '("fxloadenvlayouts" t) + '("fxusetargetlayout" t) + '("fxloadtargetlayouts" t) + + '("fxsetface" "Face" "Value") + + '("FXRegisterAuthor" "Command prefix" "Environment prefix" "Tag") + + '("fxusetheme" "Theme") + + '("FXRegisterLayout" "Name" "Macro") + '("FXRegisterLayout*" "Name" "Macro") + '("FXRegisterEnvLayout" "Name" "Opening macro" "Closing macro") + '("FXRegisterTargetLayout" "Name" "Macro") + + '("FXRequireLayout" "Name") + '("FXRequireEnvLayout" "Name") + '("FXRequireTargetLayout" "Name") + + '("FXProvidesLayout" "Name" ["Release information"]) + '("FXProvidesEnvLayout" "Name" ["Release information"]) + '("FXProvidesTargetLayout" "Name" ["Release information"]) + + '("fxenglishnotename" 0) + '("fxenglishnotesname" 0) + '("fxenglishwarningname" 0) + '("fxenglishwarningsname" 0) + '("fxenglisherrorname" 0) + '("fxenglisherrorsname" 0) + '("fxenglishfatalname" 0) + '("fxenglishfatalsname" 0) + '("fxfrenchnotename" 0) + '("fxfrenchnotesname" 0) + '("fxfrenchwarningname" 0) + '("fxfrenchwarningsname" 0) + '("fxfrencherrorname" 0) + '("fxfrencherrorsname" 0) + '("fxfrenchfatalname" 0) + '("fxfrenchfatalsname" 0) + '("fxspanishnotename" 0) + '("fxspanishnotesname" 0) + '("fxspanishwarningname" 0) + '("fxspanishwarningsname" 0) + '("fxspanisherrorname" 0) + '("fxspanisherrorsname" 0) + '("fxspanishfatalname" 0) + '("fxspanishfatalsname" 0) + '("fxitaliannotename" 0) + '("fxitaliannotesname" 0) + '("fxitalianwarningname" 0) + '("fxitalianwarningsname" 0) + '("fxitalianerrorname" 0) + '("fxitalianerrorsname" 0) + '("fxitalianfatalname" 0) + '("fxitalianfatalsname" 0) + '("fxgermannotename" 0) + '("fxgermannotesname" 0) + '("fxgermanwarningname" 0) + '("fxgermanwarningsname" 0) + '("fxgermanerrorname" 0) + '("fxgermanerrorsname" 0) + '("fxgermanfatalname" 0) + '("fxgermanfatalsname" 0) + '("fxdanishnotename" 0) + '("fxdanishnotesname" 0) + '("fxdanishwarningname" 0) + '("fxdanishwarningsname" 0) + '("fxdanisherrorname" 0) + '("fxdanisherrorsname" 0) + '("fxdanishfatalname" 0) + '("fxdanishfatalsname" 0) + '("fxcroatiannotename" 0) + '("fxcroatiannotesname" 0) + '("fxcroatianwarningname" 0) + '("fxcroatianwarningsname" 0) + '("fxcroatianerrorname" 0) + '("fxcroatianerrorsname" 0) + '("fxcroatianfatalname" 0) + '("fxcroatianfatalsname" 0) + + '("englishlistfixmename" 0) + '("frenchlistfixmename" 0) + '("spanishlistfixmename" 0) + '("italianlistfixmename" 0) + '("germanlistfixmename" 0) + '("danishlistfixmename" 0) + '("croatianlistfixmename" 0)) + (LaTeX-add-environments + '("anfxnote" ["Options"] "Summary") + '("anfxwarning" ["Options"] "Summary") + '("anfxerror" ["Options"] "Summary") + '("anfxfatal" ["Options"] "Summary") + '("afixme" ["Options"] "Summary") + + ;; #### NOTE: I would like to insert a couple of braces here. + '("anfxnote*" ["Options"] "Summary") + '("anfxwarning*" ["Options"] "Summary") + '("anfxerror*" ["Options"] "Summary") + '("anfxfatal*" ["Options"] "Summary"))))) diff --git a/Master/texmf-dist/doc/latex/fixme/fixme.pdf b/Master/texmf-dist/doc/latex/fixme/fixme.pdf index 6e825533783..dfe8945bbd4 100644 Binary files a/Master/texmf-dist/doc/latex/fixme/fixme.pdf and b/Master/texmf-dist/doc/latex/fixme/fixme.pdf differ diff --git a/Master/texmf-dist/doc/latex/fixme/header.inc b/Master/texmf-dist/doc/latex/fixme/header.inc new file mode 100644 index 00000000000..494412b3763 --- /dev/null +++ b/Master/texmf-dist/doc/latex/fixme/header.inc @@ -0,0 +1,47 @@ +%% +%% This is file `header.inc', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% fixme.dtx (with options: `header') +%% + + +%% Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2005, 2006 Didier Verna +%% Copyright (C) 2007, 2009 Didier Verna + +%% This file is part of FiXme. + +%% FiXme may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either version 1.1 +%% 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.1 or later is part of all distributions of LaTeX +%% version 1999/06/01 or later. + +%% FiXme consists of the files listed in the file `README'. + +%% \CharacterTable +%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +%% Digits \0\1\2\3\4\5\6\7\8\9 +%% Exclamation \! Double quote \" Hash (number) \# +%% Dollar \$ Percent \% Ampersand \& +%% Acute accent \' Left paren \( Right paren \) +%% Asterisk \* Plus \+ Comma \, +%% Minus \- Point \. Solidus \/ +%% Colon \: Semicolon \; Less than \< +%% Equals \= Greater than \> Question mark \? +%% Commercial at \@ Left bracket \[ Backslash \\ +%% Right bracket \] Circumflex \^ Underscore \_ +%% Grave accent \` Left brace \{ Vertical bar \| +%% Right brace \} Tilde \~} +\ProvidesPackage{fixme}[2009/09/21 v4.0 Insert fixme notes in your documents] + +\newcommand\fixmelogo{\textsf{FiXme}} + +\endinput +%% +%% End of file `header.inc'. -- cgit v1.2.3