diff website/src/tutorial.html.luan @ 693:ca169567ce07

module URIs must now include ".luan"
author Franklin Schmidt <fschmidt@gmail.com>
date Tue, 19 Apr 2016 15:54:11 -0600
parents 33f1b4ad2c9d
children 2113294ccc6d
line wrap: on
line diff
--- a/website/src/tutorial.html.luan	Mon Apr 18 20:40:21 2016 -0600
+++ b/website/src/tutorial.html.luan	Tue Apr 19 15:54:11 2016 -0600
@@ -1,7 +1,7 @@
-local Io = require "luan:Io"
-local Html = require "luan:Html"
-local Http = require "luan:http/Http"
-local Shared = require "site:/Shared"
+local Io = require "luan:Io.luan"
+local Html = require "luan:Html.luan"
+local Http = require "luan:http/Http.luan"
+local Shared = require "site:/Shared.luan"
 
 
 return function()
@@ -43,22 +43,22 @@
 <p>This should print <b>Hello Bob</b>.  Now let's try a more conventional approach:</p>
 
 <pre>
-	local Io = require "luan:Io"
+	local Io = require "luan:Io.luan"
 	local print = Io.print
 
 	print("Hello World")
 </pre>
 
-<p>In Luan, a function call with one string argument doesn't require parenthesis, so <b>print("Hello World")</b> is the same as <b>print "Hello World"</b> and <b>require "luan:Io"</b> is the same as <b>require("luan:Io")</b>.  Both <b>require</b> and <b>print</b> are functions.</p>
+<p>In Luan, a function call with one string argument doesn't require parenthesis, so <b>print("Hello World")</b> is the same as <b>print "Hello World"</b> and <b>require "luan:Io.luan"</b> is the same as <b>require("luan:Io.luan")</b>.  Both <b>require</b> and <b>print</b> are functions.</p>
 
-<p>The <b>require</b> function takes a <a href="http://en.wikipedia.org/wiki/Uniform_resource_identifier">URI</a> as an argument.  Examples of URIs are "<b>luan:Io</b>" and "<b>file:hello</b>".  <b>require</b> is used to import a module, which is returned from the <b>require</b> function call.  In the case above, we assign the module to the local variable <b>Io</b>.  The function <b>print</b> is a member of this module.  We could have done <b>Io.print("Hello World")</b> but instead we chose to assign <b>print</b> to a local variable and use that to call the function.</p>
+<p>The <b>require</b> function takes a <a href="http://en.wikipedia.org/wiki/Uniform_resource_identifier">URI</a> as an argument.  Examples of URIs are "<b>luan:Io.luan</b>" and "<b>file:hello.luan</b>".  <b>require</b> is used to import a module, which is returned from the <b>require</b> function call.  In the case above, we assign the module to the local variable <b>Io</b>.  The function <b>print</b> is a member of this module.  We could have done <b>Io.print("Hello World")</b> but instead we chose to assign <b>print</b> to a local variable and use that to call the function.</p>
 
 <p>Luan starts with only two defined functions: <b>require</b> and <b>java</b>.  You will use <b>require</b> to import whatever you need.  This is a little more work, but makes it clear in each file where each function comes from.</p>
 
 <p>Let's a make fancier version:</p>
 
 <pre>
-	local Io = require "luan:Io"
+	local Io = require "luan:Io.luan"
 	local print = Io.print
 
 	local function hello(name)
@@ -73,8 +73,8 @@
 <p>Now let's make a web page.  First we need a directory for our website.  So create a directory <b>site</b>.  In this directory, create a file <b>hi.luan</b> containing:
 
 <pre><%=Html.encode[[
-	local Io = require "luan:Io"
-	local Http = require "luan:http/Http"
+	local Io = require "luan:Io.luan"
+	local Http = require "luan:http/Http.luan"
 	
 	return function()
 		Io.stdout = Http.response.text_writer()
@@ -88,7 +88,7 @@
 	end
 ]]%></pre>
 
-<p>Now go back to the parent directory and do <b>luan luan:http/serve file:site</b>.  This will run the Luan web server on port 8080.  Try going to <a href="http://localhost:8080/">http://localhost:8080/</a>.  You should see the directory.  If you click on <b>hi.luan</b> you will see the source.  But if you remove the <b>.luan</b> and just go to <a href="http://localhost:8080/hi">http://localhost:8080/hi</a> then you will run the program which will generate the web page.</p>
+<p>Now go back to the parent directory and do <b>luan luan:http/serve.luan file:site</b>.  This will run the Luan web server on port 8080.  Try going to <a href="http://localhost:8080/">http://localhost:8080/</a>.  You should see the directory.  If you click on <b>hi.luan</b> you will see the source.  But if you remove the <b>.luan</b> and just go to <a href="http://localhost:8080/hi">http://localhost:8080/hi</a> then you will run the program which will generate the web page.</p>
 
 <p>The Luan webserver expects the file to return a function and calls it to generate the page.  Code of the form <b><%=Html.encode[[%>...<%]]%></b> writes its output to <b>Io.stdout</b> which by default is the standard output of the command line.  So in the returned function one usually starts by setting <b>Io.stdout</b> to a <code>text_writer</code> which writes its output to the HTTP response (to the web browser).</p>
 
@@ -97,10 +97,10 @@
 <p>So now you have built your website and you want to publish it to the web.  If you have your own domain, create a CNAME record for it pointing to <b>s1.luanhost.com</b>.  If you don't have a domain, just use a domain like <b>bob.s1.luanhost.com</b> (anything of the form <b>*.s1.luanhost.com</b>).  Assuming your directory is <b>site</b> and you will use the password <b>secret</b>, do the following from the command line:
 
 <pre>
-	luan luan:host/push bob.s1.luanhost.com secret site
+	luan luan:host/push.luan bob.s1.luanhost.com secret site
 </pre>
 
-<p>The form is <b>luan luan:host/push domain password directory</b>.  If you change your site, just run this again and your site will be updated.  To delete your site, do <b>luan luan:host/delete domain password</b>.</p>
+<p>The form is <b>luan luan:host/push.luan domain password directory</b>.  If you change your site, just run this again and your site will be updated.  To delete your site, do <b>luan luan:host/delete.luan domain password</b>.</p>
 
 <p>Hopefully this short tutorial gave you an idea of how to use Luan to make a website.</p>