dev_process/project-naming-policy.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'

$pageTitle 		= "Eclipse Project Naming Policy";
$pageKeywords	= "development process";
$pageAuthor		= "Bjorn Freeman-Benson Nov 20/05";

ob_start();
?>
    <div id="maincontent">
	<div id="midcolumn">

<h2>Project
      Name</h2>
      
    Naming and branding are challenging issues. In order to provide a consistent
brand for Eclipse, projects must follow these project naming guidelines. The best names are descriptive but
    at the same time memorable. The policy for project names is:
            <ul>
              <li><b>Descriptive Name.</b> A descriptive name is one that is useful
                when placed into a box on <a href="/org/councils/AC/arch2.jpg">the
                Eclipse architecture diagram</a>. For example &quot;<a href="/gmf">Graphical
                Modeling Framework</a>&quot;, &quot;Trust Framework&quot; or
                &quot;Component Assembly Tools&quot;. We want to avoid having to
                create a <a href="http://www.apache.org/foundation/projects.html" target="_top">
                separate web page to explain which names correspond to which
                technology</a>.
                <ul>
                  <li>Descriptive names do not include &quot;Eclipse&quot; or
                &quot;Project&quot;. The name should work with or without the
                prefix and suffix. For example, &quot;The Eclipse Graphical
                Modeling Framework Project&quot; as well as as &quot;Graphical
                Modeling Framework&quot;.</li>
                  <li>Descriptive names may optionally include &quot;Framework&quot;
                or &quot;Tools&quot; if the project has more of an emphasis on
                extensible frameworks, or more on exemplary tools. Eclipse
                projects always provide both but may be tailored more toward one
                or the other. When choosing to use these words, the team should
                    consider that &quot;Framework&quot; and &quot;Tools&quot;
                    mean different things to different people and may even be
                    becoming overused.&nbsp;</li>
                  <li>Top-level projects may optionally include &quot;Platform&quot;
                instead of &quot;Framework&quot;.</li>
                </ul>
              </li>
              <li><b>An optional Nickname.</b> Some teams like to have a clever
                nicknames, for example &quot;Higgins&quot; or &quot;Buckminister&quot;.</li>
              <li><b>Project Name. </b>The full name includes the optional nickname, e.g., &quot;The
                Eclipse Component Assembly Project (Buckminister)&quot;.</li>
              <li><b>Acronym.</b> Most descriptive names are sufficiently long
                that it can be convenient to abbreviate them in some way. For
                example, the Eclipse Communication Framework shortens to ECF.</li>
            </ul>
<
<h2>Using
      the Project Name</h2>

Every public use of the project name - in a web page, a presentation, a
    press release, an article, etc. - should follow these guidelines:
    <ul>
      <li>The first use of the Project Name uses the entire Descriptive Name
        and may include the optional Nickname. For
        example, &quot;The Eclipse Component Assembly
        Project (Buckminister)&quot;. Subsequent references to the project may use the
        Nickname, e.g., &quot;Buckminister&quot;.</li>
      <li>If the project is in the Proposal Phase, or is a Technology Project, that fact
        must be mentioned early in the document. For example, &quot;The proposed
        Eclipse Phoenix project ...&quot; or &quot;The Buckminister project, a
        Technology project at Eclipse, is releasing version 0.2 of their framework
        for early alpha feedback from the community.&quot;</li>
    </ul>
<p>&nbsp;

<h2>Infrastructure
      uses of the Project Name</h2>

<b>Newsgroup.<br>
</b>The project newsgroup name will be <code>eclipse.[toplevel].[shortname]</code>.
The short name can be an abbreviation of the Descriptive Name, or an Acronym, e.g.,
eclipse.technology.ecf, or it can be the optional Nickname, e.g.,
eclipse.technology.buckminister.
<p><b>Mailing Lists.<br>
</b>
New projects typically have a single <code> [shortname]-dev@</code> mailing list. When multiple components are being developed by independent teams, the new project may choose to have additional mailing lists of the form
<code>[shortname]-[component]-dev@</code>. The short name can be an abbreviation
of the Descriptive Name, or an Acronym, or the project's optional Nickname.</p>
<p><b>CVS Components.<br>
</b> Typical component names are <code>org.eclipse.[shortname].[component]</code>. The
short name is some variation of the project's Descriptive Name - the Acronym, a
shortened version, or even the whole name. The project's optional Nickname is <b><i> not</i></b> a valid
short name for CVS components. For example, org.eclipse.ecf.core and
org.eclipse.componentassembly.ui are valid component names, but
org.eclipse.buckminister.internal.connector is not.<br>
</p>
</div>
</div>
<?php
	# Paste your HTML content between the EOHTML markers!	
	$html = ob_get_contents();
	ob_end_clean();

	# Generate the web page
	$App->generatePage($theme, $Menu, $Nav, $pageAuthor, $pageKeywords, $pageTitle, $html);
?>