Revision: 1828
Author: [email protected]
Date: Mon Feb 1 01:58:14 2010
Log: Added documentation to guide new developers. This is the page that was
on the previous documentation website with the Simal codestyle files added.
(fixes issue 266)
new review
update issue 266
Added documentation to guide new developers. This is the page that was on
the previous documentation website with the Simal codestyle files added.
http://code.google.com/p/simal/source/detail?r=1828
Added:
/wiki/DevelopSimal.attach
/wiki/DevelopSimal.attach/simal.psf
/wiki/DevelopSimal.attach/simal_codetemplates.xml
/wiki/DevelopSimal.attach/simal_formatter.xml
/wiki/DevelopSimal.wiki
=======================================
--- /dev/null
+++ /wiki/DevelopSimal.attach/simal.psf Mon Feb 1 01:58:14 2010
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<psf version="2.0">
+ <provider id="org.tigris.subversion.subclipse.core.svnnature">
+ <project
reference="0.9.3,http://simal.googlecode.com/svn/trunk/simal,simal"/>
+ <project
reference="0.9.3,http://simal.googlecode.com/svn/wiki,simal-wiki"/>
+ <project
reference="0.9.3,http://simal.googlecode.com/svn/trunk/uk.ac.osswatch.simal.core,uk.ac.osswatch.simal.core"/>
+ <project
reference="0.9.3,http://simal.googlecode.com/svn/trunk/uk.ac.osswatch.simal.web,uk.ac.osswatch.simal.web"/>
+ <project
reference="0.9.3,http://simal.googlecode.com/svn/trunk/uk.ac.osswatch.simal.rest/,uk.ac.osswatch.simal.rest"/>
+ </provider>
+</psf>
=======================================
--- /dev/null
+++ /wiki/DevelopSimal.attach/simal_codetemplates.xml Mon Feb 1 01:58:14
2010
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template
autoinsert="true" context="gettercomment_context" deleted="false"
description="Comment for getter method" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
name="gettercomment">/**
+ * @return the ${bare_field_name}
+ */</template><template autoinsert="true" context="settercomment_context"
deleted="false" description="Comment for setter method" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
name="settercomment">/**
+ * @param ${param} the ${bare_field_name} to set
+ */</template><template autoinsert="true"
context="constructorcomment_context" deleted="false" description="Comment
for created constructors" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
name="constructorcomment">/**
+ * ${tags}
+ */</template><template autoinsert="false" context="filecomment_context"
deleted="false" description="Comment for created Java files" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/*
+ * Copyright 2010 University of Oxford
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+</template><template autoinsert="false" context="typecomment_context"
deleted="false" description="Comment for created types" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
name="typecomment">/**
+ *
+ * ${tags}
+ */</template><template autoinsert="true" context="fieldcomment_context"
deleted="false" description="Comment for fields" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
name="fieldcomment">/**
+ *
+ */</template><template autoinsert="true" context="methodcomment_context"
deleted="false" description="Comment for non-overriding methods"
enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
name="methodcomment">/**
+ * ${tags}
+ */</template><template autoinsert="true"
context="overridecomment_context" deleted="false" description="Comment for
overriding methods" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
name="overridecomment">/* (non-Javadoc)
+ * ${see_to_overridden}
+ */</template><template autoinsert="true"
context="delegatecomment_context" deleted="false" description="Comment for
delegate methods" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
name="delegatecomment">/**
+ * ${tags}
+ * ${see_to_target}
+ */</template><template autoinsert="true" context="newtype_context"
deleted="false" description="Newly created files" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.newtype"
name="newtype">${filecomment}
+${package_declaration}
+
+${typecomment}
+${type_declaration}</template><template autoinsert="true"
context="classbody_context" deleted="false" description="Code in new class
type bodies" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.classbody" name="classbody">
+</template><template autoinsert="true" context="interfacebody_context"
deleted="false" description="Code in new interface type bodies"
enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody"
name="interfacebody">
+</template><template autoinsert="true" context="enumbody_context"
deleted="false" description="Code in new enum type bodies" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.enumbody" name="enumbody">
+</template><template autoinsert="true" context="annotationbody_context"
deleted="false" description="Code in new annotation type bodies"
enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody"
name="annotationbody">
+</template><template autoinsert="true" context="catchblock_context"
deleted="false" description="Code in new catch blocks" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.catchblock" name="catchblock">//
${todo} Auto-generated catch block
+${exception_var}.printStackTrace();</template><template autoinsert="true"
context="methodbody_context" deleted="false" description="Code in created
method stubs" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.methodbody" name="methodbody">//
${todo} Auto-generated method stub
+${body_statement}</template><template autoinsert="true"
context="constructorbody_context" deleted="false" description="Code in
created constructor stubs" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.constructorbody"
name="constructorbody">${body_statement}
+// ${todo} Auto-generated constructor stub</template><template
autoinsert="true" context="getterbody_context" deleted="false"
description="Code in created getters" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.getterbody"
name="getterbody">return ${field};</template><template autoinsert="true"
context="setterbody_context" deleted="false" description="Code in created
setters" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.setterbody"
name="setterbody">${field} = ${param};</template><template
autoinsert="true" context="gettercomment_context" deleted="false"
description="Comment for getter function" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.gettercomment"
name="gettercomment">/**
+ * @return the ${bare_field_name}
+ */</template><template autoinsert="true" context="settercomment_context"
deleted="false" description="Comment for setter function" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.settercomment"
name="settercomment">/**
+ * @param ${param} the ${bare_field_name} to set
+ */</template><template autoinsert="true"
context="constructorcomment_context" deleted="false" description="Comment
for created constructors" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.constructorcomment"
name="constructorcomment">/**
+ * ${tags}
+ */</template><template autoinsert="true" context="filecomment_context"
deleted="false" description="Comment for created JavaScript files"
enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.filecomment"
name="filecomment">/**
+ *
+ */</template><template autoinsert="true" context="typecomment_context"
deleted="false" description="Comment for created types" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.typecomment"
name="typecomment">/**
+ * @author ${user}
+ *
+ * ${tags}
+ */</template><template autoinsert="true" context="fieldcomment_context"
deleted="false" description="Comment for vars" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.fieldcomment"
name="fieldcomment">/**
+ *
+ */</template><template autoinsert="true" context="methodcomment_context"
deleted="false" description="Comment for non-overriding function"
enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.methodcomment"
name="methodcomment">/**
+ * ${tags}
+ */</template><template autoinsert="true"
context="overridecomment_context" deleted="false" description="Comment for
overriding functions" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.overridecomment"
name="overridecomment">/* (non-JSDoc)
+ * ${see_to_overridden}
+ */</template><template autoinsert="true"
context="delegatecomment_context" deleted="false" description="Comment for
delegate functions" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.delegatecomment"
name="delegatecomment">/**
+ * ${tags}
+ * ${see_to_target}
+ */</template><template autoinsert="true" context="newtype_context"
deleted="false" description="Newly created files" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.newtype"
name="newtype">${filecomment}
+${package_declaration}
+
+${typecomment}
+${type_declaration}</template><template autoinsert="true"
context="classbody_context" deleted="false" description="Code in new class
type bodies" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.classbody" name="classbody">
+</template><template autoinsert="true" context="catchblock_context"
deleted="false" description="Code in new catch blocks" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.catchblock"
name="catchblock">// ${todo} Auto-generated catch block
+${exception_var}.printStackTrace();</template><template autoinsert="true"
context="methodbody_context" deleted="false" description="Code in created
function stubs" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.methodbody"
name="methodbody">// ${todo} Auto-generated function stub
+${body_statement}</template><template autoinsert="true"
context="constructorbody_context" deleted="false" description="Code in
created constructor stubs" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.constructorbody"
name="constructorbody">${body_statement}
+// ${todo} Auto-generated constructor stub</template><template
autoinsert="true" context="getterbody_context" deleted="false"
description="Code in created getters" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.getterbody"
name="getterbody">return ${field};</template><template autoinsert="true"
context="setterbody_context" deleted="false" description="Code in created
setters" enabled="true"
id="org.eclipse.wst.jsdt.ui.text.codetemplates.setterbody"
name="setterbody">${field} = ${param};</template></templates>
=======================================
--- /dev/null
+++ /wiki/DevelopSimal.attach/simal_formatter.xml Mon Feb 1 01:58:14 2010
@@ -0,0 +1,269 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<profiles version="11">
+<profile kind="CodeFormatterProfile" name="Simal Conventions" version="11">
+<setting
id="org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_parameters"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_type_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_arguments"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.brace_position_for_anonymous_type_declaration"
value="end_of_line"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_annotation_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_annotation"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_field"
value="0"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_while"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_annotation_type_member_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_before_else_in_if_statement"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_prefix_operator"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.keep_else_statement_on_same_line"
value="false"/>
+<setting id="org.eclipse.jdt.core.formatter.insert_space_after_ellipsis"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_annotation_type_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.indent_breaks_compare_to_cases"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.alignment_for_multiple_fields"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_array_initializer"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression"
value="80"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_for"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_binary_operator"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_wildcard"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.brace_position_for_array_initializer"
value="end_of_line"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_enum_constant"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_before_finally_in_try_statement"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_local_variable"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_before_catch_in_try_statement"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_while"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_package"
value="1"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_parameters"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.continuation_indentation"
value="2"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_postfix_operator"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_arguments"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_superinterfaces"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_new_chunk"
value="1"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_binary_operator"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_package"
value="0"/>
+<setting id="org.eclipse.jdt.core.compiler.source" value="1.5"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_constant_arguments"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_constructor_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_arguments"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_declarations"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.join_wrapped_lines"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_block"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_invocation_arguments"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.blank_lines_before_member_type"
value="1"/>
+<setting id="org.eclipse.jdt.core.formatter.align_type_members_on_columns"
value="false"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_enum_constant"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_for"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_method_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_switch"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_unary_operator"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_case"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.comment.indent_parameter_description"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_switch"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_parameters"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_type_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_block_comment"
value="false"/>
+<setting id="org.eclipse.jdt.core.formatter.lineSplit" value="80"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_if"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_between_brackets_in_array_type_reference"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_explicitconstructorcall_arguments"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_constructor_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.blank_lines_before_first_class_body_declaration"
value="0"/>
+<setting id="org.eclipse.jdt.core.formatter.indentation.size" value="2"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_enum_constant"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration"
value="16"/>
+<setting id="org.eclipse.jdt.core.formatter.alignment_for_assignment"
value="0"/>
+<setting id="org.eclipse.jdt.core.compiler.problem.assertIdentifier"
value="error"/>
+<setting id="org.eclipse.jdt.core.formatter.tabulation.char"
value="space"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_parameters"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_prefix_operator"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_body"
value="true"/>
+<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_method"
value="1"/>
+<setting
id="org.eclipse.jdt.core.formatter.format_guardian_clause_on_one_line"
value="false"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_for"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_cast"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_labeled_statement"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.brace_position_for_annotation_type_declaration"
value="end_of_line"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_method_body"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_invocation"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_allocation_expression"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_constant"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_annotation"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation_type_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_throws"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_if"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.brace_position_for_switch"
value="end_of_line"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_throws"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_return"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_conditional"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_wildcard"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_allocation_expression"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_throw"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_arguments"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.compiler.problem.enumIdentifier"
value="error"/>
+<setting
id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch"
value="false"/>
+<setting id="org.eclipse.jdt.core.formatter.insert_space_before_ellipsis"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.brace_position_for_block"
value="end_of_line"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_inits"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.brace_position_for_method_declaration"
value="end_of_line"/>
+<setting id="org.eclipse.jdt.core.formatter.compact_else_if" value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_array_initializer"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_increments"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_reference"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.brace_position_for_enum_constant"
value="end_of_line"/>
+<setting id="org.eclipse.jdt.core.formatter.comment.indent_root_tags"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_declarations"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_explicitconstructorcall_arguments"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_switch"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_superinterfaces"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_parameters"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_allocation_expression"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="2"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_type_reference"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_closing_brace_in_block"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_reference"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_constant"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_arguments"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_constructor_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_if"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_throws"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment"
value="false"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_assignment_operator"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_assignment_operator"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.indent_empty_lines"
value="false"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_synchronized"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_closing_paren_in_cast"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_parameters"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.brace_position_for_block_in_case"
value="end_of_line"/>
+<setting
id="org.eclipse.jdt.core.formatter.number_of_empty_lines_to_preserve"
value="1"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_catch"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_constructor_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_invocation"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_reference"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_and_in_type_parameter"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression"
value="16"/>
+<setting id="org.eclipse.jdt.core.compiler.compliance" value="1.5"/>
+<setting
id="org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer"
value="2"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_between_empty_brackets_in_array_allocation_expression"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_at_in_annotation_type_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_cast"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_unary_operator"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_parameterized_type_reference"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_anonymous_type_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.keep_empty_array_initializer_on_one_line"
value="false"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_declaration"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.keep_imple_if_on_one_line"
value="false"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_parameters"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_parameters"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_at_end_of_file_if_missing"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_for"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_labeled_statement"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_parameterized_type_reference"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_type_declaration"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_binary_expression"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.brace_position_for_enum_declaration"
value="end_of_line"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_while"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode"
value="enabled"/>
+<setting
id="org.eclipse.jdt.core.formatter.put_empty_statement_on_new_line"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_parameter"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_parameters"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_invocation"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_before_while_in_do_statement"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments"
value="true"/>
+<setting id="org.eclipse.jdt.core.formatter.comment.line_length"
value="80"/>
+<setting
id="org.eclipse.jdt.core.formatter.blank_lines_between_import_groups"
value="1"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_constant_arguments"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.brace_position_for_constructor_declaration"
value="end_of_line"/>
+<setting
id="org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_method_body"
value="0"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_conditional"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_type_header"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation_type_member_declaration"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.wrap_before_binary_operator"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_declaration_header"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.blank_lines_between_type_declarations"
value="1"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_synchronized"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_block"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_enum_declaration"
value="16"/>
+<setting id="org.eclipse.jdt.core.formatter.join_lines_in_comments"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_conditional"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_field_declarations"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.alignment_for_compact_if"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_inits"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_cases"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_array_initializer"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_and_in_type_parameter"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_constructor_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_assert"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_imports"
value="1"/>
+<setting id="org.eclipse.jdt.core.formatter.comment.format_html"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_parameters"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_allocation_expression"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_anonymous_type_declaration"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_conditional"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_parameterized_type_reference"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_for"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_postfix_operator"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.comment.format_source_code"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_synchronized"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_allocation_expression"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_throws"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration"
value="16"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer"
value="insert"/>
+<setting id="org.eclipse.jdt.core.compiler.codegen.targetPlatform"
value="1.5"/>
+<setting
id="org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_member"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.comment.format_header"
value="false"/>
+<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_enum_constant"
value="do not insert"/>
+<setting id="org.eclipse.jdt.core.formatter.alignment_for_enum_constants"
value="0"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_block"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_annotation_declaration_header"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_parenthesized_expression"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_catch"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_local_declarations"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_switch"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_increments"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_invocation"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_assert"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.brace_position_for_type_declaration"
value="end_of_line"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_array_initializer"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_between_empty_braces_in_array_initializer"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_declaration"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_for"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_catch"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_parameterized_type_reference"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_field_declarations"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_annotation"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_parameterized_type_reference"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments"
value="insert"/>
+<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_imports"
value="1"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_local_declarations"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_constant_header"
value="true"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_for"
value="insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.never_indent_line_comments_on_first_column"
value="false"/>
+<setting
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_arguments"
value="do not insert"/>
+<setting
id="org.eclipse.jdt.core.formatter.never_indent_block_comments_on_first_column"
value="false"/>
+<setting
id="org.eclipse.jdt.core.formatter.keep_then_statement_on_same_line"
value="false"/>
+</profile>
+</profiles>
=======================================
--- /dev/null
+++ /wiki/DevelopSimal.wiki Mon Feb 1 01:58:14 2010
@@ -0,0 +1,196 @@
+=How to develop Simal=
+
+This How-To describes how to set up your development environment
+for working with Simal. Since Simal uses many Eclipse plugins in components
+of the Simal project it makes most sense for you to work within the Eclipse
+environment (although this is not a requirement, it just makes your life
+easier). This how-to therefore focuses on configuring Eclipse for working
+on Simal.
+
+==Intended Audience==
+
+People wishing to participate in the development of Simal.
+
+==Purpose==
+
+To identify the ideal development environment for working with Simal.
+
+==Prerequisites==
+
+Readers should
+
+ * Have at least a basic understanding of RDF, HTML and Java
+ * Have at least a basic understanding of Java development in Eclipse
+
+=Install and Configure Eclipse=
+
+==Eclipse 3.5 + Web Tools Project 3.1==
+
+If you do not currently have eclipse installed we recommend that you
download and unpack the [http://www.eclipse.org/downloads/ Eclipse IDE for
Java EE Developers] package.
+
+If you already have eclipse then you will need to ensure that you also
+have the Web Standards Tools (WST) plugin installed (use the WTP
+[http://download.eclipse.org/webtools/updates/ update site]).
+
+==Codestyle and code formatting==
+
+We have defined a custom Simal formatter and code templates for Eclipse.
+To install these first download the following files:
+ *
[http://simal.googlecode.com/svn/wiki/DevelopSimal.attach/simal_formatter.xml
simal_formatter.xml]
+ *
[http://simal.googlecode.com/svn/wiki/DevelopSimal.attach/simal_codetemplates.xml
simal_codetemplates.xml]
+
+To import the Formatter go to {{{ Window -> Preferences -> Java -> Code
Style -> Formatter }}}.
+Select {{{Import}}} and choose the simal_formatter.xml.
+
+To import the code templates go to {{{ Window -> Preferences -> Java ->
Code Style -> Code Templates }}}.
+Select {{{Import}}} and choose the simal_codetemplates.xml.
+
+==Recommended Plugins==
+
+The following Eclipse plugins are useful when developing Simal.
+
+===Subclipse===
+
+We use a Subversion repository for our source code, therefore you need
+an SVN plugin like Subclipse for working with the repository. You can
install
+the Subclipse plugin in Eclipse using their update site
[http://subclipse.tigris.org/update_1.6.x";>
+http://subclipse.tigris.org/update_1.6.x] in the Eclipse Update Manager.
If you are unfamiliar
+with the Eclipse update manager you can find a good tutorial
[http://www.vogella.de/articles/Eclipse/article.html#plugin_installation
here]
+
+
+===Maven===
+
+We use Maven to build simal. If you want to use maven from the command line
+you need to [http://maven.apache.org/download.html download and install]
Maven 2 on your machine. However, if
+you only intend to use maven from within Eclipse then you just
+need the a Maven plugin described in the next section.
+
+
+===m2eclipse===
+
+If you are using Eclipse we also recommend the m2eclipse plugin that allows
+you to work with Maven projects within Eclipse. M2eclipse is available
from the
+m2eclipse [http://m2eclipse.sonatype.org/update/ update site]
+and is installed as described for the Subclipse plugin above.
+
+===Wicket Bench===
+
+[http://www.laughingpanda.org/mediawiki/index.php/Wicket_Bench Wicket
Bench] is
+a plugin that makes working with Wicket files easier. It can be installed
+from the
[http://www.laughingpanda.org/svn/wicket-bench/trunk/wicket-bench-site
update site]
+using the method described above.
+
+===Get Simal Sources===
+The first thing you need to do is checkout the Simal source code. To do
this
+use the
[http://simal.googlecode.com/svn/wiki/DevelopSimal.attach/simal.psf
simal.psf] team set.
+
+ * Save the
[http://simal.googlecode.com/svn/wiki/DevelopSimal.attach/simal.psf";>simal.psf]
+file in a convenient location
+
+ * In Eclipse select {{{File -> Import}}}
+
+ * In the dialog select {{{Team -> Team Project Set}}} and click {{{Next}}}
+
+ * Select the {{{simal.psf}}} file you saved earlier and click {{{Finish}}}
+
+After following these steps the source code for Simal will be checked out
from
+version control, ready for you to start work.
+
+After importing from SVN Maven will download all dependencies, this can
take some
+time depending on the speed of your network detection, but it is a one-off
step.
+
+
+
+===Test Setup So Far===
+
+Assuming everything has compiled OK we are now ready to run
+some tests:
+
+
+ * right click on {{{uk.ac.osswatch.simal.core/src/test/java}}}
+and select {{{Run As -> JUnit Test}}}
+
+ * Wait for the tests to run, you should get a green bar for all
+tests
+
+ * right click on {{{uk.ac.osswatch.simal.rest/src/test/java}}}
+and select {{{Run As -> JUnit Test}}}
+
+ * Wait for the tests to run, you should get a green bar for all
+tests
+
+ * right click on {{{uk.ac.osswatch.simal.web/src/test/java}}}
+and select {{{Run As -> JUnit Test}}}
+
+ * Wait for the tests to run, you should get a green bar for all
+tests
+
+
+
+
+===Optional Steps===
+
+
+===Task Management===
+
+These plugins are useful in tracking and managing
+tasks.
+
+
+===Mylyn Generic Issue Tracker Integration===
+TODO Describe use of the Mylyn generic issue tracker to
+[http://www.jroller.com/alexRuiz/entry/using_mylyn_with_google_code
integrate] with Google
+Code
+
+
+
+
+===Code Quality===
+The plugins are used for managing code quality in Simal.
+They typically generate a number of reports indicating
+potential problems with code quality. It is good practice
+to run these reports on a periodic basis and to fix as many
+issues they highlight as is possible.
+
+Many of these plugins integrated with our Maven builds
+and our [http://16degrees.com.au/hudson continuous integration]
+server. This allows us to keep an eye on the quality trends within
+our code.
+
+
+===PMD===
+
+[http://pmd.sourceforge.net/ PMD] scans Java source code and looks for
+potential problems like:
+
+
+ * Possible bugs - empty try/catch/finally/switch statements
+ * Dead code - unused local variables, parameters and private methods
+ * Suboptimal code - wasteful String/StringBuffer usage
+ * Overcomplicated expressions - unnecessary if statements, for loops that
could be while loops
+ * Duplicate code - copied/pasted code means copied/pasted bugs
+
+
+Use the [http://pmd.sourceforge.net/eclipse/ PMD Eclipse update]
+site to install this plugin.
+
+
+
+===FindBugs===
+
+[http://findbugs.sourceforge.net/ FindBugs] uses static analysis to look
for
+bugs in Java code.
+
+Use the [http://findbugs.cs.umd.edu/eclipse/ FindBugs Eclipse update]
+site to install this plugin.
+
+
+
+
+
+
+===Start developing===
+
+Assuming all tests past you are now ready to start developing.
+Further assistance is available in the relevant sections of the Simal
+documentation.
--
You received this message because you are subscribed to the Google Groups "Simal
Commits" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/simal-commits?hl=en.
