Wiclear basic architecture

Introduction

WiClear is heaviliy based on DotClear. WiClear uses two icons from the DotClear software (install/images/ok.png and install/images/nok.png)

Basic architecture

Basically, you have

• index.php page at the root of the distribution that includes inc/prepend.php and inc/append.php

• inc/prepend.php is in charge of :
  • creating the theme url (only themes/default is provided for now)
  • setting up the lang and help translation objects
  • creating all the wiki objects (the active user, the active nodes and related contents)

  It uses the node.inc.php, user.inc.php, auth.inc.php and wiki.inc.php as well as helper objects (mysql, format) to create the functionnal objects.

• inc/append.php does nothing for now.

• themes/default/template.php defines the theme it consists of
  • setting up the web page layout
  • calling back functionnal methods defined in lib/boxes.lib.php
• lib/boxes.lib.php defines functionnal methods that outputs html. It uses the object created by layout/prepend.php and transforms them in html.
  • lang : is handled in path i18n (only fr and en translations for now)
  • help : is handled in path help (only fr and en files for now)
  • themes : more can be added by modifying the conf/config.ini, and adding the proper theme in the "themes/" directory. If a prepend.inc.php file exist in the theme directory it is added

install program

Very linear : each page calls the following page one after the other until the wiki is configured. It creates as output the file conf/config.ini

Distinction between "class" and "lib" :

.class files define classes.

.lib files define only functions.

URL in Wiclear

Are created via the createURL() function

forms in WiClear

Are created by the form class

---