some stupid devel guidelines:

  • KISS programming principle
  • the library approach (which often limits ways to get things done)
    • this is why all function and variable names, but also constants start with "ewiki_"
  • not-object-oriented API for easier use and inclusion into a container CMS
    • having OO parts in it won't hurt, but users should not be enforced to use ewiki that way
    • as a bad example for OO one may consult the source of PhpWiki:
  • everything should be easy to use (or later made so) for end users
    • this however does not mean, that we needed to ensure windows users could use it ;)
  • ewiki basically only cares about WikiPages
    • anything else must be hacked into the $action/$id scheme, and shouldn't hurt the page concept to much
  • be more configurable than other wikis
    • (and this easier than with PhpWiki: or so)
  • speed
    • means regular expressions only where absolutely required, otherwise try to use simple string functions where possible
  • limiting/restrictions where helpful
  • documentation
    • throughout the code, comments for known problems and things to improve
  • DatabasePhilosophy
  • CodingGuideLines

These are milkys personal guidelines, which do not necessarily apply to plugins, and which are of course not meant to be the ONLY WAY to do things.

*AnyOne could also write a chapter about *WikiPhilosophy...

bottom corner