blob: f3cad0fc8355488072f4c40d306f24665d49acd1 [file] [log] [blame]
<?php require_once($_SERVER['DOCUMENT_ROOT'] . "/"); require_once($_SERVER['DOCUMENT_ROOT'] . "/"); require_once($_SERVER['DOCUMENT_ROOT'] . "/"); $App = new App(); $Nav = new Nav(); $Menu = new Menu(); include($App->getProjectCommon()); # All on the same line to unclutter the user's desktop'
# template.php
# Author: Denis Roy
# Date: 2005-06-16
# Description: Type your page comments here - these are not sent to the browser
# Begin: page-specific settings. Change these.
$pageTitle = "ACTF Contributors Information";
$pageKeywords = "Accessibility Tools Framework, accessibility, ACTF, Eclipse";
$pageAuthor = "ACTF Team";
# End: page-specific settings
# Paste your HTML content between the EOHTML markers!
$html = <<<EOHTML
<div id="midcolumn">
<h1>Git Repository</h1>
<p>The source code of the ACTF project can be found in the Git Repository.
To access repository list, please visit &quot;<a href="">Developer Resources</a>&quot; tab of <a href="">ACTF project page</a>.</p>
<p>For more details to use Git in Eclipse, please visit <a href="">EGit User Guide</a> page.</p>
<h1>Development Guidelines</h1>
<h2 id="naming">1. Naming Conventions</h2>
<p>Naming Conventions in the ACTF project follow the <a href="">Eclipse Naming
Conventions</a> except for Java packages containing 'internal', 'tests', or 'examples'.</p>
<h3 name="package" id="package">Java Packages</h3>
<p>One of the main goals of this naming convention is to make it easy to find the component to which any given class belongs.
The general form of java package names is as follows:</p>
<p name="group" id="group">
Currently, ACTF includes the components listed below. This table also shows the subcomponents within each ACTF component. The
<a href="#dir">directory structure of the Git repository</a> is defined based on this grouping.</p>
<table border="1">
<th>Component name</th>
<th rowspan="6">common</th>
<td>accservice </td>
<td>includes components for accessing native accessibility architectures and APIs</td>
<td><i>is reserved for future use</i></td>
<td>includes components to support access to runtime properties of GUI components, document elements, and other runtime structures. It also includes typical application plugins as Editor Extensions.</td>
<td>includes mediator services.</td>
<td>includes repository services.</td>
<td>includes common utilities for other ACTF components.</td>
<td>includes components for adaptive interfaces.</td>
<td>includes exemplary applications.</td>
<td>includes validation engine, rulebase manager, interfaces for and base implementations of rulesets and rules and so on.</td>
<th rowspan="2">visualization</th>
<td>includes report generators.</td>
<td>includes accessibility/usability visualization engines.</td>
<p>In the ACTF project, the reserved words 'internal', 'tests', or 'examples' may appear after the component name. For example,
<tt>org.eclipse.actf.validation.tests</tt> indicates test cases that are used for the validation component. The prefered usage is
to put the reserved names in the fifth position, leaving the fourth position for the component name. In addition to
this, each component has its own ui components in the ACTF project. So, the word "ui" may appear after the component name as well.</p>
<p>The names of internal/tests/examples/ui packages in ACTF will be:</p>
<li>org.eclipse.actf.&lt;component&gt;.internal[.*] - internal packages of &lt;component&gt;</li>
<li>org.eclipse.actf.&lt;component&gt;.tests[.*] - test packages of &lt;component&gt; </li>
<li>org.eclipse.actf.&lt;component&gt;.examples[.*] - examples of &lt;component&gt;</li>
<li>org.eclipse.actf.&lt;component&gt;.ui[.*] - ui components of &lt;component&gt;</li>
<h2 name="dir" id="dir">2. Directory structure</h2>
<p>We will ask you to organize your files as described below. Basically you will need to create the following directory
structure for each subdirectory you own under the <a href="#group">ACTF component group</a>:</p>
<table cellpadding="2" cellspacing="2" border="1">
<td colspan="1"><b style="color:darkgreen">Directory structure</b></td>
<tr valign="top"><td>
<tr valign="top"><td colspan="1">
<ol><li> plugins:
<ul><li> the plugins that provide the function
</li><li> doc:
<ul><li> the doc plugins
</li><li> tests:
<ul><li> the test plugins
</li><li> features:
<ul><li> the SDK feature (to generate a bundle that includes source + the plugins) and fragments
</li><li> all main, source, test, doc, and example features and fragments
<p>The projects containing features and fragments must be suffixed by <i>-feature</i> and <i>-fragment</i> respectively.</p>
<h2>3. Coding conventions</h2>
<p>The ACTF project uses the built-in Java-convention in Eclipse.</p>
<h2>4. Namespace URI conventions</h2>
<p>To avoid unexpected propagation, namespace URIs in ACTF project will be defined as follows:</p>
If you need to create new namespaces, please submit a request to the newsgroup.
<h2 id="API">5. APIs</h2>
<p>In ACTF, all internal APIs are in internal packages
and currently are not exported to others.
(see also <a href="#naming">Naming Conventions</a>)
All public APIs exported to others are currently provisional.
ACTF plans to freeze the APIs after reflecting community feedback in Indigo release (0.9),
then all APIs will be graduating from provisional in Juno release (1.0).
<h2>6. Others</h2>
For more details about development conventions and guidelines, please visit
<a href="">Eclipse development guidelines</a> page.
# Generate the web page
$App->generatePage($theme, $Menu, $Nav, $pageAuthor, $pageKeywords, $pageTitle, $html);