Difference between revisions of "Help:Wiki Design"
Jump to navigation
Jump to search
| Line 11: | Line 11: | ||
=== Component Page === | === Component Page === | ||
| − | * Naming : using the component name only (ie : THttpCli, TFtpServer, ...) | + | * '''Naming''' : using the component name only (ie : THttpCli, TFtpServer, ...) |
| − | * Section Overview : | + | * '''Section Overview''' : Summarize functionalities and usage. |
| − | Summarize functionalities and usage. | + | ''([QUESTION] : do we precise here or give a complete section to the inheritence path as in the Borland Help ?)'' |
| − | ([QUESTION] : do we precise here or give a complete section to the inheritence path as in the Borland Help ?) | + | * '''Section Properties''' : Properties references (links) with small descriptions |
| − | * Section Properties | + | * '''Section Methods''' : Methods references (links) with small descriptions |
| − | Properties references (links) with small descriptions | + | * '''Section Events''' : Events references (links) with small descriptions |
| − | * Section Methods | + | * '''Section FAQ''' : FAQs concerning the component (links) with an explicit name |
| − | Methods references (links) with small descriptions | ||
| − | * Section Events | ||
| − | Events references (links) with small descriptions | ||
| − | * Section FAQ | ||
| − | FAQs concerning the component (links) with an explicit name | ||
=== Property/Method/Event Page === | === Property/Method/Event Page === | ||
| − | * Naming : | + | * '''Naming''' : using the "Component:Property/Method/Event name" only (ie : THttpCli:Abort) |
| − | using the "Component:Property/Method/Event name" only (ie : THttpCli:Abort) | + | ''([QUESTION] : do we use the ':' or the '.' to separate the terms ?)'' |
| − | + | * '''Section Definition''' : Give the complete definition with description of each parameter (if applicable) | |
| − | ([QUESTION] : do we use the ':' or the '.' to separate the terms ?) | + | * '''Section Description''' : Complete explanation |
| − | * Section Definition | + | * '''Section Examples''' : Give a small and explained example of its use (property, method) or implementation (Event) |
| − | Give the complete definition with description of each parameter (if applicable) | + | * '''Section FAQ''' : List some FAQs where this property/method/event is used. |
| − | * Section Description | ||
| − | Complete explanation | ||
| − | * Section Examples | ||
| − | Give a small and explained example of its use (property, method) or implementation (Event) | ||
| − | * Section FAQ | ||
| − | List some FAQs where this property/method/event is used. | ||
Revision as of 15:42, 15 February 2006
Wiki Design
- Components Reference
- FAQs
- Articles (more general about networking, asynchronous paradigm, multithreading w/ ICS, Design Patterns w/ICS, ...)
- Links (Delphi resources around the web)
- Wiki Help
- Authors list & TeamICS
Pages Design
Component Page
- Naming : using the component name only (ie : THttpCli, TFtpServer, ...)
- Section Overview : Summarize functionalities and usage.
([QUESTION] : do we precise here or give a complete section to the inheritence path as in the Borland Help ?)
- Section Properties : Properties references (links) with small descriptions
- Section Methods : Methods references (links) with small descriptions
- Section Events : Events references (links) with small descriptions
- Section FAQ : FAQs concerning the component (links) with an explicit name
Property/Method/Event Page
- Naming : using the "Component:Property/Method/Event name" only (ie : THttpCli:Abort)
([QUESTION] : do we use the ':' or the '.' to separate the terms ?)
- Section Definition : Give the complete definition with description of each parameter (if applicable)
- Section Description : Complete explanation
- Section Examples : Give a small and explained example of its use (property, method) or implementation (Event)
- Section FAQ : List some FAQs where this property/method/event is used.
