summaryrefslogtreecommitdiffstats
path: root/kjsembed/docs/embedding/simple-embed/demo.html
diff options
context:
space:
mode:
Diffstat (limited to 'kjsembed/docs/embedding/simple-embed/demo.html')
-rw-r--r--kjsembed/docs/embedding/simple-embed/demo.html93
1 files changed, 93 insertions, 0 deletions
diff --git a/kjsembed/docs/embedding/simple-embed/demo.html b/kjsembed/docs/embedding/simple-embed/demo.html
new file mode 100644
index 00000000..8b8f236e
--- /dev/null
+++ b/kjsembed/docs/embedding/simple-embed/demo.html
@@ -0,0 +1,93 @@
+<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
+kdebindings module of KDE. This library provides a binding between
+Qt/KDE applications and KJS.
+
+<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="ChangeLog">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">KJSEmbed Type Reference</a></b><br>
+ Documents the custom data types KJSEmbed uses to represent complex types.
+ <li><b><a href="jsref/index.html">KJSEmbed Class Reference</a></b><br>
+ Documents the types of object scripts are allowed to create.
+ <li><b><a href="jsref">KJSEmbed Scripting Reference</a></b><br>
+ Partial reference to the API available to scripts.</li>
+</ul>
+
+<h4>Host API</h4>
+<ul>
+ <li><b><a href="classdocs/index.html">KJSEmbed Native API Reference</a> (C++)</b><br>
+ Reference manual for the C++ API of the KJSEmbed library.</li>
+</ul>
+
+<h3>Appendices</h3>
+<ul>
+ <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 QSA</a></b><br>
+ Discusses the differences between KJSEmbed and QSA.</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 QSA, this is Trolltech's ECMAScript binding
+ for Qt.
+ </li>
+</ul>
+
+<hr>
+</body>
+</html>