summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/fixmetodonotes
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-09-18 00:04:03 +0000
committerKarl Berry <karl@freefriends.org>2012-09-18 00:04:03 +0000
commit117c9494a1d801a829f6e898f493e2d18c6e07d3 (patch)
treed82670ca4769d15664a4eb752e39a8590781132d /Master/texmf-dist/doc/latex/fixmetodonotes
parentc1d60321ff8dce536932b6ae6a195ffdc082beab (diff)
fixmetodonotes (17sep12)
git-svn-id: svn://tug.org/texlive/trunk@27685 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/fixmetodonotes')
-rw-r--r--Master/texmf-dist/doc/latex/fixmetodonotes/README37
1 files changed, 37 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/fixmetodonotes/README b/Master/texmf-dist/doc/latex/fixmetodonotes/README
index 46d9aca6e1e..ae6c7e7118e 100644
--- a/Master/texmf-dist/doc/latex/fixmetodonotes/README
+++ b/Master/texmf-dist/doc/latex/fixmetodonotes/README
@@ -27,6 +27,36 @@ To show a list of pending notes, together with links to their pages, use
The list of notes will be shown like a table of content or a list of figures.
+### Creating new kinds of notes
+
+By default, `fixmetodonotes` provides three kinds of notes: `FIXME`, `TODO` and
+`CITE`.
+
+It is possible to add declare new kinds of notes using the `\defnote`
+command. Notes can be declared as _margin_ or _inline_ notes. It is also
+possible to specify new ways to mark the text.
+
+To define a new kind of note marginal note `REMOVE` with crossed out text use
+
+ \defnote{REMOVE}{margin}{\sout}
+
+Similarly, to define a red highlight marker `STYLE` use
+
+ \defnote{STYLE}{inline}{\NOTES@colorline{red}}
+
+
+### Automatic "DRAFT" watermark
+
+`fixmetodonotes` will add a "DRAFT" watermark to any page that has at least
+one notes.
+
+When all the notes are removed from a page, the watermark will not be produced
+at all. This means that it is possible to leave `fixmetodonotes` enabled even
+in final versions of the documents.
+
+Use the `nowatermark` option to disable all watermarks.
+
+
Installation
------------
@@ -46,6 +76,13 @@ git repository.
git clone git://github.com/gioele/fixmetodonotes.git
+Contact
+-------
+
+The homepage of `fixmetodonotes` is <https://github.com/gioele/fixmetodonotes>.
+You can send any issue or comment to <https://github.com/gioele/fixmetodonotes/issues>.
+
+
Authors
-------