File: README-web.html

package info (click to toggle)
coccinella 0.96.20-7
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 13,108 kB
  • ctags: 5,908
  • sloc: tcl: 124,744; xml: 206; makefile: 66; sh: 62
file content (154 lines) | stat: -rw-r--r-- 5,737 bytes parent folder | download | duplicates (4)
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XMPP URI Examples</title>

</head>

<body>
<center><h1><u>XMPP Protocol Initiation URI Syntax.</u></h1></center>

<h2>Specifications</h2>

You can put an url in a web page to launch The Coccinella. Use a link:
<a href="xmpp:matben@athlon.se">xmpp:matben@athlon.se</a>
This works presently only on Windows and on unix systems with the KDE
environment:

<UL TYPE="SQUARE">
    <LI>On <B>Windows</B> you need to launch Coccinella
at least once with administrator privilegies to make it work.
    <LI>On <B>KDE</B> systems it writes a file ~/.kde/share/services/xmpp.protocol the 
first time Coccinella is launched, which is in turn used by KDE to
communicate with The Coccinella. It seems that the desktop environment
caches this info so a second login may be necessary for this to take effect.
Not all web browsers seem to understand the KDE desktop but at least
Konqueror does.
</UL>

<p>
Note that the JID you supplu in the uri is <EM>not</EM> your own login JID
but the target address for any action specified.
The login uses the active profile in the application, not the JID in the uri!

<p>
The definition of the uri syntax is found in RFC 4622 from 
<A HREF="http://www.ietf.org/">http://www.ietf.org/</A>.
If you use non US-ascii characters make sure the JID is encoded according
to the reference above.

<p>
The other specifications can be found at

<UL TYPE="DISC">
    <LI><A HREF="http://www.jabber.org/jeps/jep-0147.html">http://www.jabber.org/jeps/jep-0147.html</A>
    <LI><A HREF="http://www.jabber.org/registrar/querytypes.html">http://www.jabber.org/registrar/querytypes.html</A>
</UL>

<p>
You can also launch The Coccinella using the switch -uri:
set argv <CODE>-uri xmpp:marilu@l4l.be?...</CODE> from the console or terminal.

<p>
The specification does only specify the syntax used, and is considered
to be generic.
The syntax is:
<pre>
xmppuri   = "xmpp" ":" hierxmpp [ "?" querycomp ] [ "#" fragment ]
hierxmpp  = authpath / pathxmpp
authpath  = "//" authxmpp [ "/" pathxmpp ]
authxmpp  = nodeid "@" host
pathxmpp  = [ nodeid "@" ] host [ "/" resid ]
querycomp = querytype [ *pair ]
pair      = ";" key "=" value
</pre>

<p>
Note that the form with an <CODE>authpath</CODE> is not recomended.
The following XMPP IRI/URI
signals the processing application to authenticate as
"guest@example.com" and to send a message to "support@example.com":
<pre>
      xmpp://guest@example.com/support@example.com?message
      </pre>
By contrast, the following XMPP IRI/URI signals the processing
application to authenticate as its configured default account and to
send a message to "support@example.com":
<pre>
      xmpp:support@example.com?message
      </pre>
      
<p>
In addition to the standards described above, there are currently a few additions
which may change later.
For any querytype you may specify the following key-value pairs:

<pre>
"ssl"           0|1
"priority"      integer
"invisible"     0|1
"ip"            network domain name or number
"sasl"          0|1
</pre>


<p>
For the <CODE>join</CODE> type the following key-value pair has been added:
(note that the JID you specify here must be room/nickname):
<pre>
"xmlns"         "whiteboard"
</pre>
The server must support the disco method for service discovery, and the
groupchat must be of the MUC type. All modern servers comply with this.

<h2>Examples</h2>

<h3>01 Perform a Coccinella login ##
<small>xmpp:admin_user_node@example.com</small></h3>
Perform a Coccinella login using your <EM>current selected profile</EM>. This is not very useful
since there is no query type. The JID you specify is supposed to be the target of your action,
or query, but since this is missing, it just performs a standard login.

<h3>02 Prepare to send an instant message ##
<small>xmpp:contact_user_node@example.com</small></h3>
Prepare to send a "Hello World" message to mickey@example.com:
<a href="xmpp:mickey@example.com?message;subject=Hi;body=Hello%20World">
xmpp:mickey@example.com?message;subject=Hi;body=Hello%20World</a>.
<p>
Note that the same presumption of the <EM>current selected profile</EM>
is providing the necessary authentication for this activity on the server.
Valid in all cases below!

<h3>03 Prepare to start a chat session ##
<small>xmpp:contact_user_node@example.com</small></h3>
Prepare to start a chat session with mickey@example.com:
<a href="xmpp:mickey@example.com?message;subject=Hi;body=Hello%20World;type=chat">
xmpp:mickey@example.com?message;subject=Hi;body=Hello%20World;type=chat</a>.

<h3>04 Enter a chat room ##
<small>xmpp:roomname@conference.example.com/nickname</small></h3>
Enter the sss chat room using nickname Terry:
<a href="xmpp:sss@conference.example.com/Terry?join">
xmpp:sss@conference.example.com/Terry?join</a>.
<p>
Note that the same presumption of the <EM>current selected profile</EM>
is providing the necessary authentication for this activity on the server.
Now, moreover, the <i>server-side rule</i> that the owner of a room
has automatic access irrespective of password also is at play here because
the 'sss' room requires a password.

<h3>05 Start a whiteboard session ##
<small>xmpp:roomname@conference.example.com/nickname</small></h3>
Start a whiteboard session in the sss chat room with nickname Terry:
<a href="xmpp:sss@conference.example.com/Terry?join;xmlns=whiteboard">
xmpp:sss@conference.example.com/Terry?join;xmlns=whiteboard</a>.
<p>
Again, this works because Terry owns 'sss', or actually, the JID behind Terry owns the room.
However, most rooms are not password protected, hence no password key is necessary.

</body>
</html>