CTAN
Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/fixme

README
				 ABOUT FIXME


Copyright (C) 1998-2002, 2004-2007, 2009, 2013, 2017 Didier Verna

Author: Didier Verna <didier@didierverna.net>

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:

Down­load the con­tents of this pack­age in one zip archive (368.2k).

FiXme – Col­lab­o­ra­tive an­no­ta­tion tool for

FiXme is a col­lab­o­ra­tive an­no­ta­tion tool for doc­u­ments. An­no­tat­ing a doc­u­ment here refers to in­sert­ing meta-notes, that is, notes that do not be­long to the doc­u­ment it­self, but rather to its de­vel­op­ment or re­view­ing pro­cess. Such notes may in­volve things of dif­fer­ent im­por­tance lev­els, rang­ing from sim­ple “fix the spelling” flags to crit­i­cal “this para­graph is a lie” men­tions. An­no­ta­tions like this should be vis­i­ble dur­ing the de­vel­op­ment or re­view­ing phase, but should nor­mally dis­ap­pear in the fi­nal ver­sion of the doc­u­ment.

FiXme is de­signed to ease and au­to­mate the pro­cess of man­ag­ing col­lab­o­ra­tive an­no­ta­tions, by of­fer­ing a set of pre­de­fined note lev­els and lay­outs, the pos­si­bil­ity to reg­is­ter mul­ti­ple au­thors, to ref­er­ence an­no­ta­tions by list­ing and in­dex­ing etc. FiXme is ex­ten­si­ble, giv­ing you the pos­si­bil­ity to cre­ate new lay­outs or even com­plete “themes“, and also comes with sup­port for AUC-.

Pack­ageFiXme
Ver­sion4.3
Li­cense The Project Public Li­cense 1
Main­tainerDi­dier Verna
Con­tained inTeX Live as fixme
MiKTeX as fixme
Topics ed­i­tor’s marks, high­lights, etc.
...
Guest Book Sitemap Contact Contact Author