Skip to content
This repository has been archived by the owner on Nov 20, 2020. It is now read-only.

Commit

Permalink
Documentation update reflecting the Kepler structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Andre Carregal committed Mar 20, 2006
1 parent a4a83ac commit 0e9df68
Show file tree
Hide file tree
Showing 5 changed files with 137 additions and 105 deletions.
14 changes: 10 additions & 4 deletions doc/us/examples.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html>
<head>
<title>LuaExpat: XML Expat parsing for the Lua programming language</title>
<link rel="stylesheet" href="http://www.keplerproject.org/doc.css" type="text/css"/>
<link rel="stylesheet" href="file://S:\Kepler\work\carregal\kepler\css\doc.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
</head>
<body>
Expand Down Expand Up @@ -43,6 +43,12 @@ <h1>LuaExpat</h1>
</li>
<li><strong>Examples</strong></li>
<li><a href="lom.html">Lua Object Model</a></li>
<li><a href="http://luaforge.net/projects/luaexpat/">Project</a>
<ul>
<li><a href="http://luaforge.net/tracker/?group_id=13">Bug Tracker</a></li>
<li><a href="http://luaforge.net/scm/?group_id=13">CVS</a></li>
</ul>
</li>
<li><a href="license.html">License</a></li>
</ul>
</div> <!-- id="navigation" -->
Expand Down Expand Up @@ -98,7 +104,7 @@ <h2><a name="examples"></a>Examples</h2>
</pre>

<p>Note that the text parts are not handled since the corresponding
callback (<em>CharacterData</em>) have not been defined. Also note
callback (<em>CharacterData</em>) has not been defined. Also note
that defining this callback after the call to lxp.new would make no
difference. But had the callback table been defined as</p>

Expand Down Expand Up @@ -132,7 +138,7 @@ <h2><a name="examples"></a>Examples</h2>
<p>Another example would be the use of <em>false</em> as a
placeholder for the callback. Suppose that we would like to print
only the text associated with <em>elem2</em> elements and that the
XML sample was</p>
XML sample is</p>

<pre class="example">
&lt;elem1&gt;
Expand Down Expand Up @@ -183,7 +189,7 @@ <h2><a name="examples"></a>Examples</h2>
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
<p><small>
$Id: examples.html,v 1.2 2005-05-23 14:01:12 carregal Exp $
$Id: examples.html,v 1.3 2006-03-20 22:26:00 carregal Exp $
</small></p>
</div> <!-- id="about" -->

Expand Down
76 changes: 44 additions & 32 deletions doc/us/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
<div id="container">

<div id="product">
<div id="product_logo"><a href="http://www.keplerproject.org">
<img alt="LuaExpat logo" src="luaexpat.png"/>
</a></div>
<div id="product_logo">
<a href="http://www.keplerproject.org"><img alt="LuaExpat logo" src="luaexpat.png"/></a>
</div>
<div id="product_name"><big><strong>LuaExpat</strong></big></div>
<div id="product_description">XML Expat parsing for the Lua programming language</div>
</div> <!-- id="product" -->
Expand Down Expand Up @@ -43,6 +43,12 @@ <h1>LuaExpat</h1>
</li>
<li><a href="examples.html">Examples</a></li>
<li><a href="lom.html">Lua Object Model</a></li>
<li><a href="http://luaforge.net/projects/luaexpat/">Project</a>
<ul>
<li><a href="http://luaforge.net/tracker/?group_id=13">Bug Tracker</a></li>
<li><a href="http://luaforge.net/scm/?group_id=13">CVS</a></li>
</ul>
</li>
<li><a href="license.html">License</a></li>
</ul>
</div> <!-- id="navigation" -->
Expand All @@ -59,36 +65,40 @@ <h2><a name="overview"></a>Overview</h2>

<h2><a name="status"></a>Status</h2>

<p>Current version is 1.0.2. It has been tested in
Linux, Windows and MacOS X with Expat 1.95.8.</p>
<p>Current version is 1.0.2. It was developed for Lua 5.0 and has been tested on
Linux, Windows (2000/XP) and MacOS X with Expat 1.95.8.</p>

<p>LuaExpat 1.0.2 follows the
<a href="http://www.keplerproject.org/compat/">package model</a>
for Lua 5.1 (see section <a href="manual.html#installation">Installation</a>
for more details).</p>

<h2><a name="download"></a>Download</h2>

<p>LuaExpat source can be downloaded from its
<a href="http://luaforge.net/projects/luaexpat/files">LuaForge</a>
page. If you are using
<a href="http://luabinaries.luaforge.net">LuaBinaries</a> Release 2
a Windows pre-compiled version of LuaExpat can also be found at the same
LuaForge page.</p>
a Windows binary version of LuaExpat can be found at the LuaForge page.</p>

<h2><a name="history"></a>History</h2>

<ul>
<li>[09/Jun/2005] Version 1.0.2 released</li>
<li>[06/Jun/2005] Version 1.0.1 released</li>
<li>[2/Dec/2004] Version 1.0 released</li>
<li>[4/Apr/2004] Version 1.0 beta released</li>
<li>[10/Dec/2003] Version 1.0 alpha released</li>
</ul>
<dl class="history">
<dt><strong>Version 1.0.2</strong> [22/Mar/2006]</dt>
<dd>minor bugfix, <code>lom</code> correct module name is <code>lxp.lom</code>.</dd>

<p>Version 1.0.2 has a minor bugfix, lom correct module name is "lxp.lom".</p>
<p>Version 1.0.1 has some minor changes to follow Expat's version 1.95.8.</p>
<dt><strong>Version 1.0.1</strong> [06/Jun/2005]</dt>
<dd>minor changes for compatibility with Expat version 1.95.8.</dd>

<p>LuaExpat 1.0 follows the
<a href="http://www.keplerproject.org/compat/">package model</a>
for Lua 5.1 (see section <a href="manual.html#installation">Installation</a>
for more details).</p>
<dt><strong>Version 1.0</strong> [2/Dec/2004]</dt>
<dd />

<dt><strong>Version 1.0 Beta</strong> [4/Apr/2004]</dt>
<dd />

<dt><strong>Version 1.0 Alpha</strong> [10/Dec/2003]</dt>
<dd />
</dl>

<h2><a name="references"></a>References</h2>

Expand All @@ -102,30 +112,32 @@ <h2><a name="references"></a>References</h2>
<h2><a name="credits"></a>Credits</h2>

<p>Version 1.0 was designed by Roberto Ierusalimschy, Andr&eacute;
Carregal and Tom&aacute;s Guisasola as part of the Kepler Project.
The implementation is compatible with Lua 5.0 and was coded by
Roberto Ierusalimschy, based on a previous design by <a href=
"http://www.place.org/~nop/lua">Jay Carlson</a>.</p>
Carregal and Tom&aacute;s Guisasola as part of the Kepler Project
which holds its copyright. The implementation is compatible with Lua 5.0
and was coded by Roberto Ierusalimschy, based on a previous design by
<a href="http://www.place.org/~nop/lua">Jay Carlson</a>.</p>

<p>LuaExpat development was sponsored by <a href=
"http://www.fabricadigital.com.br">F&aacute;brica Digital</a> and
<p>LuaExpat development was sponsored by
<a href="http://www.fabricadigital.com.br">F&aacute;brica Digital</a> and
FINEP.</p>

<h2><a name="contact"></a>Contact</h2>

<p>For more information please <a href=
"mailto:[email protected]">contact us</a>.
<p>For more information please
<a href="mailto:[email protected]">contact us</a>.
Comments are welcome!</p>

<p>You can also reach other Kepler developers and users on the Kepler Project
<a href="http://luaforge.net/mail/?group_id=104">mailing list</a>.</p>

</div> <!-- id="content" -->

</div> <!-- id="main" -->

<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
<p><small>
$Id: index.html,v 1.37 2006-03-03 23:36:59 tomas Exp $
</small></p>
<p><a href="http://validator.w3.org/check?uri=referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
<p><small>$Id: index.html,v 1.38 2006-03-20 22:26:00 carregal Exp $</small></p>
</div> <!-- id="about" -->

</div> <!-- id="container" -->
Expand Down
10 changes: 8 additions & 2 deletions doc/us/license.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ <h1>LuaExpat</h1>
</li>
<li><a href="examples.html">Examples</a></li>
<li><a href="lom.html">Lua Object Model</a></li>
<li><a href="http://luaforge.net/projects/luaexpat/">Project</a>
<ul>
<li><a href="http://luaforge.net/tracker/?group_id=13">Bug Tracker</a></li>
<li><a href="http://luaforge.net/scm/?group_id=13">CVS</a></li>
</ul>
</li>
<li><strong>License</strong></li>
</ul>
</div> <!-- id="navigation" -->
Expand Down Expand Up @@ -74,7 +80,7 @@ <h2>License</h2>
software.</p>

<hr/>
<p>Copyright &copy; 2003-2005 The Kepler Project.
<p>Copyright &copy; 2003-2006 The Kepler Project.
</p>

<p>Permission is hereby granted, free of charge, to any person
Expand Down Expand Up @@ -104,7 +110,7 @@ <h2>License</h2>
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
<p><small>
$Id: license.html,v 1.7 2005-05-23 14:01:12 carregal Exp $
$Id: license.html,v 1.8 2006-03-20 22:26:00 carregal Exp $
</small></p>
</div> <!-- id="about" -->

Expand Down
36 changes: 21 additions & 15 deletions doc/us/lom.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ <h1>LuaExpat</h1>
</li>
<li><a href="examples.html">Examples</a></li>
<li><strong>Lua Object Model</strong></li>
<li><a href="http://luaforge.net/projects/luaexpat/">Project</a>
<ul>
<li><a href="http://luaforge.net/tracker/?group_id=13">Bug Tracker</a></li>
<li><a href="http://luaforge.net/scm/?group_id=13">CVS</a></li>
</ul>
</li>
<li><a href="license.html">License</a></li>
</ul>
</div> <!-- id="navigation" -->
Expand All @@ -56,7 +62,7 @@ <h2><a name="introduction"></a>Introduction</h2>
complete, but simple.</p>

<p>LuaExpat's distribution provides an implementation of LOM that
gets a XML documenta (a string) and transforms it to a Lua table.
gets an XML documenta (a string) and transforms it to a Lua table.
The only function exported is <strong><code>lxp.lom.parse</code></strong>.</p>


Expand All @@ -66,17 +72,17 @@ <h2><a name="characteristics"></a>Characteristics</h2>
table has three special characteristics:</p>

<ul>
<li>a special field called <strong><code>tag</code></strong> that holds the
element's name;</li>

<li>an optional field called <strong><code>attr</code></strong> that stores
the element's attributes (see <a href="#attributes">attribute's
section</a>); and</li>

<li>the element's children are stored at the <em>array-part</em> of
the table. A child could be an ordinary string or another XML
element that will be represented by a Lua table following these
same rules.</li>
<li>a special field called <strong><code>tag</code></strong> that holds the
element's name;</li>

<li>an optional field called <strong><code>attr</code></strong> that stores
the element's attributes (see <a href="#attributes">attribute's
section</a>); and</li>
<li>the element's children are stored at the <em>array-part</em> of
the table. A child could be an ordinary string or another XML
element that will be represented by a Lua table following these
same rules.</li>
</ul>


Expand Down Expand Up @@ -118,7 +124,7 @@ <h2><a name="examples"></a>Examples</h2>
}
</pre>

<p>Now an example with an element inside another one</p>
<p>Now an example with an element nested inside another element</p>

<pre class="example">
tab = lxp.lom.parse(
Expand All @@ -128,7 +134,7 @@ <h2><a name="examples"></a>Examples</h2>
)
</pre>

<p>The results would have been a table equivalent to</p>
<p>The result would have been a table equivalent to</p>

<pre class="example">
tab = {
Expand Down Expand Up @@ -162,7 +168,7 @@ <h2><a name="examples"></a>Examples</h2>
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
<p><small>
$Id: lom.html,v 1.5 2005-06-06 19:23:39 tuler Exp $
$Id: lom.html,v 1.6 2006-03-20 22:26:00 carregal Exp $
</small></p>
</div> <!-- id="about" -->

Expand Down
Loading

0 comments on commit 0e9df68

Please sign in to comment.