createtopic.html.tmpl

codestriker is a develop useful tool to review code on web user interface.

[%# Screen for the create topic form. #%]

[% PROCESS header.html.tmpl version = version displaymenu = 1 
                            closehead = 1 subtitle = "Create New Topic" %]

[%# Display any "feedback" to the user if necessary. #%]
[% IF feedback != '' %]
    <span class="feedback">[% feedback %]</span>
[% END %]

<P>

[%# Show any topics that this topic will obsolete #%]
[% IF obsoleted_topics.size > 0 %]
<span style="obsolete-header">Topics to obsolete:</span>
[% FOREACH topic = obsoleted_topics %]
<a href="[% topic.view_url %]">[% topic.title | html_entity %]</a>[% IF ! loop.last() %],[% END %]

[% END %]
<p>
[% END %]

<FORM NAME="createtopicform" METHOD="post" ENCTYPE="multipart/form-data" ACCEPT-CHARSET="UTF-8" action="[% action_url %]" 
    [% IF action_url.match('topics/create') %]
      ONSUBMIT="document.createtopicform.action = '[% action_url %]/project/' + document.createtopicform.elements['projectid'].options[document.createtopicform.elements['projectid'].selectedIndex].value + '/topics/add';"
    [% END %]
>
<INPUT TYPE="hidden" NAME="action" VALUE="submit_new_topic" />
<INPUT TYPE="hidden" NAME="obsoletes" VALUE="[% obsoletes %]" />

[%# The topic title input field #%]
Topic title:
<FONT SIZE="-2"><a href="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('The topic title should be a concise but \
informative summary of the code to be reviewed.  The title is used in the \
subject of sent emails, and in the topic list screen.');">(?)</a></FONT>
<BR/>
<INPUT TYPE="text" NAME="topic_title" VALUE="[% topic_title | html_entity %]" SIZE=70 MAXLENGTH=70 />
<P>

[%# The topic description input field #%]
Topic description:
<FONT SIZE="-2"><a href="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
The topic description should contain enough information \
for a reviewer to understand broadly what the code change \
achieves. This information is sent with the new topic \
notification email to all reviewers.')">(?)</a></FONT>
<BR/>
<TEXTAREA NAME="topic_description" ROWS=12 COLS=70 WRAP="hard">[% topic_description | html_entity %]</TEXTAREA>
<P>

<TABLE>
[% IF maximum_topic_size_lines != 0 || suggested_topic_size_lines != 0 %]
  <TR><TD COLSPAN="3">
  [% IF maximum_topic_size_lines != 0 %]
    <EM>Topics cannot be larger than [% maximum_topic_size_lines %] lines.</EM>
  [% END %]
  [% IF suggested_topic_size_lines != 0 %]
    <EM>The suggested topic size limit is [% suggested_topic_size_lines %] lines.</EM>
  [% END %]
  </TD></TR>
[% END %]
[%# The topic text upload button #%]
<TR>
 <TD>Topic text upload:
<FONT SIZE="-2"><a href="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
The uploaded file contains the actual text of the review. \
Typically, the text is the output of a command such as: \
<p> \
cvs diff -uN &gt; output.txt \
<p> or <p> \
svn diff -uN &gt; output.txt \
<p> or <p> \
diff -urN ../old-version/ . &gt; output.txt \
<p> \
Non-unidiff files, or ordinary text files can be uploaded, \
but will be treated simply as \'new files\'. \
<p> \
This should be left blank if you are reviewing files \
directly from a repository.')">(?)</a></FONT>
</TD>
 <TD COLSPAN="3"><INPUT TYPE="file" NAME="topic_file" VALUE="[% topic_file | html_entity %]" SIZE=40 MAXLENGTH=200 /></TD>
</TR>

[% IF allow_repositories != 0 %]
[%# The diff fetcher #%]
<TR>
 <TD>
Start tag:
<FONT SIZE="-2"><a href="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
Rather than uploading the topic text, if the repository \
supports it, the text can be fetched by querying the \
repository, given start and/or end tags, and a module name. \
The start tag, end tag, and module fields are ignored if text \
is uploaded.<p> \
If only one tag value is specified, the full contents of all \
files in the specified module corresponding to the entered tag \
will be downloaded.')">(?)</a></FONT>
</TD>
<TD>
<INPUT TYPE="text" NAME="start_tag" VALUE="[% start_tag | html_entity %]" SIZE=20 MAXLENGTH=150 />
</TD>
<TD>End tag: <FONT SIZE="-2"><a href="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
Rather than uploading the topic text, if the repository \
supports it, the text can be fetched by querying the \
repository, given start and/or end tags, and a module name. \
The start tag, end tag, and module fields are ignored if text \
is uploaded. <p> \
If only one tag value is specified, the full contents of all \
files in the specified module corresponding to the entered tag \
will be downloaded.')">(?)</A></FONT></TD>
<TD>
<INPUT TYPE="text" NAME="end_tag" VALUE="[% end_tag  | html_entity %]" SIZE=20 MAXLENGTH=150 />
</TD>
</TR>
<TR>
<TD>&nbsp;</TD><TD>&nbsp;</TD>
<TD>
Module:
<FONT SIZE="-2"><A HREF="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
This is the path to the file or module relative to the repository \
root that should be inspected. It is ignored if text is uploaded.')">(?)</a></FONT>
</TD>
<TD>
<INPUT TYPE="text" NAME="module" VALUE="[% module | html_entity %]" SIZE=20 MAXLENGTH=150 />
</TD>
</TR>

<TR>
 <TD>&nbsp;</TD><TD>&nbsp;</TD>
[%# The default_to_head input field #%]
 <TD>Default to HEAD:
<FONT SIZE="-2"><a href="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
Fall back to HEAD revision if a file does not exist on either tag. \
This will allow diffs between a branch and the HEAD revision, without \
showing files not on the branch as deleted. \
This option affects only CVS topics currently.')">(?)</A></FONT>
</TD>
 <TD COLSPAN="3"><INPUT TYPE="checkbox" NAME="default_to_head" [% IF default_to_head %]CHECKED[% END %] /></TD>
</TR>
[% END %]

[%# The repository the review is made against #%]
[%# Only display the repository select if there is more than one #%]
[% IF repositories.size > 1 %]
<TR>
 <TD>Repository:
<FONT SIZE="-2"><A HREF="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
The SCM system (eg CVS, Subversion, ClearCase) \
which the topic text was prepared against.  If \
this is correctly set, this provides the \
ability to view the entire contents of a file \
with and/or without a proposed change, which \
an aid in the reviewing process.')">(?)</a></FONT>
</TD>
 <TD COLSPAN="3"><SELECT NAME="repository">
       [% FOREACH entry = repositories %]
          [% IF entry == default_repository %]
	      <OPTION SELECTED VALUE="[% entry %]">[% entry %]</OPTION>
	  [% ELSE %]
	      <OPTION VALUE="[% entry %]">[% entry %]</OPTION>
	  [% END %]
       [% END %]
      </SELECT>
 </TD>
</TR>
[% END %]

[% IF projects_enabled != 0 %]

[%# The project the review belongs to #%]
<TR>
 <TD>Project:
<FONT SIZE="-2"><a href="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
Topics are associated with a specific project, which can be \
used as filtering criteria in the search screen.')">(?)</a></FONT>
</TD>
 <TD COLSPAN="3"><SELECT NAME="projectid">
       [% FOREACH project = projects %]
          [% IF project.id == default_projectid %]
	      <OPTION SELECTED VALUE="[% project.id %]">[% project.name | html_entity %]</OPTION>
	  [% ELSE %]
	      <OPTION VALUE="[% project.id %]">[% project.name | html_entity %]</OPTION>
	  [% END %]
       [% END %]
      </SELECT>
 </TD>
</TR>

[% END %]

[%# The bug ids input field #%]
[% IF bugdb_enabled != 0 %]
<TR>
 <TD>Bug IDs:
<FONT SIZE="-2"><a href="javascript:void(0)"
onmouseout="return nd();"
onmouseover="return create_window('\
Indicates what bug identifiers are addressed by this code change. \
These are space or comma separated identifiers, such as: \
<p> \
1634 \
<p> \
or \
<p> \
1534, 4625, 1243 \
<p> \
The appropriate links to the bug-tracking system will be made \
when the topic is viewed, for the reviewer\'s reference. \
<p> \
In addition, if integrating with Bugzilla, when the topic state \
is changed, a comment will be inserted automatically to the \
associated bugs for cross referencing.  When a bug is viewed, \
it can be easily determined what code fixes have been applied \
to it.')">(?)</a></FONT>
</TD>
 <TD COLSPAN="3"><INPUT TYPE="text" NAME="bug_ids" VALUE="[% bug_ids | html_entity %]" SIZE=30 MAXLENGTH=50 /></TD>
</TR>
[% END %]

[%# The email input field #%]
<TR>
 <TD>Your email address:
<FONT SIZE="-2"><A HREF="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
This is your email address.  All comments made against a topic \
will be sent to this address.  The new topic notification email \
will also be sent to this address.')">(?)</a></FONT>
</TD>
 <TD COLSPAN="3"><INPUT TYPE="text" NAME="email" VALUE="[% email | html_entity %]" SIZE=50 MAXLENGTH=80 /></TD>
</TR>

[%# The reviewers input field #%]
<TR>
 <TD>Reviewers:
<FONT SIZE="-2"><a href="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
This is a comma separated list of email addresses, which are the \
people who need to review this code.  When the topic is created, \
the new topic notification  email will be sent to these addresses.')">(?)</a></FONT>
</TD>
 <TD COLSPAN="3"><INPUT TYPE="text" NAME="reviewers" VALUE="[% reviewers | html_entity %]" SIZE=50 MAXLENGTH=1024 /></TD>
</TR>

[%# The Cc input field #%]
<TR>
 <TD>Cc: 
<FONT SIZE="-2"><a href="javascript:void(0);"
onmouseout="return nd();"
onmouseover="return create_window('\
This is a comma separated list of email addresses, which are \
not intended to be reviewers, but typically a mailing list \
to notify a number of people about the creation of a new topic.')">(?)</a></FONT>
</TD>
 <TD COLSPAN="3"><INPUT TYPE="text" NAME="cc" VALUE="[% cc | html_entity %]" SIZE=50 MAXLENGTH=1024 /></TD>
</TR>

<tr>
 <td>State:
   <FONT SIZE="-2"><a href="javascript:void(0);"
onmouseover="return create_window('When a topic is created, it is by default in state \'open\'.\
Once a topic has been reviewed, and the code has been committed, \
the state should be updated to \'committed\'.  If the code \
in this review is not to be committed, perhaps because a \
new review will superceed this one, or because it was rejected, \
the state should be changed to \'closed\'. \
\
If a topic is linked to Bugzilla bugs, each time the topic \
state is changed, an appropriate comment will be appended to \
all associated bugs, as a form of tracking. \
\
The topic states are also useful as a form of filtering, when \
retrieving lists of topics from the search page. \
\
This topic can be superceeded by a new topic, by selecting the \
state \'obsoleted\'.');"
onmouseout="return nd();">(?)</A></FONT>
  </td>
  <td>
    [%# Now display the option button for changing the topic state #%]
    <select name="topic_state">
    [% FOREACH state = states %]
       [% IF state == 'Open' %]
           <option selected value="[% state %]">[% state %]</option>
       [% ELSIF state != 'Deleted' && state != 'Obsoleted' %]
           <option value="[% state %]">[% state %]</option>
       [% END %]
    [% END %]
    </select>
 </td>
</tr>
</TABLE>

<P>
<INPUT TYPE="submit" NAME=".submit" VALUE="Create Topic" />

</FORM>

[% PROCESS trailer.html.tmpl %]

</BODY>
</HTML>