ProjectInfoKeys

From Eclipsepedia

Jump to: navigation, search

Key Definitions for ProjectInfo Data

It is necessary to keep track of the MainKeys to be used by this schema for tracking production data in order for the data to be easily queried by page/api developers. The following is the list of MainKeys and SubKeys currently defined:

  Each Eclipse project has an official name, e.g., 
 "AJDT - AspectJ Development Tools Project" and a foundation database 
 key, e.g., "technology.ajdt". These are stored in an Eclipse Foundation
 database; You can override the name stored on the database by filling 
 the projectname key

MainKey: projectname
     SubKey: NULL Value: AspectJ Development Tools Project

 Each project can also have a short name to be used in HTML lists and 
 other horizontally challenged places.

MainKey: projectshortname
     SubKey: NULL Value: AJDT

  This field is used to track the URL to the projects homepage

MainKey: projecturl
     SubKey: NULL Value: http://www.eclipse.org/tptp/

 Each Eclipse project has one or more Bugzilla products and components.
 Some projects also have a separate web page describing how to submit
 a bug, how bugs are prioritized, and other useful information.
 The <bugzilla> collects this information.
<bugzilla url="..."> <product name="..."/> ... </bugzilla>
The url is optional; if absent, the url will default to the Bugzilla page of the first product. Multiple <product>s are allowed.

MainKey: bugzilla
     SubKey: productname Value: Mylar

 Committers and non-committer Contributors are the raison d'etre of 
 an Eclipse project, thus each project should list and acknowledge these
 developers. Some of the Committers are 'special' in the sense that
 they are the project leaders.  The <team> element contains the 
 URL of the project's pages listing these important people.
 The eclipse.org website infrastructure has a handy link for you to
 include in the url: see [1].

MainKey: teamurl
     SubKey: NULL Value: /projects/lists.php?list=byproject&param=technology.dash

 Most projects have wiki pages with documentation or work in progress
 or discussions or whatever wikis are good for. The <wiki> element
 contains the URL of the 'root' of the project's wiki pages.

MainKey: wikiurl
     SubKey: NULL Value: http://wiki.eclipse.org/index.php/STP

 The source code of each Eclipse project is stored in CVS. Eclipse maintains
 a number of CVS repositories, thus the <cvs> element specifies which
 CVS repository and (if applicable) which root path stores this project's
 source code.
 A top-level project typically specifies only the repository:
   <cvs repository="/cvsroot/tptp"/>
A sub-project includes the root path as well: <cvs repository="/cvsroot/technology/">
<module path="org.eclipse.higgins" />
</cvs>

MainKey: cvs
     SubKey: repository Value: /cvsroot/tools
MainKey: cvs
     SubKey: modulepath Value: org.eclipse.cdt-build
MainKey: cvs
     SubKey: modulepath Value: org.eclipse.cdt-contrib
MainKey: cvs
     SubKey: modulepath Value: org.eclipse.cdt-core
MainKey: cvs
     SubKey: modulepath Value: org.eclipse.cdt-cppunit

 The description of an Eclipse project shows up in many places: the
 project's home page, perhaps the /projects/ page listing all the
 top-level projects, in the Roadmap, and so on. Some of the descriptions
 are separate HTML files (such as those described in 
 http://phoenix.eclipse.org/projects/dev_process/project-status-infrastructure.php).
 It would be nice 
 This <description> element contains two additional descriptions.

      1. The optional <description url="..."> points to a web page with a larger
      description of the entire project.
      2. The required <description paragraph-url="..."> points to a file
      containing a couple of simple HTML paragraphs describing the project.
      This file is often stored in the /project-info/ directory, thus the
      url would be something like "/tptp/project-info/description.html".

MainKey: descriptionurl
     SubKey: NULL Value: /tptp/home/project_info/general/whatisTPTP.html
     
MainKey: paragraphurl
     SubKey: NULL Value: /webtools/project-page-paragraph.html

 In addition to the description, each Eclipse project is also required to
 provide an up-to-date status summary. "Up to date" means revised at least
 quarterly. 
 The required <summary paragraph-url="..."> points to a file
 containing a number of simple HTML paragraphs with an executive summary
 of the project status.
 This file is often stored in the /project-info/ directory, thus the
 url would be something like "/technology/project-info/executive-summary.html".

MainKey: summaryurl
     SubKey: NULL Value: /technology/project-info/executive-summary.html

 It is important to help new users get started with an Eclipse project
 because most Eclipse projects are solving some difficult technical
 problem and thus are somewhat complex. The <getting-started> element
 points to a web page on the project's site that describes how to
 get started using and extending the project's tools and frameworks.

MainKey: gettingstartedurl
     SubKey: NULL Value: /webtools/community/communityresources.html#tutorials

 It is also important to help new contributors get started with an Eclipse project.
 Most Eclipse projects have interesting/complex development environment
 setups or to-do lists. The <contributing> element
 points to a web page on the project's site that describes how to
 get started developing on, and contributing to, the project.

MainKey: contributingurl
     SubKey: NULL Value: /webtools/adopters/

 Each Eclipse project is required to maintain a current Project IP Log.
 See http://www.eclipse.org/projects/dev_process/project-log.php
 The <ip-log> contains the URL of that log.  If the project has
 other legal information as well, it can use the <legal> element
 instead and then include the IP Log information on the Legal web page.

MainKey: iplogurl
     SubKey: NULL Value: /projects/slides/Web%20Tools%20Platform%201.0%20Project%20IP%20Log.pdf

MainKey: legalurl
     SubKey: NULL Value: /projects/slides/Web%20Tools%20Platform%201.0%20Project%20IP%20Log.pdf

 Each Eclipse project has one or more mailing lists.
 Some projects also have a separate web page describing these lists
 while others rely on the main Eclipse mailing lists page.
 <mailing-lists url="..."> <list name="..."/> ... </mailing-lists>
 The url is optional; if absent, the url will default to the Eclipse
 mailing lists page. Multiple <lists>s are allowed.
 Note that currently mailing lists must be redundantly listed in
 the separate project-info/maillist file as well.

MainKey: mailinglist
     SubKey: url Value: /birt/index.php?page=community.html
MainKey: mailinglist
     SubKey: name Value: birt-news
     SubKey: type Value: main
MainKey: mailinglist
     SubKey: name Value: birt-pmc
MainKey: mailinglist
     SubKey: name Value: birt-dev
MainKey: mailinglist
     SubKey: name Value: birt-charting-dev
MainKey: mailinglist
     SubKey: name Value: birt-charting-dev

 Each Eclipse project has one or more newsgroups.
 Some projects also have a separate web page describing these lists
 while others rely on the main Eclipse newsgroups page.
 <newsgroups url="..."> <newsgroup name="..."/> ... </newsgroups>
 The url is optional; if absent, the url will default to the Eclipse
 newsgroups page. Multiple <newsgroups>s are allowed.

MainKey: newsgroup
     SubKey: name Value: eclipse.platform.rcp
     SubKey: type Value: main
MainKey: newsgroup
     SubKey: name Value: eclipse.platform.swt

 The dashboard attempts to measure the liveness of a project in many
 ways including the traffic on the mailing lists and newsgroups. There
 are other places where significant project-related traffic can occur
 including blogs and articles. When listed here, the dashboard incorporates
 them into the liveness measure (or rather, "will incorporate").

MainKey: articles
     SubKey: url Value: articles/Article-Forms/article.html
MainKey: articles
     SubKey: url Value: http://www.onjava.com/pub/a/onjava/2002/12/11/eclipse.html

MainKey: blogs
     SubKey: rss Value: http://eclipse-projects.blogspot.com/atom.xml

 Each Eclipse project needs to have a plan both for its internal purposes
 (to guide development and resource allocation) and for the larger Eclipse
 community and ecosystem to understand what will be delivered and when
 it will be delivered.

MainKey: projectplanurl
     SubKey: NULL Value: /birt/index.php?page=project/project_plan_R2_0_0_Draft.html

 Each Eclipse project can choose to be listed on the category pages off of
 the main homepage of www.eclipse.org.  This key will allow the project to
 specify which categories they belong to.  Projects can specify more then one
 category. There are 5 values currently that this field can be.
 ENT - Enterprise Development
 EMB - Embedded and Device Development
 RCP - Rich Client Platform
 APP - Application Frameworks
 IDE - Languages IDEs

MainKey: categories
     SubKey: NULL Value: RCP
MainKey: categories
     SubKey: NULL Value: IDE


 The documentation url is an optional field that would point to the location of the
 projects documentation.  This could be a URL that is part of the projects website
 or a link to the help.eclipse.org page for that project.

MainKey: documentationurl
     SubKey: NULL Value: http://www.eclipse.org/ecf/documentation.php

 Each Eclipse project creates (optional) nightly builds and milestone builds,
 but the important builds of a project are the releases. This section of the
 status file records the completed (past) and scheduled (future) releases of
 the project. 
 The status, name, and date are required attributes. The download is optional
 and only valid for completed releases; the plan is optional and valid for
 all releases.  The three valid types of releases are, in order of ascending 
 uncertainity: "completed", "scheduled", and "tentative".  Dates can be
 specified as particular day DD/MM/YYYY (e.g., 22/03/2005) or a particular
 month MM/YYYY (e.g., 10/2005), or a quarter NQYYYY (e.g., 3Q2005). Obviously
 completed releases should include the exact day the release was completed.
 In the following example, we have three completed, two scheduled, and one 
 tentative release.

MainKey: release
     SubKey: status Value: completed
     SubKey: name Value: 3.0.2
     SubKey: date Value: 2005-02-01
     SubKey: download Value: /tptp/home/downloads/drops/3.0.2.html
MainKey: release
     SubKey: status Value: completed
     SubKey: name Value: 3.3.0
     SubKey: date Value: 2005-06-01
     SubKey: download Value: /tptp/home/downloads/drops/3.3.0.html
MainKey: release
     SubKey: status Value: scheduled
     SubKey: name Value: 4.2.0
     SubKey: date Value: 2006-06-01