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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Seed Documentation</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<link rel="stylesheet" href="style.css" type="text/css" charset="utf-8" />
<script type="text/javascript" src="sh.js"></script>
<script type="text/javascript" src="sh_js.js"></script>
<link type="text/css" rel="stylesheet" href="sh.css" />
</head>
<body onload="sh_highlightDocument();">
<div id="header">Seed Documentation</div>
<div id="subheader">v.@VERSION@</div>
<div class="section"><b>Tutorial</b></div>
<p>
There is a (very) introductory tutorial to Seed, covering the creation of a small GTK+ WebKit browser, <a href="tutorial-standalone/tutorial.html">here</a>.
</p>
<div class="section"><b>Mapping</b></div>
<p>
There is a document covering at a broad level, how things in a namespace are mapped to Seed when importing, <a href="mapping/mapping.html">here</a>.
<div class="section"><b>Reference Manual</b></div>
<p>
The C API, some of the modules, and a small (but expanding) portion of the runtime API is documented <a href="reference/html/index.html">here</a>.
</p>
<div class="section"><b>Runtime</b></div>
<p>
Documentation on the Seed builtins and runtime is <a href="runtime.html">here</a>.
</p>
<div class="section"><b>Examples</b></div>
<p>
Seed has a wide variety of examples <a href="http://git.gnome.org/cgit/seed/tree/examples">in git</a>. A partial index of some of the more useful examples is below:
</p>
<p><b>Large Examples</b></p>
<ul>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/browser">browser</a> - An expanded version of the simple WebKit browser outlined in the tutorial</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/clutter-pad">clutter-pad</a> - An example to prototype Clutter scripts using a GtkSourceView widget and a GtkClutter stage. Demonstrates usage of sandbox module and GtkBuilder</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/clutter-shader">clutter-shader</a> - Demonstrates the use of Clutter Shaders and GtkSourceView</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/pango.js">pango</a> - Demonstrates a bit more complicated Pango usage, and Clutter usage, to create a sort of font playground</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/turtle">turtle</a> - a simple example of the C embedding API to create a logo like turtle</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/twitter">twitter</a> - A moderately simple Gtk twitter client, demonstrates GIO, Gtk, GdkPixbuf.</li>
</ul>
<p><b>Small Examples</b></p>
<ul>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/accelgroup.js">accelgroup.js</a> - Demonstrates proper use of Gtk key accelerators</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/actions.js">actions.js</a> - Gtk actions, for menus, toolbars, and accelerators</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/async-quine.js">async-quine.js</a> - A Quine which loads itself asynchronously</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/broken">broken</a> - Several old examples, or old versions of examples which have not been updated</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/calculator.js">calculator.js</a> - A simple GTK calculator</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/clutter-1.0.js">clutter-1.0.js</a> - A silly demo of Clutter 1.0</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/clutter-cairo-1.0.js">clutter-cairo-1.0.js</a> - Simple use of Clutter 1.0's Cairo component</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/clutter-cogl-1.0.js">clutter-cogl-1.0.js</a> - Demonstrates usage of COGL for drawing in Clutter</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/dbus/dbus-banshee.js">dbus-banshee</a> - Demonstrates the use of DBus to control Banshee</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/dbus/dbus-consolekit.js">dbus-consolekit</a> - Demonstrates the use of DBus to query ConsoleKit</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/dbus/dbus-networkmanager.js">dbus-networkmanager</a> - Demonstrates the use of DBus to query NetworkManager</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/gconf.js">gconf.js</a> - Simple GConf usage (reading keys)</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/gdkpixbufloader.js">gdkpixbufloader.js</a> - Demonstrates reading an image with GIO and loading it in to a GdkPixbuf</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/glib">glib</a> - Several examples of using GLib, including timers, timeouts and threading</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/Gnio.js">Gnio.js</a> - Basic client usage of GIO</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/Gnio-server.js">Gnio-server.js</a> -Implementing a server using GIO</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/gtkplug.js">gtkplug.js</a> - Demonstrates GtkPlug usage</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/gtktextview.js">gtktextview.js</a> - A very simple use of GtkTextView</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/gtktreeview.js">gtktreeview.js</a> - Demonstrates the use of GtkTreeView</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/json-reddit.js">json-reddit.js</a> - Uses GIO and JSON to parse the reddit homepage</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/ls.js">ls.js</a> - Enumerating a directory with GIO</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/n-oscillator.js">n-oscillator.js</a> - Demonstrates basic Gtk and GStreamer usage</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/notify-test.js">notify-test.js</a> - Usage of libnotify</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/opengl">opengl</a> - Reimplementations of classic opengl examples in Seed (including glxgears!)</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/pango-fontset.js">pango-fontset</a> - Demonstrates basic Pango usage (for querying font information)</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/poppler.js">poppler.js</a> - A simple PDF viewer, demonstrates poppler and GTK</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/quine.js">quine.js</a> - Reads itself with GIO</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/repl.js">repl.js</a> - The Seed REPL</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/soup.js">soup.js</a> - Basic client usage of soup</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/threaded-repl.js">threaded-repl.js</a> - An example of a REPL which runs async while a GTK program continues to run</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/video.js">video.js</a> - Runs the GStreamer video test</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/vte-test.js">vte-test.js</a> - A simple terminal using VTE</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/xml/xml-dom.js">xml-dom</a> - Demonstrates the use of the libxml module for basic document access using DOM methods</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/xml/xml-tree.js">xml-tree</a> - Demonstrates the use of the libxml module for basic document access using the document tree</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/xml/xml-xpath.js">xml-xpath</a> - Demonstrates the use of the libxml module for basic document access using XPath</li>
<li><a href="http://git.gnome.org/cgit/seed/tree/examples/xml/weather.js">weather</a> - Demonstrates the use of XPath and Soup to check the weather using the Yahoo API</li>
</ul>
<div class="section"><b>Native Modules</b></div>
<p>
Seed has several C extension modules, to bind libraries not available from GObject-introspection.
</p>
<div class="subsection"><b>readline, sqlite, GtkBuilder, and sandbox</b></div>
<p>
Documented in the main manual (<a href="reference/html/modules.html">html</a> <a href="modules/modules.pdf">pdf</a>)
</p>
<div class="subsection"><b>canvas</b></div>
<p>
A reimplementation of HTML5 canvas, with some Cairo integration. Documented <a href="modules/canvas.html">here</a>
</p>
<div class="subsection"><b>os</b></div>
<p>
A module similar (nearly identical) to python's os module. Not yet documented, python os module documentation is useful.
</p>
<div class="subsection"><b>dbus</b></div>
<p>
A module which allows usage of DBus. Not yet documented, but see the <a href="http://git.gnome.org/cgit/seed/tree/examples/dbus-banshee.js">dbus-banshee</a> or <a href="http://git.gnome.org/cgit/seed/tree/examples/dbus-consolekit.js">dbus-consolekit</a> examples.
</p>
<div class="subsection"><b>libxml</b></div>
<p>
A module which allows basic usage of libxml. Not yet documented, or complete, however very similar to the <a href="http://xmlsoft.org/python.html">libxml2 python module</a>.
</p>
</body>
</html>
|
