annotate website/src/tutorial.html @ 1617:d88fb2eb15aa

minor
author Franklin Schmidt <fschmidt@gmail.com>
date Sun, 13 Jun 2021 23:39:09 -0600
parents 13135e289b50
children 7eddf1e990c0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1216
5dbb552075ff doctype
Franklin Schmidt <fschmidt@gmail.com>
parents: 1045
diff changeset
1 <!doctype html>
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
2 <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
3 <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
4 <title>Luan Tutorial</title>
1521
d3e61cd2aca0 docs and shell bug fix
Franklin Schmidt <fschmidt@gmail.com>
parents: 1326
diff changeset
5 <meta name="viewport" content="width=device-width, initial-scale=1">
562
7cc9d4a53d3b remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents: 512
diff changeset
6 <style>
1326
29d6d7d79c41 website - use relative paths
Franklin Schmidt <fschmidt@gmail.com>
parents: 1325
diff changeset
7 @import "site.css";
562
7cc9d4a53d3b remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents: 512
diff changeset
8 </style>
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 </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
10 <body>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
11
1326
29d6d7d79c41 website - use relative paths
Franklin Schmidt <fschmidt@gmail.com>
parents: 1325
diff changeset
12 <div small>
29d6d7d79c41 website - use relative paths
Franklin Schmidt <fschmidt@gmail.com>
parents: 1325
diff changeset
13 <a href=".">Luan</a>
29d6d7d79c41 website - use relative paths
Franklin Schmidt <fschmidt@gmail.com>
parents: 1325
diff changeset
14 / <a href="docs.html">Documentation</a>
29d6d7d79c41 website - use relative paths
Franklin Schmidt <fschmidt@gmail.com>
parents: 1325
diff changeset
15 </div>
1324
1660136ac451 website - remove Shared.luan
Franklin Schmidt <fschmidt@gmail.com>
parents: 1323
diff changeset
16
562
7cc9d4a53d3b remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents: 512
diff changeset
17 <h1>Luan Tutorial</h1>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
18
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
19
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
20 <p>Create a file <b>hello.luan</b> containing:</p>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
21
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
22 <pre>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
23 %>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
24 Hello World
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
25 <%
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
26 </pre>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
27
1045
48506d03e230 tutorial fix
Franklin Schmidt <fschmidt@gmail.com>
parents: 736
diff changeset
28 <p>To run this, type <b>luan hello.luan</b> on the command line. This should print <b>Hello World</b>.</p>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
29
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
30 <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>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
31
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
32 <pre>
686
33f1b4ad2c9d more documentation fixes
Franklin Schmidt <fschmidt@gmail.com>
parents: 562
diff changeset
33 local name = "Bob"
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
34 %>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
35 Hello <%= name %>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
36 <%
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
37 </pre>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
38
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
39 <p>This should print <b>Hello Bob</b>. Now let's try a more conventional approach:</p>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
40
562
7cc9d4a53d3b remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents: 512
diff changeset
41 <pre>
693
ca169567ce07 module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents: 686
diff changeset
42 local Io = require "luan:Io.luan"
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
43 local print = Io.print
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
44
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
45 print("Hello World")
562
7cc9d4a53d3b remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents: 512
diff changeset
46 </pre>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
47
693
ca169567ce07 module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents: 686
diff changeset
48 <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>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
49
693
ca169567ce07 module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents: 686
diff changeset
50 <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>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
51
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
52 <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>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
53
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
54 <p>Let's a make fancier version:</p>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
55
562
7cc9d4a53d3b remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents: 512
diff changeset
56 <pre>
693
ca169567ce07 module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents: 686
diff changeset
57 local Io = require "luan:Io.luan"
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
58 local print = Io.print
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
59
512
d96944467ffc update documentation for luan changes
Franklin Schmidt <fschmidt@gmail.com>
parents: 505
diff changeset
60 local function hello(name)
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
61 print("Hello "..name)
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
62 end
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
63
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
64 hello("Bob")
562
7cc9d4a53d3b remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents: 512
diff changeset
65 </pre>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
66
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
67 <p>The <b>..</b> operator does concatenation. This will print <b>Hello Bob</b>.</p>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
68
1217
4c2972f4d862 .html in examples
Franklin Schmidt <fschmidt@gmail.com>
parents: 1216
diff changeset
69 <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.html.luan</b> containing:
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
70
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
71 <pre>
693
ca169567ce07 module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents: 686
diff changeset
72 local Io = require "luan:Io.luan"
ca169567ce07 module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents: 686
diff changeset
73 local Http = require "luan:http/Http.luan"
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
74
512
d96944467ffc update documentation for luan changes
Franklin Schmidt <fschmidt@gmail.com>
parents: 505
diff changeset
75 return function()
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
76 Io.stdout = Http.response.text_writer()
736
Franklin Schmidt <fschmidt@gmail.com>
parents: 693
diff changeset
77 %>
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
78 &lt;!doctype html>
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
79 &lt;html>
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
80 &lt;body>
736
Franklin Schmidt <fschmidt@gmail.com>
parents: 693
diff changeset
81 Hello World
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
82 &lt;/body>
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
83 &lt;/html>
736
Franklin Schmidt <fschmidt@gmail.com>
parents: 693
diff changeset
84 <%
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
85 end
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
86 </pre>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
87
1217
4c2972f4d862 .html in examples
Franklin Schmidt <fschmidt@gmail.com>
parents: 1216
diff changeset
88 <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.html.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.html">http://localhost:8080/hi.html</a> then you will run the program which will generate the web page.</p>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
89
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
90 <p>The Luan webserver expects the file to return a function and calls it to generate the page. Code of the form <b>%>...<%</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>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
91
1325
28c1fc6d9d29 website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents: 1324
diff changeset
92 <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.</p>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
93
1576
13135e289b50 domain change
Franklin Schmidt <fschmidt@gmail.com>
parents: 1521
diff changeset
94 <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.luan.software</b>. If you don't have a domain, just use a domain like <b>bob.s1.luan.software</b> (anything of the form <b>*.s1.luan.software</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
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
95
562
7cc9d4a53d3b remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents: 512
diff changeset
96 <pre>
1576
13135e289b50 domain change
Franklin Schmidt <fschmidt@gmail.com>
parents: 1521
diff changeset
97 luan luan:host/push.luan bob.s1.luan.software secret site
562
7cc9d4a53d3b remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents: 512
diff changeset
98 </pre>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
99
693
ca169567ce07 module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents: 686
diff changeset
100 <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>
382
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
101
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
102 <p>Hopefully this short tutorial gave you an idea of how to use Luan to make a website.</p>
8557581740db added tutorial
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
103
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
104 </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
105 </html>