summaryrefslogtreecommitdiff
path: root/plugins/IEView/docs/ieview-templates.txt
blob: e17303a900113a2c446282015da6720a0f5331d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
Each template begins with template name, which is a special kind of HTML comment, for instance:
<!--HTMLStart-->
or
<!--MessageIn-->
A template ends whenever a new template begins or EOF is reached.

The following templates may be defined:

<!--HTMLStart-->
<!--MessageIn-->
<!--hMessageIn-->
<!--MessageOut-->
<!--hMessageOut-->
<!--File-->
<!--hFile-->
<!--URL-->
<!--hURL-->
<!--Status-->
<!--hStatus-->
<!--MessageInGroupStart-->
<!--MessageInGroupInner-->
<!--MessageInGroupEnd-->
<!--hMessageInGroupStart-->
<!--hMessageInGroupInner-->
<!--hMessageInGroupEnd-->
<!--MessageOutGroupStart-->
<!--MessageOutGroupInner-->
<!--MessageOutGroupEnd-->
<!--hMessageOutGroupStart-->
<!--hMessageOutGroupInner-->
<!--hMessageOutGroupEnd-->

<!--HTMLStartRTL-->
<!--MessageInRTL-->
<!--hMessageInRTL-->
<!--MessageOutRTL-->
<!--hMessageOutRTL-->
<!--MessageInGroupStartRTL-->
<!--MessageInGroupInnerRTL-->
<!--MessageInGroupEndRTL-->
<!--hMessageInGroupStartRTL-->
<!--hMessageInGroupInnerRTL-->
<!--hMessageInGroupEndRTL-->
<!--MessageOutGroupStartRTL-->
<!--MessageOutGroupInnerRTL-->
<!--MessageOutGroupEndRTL-->
<!--hMessageOutGroupStartRTL-->
<!--hMessageOutGroupInnerRTL-->
<!--hMessageOutGroupEndRTL-->


All templates of which names begin with 'h' are used to display historical events.

If a template is not present the corresponding event will not be shown in the log at all !

The following variables are available in all templates EXCEPT HTMLStart:
%base%  - base URL
%name%  - contact's name or user's name (depends on context)
%time%  - event's time
%date%  - event's date
%text%  - event's text
%cid%  - contact's ID or user's ID (depends on context)
%avatar% - link to contact's picture file or user's picure file (depends on context)
%avatarIn% - link to contact's picture
%avatarOut% - link to user's picture
%nameIn% - contact's name
%nameOut% - users's name
%proto% - protocol name
%uin% - contact's ID or user's ID
%uinIn% - contact's ID
%uinOut% - user's ID
%nick% - contact's nick name or user's nick name
%nickIn% - contact's nick name
%nickOut% - user's nick name
%statusMsg% - contact's status message
%fileDesc% - file description

The following variables are available in HTMLStart:
%base%  - base URL (this variable should be used in <base> tag)
%avatarIn% - link to contact's picture
%avatarOut% - link to user's picture
%nameIn% - contact's name
%nameOut% - users's name
%nickIn% - contact's nick name
%nickOut% - user's nick name
%uinIn% - contact's ID
%uinOut% - user's ID
%proto% - protocol name

All tokens are also available in Javascript friendly (escaped) form. 
In that case please use the follwoing token names: %\base%, %\time%, %\name% etc.