1================
2 What is Whups?
3================
4
5:Contact: horde@lists.horde.org
6
7.. contents:: Contents
8.. section-numbering::
9
10Whups is a Horde ticket-tracking application. It is very flexible in design,
11and can be used for help-desk requests, tracking software development, and
12anything else that needs to track a set of requests and their status.
13
14This software is OSI Certified Open Source Software. OSI Certified is a
15certification mark of the `Open Source Initiative`_.
16
17.. _`Open Source Initiative`: http://www.opensource.org/
18
19
20Features
21========
22
23Currently Whups supports the following features:
24
25- Support for multiple "Queues" (aka Projects).
26- Custom ticket types, states, priorities, attributes per Queue.
27- Create, update, assign, close tickets.
28- Search for tickets matching specific criteria.
29- A complex query building for building and saving/storing custom searches.
30- Guest access (in addition to login access).
31- E-mail notification of changes to tickets.
32- Ticket creation and updating through e-mail messages.
33- Permissions support.
34
35
36Terminology
37===========
38
39Queues
40 Project name (or other major category name). This is the top level
41 structure.
42
43Types
44 Project Type, each Type has the following components:
45
46 States
47 State (Stage) of the current item. For example: new, open, closed,
48 resolved, etc.
49
50 Priorities
51 Priority of the current item. For example: Critical, High, Low, Normal,
52 Urgent, etc. Could also be abstracted (Red, Yellow, Green; 1, 2, 3; etc)
53
54 Attributes
55 From a large set of attribute types, an arbitrary number of attributes can
56 be added, including attribute names, descriptions, whether they are
57 required etc.
58
59 Form Replies
60 Reply texts for updating tickets, used for automatically filling ticket
61 comments with stock phrases.
62
63Responsible Users
64 Users responsible for a queue. These can be anyone, but should be Horde
65 users. Notifications only work with Horde users who have identities with an
66 email address set.
67
68Versions
69 Allows you to track multiple versions of the same project. Can be used for
70 actual versions (CVS HEAD, 1.0, etc), development cycles (planning,
71 prototyping, production), etc.
72
73Tickets
74 This is an "Instance" of a Type.
75
76
77Obtaining Whups
78==================
79
80Further information on Whups and the latest version can be obtained at
81
82 http://www.horde.org/apps/whups
83
84
85Documentation
86=============
87
88The following documentation is available in the Whups distribution:
89
90:README_: This file
91:LICENSE_: Copyright and license information
92:`docs/CHANGES`_: Changes by release
93:`docs/CREDITS`_: Project developers
94:`docs/INSTALL`_: Installation instructions and notes
95:`docs/TODO`_: Development TODO list
96
97
98Installation
99============
100
101Instructions for installing Whups can be found in the file INSTALL_ in the
102``docs/`` directory of the Whups distribution.
103
104
105Assistance
106==========
107
108If you encounter problems with Whups, help is available!
109
110The Horde Frequently Asked Questions List (FAQ), available on the Web at
111
112 http://wiki.horde.org/FAQ
113
114Horde LLC runs a number of mailing lists, for individual applications
115and for issues relating to the project as a whole. Information, archives, and
116subscription information can be found at
117
118 http://www.horde.org/community/mail
119
120Lastly, Horde developers, contributors and users also make occasional
121appearances on IRC, on the channel #horde on the freenode Network
122(irc.freenode.net).
123
124
125Licensing
126=========
127
128For licensing and copyright information, please see the file LICENSE_ in the
129Whups distribution.
130
131Thanks,
132
133The Whups team
134
135
136.. _README: README
137.. _LICENSE: http://www.horde.org/licenses/bsd
138.. _docs/CHANGES: CHANGES
139.. _docs/CREDITS: CREDITS
140.. _INSTALL:
141.. _docs/INSTALL: INSTALL
142.. _docs/TODO: TODO
143