Changes between Version 43 and Version 44 of CodeTagsPlugin

Timestamp:

Jun 13, 2015, 1:56:04 PM (9 years ago)

Author:

figaro

Comment:

Cosmetic changes, removed dead links, tagged with nosource

CodeTagsPlugin

@@ +1 @@
+[[PageOutline(2-5,Contents,pullout)]]
+
 = A plugin for displaying code tags (`XXX`, `FIXME`, `TODO`, etc.)
 
-Demo [http://developer.wz2100.net/codetags here], [http://git.mortis.eu/codetags.git git repository].
-Since I cannot find any documentation directly I want to point out that you need a subdirectory named cache thats writeable by your Trac to make this work. This takes some time in the first time used. Also don't forget to grant the `CODETAGS_VIEW` permission.
+== Description
 
-To enable in the `trac.ini` file:
-{{{
-#!ini
-[components]
-codetags.* = enabled
-}}}
+Code tags are additions to the code or wiki pages that flag to the reader that attention is needed. 
+ * `FIXME` is for things which are definitely broken, but where you want to not worry about it for the moment. Shows up as FIXME.
+ * `TODO` is for useful features, optimizations or refactorings that might be worth doing in the future. Shows up as TODO. 
+ * `XXX` is for things that require more thought and that are arguably broken.
 
-Additional configuration options can be added to the `trac.ini` file:
-{{{
-#!ini
-[code-tags]
-scan_files = *.html, *.py, *.c, *.h, *.hh, *.m, *.pch, *.hpp
-scan_folders = trunk/*, branches/*
-tags = XXX, TODO, FIXME, BUG
-}}}
+See [http://c2.com/cgi/wiki?FixmeComment FixmeComment].
 
- {{{scan_files}}} :: allows you to define specific file types to scan (default: *)
- {{{scan_folders}}} :: specifies which directories within the repository to scan (default: *) [[br]]
- {{{exclude_folders}}} :: specifies directories that are subdirectories of {{{scan_folders}}} but don't need to be scanned [[br]]
- {{{exclude_files}}} :: specifies files that shouldn't be scanned even though they're included by scan_files [[br]]
- {{{tags}}} :: allows you to specify what tags to locate, though only the defaults are colored at all. (default: XXX, TODO, FIXME) [[br]]
-
-By default, this plugin doesn't ignore binary files. If you use svn/trac in a web-dev environment, this is a pain, since the tagger finds tags in files such as `.gif`.
-
-This, however, shouldn't be a serious problem because CodeTagsPlugin plugin searches for word boundaries (regex '\b') at the edges of words.
+You need a subdirectory named `cache` that's writeable by your Trac to make this work. This takes some time in the first time used. Also don't forget to grant the `CODETAGS_VIEW` permission.
 
 == Download / Source
@@ -58 +42 @@
   * Chose display for only specified path in repository
  * Allowing regex's for the [code-tags] fields would increase flexibility (scan_files, scan_folders, tags).
+
+== Installation / Configuration
+
+To enable in the `trac.ini` file:
+{{{#!ini
+[components]
+codetags.* = enabled
+}}}
+
+Additional configuration options can be added to the `trac.ini` file:
+{{{#!ini
+[code-tags]
+scan_files = *.html, *.py, *.c, *.h, *.hh, *.m, *.pch, *.hpp
+scan_folders = trunk/*, branches/*
+tags = XXX, TODO, FIXME, BUG
+}}}
+
+ {{{scan_files}}} :: allows you to define specific file types to scan (default: *)
+ {{{scan_folders}}} :: specifies which directories within the repository to scan (default: *) [[br]]
+ {{{exclude_folders}}} :: specifies directories that are subdirectories of {{{scan_folders}}} but don't need to be scanned [[br]]
+ {{{exclude_files}}} :: specifies files that shouldn't be scanned even though they're included by scan_files [[br]]
+ {{{tags}}} :: allows you to specify what tags to locate, though only the defaults are colored at all. (default: XXX, TODO, FIXME) [[br]]
+
+By default, this plugin doesn't ignore binary files. If you use svn/trac in a web-dev environment, this is a pain, since the tagger finds tags in files such as `.gif`.
+
+This, however, shouldn't be a serious problem because CodeTagsPlugin plugin searches for word boundaries (regex '\b') at the edges of words.