Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Template - Component Description"

(Plans)
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{#eclipseproject:technology.higgins|eclipse_custom_style.css}}
 
__NOTOC__
 
__NOTOC__
This page describes the wiki page in the leftmost column of each row here [[Components]]:
+
This page is a template for the wiki page linked from the header of each table on these pages: [[Components]]. If a component is implemented by only one Eclipse project folder (as is most often the case), then there MUST be two wiki pages created: (a) a redirect page with a nice "human friendly" name (e.g. I-Card Fribulator) that points to (b) a page that is named by the EXACT eclipse project name (e.g. org.eclipse.higgins.foo.bar) that implements this component.
  
 
<one para intro>
 
<one para intro>
== Details ==
 
* Status: E.g. Available since 1.0M8
 
* Language: E.g. Java
 
* Packaging: E.g. JAR
 
  
==Backlog==
+
=== Service ===
* <put a link to a wiki page that listing features and enhancements that are being considered. This wiki page name should end in "<space>Backlog" and a link to it should be added to [[Backlog]]>
+
 
+
== Service ==
+
 
* <Description of the main responsibilities of this project or component>
 
* <Description of the main responsibilities of this project or component>
* <Description of other components this component depends on>
+
* OPTIONAL: mention of some key API methods
 +
 
 +
=== Backlog  ===
 +
 
 +
*&lt;put a link to a wiki page that listing features and enhancements that are being considered. This wiki page name should end in "&lt;space&gt;Backlog" and a link to it should be added to [[Higgins Backlog]]&gt;
  
== API ==
+
''Add this at the bottom:'' <nowiki>[[Category: Higgins Components]]</nowiki>  
* <key API methods>
+
  
== Links ==
+
[[Category:Higgins_Developer_Info]]
* [http://eclipse.org/higgins Higgins Home]
+

Latest revision as of 16:38, 25 April 2011

{{#eclipseproject:technology.higgins|eclipse_custom_style.css}}

This page is a template for the wiki page linked from the header of each table on these pages: Components. If a component is implemented by only one Eclipse project folder (as is most often the case), then there MUST be two wiki pages created: (a) a redirect page with a nice "human friendly" name (e.g. I-Card Fribulator) that points to (b) a page that is named by the EXACT eclipse project name (e.g. org.eclipse.higgins.foo.bar) that implements this component.

<one para intro>

Service

  • <Description of the main responsibilities of this project or component>
  • OPTIONAL: mention of some key API methods

Backlog

  • <put a link to a wiki page that listing features and enhancements that are being considered. This wiki page name should end in "<space>Backlog" and a link to it should be added to Higgins Backlog>

Add this at the bottom: [[Category: Higgins Components]]

Back to the top