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.
Difference between revisions of "E4/Doc/Template"
Line 1: | Line 1: | ||
{{E4/Doc/Under construction}} | {{E4/Doc/Under construction}} | ||
− | == | + | == Description == |
<div style="margin-left:10px;"> | <div style="margin-left:10px;"> | ||
A generic description of the service. | A generic description of the service. | ||
</div> | </div> | ||
− | == | + | == Consumer == |
<div style="margin-left:10px;"> | <div style="margin-left:10px;"> | ||
e4 specific description of the service/ implementation details etc. | e4 specific description of the service/ implementation details etc. | ||
− | + | === Usage === | |
(natural breakdown relevant to the service itself here) | (natural breakdown relevant to the service itself here) | ||
− | + | === Code Samples === | |
<source lang="java"> | <source lang="java"> | ||
Line 21: | Line 21: | ||
</source> | </source> | ||
− | + | === Eclipse 3.x === | |
(only if it's relevant AND helpful) | (only if it's relevant AND helpful) | ||
</div> | </div> | ||
− | == | + | == Producer == |
<div style="margin-left:10px;"> | <div style="margin-left:10px;"> | ||
e4 specific description of the service/ implementation details etc. | e4 specific description of the service/ implementation details etc. | ||
− | + | === Usage === | |
− | + | === Code Samples === | |
− | + | === Eclipse 3.x === | |
(this is not likely needed here) | (this is not likely needed here) | ||
</div> | </div> | ||
− | == | + | == Related Materials == |
<div style="margin-left:10px;"> | <div style="margin-left:10px;"> | ||
− | + | === Related Services === | |
− | + | === Related API's === | |
− | + | === See Also === | |
</div> | </div> |
Revision as of 18:10, 11 February 2010
The evolution of this document is a collaborative effort between a team of students at the University of Manitoba and the wider Eclipse community. Details about the project can be found here and on our Blog.
Your input is not just welcome; it is needed! Please contribute as your expertise allows, while adhering to our template. To send your feedback and any questions or comments you may have please email us. Also, while we do our very best to be as accurate and precise as possible, it is worth noting that we are students with limited exposure to the Eclipse platform, so if you see any incorrect technical details please let us know.
Contents
Description
A generic description of the service.
Consumer
e4 specific description of the service/ implementation details etc.
Usage
(natural breakdown relevant to the service itself here)
Code Samples
System.out.println("I'm some java code");
alert("I'm some javascript");
Eclipse 3.x
(only if it's relevant AND helpful)
Producer
e4 specific description of the service/ implementation details etc.
Usage
Code Samples
Eclipse 3.x
(this is not likely needed here)