CTAN
Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/fixme

README.md

ABOUT FIXME

Copy­right (C) 1998-2002, 2004-2007, 2009, 2013, 2017 Di­dier Verna

Author: Di­dier Verna <di­dier@di­dierverna.net>

This file is part of FiXme.

FiXme may be dis­tributed and/or mod­i­fied un­der the con­di­tions of the Project Public Li­cense, ei­ther ver­sion 1.3 of this li­cense or (at your op­tion) any later ver­sion. The lat­est ver­sion of this li­cense is in http://www.la­tex-project.org/lppl.txt and ver­sion 1.3 or later is part of all dis­tri­bu­tions of ver­sion 2005/12/01 or later.

FiXme con­sists of the fol­low­ing files:

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

De­scrip­tion

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 refers here 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-.

FiXme home­page: http://www.lrde.epita.fr/~di­dier/soft­ware/la­tex.php#fixme

In­stal­la­tion

If you are build­ing FiXme from the tar­ball you need to ex­e­cute the fol­low­ing steps in or­der to ex­tract the nec­es­sary files. FiXme also re­quires the DoX pack­age (ver­sion 2.0, re­lease date 2009/09/21 or later), to build. It is not re­quired to use the pack­age.

[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 in­stall the gen­er­ated doc­u­men­ta­tion and style files to a lo­ca­tion where can find them. For a TDS-com­pli­ant lay­out, the fol­low­ing lo­ca­tions are sug­gested:

[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- user, you may also in­stall the file fixme.el in a suit­able AUC- style di­rec­tory.

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

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.4
Li­cense The Project Public Li­cense 1.3
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