Owl Lua API - Revision history

Admin at 16:18, 10 June 2014

2014-06-10T16:18:12Z

2014-06-10T16:17:57Z

2013-03-04T01:48:37Z

2013-03-03T16:51:35Z

‎sgml Class

2013-03-03T16:50:45Z

2013-03-03T16:50:36Z

2013-03-03T16:50:23Z

2013-03-03T16:49:00Z

‎Params

2013-03-03T16:48:44Z

‎webclient.post()

2013-03-03T16:46:39Z

‎webclient.post()

← Older revision		Revision as of 16:17, 10 June 2014
Line 120:		Line 120:
	* <code>params["html"]</code> - The html being parsed, can be partial Html from the last request.		* <code>params["html"]</code> - The html being parsed, can be partial Html from the last request.
	* <code>params["url"]</code> - The url that resulted in the html.		* <code>params["url"]</code> - The url that resulted in the html.
		+
		+	[[Category:Lua]]
		+	[[Category::Parsers]]

@@ Line 1: / Line 1: @@
-The Owl Lua API is a platform for building parsers in Owl. It consists of instantiable classes and static objects. Each response is processed through [http://tidy.sourceforge.net/ HTML Tidy] so that all HTML returned is valid XHTML.
+The Owl Lua API is a platform for building parsers in Owl. It consists of instantiable classes and static objects.
 == <code>regexp</code> Class ==
@@ Line 42: / Line 42: @@
 == <code>webclient</code> Class ==
-The <code>webclient</code> class is used to make HTTP requests. To help reduce load and improve loading time, this class uses an internal cache. Cache requests expire in by default in 30 seconds.
+The <code>webclient</code> class is used to make HTTP requests. To help reduce load and improve loading time, this class uses an internal cache. Cache requests expire in by default in 30 seconds. Each response is processed through [http://tidy.sourceforge.net/ HTML Tidy] so that all HTML returned is valid XHTML.
 === <code>webclient.new()</code> ===

@@ Line 11: / Line 11: @@
 == <code>sgml</code> Class ==
-The <code>sgml</code> class parses Html markup and builds an SGML DOM. '''Note:''' Parsing of even well formed documents can be slow for very large files.
+The <code>sgml</code> class parses Html markup and builds an SGML DOM.
 == <code>utils</code> Class ==

← Older revision		Revision as of 16:50, 3 March 2013
Line 1:		Line 1:
	The Owl Lua API is a platform for building parsers in Owl. It consists of instantiable classes and static objects. Each response is processed through [http://tidy.sourceforge.net/ HTML Tidy] so that all HTML returned is valid XHTML.		The Owl Lua API is a platform for building parsers in Owl. It consists of instantiable classes and static objects. Each response is processed through [http://tidy.sourceforge.net/ HTML Tidy] so that all HTML returned is valid XHTML.
−
−	~~{{TOC}}~~

	== <code>regexp</code> Class ==		== <code>regexp</code> Class ==

@@ Line 118: / Line 118: @@
 The following indexes in the `params` table are used in Owl.
 * <code>params["error-text"]</code> - (required) Displayed as the error's text
-* <code>params["html"]<code> - The html being parsed, can be partial Html from the last request.
+* <code>params["html"]</code> - The html being parsed, can be partial Html from the last request.
-* <code>params["url"]<code> - The url that resulted in the html.
+* <code>params["url"]</code> - The url that resulted in the html.

← Older revision		Revision as of 16:48, 3 March 2013
Line 95:		Line 95:
	print (source)		print (source)
	</syntaxhighlight>		</syntaxhighlight>
		+
		+	== Error Handling ==
		+
		+	When a Lua parser encounters an error there are a few different ways the error can be dispatched. Note: None of these methods will explicitly abort the Lua script, this must be done in the Lua implementation.
		+
		+	=== <code>error.warn(params)</code> ===
		+
		+	The error-text will be displayed in the status bar and, if logging is turned on, the error will be written to the log file. Note: If Owl is in Debug mode then an error packet is created.
		+
		+	''' Parameters '''
		+	* params (table) - String index dictionary of data.
		+
		+	=== <code>error.throw(params)</code> ===
		+
		+	This will throw an exception in the Owl client causing the request to stop. The error-text will be reported in the status bar and in a pop-up dialog.
		+
		+	''' Parameters '''
		+	* params (table) - String index dictionary of data.
		+
		+	=== Params ===
		+
		+	The following indexes in the `params` table are used in Owl.
		+	* <code>params["error-text"]</code> - (required) Displayed as the error's text
		+	* <code>params["html"]<code> - The html being parsed, can be partial Html from the last request.
		+	* <code>params["url"]<code> - The url that resulted in the html.

← Older revision		Revision as of 16:46, 3 March 2013
Line 86:		Line 86:
	* status (numeric) - HTTP status code result of the request.		* status (numeric) - HTTP status code result of the request.
	* isError (boolean) - TRUE if there was an error with the request, otherwise FALSE.		* isError (boolean) - TRUE if there was an error with the request, otherwise FALSE.
		+
		+	''' Example '''
		+
		+	<syntaxhighlight lang="lua">
		+	-- print the HTML source code of www.google.com
		+	local client = webclient.new()
		+	local source = client:get("http://www.google.com")
		+	print (source)
		+	</syntaxhighlight>