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

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tomas Guisasola committed Jul 24, 2006
1 parent 269ff13 commit 0e5d8fc
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 5 deletions.
7 changes: 4 additions & 3 deletions doc/us/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ <h1>LuaExpat</h1>
<li><a href="manual.html">Manual</a>
<ul>
<li><a href="manual.html#introduction">Introduction</a></li>
<li><a href="manual.html#building">Building</a></li>
<li><a href="manual.html#installation">Installation</a></li>
<li><a href="manual.html#parser">Parser Objects</a></li>
</ul>
Expand Down Expand Up @@ -124,8 +125,8 @@ <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
which holds its copyright. The implementation is compatible with Lua 5.0
and was coded by Roberto Ierusalimschy, based on a previous design by
which holds its copyright. The implementation 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
Expand All @@ -148,7 +149,7 @@ <h2><a name="contact"></a>Contact</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: index.html,v 1.42 2006-06-26 18:28:26 carregal Exp $</small></p>
<p><small>$Id: index.html,v 1.43 2006-07-24 00:32:52 tomas Exp $</small></p>
</div> <!-- id="about" -->

</div> <!-- id="container" -->
Expand Down
32 changes: 30 additions & 2 deletions doc/us/manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,43 @@ <h2><a name="introduction"></a>Introduction</h2>
<p>LuaExpat is distributed as a library and a file <code>lom.lua</code> that
implements the <a href="lom.html">Lua Object Model</a>.</p>


<h2><a name="building"></a>Building</h2>

<p>
LuaExpat could be built to Lua 5.0 or to Lua 5.1.
In both cases,
the language library and headers files for the desired version
must be installed properly.
LuaExpat also depends on Expat 2.0 which should also be installed.
</p>
<p>
LuaExpat offers a Makefile and a separate configuration file,
<code>config</code>,
which should be edited to suit the particularities of the target platform
before running
<code>make</code>.
The file has some definitions like paths to the external libraries,
compiler options and the like.
One important definition is the version of Lua language,
which is not obtained from the installed software.
</p>


<h2><a name="installation"></a>Installation</h2>

<p>The compiled binary file should be copied to a directory in your
<code><a href="http://www.lua.org/manual/5.1/manual.html#pdf-package.cpath">LUA_CPATH</a></code>. Lua 5.0 users should install <a href="http://www.keplerproject.org/compat">Compat-5.1</a> also.</p>
<a href="http://www.lua.org/manual/5.1/manual.html#pdf-package.cpath">C path</a>.
Lua 5.0 users should also install
<a href="http://www.keplerproject.org/compat">Compat-5.1</a>.</p>

<p>Windows users can use the binary version of LuaExpat (<code>lxp.dll</code>, compatible with
<a href="http://luabinaries.luaforge.net">LuaBinaries</a> 5.0.2 Release 2) available at
<a href="http://luaforge.net/projects/luaexpat/files">LuaForge</a>.</p>

<p>The file <code>lom.lua</code> should be copied to a directory in your
<a href="http://www.lua.org/manual/5.1/manual.html#pdf-package.path">Lua path</a>.

<h2><a name="parser"></a>Parser objects</h2>

<p>Usually SAX implementations base all operations on the
Expand Down Expand Up @@ -326,7 +354,7 @@ <h4><a name="separator"></a>The separator character</h4>
<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: manual.html,v 1.25 2006-06-26 18:28:26 carregal Exp $</small></p>
<p><small>$Id: manual.html,v 1.26 2006-07-24 00:32:52 tomas Exp $</small></p>
</div> <!-- id="about" -->

</div> <!-- id="container" -->
Expand Down

0 comments on commit 0e5d8fc

Please sign in to comment.