docs: add menu for UCI config files
authorÁlvaro Fernández Rojas <noltari@gmail.com>
Mon, 2 May 2016 12:46:03 +0000 (14:46 +0200)
committerÁlvaro Fernández Rojas <noltari@gmail.com>
Mon, 2 May 2016 12:46:03 +0000 (14:46 +0200)
Signed-off-by: Álvaro Fernández Rojas <noltari@gmail.com>
css/lede.css
docs/uci_dnsmasq.txt
docs/uci_dropbear.txt
docs/uci_firewall.txt
docs/uci_fstab.txt
docs/uci_net.txt
docs/uci_qos.txt
docs/uci_samba.txt
docs/uci_system.txt
docs/uci_wireless.txt

index 00b3997062e7ffd61ee1c2d096f6be108936a976..813b9ce7982ddfbcc81a6fce3ddf37de273fcd04 100644 (file)
@@ -90,3 +90,43 @@ h1 {
        color: #fff;
 }
 
+.docs_menu ol {
+       padding: 0;
+       margin: 0 -10px;
+       border: 2px solid #527bbd;
+       border-width: 2px 0;
+}
+
+.docs_menu ol li,
+.docs_menu ol li p {
+       padding: 0;
+       margin: 1px 1px 1px 1px;
+}
+
+.docs_menu ol:after {
+       content: "";
+       display: block;
+       clear: both;
+}
+
+.docs_menu ol li {
+       list-style: none;
+       float: left;
+}
+
+.docs_menu ol li p a:link,
+.docs_menu ol li p a:visited {
+       color: #527bbd;
+       font-size: 1.1em;
+       text-decoration: none;
+       display: block;
+    padding: 2px 4px;
+    border-radius: 3px 3px 3px 3px;
+}
+
+.docs_menu ol li p a:hover,
+.docs_menu ol li p a:active,
+.docs_menu ol li p a.active {
+    background-color: #527bbd;
+       color: #fff;
+}
index 0e5789820201ef73fd1015fb17c8ae448755b35f..764bbbcf3cff761b445dbc10ac23f79c0755568f 100644 (file)
@@ -1,7 +1,11 @@
 DNS and DHCP configuration
 ==========================
 
-The _dnsmasq_ and dhcpd configuration is located in '/etc/config/dhcp' and controls both DNS and DHCP server options on the device.
+include::uci_menu.inc[]
+
+== DNS and DHCP configuration
+
+The _dnsmasq_ and dhcpd configuration is located in **'/etc/config/dhcp'** and controls both DNS and DHCP server options on the device.
 
 In the default configuration this file contains one _common section_ to specify DNS and daemon related options and one or more _DHCP pools_ to define DHCP ranges serving on network interfaces.
 
index eecfe13dd7ca059a716fba8b2b2dfcc6ab62bb2d..1c71d461b12cbdaa8a2dbc0e6c6da0c17e8e8f26 100644 (file)
@@ -1,7 +1,11 @@
 Dropbear Configuration
 ======================
 
-'/etc/config/dropbear'.
+include::uci_menu.inc[]
+
+== Dropbear Configuration
+
+The firewall configuration located in **'/etc/config/dropbear'**.
 
 == Sections
 
index feaf5736072a5b30c95f6dbf286d0df75d7ca0a5..5ce2dfd7194510b3860cf2a211a8e32ec0b55315 100644 (file)
@@ -1,6 +1,10 @@
 Firewall configuration
 ======================
 
+include::uci_menu.inc[]
+
+== Firewall Configuration
+
 The firewall configuration located in **'/etc/config/firewall'**.
 
 == Overview
index b157f149581d1d7c6b9600172b8607dc282d88ce..280ed24068a1326bdaed9a38e06359e14aec1035 100644 (file)
@@ -1,11 +1,11 @@
 Fstab Configuration
 ===================
 
-The Fstab, or **f**ile **s**ystems **tab**le, is a central configuration that defines how file systems (usually on block devices) should be mounted if requested (such as on booting the device or connecting it physically). This way, you don't have to manually mount your devices when you want to access them. The mounting configuration can consist of static file systems but also swap partitions. The fstab UCI configuration file is where all the options for all devices and file systems to be mounted are defined and is located at...
+include::uci_menu.inc[]
 
-----
-/etc/config/fstab
-----
+== Fstab Configuration
+
+The Fstab, or **f**ile **s**ystems **tab**le, is a central configuration that defines how file systems (usually on block devices) should be mounted if requested (such as on booting the device or connecting it physically). This way, you don't have to manually mount your devices when you want to access them. The mounting configuration can consist of static file systems but also swap partitions. The fstab UCI configuration file is where all the options for all devices and file systems to be mounted are defined and is located at **'/etc/config/fstab'**.
 
 == Initial Configuration
 
index 4a2b32a49d1f663fe781b56d060ffc441d476913..aa338c2734f6dd7882bfeb1dca6081ce67182c6e 100644 (file)
@@ -1,11 +1,15 @@
 Network configuration
 =====================
 
-The central network configuration is located in the file '/etc/config/network'. This configuration file is responsible for defining _switch VLANs_, _interface configurations_ and _network routes_.
+include::uci_menu.inc[]
+
+== Network configuration
+
+The central network configuration is located in the file **'/etc/config/network'**. This configuration file is responsible for defining _switch VLANs_, _interface configurations_ and _network routes_.
 
 After editing and saving '/etc/config/network' you need to execute '/etc/init.d/network reload' to stop and restart the network before any changes take effect. Rebooting the router is not necessary.
 
-Feel free to inform yourself about link:https://www.lede-project.org/docs/procd.html[netifd] (Network Interface Daemon).
+Feel free to inform yourself about link:procd.html[netifd] (Network Interface Daemon).
 
 == Sections
 
index 047dcd0fc470c65c7fc95a79bbd3c34680d1a866..78d4a684bbdca9f2caab3cd8966f31bcb9a89860 100644 (file)
@@ -1,10 +1,13 @@
 Quality of Service (qos-scripts) configuration
 ==============================================
 
-This is the documentation for the UCI configuration file '/etc/config/qos'.
+include::uci_menu.inc[]
 
-*WARNING*: 'luci-app-qos' won't start until you enable the 'qos' Initscript within the System-->Startup tab as well as enable qos under Network-->QoS
+== Quality of Service configuration
+
+This is the documentation for the UCI configuration file **'/etc/config/qos'**.
 
+*WARNING*: 'luci-app-qos' won't start until you enable the 'qos' Initscript within the System-->Startup tab as well as enable qos under Network-->QoS
 
 == Sections
 
index 1ca3e9f1c66522df2cd1df74bb72f904f85aa393..4cb73c8a0e4f5ccba0fc056a6015e17162b0345f 100644 (file)
@@ -1,9 +1,11 @@
 Samba (smb)
 ===========
 
-== UCI configuration options
+include::uci_menu.inc[]
 
-The UCI configuration file is located at /etc/config/samba.
+== Samba configuration
+
+The Samba UCI configuration file is located at **'/etc/config/samba'**.
 
 === Common Options
 
index fe295a43c7ebf1e51493609d7e8a270ebe228b6d..d5ec22f07cbdeb6da27be501cad86f1acf9da9b2 100644 (file)
@@ -1,6 +1,12 @@
 System configuration
 ====================
 
+include::uci_menu.inc[]
+
+== System configuration
+
+The system UCI configuration is located in **'/etc/config/system'**.
+
 == Sections
 
 The 'system' configuration contains basic settings for the whole router. Larger subsystems such as the network configuration, the DHCP and DNS server, and similar, have their own configuration file.
index 48fd835bb9dbdd457b560256cd6cda545f5376e9..36b131cc4bfdeafd1cdd68ab990014dfd462c270 100644 (file)
@@ -1,7 +1,11 @@
 Wireless configuration
 ======================
 
-The wireless UCI configuration is located in '/etc/config/wireless'. Learn about the entire [[doc:howto:wireless.overview|IEEE 802.11 "wireless" subsystem]].
+include::uci_menu.inc[]
+
+== Wireless configuration
+
+The wireless UCI configuration is located in **'/etc/config/wireless'**. Learn about the entire [[doc:howto:wireless.overview|IEEE 802.11 "wireless" subsystem]].
 
 By default the wireless is **OFF**. You can turn it on in the '/etc/config/wireless' by changing 'disabled 1' to 'disabled 0'