docs: add documentation for site library

This commit is contained in:
Matthias Schiffer 2018-07-07 11:43:18 +02:00
parent 68af719e24
commit 6a5e67b383
No known key found for this signature in database
GPG Key ID: 16EF3F64CB201D9C
2 changed files with 37 additions and 0 deletions

36
docs/dev/site_library.rst Normal file
View File

@ -0,0 +1,36 @@
gluon.site library
==================
The *gluon.site* library allows convenient access to the site configuration
from Lua scripts. Example:
.. code-block:: lua
local site = require 'gluon.site'
print(site.wifi24.ap.ssid())
The *site* object in this example does not directly represent the *site.conf* data structure;
instead, it is wrapped in a way that makes it more convenient to access deeply nested elements.
To access the the underlying values, they must be unwrapped using the function call notation
(the ``()`` after ``site.wifi24.ap.ssid`` in the example).
The wrapper objects have two advantages over simple Lua tables:
* Accessing non-existing values is never an error: ``site.wifi24.ap.ssid()`` will simply
return *nil* if ``site.wifi24`` or ``site.wifi24.ap`` do not exist
* Default values: A default value can be passed to the unwrapping function call:
.. code-block:: lua
print(site.wifi24.ap.ssid('Default'))
will return *'Default'* instead of *nil* when the value is unset.
Note that *nil* values and unset values are equivalent in Lua.
A simple way to access the whole site configuration as a simple table
is to unwrap the top-level site object:
.. code-block:: lua
local site_table = site()

View File

@ -40,6 +40,7 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre
dev/upgrade dev/upgrade
dev/wan dev/wan
dev/mac_addresses dev/mac_addresses
dev/site_library
.. toctree:: .. toctree::
:caption: gluon-web Reference :caption: gluon-web Reference