/dev/trunk

To get this branch, use:
bzr branch http://darksoft.org/webbzr/dev/trunk

« back to all changes in this revision

Viewing changes to docs/README

  • Committer: Suren A. Chilingaryan
  • Date: 2008-04-02 10:23:22 UTC
  • Revision ID: csa@dside.dyndns.org-20080402102322-okib92sicg2dx3o3
Initial import

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
BROWSER SUPPORT
 
2
===============
 
3
 The ADEI is optimized for browsers of mozilla family. However it tested and
 
4
shown to work with Opera and Internet Explorer as well. Tested in:
 
5
    * Mozilla Seamonkey 1.1.7 (Linux, amd64)
 
6
    * Mozilla Firefox 2.0.0.11 (Linux, x86)
 
7
    * Opera 9.23 (Linux, x86)
 
8
    * Internet Explorer 6.0 SP1 (Win2000)
 
9
    * Internet Explorer 7.0 (WinXP)
 
10
    * Safari 3.1 (WinXP)
 
11
 
 
12
Following browsers are not thorougly tested, but reported to work
 
13
    * Safari 3.0.4 (MacOS 10.4.11, PowerPC G4)
 
14
    * Safari (MacOS Tiger) 
 
15
 
 
16
Following browsers are surelly not working:
 
17
    * Konqueror 3.5.7
 
18
 
 
19
 
 
20
FUNCTIONS
 
21
=========
 
22
 Overall:
 
23
    - Clicking on buttons on the left side of image will open various
 
24
    controls:
 
25
        1) Various graphic options
 
26
        2) Source of the data: database, data group, etc
 
27
        3) Data export settings
 
28
    - Mentioned above buttons may had special pictograms allowing fast
 
29
    access to the encompassed options, allowing basic operations without
 
30
    opening full controls.
 
31
    
 
32
 Graph:
 
33
    - Holding left mouse key it is possible to select area. Afterwards the
 
34
    selection area could be adjusted and shifted. Besides that it is possible
 
35
    to select:
 
36
        + Only timeframe leaving the allowed value-range untouched. To achieve
 
37
        that, please, select area with only a few pixels height.
 
38
        + Only accepted value range leaving the timeframe untouch. To achieve
 
39
        that, please, slect area with only a few pixels width.
 
40
    Following actions can be pefrormed with selection:
 
41
        +) Zoom: by double clicking within the selction, or by clicking
 
42
        on apply button attached to the selection.
 
43
        +) Export: Export the data within selection using current export 
 
44
        settings. Achieved by clicking on export button attached to the
 
45
        selection.
 
46
        +) Cancel: To cancel selection just click with a mouse somethere 
 
47
        outside of the selection.
 
48
    - By clicking on the graphic it is possible to get information about
 
49
    data items displayed (and alter items mask: display only selected items
 
50
    or remove selected items from display).
 
51
        + The mentioned information is shown in popup window which could be 
 
52
        moved and resized. If it's moved, the folowing clicks will alter
 
53
        content in the window but not window position and size.
 
54
        + To enable again size and possition auto-adjustment the window
 
55
        should be closed by clicking "close" button in the left-upper
 
56
        angle.
 
57
        + The second button in the angle will maximize window.
 
58
    - Changing certain parameters (for example items, non-by-item masks, 
 
59
    display window size) will automaticaly apply configuration. The rest
 
60
    of the parameters should be manually applied.
 
61
    - The graphic is pereodically auto-updated to display newly obtained
 
62
    data (update rate is specified in the server configuration).
 
63
    - The accuracy of the graph is highly dependent on amount of the data
 
64
    items and may varry from 1 to appr. 100 pixels (actual values are
 
65
    specified in the server configuration).
 
66
    - Zooming time window in and out could be done with mouse wheel.
 
67
 
 
68
 History:
 
69
    - The history is only updated if the graph (or some equivalent on other
 
70
    pages) is changed. The alteration of EXPORT setting will be ignored by
 
71
    history (but they will be reflected in the browser location).
 
72
    
 
73
    
 
74
TIME.
 
75
====
 
76
 In order to prevent problems with time, it is highly recommended:
 
77
    a) Set CACHE MySQL to GMT timezone
 
78
    b) Set C/en_US locale
 
79
 
 
80
DATABASES.
 
81
=========
 
82
 * MSSQL (Microsoft SQL Server)
 
83
    - The PDO(dblib) and mssql_* should not be used. The php driver is (5.2.4)
 
84
    really ugly. It obtains whole result dataset in internal buffer. 
 
85
    - The PDO(ODBC) driver works correctly.
 
86
 
 
87
 * ODBC
 
88
    - ODBC have some problems as well (both PDO and odbc_* versions):
 
89
     + It crashes when executed using mod_php, but works from php_cli
 
90
     + While executed with php_cli, the php is hang on exit
 
91
    this have been solved by 
 
92
     + using apache 2.2.6, instead of 2.0.x
 
93
     + removing -fPIC compilation flag
 
94
     + compiling into the php only odbc, pdo and mysql DB modules
 
95
   - Still there are in some circumstances quite strange behavior. The 
 
96
   'query' request could fail with error code '0' or just complaining what
 
97
   it could not prepare SQL request. 
 
98
     + This is a bug in PhP odbc(PDO/non-PDO) driver or in it interaction with
 
99
     FreeTDS odbc driver.
 
100
     + The problem looks to arise when a single connection tries to open
 
101
     second result set (two parallel queries exists) to the database.
 
102
     + Please, note that the following would trigger a error:
 
103
        while () {
 
104
            $res = $odbc->Query();
 
105
        }
 
106
    and this not (since, in the first case connection closed after another is
 
107
    openned):
 
108
        while () {
 
109
            $res = NULL;
 
110
            $res = $odbc->Query();
 
111
        }
 
112
     + The problem is handled in database.php by converting resultsets to the
 
113
     arrays. We expect what all big queries are executed with Prepare.
 
114
 
 
115
 
 
116
MULTIPLE SETUPS
 
117
===============
 
118
 To use multiple configurations with single code base, it is necesary to
 
119
 enable "$SETUP_MULTI_MODE = true;" in the configuration.
 
120
 Afterwards, it is possible to specify required setup with
 
121
 a) '?setup=<setup_name>' - in the browser
 
122
 b) 'php -- -setup <setup_name>' - in scripts
 
123