Mercurial Hosting > luan
annotate website/src/tutorial.html.luan @ 512:d96944467ffc
update documentation for luan changes
| author | Franklin Schmidt <fschmidt@gmail.com> |
|---|---|
| date | Fri, 22 May 2015 16:08:23 -0600 |
| parents | 7bc63886d4f2 |
| children | 7cc9d4a53d3b |
| rev | line source |
|---|---|
| 382 | 1 local Io = require "luan:Io" |
| 2 local Html = require "luan:Html" | |
|
494
2b9bc97f0439
change luan:web to luan:http
Franklin Schmidt <fschmidt@gmail.com>
parents:
401
diff
changeset
|
3 local Http = require "luan:http/Http" |
|
387
23d075ce1e48
add website/src/Shared.luan
Franklin Schmidt <fschmidt@gmail.com>
parents:
386
diff
changeset
|
4 local Shared = require "site:/Shared" |
| 382 | 5 |
|
386
db23f654f87d
make all of website use luan
Franklin Schmidt <fschmidt@gmail.com>
parents:
383
diff
changeset
|
6 |
|
505
7bc63886d4f2
web page modules now return a function
Franklin Schmidt <fschmidt@gmail.com>
parents:
503
diff
changeset
|
7 return function() |
| 382 | 8 Io.stdout = Http.response.text_writer() |
|
391
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
9 %> |
|
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
10 <html> |
|
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
11 <head> |
|
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
12 <% Html.simply_html_head() %> |
|
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
13 <title>Luan Tutorial</title> |
|
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
14 </head> |
|
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
15 <body> |
| 382 | 16 |
| 17 <div container> | |
|
387
23d075ce1e48
add website/src/Shared.luan
Franklin Schmidt <fschmidt@gmail.com>
parents:
386
diff
changeset
|
18 <% Shared.header() %> |
| 382 | 19 <h1 margin-bottom="1em">Luan Tutorial</h1> |
| 20 | |
| 21 | |
| 22 <p>Create a file <b>hello.luan</b> containing:</p> | |
| 23 | |
| 24 <p><tt><pre><%=Html.encode[[ | |
| 25 %> | |
| 26 Hello World | |
| 27 <% | |
| 28 ]]%></pre></tt></p> | |
| 29 | |
| 30 <p>To run this, type <b>luan file:hello</b> on the command line. This should print <b>Hello World</b>.</p> | |
| 31 | |
| 32 <p>The syntax here is based on <a href="http://en.wikipedia.org/wiki/JavaServer_Pages">JSP</a>. Let's change it a little:</p> | |
| 33 | |
| 34 <p><tt><pre><%=Html.encode[[ | |
| 35 name = "Bob" | |
| 36 %> | |
| 37 Hello <%= name %> | |
| 38 <% | |
| 39 ]]%></pre></tt></p> | |
| 40 | |
| 41 <p>This should print <b>Hello Bob</b>. Now let's try a more conventional approach:</p> | |
| 42 | |
| 43 <p><tt><pre> | |
| 44 local Io = require "luan:Io" | |
| 45 local print = Io.print | |
| 46 | |
| 47 print("Hello World") | |
| 48 </pre></tt></p> | |
| 49 | |
| 50 <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> | |
| 51 | |
| 52 <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> | |
| 53 | |
| 54 <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> | |
| 55 | |
| 56 <p>Let's a make fancier version:</p> | |
| 57 | |
| 58 <p><tt><pre> | |
| 59 local Io = require "luan:Io" | |
| 60 local print = Io.print | |
| 61 | |
|
512
d96944467ffc
update documentation for luan changes
Franklin Schmidt <fschmidt@gmail.com>
parents:
505
diff
changeset
|
62 local function hello(name) |
| 382 | 63 print("Hello "..name) |
| 64 end | |
| 65 | |
| 66 hello("Bob") | |
| 67 </pre></tt></p> | |
| 68 | |
| 69 <p>The <b>..</b> operator does concatenation. This will print <b>Hello Bob</b>.</p> | |
| 70 | |
| 71 <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: | |
| 72 | |
| 73 <p><tt><pre><%=Html.encode[[ | |
| 74 local Io = require "luan:Io" | |
|
494
2b9bc97f0439
change luan:web to luan:http
Franklin Schmidt <fschmidt@gmail.com>
parents:
401
diff
changeset
|
75 local Http = require "luan:http/Http" |
| 382 | 76 |
|
512
d96944467ffc
update documentation for luan changes
Franklin Schmidt <fschmidt@gmail.com>
parents:
505
diff
changeset
|
77 return function() |
| 382 | 78 Io.stdout = Http.response.text_writer() |
| 79 %> | |
| 80 <html> | |
| 81 <body> | |
| 82 Hello World | |
| 83 </body> | |
| 84 </html> | |
| 85 <% | |
| 86 end | |
| 87 ]]%></pre></tt></p> | |
| 88 | |
|
494
2b9bc97f0439
change luan:web to luan:http
Franklin Schmidt <fschmidt@gmail.com>
parents:
401
diff
changeset
|
89 <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> |
| 382 | 90 |
|
512
d96944467ffc
update documentation for luan changes
Franklin Schmidt <fschmidt@gmail.com>
parents:
505
diff
changeset
|
91 <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 <tt>text_writer</tt> which writes its output to the HTTP response (to the web browser).</p> |
| 382 | 92 |
| 93 <p>You can find this example and others in the <a href="examples">examples directory</a>. Take a look at <a href="examples/hi2.luan">hi2.luan</a> next. Remember to remove the <b>.luan</b> from the URL to run the code. And by the way, you can see the source for this page at <a href="tutorial.html.luan">tutorial.html.luan</a>.</p> | |
| 94 | |
| 401 | 95 <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: |
| 382 | 96 |
| 97 <p><tt><pre> | |
| 98 luan luan:host/push bob.s1.luanhost.com secret site | |
| 99 </pre></tt></p> | |
| 100 | |
| 101 <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> | |
| 102 | |
| 103 <p>Hopefully this short tutorial gave you an idea of how to use Luan to make a website.</p> | |
| 104 | |
| 105 </div> | |
| 106 | |
|
391
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
107 <% Html.simply_html_body_bottom() %> |
|
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
108 </body> |
|
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
109 </html> |
|
2f5cc9c2cbf0
replace Html.simply_html_page with simply_html_head and simply_html_body_bottom
Franklin Schmidt <fschmidt@gmail.com>
parents:
387
diff
changeset
|
110 <% |
| 382 | 111 end |