(no commit message)
[project/luci.git] / README
1 FFLuCI - Freifunk Lua Configuration Interface
2
3 This is a leightweight MVC-Webframework for small embedded devices.
4 It uses the the Lua programming language and relies on Haserl.
5
6 It consists of several parts:
7
8 MVC Dispatcher
9 Simple PATH_INFO based dispatching mechanism using Lua modules
10
11
12 Template engine
13 Support for plain and compiled templates, on-demand compiling support
14 Short markups:
15 <% Lua-Code %>
16 <%= Lua-Code with return value %>
17 <%:i18nkey default translation%>
18 <%+template-to-be-included%>
19 <%~uci.short.cut%>
20
21 Predefined variables for controller dir and media dir
22
23
24 Configuration Bind Interface (CBI)
25 Generates and validates XHTML-Forms out of an UCI model description
26 Makes it very easy to create webinterface pages that manipulate UCI files
27
28
29 i18n Translation support
30 Simple multi-language per-module internationalization support
31
32
33 UCI wrapper support
34 Lua UCI-Wrapper adapting the CLI of the uci binary
35
36
37 Menu Building support
38 Supports menu building for modules and exported actions
39
40
41 HTTP-Abstraction and Formvalue validation support
42 HTTP-Redirect, Statuscode, Content-Type abstraction
43 Dynamic formvalue validation support including varaible type and
44 value range validation
45
46
47 Known issues:
48 There is a bug in older versions of busybox-httpd (as those in Kamikaze 7.09)
49 that do not handle Status-headers correctly making valid HTTP-Redirects impossible.
50 Using a newer version of Kamikaze should fix this.