Mercurial Hosting > luan
annotate website/src/tutorial.html.luan @ 1809:90187946d1a4
minor
| author | Franklin Schmidt <fschmidt@gmail.com> |
|---|---|
| date | Sun, 12 May 2024 17:15:33 -0600 |
| parents | 4b56eff90040 |
| children | f44dcb3fedf7 |
| rev | line source |
|---|---|
| 1651 | 1 local Luan = require "luan:Luan.luan" |
| 2 local error = Luan.error | |
| 3 local Io = require "luan:Io.luan" | |
| 4 local Http = require "luan:http/Http.luan" | |
| 5 local Shared = require "site:/lib/Shared.luan" | |
| 6 local head = Shared.head or error() | |
| 1735 | 7 local header = Shared.docs_header or error() |
| 1651 | 8 |
| 9 | |
| 10 return function() | |
| 11 Io.stdout = Http.response.text_writer() | |
| 12 %> | |
| 1216 | 13 <!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
|
14 <html> |
| 1651 | 15 <head> |
| 16 <% head() %> | |
| 17 <title>Luan Tutorial</title> | |
| 18 </head> | |
| 19 <body> | |
| 1735 | 20 <% header() %> |
| 1651 | 21 <div content> |
|
1324
1660136ac451
website - remove Shared.luan
Franklin Schmidt <fschmidt@gmail.com>
parents:
1323
diff
changeset
|
22 |
|
562
7cc9d4a53d3b
remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents:
512
diff
changeset
|
23 <h1>Luan Tutorial</h1> |
| 382 | 24 |
| 25 | |
| 26 <p>Create a file <b>hello.luan</b> containing:</p> | |
| 27 | |
|
1325
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
28 <pre> |
| 1651 | 29 %> |
| 382 | 30 Hello World |
| 1651 | 31 <% |
|
1325
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
32 </pre> |
| 382 | 33 |
| 1045 | 34 <p>To run this, type <b>luan hello.luan</b> on the command line. This should print <b>Hello World</b>.</p> |
| 382 | 35 |
| 36 <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> | |
| 37 | |
|
1325
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
38 <pre> |
|
686
33f1b4ad2c9d
more documentation fixes
Franklin Schmidt <fschmidt@gmail.com>
parents:
562
diff
changeset
|
39 local name = "Bob" |
| 1651 | 40 %> |
| 41 Hello <%= name %> | |
| 42 <% | |
|
1325
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
43 </pre> |
| 382 | 44 |
| 45 <p>This should print <b>Hello Bob</b>. Now let's try a more conventional approach:</p> | |
| 46 | |
|
562
7cc9d4a53d3b
remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents:
512
diff
changeset
|
47 <pre> |
|
693
ca169567ce07
module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents:
686
diff
changeset
|
48 local Io = require "luan:Io.luan" |
| 382 | 49 local print = Io.print |
| 50 | |
| 51 print("Hello World") | |
|
562
7cc9d4a53d3b
remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents:
512
diff
changeset
|
52 </pre> |
| 382 | 53 |
|
693
ca169567ce07
module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents:
686
diff
changeset
|
54 <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 | 55 |
|
693
ca169567ce07
module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents:
686
diff
changeset
|
56 <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 | 57 |
| 1647 | 58 <p>Luan starts with only one defined function: <b>require</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> |
| 382 | 59 |
| 60 <p>Let's a make fancier version:</p> | |
| 61 | |
|
562
7cc9d4a53d3b
remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents:
512
diff
changeset
|
62 <pre> |
|
693
ca169567ce07
module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents:
686
diff
changeset
|
63 local Io = require "luan:Io.luan" |
| 382 | 64 local print = Io.print |
| 65 | |
|
512
d96944467ffc
update documentation for luan changes
Franklin Schmidt <fschmidt@gmail.com>
parents:
505
diff
changeset
|
66 local function hello(name) |
| 382 | 67 print("Hello "..name) |
| 68 end | |
| 69 | |
| 70 hello("Bob") | |
|
562
7cc9d4a53d3b
remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents:
512
diff
changeset
|
71 </pre> |
| 382 | 72 |
| 73 <p>The <b>..</b> operator does concatenation. This will print <b>Hello Bob</b>.</p> | |
| 74 | |
| 1647 | 75 <p>Now let's make a web page. First we need a directory for our website. So create a directory <b>src</b>. In this directory, create a file <b>hi.html.luan</b> containing: |
| 382 | 76 |
|
1325
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
77 <pre> |
|
693
ca169567ce07
module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents:
686
diff
changeset
|
78 local Io = require "luan:Io.luan" |
|
ca169567ce07
module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents:
686
diff
changeset
|
79 local Http = require "luan:http/Http.luan" |
| 382 | 80 |
|
512
d96944467ffc
update documentation for luan changes
Franklin Schmidt <fschmidt@gmail.com>
parents:
505
diff
changeset
|
81 return function() |
| 382 | 82 Io.stdout = Http.response.text_writer() |
| 1651 | 83 %> |
|
1325
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
84 <!doctype html> |
|
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
85 <html> |
|
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
86 <body> |
| 736 | 87 Hello World |
|
1325
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
88 </body> |
|
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
89 </html> |
| 1651 | 90 <% |
| 382 | 91 end |
|
1325
28c1fc6d9d29
website - make docs html
Franklin Schmidt <fschmidt@gmail.com>
parents:
1324
diff
changeset
|
92 </pre> |
| 382 | 93 |
| 1652 | 94 <p>Now go back to the parent directory and do <b>luan luan:http/serve.luan src</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. In fact the page that you are currently looking at <b>tutorial.html</b> is generated from <a href="tutorial.html.luan">tutorial.html.luan</a>.</p> |
| 382 | 95 |
| 1651 | 96 <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 | 97 |
| 1659 | 98 <p>You can find this example and others in the <a href="examples/">examples directory</a>. Take a look at <a href="examples/hi2.html.luan">hi2.html.luan</a> next. Remember to remove the <b>.luan</b> from the URL to run the code.</p> |
| 382 | 99 |
| 1647 | 100 <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>src</b> and you will use the password <b>secret</b>, do the following from the command line: |
| 382 | 101 |
|
562
7cc9d4a53d3b
remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents:
512
diff
changeset
|
102 <pre> |
| 1647 | 103 luan luan:host/push.luan bob.s1.luan.software secret src |
|
562
7cc9d4a53d3b
remove SimplyHTML from documentation
Franklin Schmidt <fschmidt@gmail.com>
parents:
512
diff
changeset
|
104 </pre> |
| 382 | 105 |
|
693
ca169567ce07
module URIs must now include ".luan"
Franklin Schmidt <fschmidt@gmail.com>
parents:
686
diff
changeset
|
106 <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 | 107 |
| 108 <p>Hopefully this short tutorial gave you an idea of how to use Luan to make a website.</p> | |
| 109 | |
| 1651 | 110 </div> |
| 111 </body> | |
|
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
|
112 </html> |
| 1651 | 113 <% |
| 114 end |