ui/doc/bug-annotation.php

<?php  																														require_once($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common/system/app.class.php");	require_once($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common/system/nav.class.php"); 	require_once($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common/system/menu.class.php"); 	$App 	= new App();	$Nav	= new Nav();	$Menu 	= new Menu();		include($App->getProjectCommon());    # All on the same line to unclutter the user's desktop'
	# Begin: page-specific settings.  Change these. 
	$pageTitle 		= "JDT UI Bug Annotation Conventions";
	$pageKeywords	= "JDT/UI, JDT, Java development tools UI, Java, java, development, tools, java ide, Eclipse";
	$pageAuthor		= "JDT/UI Team";
	
	# Add page-specific Nav bars here
	# Format is Link text, link URL (can be http://www.someothersite.com/), target (_self, _blank), level (1, 2 or 3)
	# $Nav->addNavSeparator("My Page Links", 	"downloads.php");
	# $Nav->addCustomNav("My Link", "mypage.php", "_self", 3);
	# $Nav->addCustomNav("Google", "http://www.google.com/", "_blank", 3);

	# End: page-specific settings
	#
	
function bugsByUser($name, $email) {
	echo '<tr>
		<td colspan="2" class="owner">
			<a href="' .
			'https://bugs.eclipse.org/bugs/buglist.cgi?' .
			'bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&' .
			'emailassigned_to1=1&emailtype1=substring&email1=' . 
			"$email" . 
			'&cmdtype=doit">' .
			"$name" .
			'</a>:
		</td>
	</tr>
	';
}

function internalBugsWithSummary($tag, $description, $filter) {
	echo '<tr>
		<td style="white-space:nowrap">
			<a href="' .
			'https://bugs.eclipse.org/bugs/buglist.cgi?' .
			'short_desc_type=substring&short_desc=' .
			urlencode ($tag) .
			"$filter" .
			'&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&' .
			'cmdtype=doit">' .
			"$tag" .
			'</a>
		</td>
		<td>
			' .
			"$description" .
			'
		</td>
	</tr>  
	';
}

function bugsWithSummaryJDT($tag, $description) {
	internalBugsWithSummary($tag, $description, '&product=JDT');
}


ob_start();
?>

	<div id="midcolumn">
		<h1><?= $pageTitle ?></h1>

		<p>
			To simplify bug management we started to tag JDT UI bugs with additional pseudo 
			keywords (not normal Bugzilla keywords). The tags are prepended to the bug's 
			summary field. Since we use these tags for internal bug management reporters 
			of a bug <i>should not</i> add any pseudo keywords when filing the bug. The 
			owner of the component bucket is responsible to add the keywords.
		</p>
		<p>
			Keywords are used to group bugs without assigning them to a developer. So with 
			the introduction of the keywords it is easy to search for all bugs belonging 
			to a specific sub component. For example to get an overview of all open refactoring 
			issues search for new, assigned or reopened bugs containing the word [refactoring] 
			in the summary field.
		</p>
		<p>
			The JDT Text component uses the
			<a href="http://www.eclipse.org/eclipse/platform-text/development/bug-annotation.htm">keywords defined by Platform Text</a>.
		</p>
		
		<table width="735" border="1">
			
			<?php
				bugsWithSummaryJDT("[actions]", "Bugs related to global menu, context menu, and toolbar actions");
				bugsWithSummaryJDT("[api]", "API bugs: wrong or missing API, API requests");
				bugsWithSummaryJDT("[ast rewrite]", "AST rewrite bugs");  
				bugsWithSummaryJDT("[BiDi]", "Bugs related to BiDi problems");
				bugsWithSummaryJDT("[browsing]", "Bugs related to the Java Browsing perspective");
				bugsWithSummaryJDT("[build path]", "Bugs related to the Java build path page and build path actions");
				bugsWithSummaryJDT("[call hierarchy]", "Bugs related to the call hierarchy view");    
				bugsWithSummaryJDT("[ccp]", "Copy, Cut, Paste bugs where no refactoring is involved");
				bugsWithSummaryJDT("[change method signature]", "Bugs related to the change method signature refactoring");
				bugsWithSummaryJDT("[clean up]", "Bugs related to the clean up wizard");
				bugsWithSummaryJDT("[code style]", "Bugs related to code style settings including new code style options");
				bugsWithSummaryJDT("[code templates]", "Bugs related to code templates");
				bugsWithSummaryJDT("[common navigator]", "Bugs related to JDT extensions for the Common Navigator aka Project Explorer");
				bugsWithSummaryJDT("[compare]", "Bugs related to Java compare functionality. Not used to tag general compare bugs");
				bugsWithSummaryJDT("[convert anonymous]", "Bugs related to the convert anonymous to nested class refactoring");  
				bugsWithSummaryJDT("[convert local]", "Bugs related to the convert local to field refactoring"); 
				bugsWithSummaryJDT("[create on paste]", "Bugs related to creating Java elements when pasting source into the Package Explorer");
				bugsWithSummaryJDT("[dnd]", "Drag and Drop bugs. This keyword is mostly used together with other keywords like [reorg], [refactoring], [type hierarchy], ...");
				bugsWithSummaryJDT("[encapsulate field]", "Bugs to the encapsulate field refactoring");
				bugsWithSummaryJDT("[expand selection]", "Bugs related to 'Expand selection'");
				bugsWithSummaryJDT("[expressions]", "Bugs related to org.eclipse.core.expressions");
				bugsWithSummaryJDT("[extract constant]", "Bugs related to the extract constant refactoring");
				bugsWithSummaryJDT("[extract interface]", "Bugs related to the extract interface refactoring");  
				bugsWithSummaryJDT("[extract local]", "Bugs related to the extract local variable refactoring");   
				bugsWithSummaryJDT("[extract method]", "Bugs related to the extract method refactoring");
				bugsWithSummaryJDT("[extract superclass]", "Bugs related to the extract superclass refactoring");
				bugsWithSummaryJDT("[generalize type]", "Bugs related to the generalize type refactoring");
				bugsWithSummaryJDT("[generate constructor]", "Bugs related to the generate constructor wizards");   
				bugsWithSummaryJDT("[generate delegate]", "Bugs related to the generate delegate wizard");   
				bugsWithSummaryJDT("[getter setter]", "Bugs related to the generate getter/setter wizard");
				bugsWithSummaryJDT("[Graphics]", "Bugs related to icons and images");
				bugsWithSummaryJDT("[hashcode/equals]", "Bugs related to the generate hashCode/equals wizard");
				bugsWithSummaryJDT("[imports on paste]", "Bugs related to imports on paste functionality");
				bugsWithSummaryJDT("[infer type arguments]", "Bugs related to the infer type arguments refactoring");  
				bugsWithSummaryJDT("[inline]", "Bugs related to the inline refactoring");
				bugsWithSummaryJDT("[introduce factory]", "Bugs related to the introduce factory refactoring");   
				bugsWithSummaryJDT("[introduce indirection]", "Bugs related to the introduce indirection refactoring");
				bugsWithSummaryJDT("[introduce parameter]", "Bugs related to the introduce parameter refactoring");
				bugsWithSummaryJDT("[jar exporter]", "Bugs related to the jar export wizard");  
				bugsWithSummaryJDT("[javadoc wizard]", "Bugs related to the Javadoc export wizard");
				bugsWithSummaryJDT("[JUnit]", "Bugs related to the org.eclipse.jdt.junit plug-in");
				bugsWithSummaryJDT("[ltk]", "Bugs related to the refactoring framework, org.eclipse.ltk.refactoring");
				bugsWithSummaryJDT("[mark occurrence]", "Bugs related to mark occurrence");  
				bugsWithSummaryJDT("[migrate jar]", "Bugs related to the migrate jar wizard");
				bugsWithSummaryJDT("[move member type]", "Bugs related to the convert member to top level refactoring");
				bugsWithSummaryJDT("[move method]", "Bugs related to the move method refactoring");
				bugsWithSummaryJDT("[move static members]", "Bugs related to the move static members refactoring");
				bugsWithSummaryJDT("[nls tooling]", "Bugs related to NLS tooling");
				bugsWithSummaryJDT("[open type]", "Bugs to the open type dialog");
				bugsWithSummaryJDT("[organize imports]", "Bugs related to organize imports");
				bugsWithSummaryJDT("[override method]", "Bugs related to the override/implement methods wizard");  
				bugsWithSummaryJDT("[package explorer]", "Bugs related to JDT's package explorer");
				bugsWithSummaryJDT("[plan item]", "Official plan items");    
				bugsWithSummaryJDT("[preferences]", "Bugs related to preference pages");    
				bugsWithSummaryJDT("[pull up]", "Bugs related to the pull up refactoring");
				bugsWithSummaryJDT("[push down]", "Bugs related to the push down refactoring");
				bugsWithSummaryJDT("[quick assist]", "Bugs related to the Quick Assist functionality");
				bugsWithSummaryJDT("[quick fix]", "Bugs related to the Quick Fix functionality");
				bugsWithSummaryJDT("[refactoring]", "General bugs regarding the refactoring framework");  
				bugsWithSummaryJDT("[rename]", "Bugs related to the rename refactoring");
				bugsWithSummaryJDT("[render]", "Bugs related to rendering of Java elements");  
				bugsWithSummaryJDT("[reorg]", "Bugs related to the copy, move and delete refactorings");
				bugsWithSummaryJDT("[search]", "Java search bugs. Not used to tag general search bugs");
				bugsWithSummaryJDT("[surround with try/catch]", "Bugs related to the surround with try/catch refactoring");
				bugsWithSummaryJDT("[toString]", "Bugs related to the generate toString() wizard");
				bugsWithSummaryJDT("[type hierarchy]", "Bugs related to the Type Hierarchy view");
				bugsWithSummaryJDT("[type wizards]", "Bugs related to the new type wizards");
				bugsWithSummaryJDT("[use supertype]", "Bugs related to the use supertype refactoring");
				bugsWithSummaryJDT("[working sets]", "Bugs related to working sets");
				bugsWithSummaryJDT("[5.0]", "Bugs related to J2SE 5.0");
				bugsWithSummaryJDT("[1.7]", "Bugs related to J2SE 7.0");
			?>
	  
		</table>
		<br>
	</div>

<?php
	$html = ob_get_contents();
	ob_end_clean();

	# Generate the web page
	$App->AddExtraHtmlHeader("<style type=\"text/css\">
		td.owner {
			background-color: #DDDDDD;
			font-style: italic;
		}
</style>");

	$App->generatePage($theme, $Menu, $Nav, $pageAuthor, $pageKeywords, $pageTitle, $html);
?>