Help:Wiki Design

From Overbyte
Revision as of 18:09, 10 April 2006 by Sysop (talk | contribs) (→‎Component Page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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] : go into details here or give a complete section to the inheritance 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.
Retrieved from "http://wiki.overbyte.eu/wiki/index.php?title=Help:Wiki_Design&oldid=1997"