|
| Attributes your pattern should consist of:
|
| Title:
| The name of the pattern has to transport its idea in one or a few words show markup
Insert the pattern's name inside the title tag like (:title Pattern Name:)
|
| Rating:
| Degree of confidence in the pattern's validity show markup
(:rating 1:) means the pattern needs to be worked on.
(:rating 2:) means it's pretty solid.
(:rating 3:) the pattern is proven to work for all cases of the problem domain.
|
| Summary:
| Give a short summary that contains the main points of what the pattern solves and how.
|
| Illustration:
| Provide an illustration to give a quick idea about how the pattern works show instructions
The illustration can be a sketch, flash example, openlaszlo prototype or a movie clip.
- Embed images by clicking the image button
on the edit toolbar. In the pasted markup replace Filename.png with the image filename you want to upload. Also replace Image Description with a short description what the illustration shows. Once you have saved the page, click on the image filename to upload the image.
- For flash or openlaszlo prototypes use the
toolbar button.
- Close the examples with
[[<<]] to get a line break.
|
| Context:
| In which context can the pattern be applied?
|
| Problems:
| Write about the problems that drive the pattern
|
| Examples:
| List up to three screenshots of real world examples that show the pattern in use.
|
| Solution:
| State the solution in a few catchy sentences
|
| Rationale:
| Explain the rationale behind the solution
|
| Code Examples:
| If available, give reusable code examples show instructions
- To embed code examples use the Attach:code-12.gif Δ button in the toolbar below.
- Then paste your code inside the
(:Codeexample:) markup like
(:Codeexample:)
Source code goes here
(:End of Codeexample:)
- To get colored syntax highlighting, specify the programming language within the Codeexample attribute like
(:Codeexample c++:) or (:Codeexample java:)
|
| Related:
| Links to related patterns
|
| Literature:
| Related literature to emphasize the validity of your patterns
|