summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/en/xml/administration.xml45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml
index 24aa18954..56de1e9bf 100644
--- a/docs/en/xml/administration.xml
+++ b/docs/en/xml/administration.xml
@@ -629,6 +629,51 @@
</orderedlist>
</section>
+ <section id="quips">
+ <title>Quips</title>
+
+ <para>
+ Quips are small text messages that can be configured to appear
+ next to search results. A Bugzilla installation can have its own specific
+ quips. Whenever a quip needs to be displayed, a random selection
+ is made from the pool of already existing quips.
+ </para>
+
+ <para>
+ Quips are controlled by the <emphasis>enablequips</emphasis> parameter.
+ It has several possible values: on, approved, frozen or off.
+ In order to enable quips approval you need to set this parameter
+ to "approved". In this way, users are free to submit quips for
+ addition but an administrator must explicitly approve them before
+ they are actually used.
+ </para>
+
+ <para>
+ In order to see the user interface for the quips, it is enough to click
+ on a quip when it is displayed together with the search results. Or
+ it can be seen directly in the browser by visiting the quips.cgi URL
+ (prefixed with the usual web location of the Bugzilla installation).
+ Once the quip interface is displayed, it is enough to click the
+ "view and edit the whole quip list" in order to see the administration
+ page. A page with all the quips available in the database will
+ be displayed.
+ </para>
+
+ <para>
+ Next to each tip there is a checkbox, under the
+ "Approved" column. Quips who have this checkbox checked are
+ already approved and will appear next to the search results.
+ The ones that have it unchecked are still preserved in the
+ database but they will not appear on search results pages.
+ User submitted quips have initially the checkbox unchecked.
+ </para>
+
+ <para>
+ Also, there is a delete link next to each quip,
+ which can be used in order to permanently delete a quip.
+ </para>
+ </section>
+
<section id="groups">
<title>Groups and Group Security</title>