summaryrefslogtreecommitdiffstats
path: root/kjsembed/docs/index.html
blob: 735310aa3fdc38f1bcb4dde37c6f30a0205bd466 (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
93
94
95
96
97
98
<html>
<head>
<link href="kjsembed.css" rel="stylesheet" type="text/css">
<title>KJSEmbed Documentation</title>
</head>
<body>
<h1>KJSEmbed Documentation</h1>
<hr>

<h3>Introduction</h3>

The KJSEmbed library is an easy-to-use wrapper around the KDE
ECMAScript interpreter (kjs) that makes it easy to add scriptability
to an application. The kjsembed library is distributed in the
tdebindings module of KDE. This library provides a binding between
Qt/KDE applications and KJS. As well as working in its native KDE environment,
the library supports a Qt-only build that has no KDE dependencies.

<h3>Discussion Forums</h3>

There is now a KJSEmbed mailing list, see
<a href="http://mail.kde.org/mailman/listinfo/kjsembed">http://mail.kde.org/mailman/listinfo/kjsembed</a>
for more information about the list. In addition to the mailing list,
KJSEmbed is discussed on the #kaxul IRC channel (on the freenode IRC network).

<h3>Learning KJSEmbed</h3>

An introduction to KJSEmbed. The example scripts demonstrate the use
of all the major objects, and even provides some useful tools. The
tutorial provides a basic introduction to using KJSEmbed, though it is
a little out of date.

<ul>
  <li><b><a href="examples/index.html">Examples</a></b><br>
  Example scripts showing how to use KJSEmbed.</li>
  <li><b><a href="tutorial">Tutorial</a></b><br>
  A tutorial for the library. NOTE: Some of the info here is out of date, see the
  examples for cleaner ways to do things.</li>
  <li><b><a href="changes.html">ChangeLog</a></b><br>
  A log of the change history generated from CVS commit messages.</li>
  <li><b><a href="TODO">TODO</a></b><br>
  The todo list for KJSEmbed.</li>
</ul>

<h3>Reference Information</h3>

A reference manual for both the C++ and Javascript APIs defined by
KJSEmbed. The C++ API is of interest to developers looking to adding
scripting to support to their applications, the JS API is for people
who want to write scripts.

<h4>JavaScript API</h4>
<ul>
  <li><b><a href="types.html">Type Reference</a></b><br>
  Documents the custom data types KJSEmbed uses to represent complex types.
  <li><b><a href="jsref/index.html">Object Reference</a></b><br>
  Documents the types of object scripts are allowed to create.
</ul>

<h4>Host API</h4>
<ul>
  <li><b><a href="classdocs/index.html">C++ API Reference</a> (C++)</b><br>
  Reference manual for the C++ API of the KJSEmbed library.</li>
  <li><b><a
  href="http://webcvs.kde.org/tdebindings/kjsembed/kjscmd.cpp?view=markup">Example of embedding</a></b><br>
  KJSCmd is a simple example of embedding the interpreter.
</ul>

<h3>Appendices</h3>
<ul>
  <li><b><a href="qtonly.html">Qt Only Mode</a></b><br>
  How to build KJSEmbed with no KDE dependency.</li>

  <li><b><a href="conventions.html">Document Conventions</a></b><br>
  Explains the typographical conventions used by the documents.</li>

  <li><b><a href="kjsembed-qsa.html">KJSEmbed and TQSA</a></b><br>
  Discusses the differences between KJSEmbed and TQSA.</li>
</ul>

<h3>References</h3>
<ul>
  <li><b><a href="http://www.mozilla.org/js/language/">Mozilla Javascript Resources</a></b><br>
  Mozilla's Javascript resources page, includes links to the various
  releases of the ECMA-262 specification that define the language.
  </li>
  <li><b><a href="http://www.kevlindev.com/tutorials/javascript/inheritance/">Inheritance in Javascript</a></b><br>
  A tutorial on how to implement inheritence in JavaScript.
  </li>
  <li><b><a href="http://doc.trolltech.com/qsa/">Qt Script for Applications Documentation</a></b><br>
  The documentation for TQSA, this is Trolltech's ECMAScript binding
  for Qt.
  </li>
</ul>

<hr>
</body>
</html>