Mercurial > p > roundup > code

annotate plugins/README.md @ 4946:8aac417c1899 routing

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docfixes
author anatoly techtonik <techtonik@gmail.com>
date Wed, 26 Nov 2014 09:40:51 +0300
parents 7920d700e580
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4943
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
1
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
2 This directory contains useful `detectors` and `extensions`, which
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
3 are both Roundup `plugins`.
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
4
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
5
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
6 ### Plugins or Extensions
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
7
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
8 Historically, Roundup plugins were called `extensions`, then at some
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
9 point appeared specialized class of extensions called `detectors`.
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
10
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
11 `extensions` extend tracker instance adding new utils, actions and
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
12 (since 1.6.0) URL handlers for web part. `detectors` allow to change
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
13 the behavior of data model by adding reactors to data change events.
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
14
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
15 The API difference between `detector` and `extension` is that first
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
16 gets `db` argument for its `init()` function and the second gets
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
17 `tracker` instance. Both extend Roundup if placed into corresponding
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
18 directories of tracker home, so they both can be called in a more
7920d700e580 Add support for extensions to provide custom pages to Roundup
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
19 familiar manner as `plugins`.
Roundup Issue Tracker: http://roundup-tracker.org/