Difference between revisions of "UI Best Practices Template v3.x"

From Eclipsepedia

Jump to: navigation, search
m (Current Template)
m
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
= Proposed Template Revision =
+
= Current Template =
 +
 
 +
Please use this template when creating new pages or converting old 2.1 content.
 +
 
 
== Topic Name ==
 
== Topic Name ==
 
=== Title ===
 
=== Title ===
Line 47: Line 50:
  
  
 +
= Old Template =
  
 +
For reference only. Please do not use this template. Use the one above.
  
= Past Template =
 
 
== Topic Name ==
 
== Topic Name ==
  
Line 79: Line 83:
 
=== Related Information ===
 
=== Related Information ===
 
<This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.>
 
<This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.>
 +
 +
[[Category:UI_Guidelines]]

Latest revision as of 12:43, 31 October 2007

Contents

[edit] Current Template

Please use this template when creating new pages or converting old 2.1 content.

[edit] Topic Name

[edit] Title

<Content of this section includes summary and problem description type information.>

  • Description short 1 – 3 paragraph description of the problem.

[edit] Design Rationale

<This describes the thinking behind the design and the best practices to solve the problem.>

[edit] Examples

<This shows good examples, common errors, and tips and tricks.>

(Required)

  • Good example 1
  • Good example 2

(Optional)

  • Common error example 1
  • Common error example 2

(Optional)

  • Tip and trick 1
  • Tip and trick 2

[edit] Guidelines

<This is a list of Do's and Dont's>

[edit] Implementation

(Optional)

<This offers information for implementing the solution. It could be a link to the API code for example, or some instructions.>

  • Sample code 1
  • Sample code 2

[edit] Related Information

<This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.>


[edit] Old Template

For reference only. Please do not use this template. Use the one above.

[edit] Topic Name

[edit] Summary

<This is a single active and concise statement describing what to do to follow the best practice. It should start with a verb.>

[edit] Problem Description

<This is short 1 – 3 paragraph description of the problem.>

[edit] Best Practice

<This lists and describes the best practices or best practices in solve the problem.>

[edit] Tips and Tricks

<This offers tips and tricks for solving the problem.>

[edit] Common Errors

  • Example 1
  • Example 2

[edit] Implementation

<This offers information for implementing the solution. It could be a link to the API code for example, or some instructions.>

  • Sample code 1
  • Sample code 2

[edit] Related Information

<This is for links to related information internal or external to the guidelines and to areas of the 2.1 guidelines that your best practice extends. Provide as direct links as possible.>