Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added basic bug and bugnote view events.
- Loading branch information
Showing
1 changed file
with
126 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,129 @@ | ||
| <sect1 id="dev.eventref.bug"> | ||
| <title>Bug / Bugnote Actions</title> | ||
| <title>Bug and Bugnote Actions</title> | ||
|
|
||
| <sect2 id="dev.eventref.bug.view"> | ||
| <title>Bug View Events</title> | ||
|
|
||
| <blockquote id="dev.eventref.bug.view.details"> | ||
| <title>EVENT_VIEW_BUG_DETAILS (Execute)</title> | ||
|
|
||
| <blockquote> | ||
| <para> | ||
| This event allows a plugin to either process information or display some | ||
| data in the bug view page. It is triggered after the row containing the | ||
| target version and product build fields, and before the bug summary is | ||
| displayed. | ||
| </para> | ||
|
|
||
| <para> | ||
| Any output here should be defining appropriate rows and columns for the | ||
| surrounding <programlisting><table></programlisting> elements. | ||
| </para> | ||
|
|
||
| <itemizedlist> | ||
| <title>Parameters</title> | ||
| <listitem><para><Integer>: Bug ID</para></listitem> | ||
| <listitem><para><Boolean>: Advanced view (false for simple view)</para></listitem> | ||
| </itemizedlist> | ||
| </blockquote> | ||
| </blockquote> | ||
|
|
||
| <blockquote id="dev.eventref.bug.view.extra"> | ||
| <title>EVENT_VIEW_BUG_EXTRA (Execute)</title> | ||
|
|
||
| <blockquote> | ||
| <para> | ||
| This event allows a plugin to either process information or display some | ||
| data in the bug view page. It is triggered after the bug notes have been | ||
| displayed, but before the history log is shown. | ||
| </para> | ||
|
|
||
| <para> | ||
| Any output here should be contained within its own | ||
| <programlisting><table></programlisting> element. | ||
| </para> | ||
|
|
||
| <itemizedlist> | ||
| <title>Parameters</title> | ||
| <listitem><para><Integer>: Bug ID</para></listitem> | ||
| <listitem><para><Boolean>: Advanced view (false for simple view)</para></listitem> | ||
| </itemizedlist> | ||
| </blockquote> | ||
| </blockquote> | ||
|
|
||
| </sect2> | ||
|
|
||
| <sect2 id="dev.eventref.bug.noteview"> | ||
| <title>Bugnote View Events</title> | ||
|
|
||
| <blockquote id="dev.eventref.bug.noteview.start"> | ||
| <title>EVENT_VIEW_BUGNOTES_START (Execute)</title> | ||
|
|
||
| <blockquote> | ||
| <para> | ||
| This event allows a plugin to either process information or display some | ||
| data in the bug notes section, before any bug notes are displayed. It is | ||
| triggered after the bug notes section title. | ||
| </para> | ||
|
|
||
| <para> | ||
| Any output here should be defining appropriate rows and columns for the | ||
| surrounding <programlisting><table></programlisting> elements. | ||
| </para> | ||
|
|
||
| <itemizedlist> | ||
| <title>Parameters</title> | ||
| <listitem><para><Integer>: Bug ID</para></listitem> | ||
| <listitem><para><Complex>: A list of all bugnotes to be displayed to the user</para></listitem> | ||
| </itemizedlist> | ||
| </blockquote> | ||
| </blockquote> | ||
|
|
||
| <blockquote id="dev.eventref.bug.noteview.note"> | ||
| <title>EVENT_VIEW_BUGNOTE (Execute)</title> | ||
|
|
||
| <blockquote> | ||
| <para> | ||
| This event allows a plugin to either process information or display some | ||
| data in the bug notes section, interleaved with the individual bug notes. | ||
| It gets triggered after every bug note is displayed. | ||
| </para> | ||
|
|
||
| <para> | ||
| Any output here should be defining appropriate rows and columns for the | ||
| surrounding <programlisting><table></programlisting> elements. | ||
| </para> | ||
|
|
||
| <itemizedlist> | ||
| <title>Parameters</title> | ||
| <listitem><para><Integer>: Bug ID</para></listitem> | ||
| <listitem><para><Integer>: Bugnote ID</para></listitem> | ||
| <listitem><para><Boolean>: Private bugnote (false if public)</para></listitem> | ||
| </itemizedlist> | ||
| </blockquote> | ||
| </blockquote> | ||
|
|
||
| <blockquote id="dev.eventref.bug.noteview.end"> | ||
| <title>EVENT_VIEW_BUGNOTES_END (Execute)</title> | ||
|
|
||
| <blockquote> | ||
| <para> | ||
| This event allows a plugin to either process information or display some | ||
| data in the bug notes section, after all bugnotes have been displayed. | ||
| </para> | ||
|
|
||
| <para> | ||
| Any output here should be defining appropriate rows and columns for the | ||
| surrounding <programlisting><table></programlisting> elements. | ||
| </para> | ||
|
|
||
| <itemizedlist> | ||
| <title>Parameters</title> | ||
| <listitem><para><Integer>: Bug ID</para></listitem> | ||
| </itemizedlist> | ||
| </blockquote> | ||
| </blockquote> | ||
|
|
||
| </sect2> | ||
|
|
||
| <para></para> | ||
| </sect1> |