Settings Help
CTAN
Comprehensive TeX Archive Network
Home Upload Browse

Direc­tory tex-archive/macros/latex/contrib/fixme

				 ABOUT FIXME


Copyright (C) 1998-2002, 2004-2007, 2009, 2013 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 following files:

- README (this file)
- NEWS
- fixme.ins
- fixme.dtx
- fixme.el
- THANKS


* Description

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

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]

If you're an AUC-TeX user, you may also install the file 'fixme.el' in a
suitable AUC-TeX style directory.




Local Variables:
mode: outline
End:

Files

Name Size Date Notes
NEWS 4061 2013-01-28 04:07:52
README 2606 2013-01-28 04:07:52
THANKS 1033 2013-01-28 04:07:52
fixme.dtx 166318 2013-01-28 04:07:52
fixme.el 4855 2013-01-28 04:07:52
fixme.ins 3003 2013-01-28 04:07:52
fixme.pdf 384365 2013-01-28 04:07:52

Down­load the com­plete con­tents of this di­rec­tory in one zip archive (368.8k).

FiXme – Insert "fixme" notes into draft doc­u­ments

This pack­age pro­vides a way to in­sert fixme notes in doc­u­ments be­ing de­vel­oped (in draft mode). Such notes can ap­pear in the mar­gin of the doc­u­ment, as in­dex en­tries, in the log file and as warn­ings on std­out. It is also pos­si­ble to sum­ma­rize them in a list. If your doc­u­ment is in a fi­nal ver­sion, any re­main­ing fixme notes will pro­duce an er­ror. FiXme also comes with sup­port for AUC-TeX.

Doc­u­men­ta­tion
Ver­sion4.2
Li­censeThe LaTeX Project Public Li­cense
Copy­right1998-2002,2004-2007,2009,2013 Di­dier Verna
Main­tainerDi­dier Verna
Con­tained inTeXLive as fixme
MiKTeX as fixme
Topics ed­i­tor’s marks, high­lights, etc.
Guest Book Sitemap Contact 2014-04-20 01:31 CEST