\ No newline at end of file
--
cgit v1.2.3-55-g7522
From f5f8d91f25378464c59fbec49ebf43f00c668966 Mon Sep 17 00:00:00 2001
From: Simon Rettberg
Date: Tue, 14 Jun 2016 16:12:17 +0200
Subject: Fix main menu text color, make sub-section text bold
---
style/default.css | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/style/default.css b/style/default.css
index c77149da..bf1834d6 100644
--- a/style/default.css
+++ b/style/default.css
@@ -469,10 +469,14 @@ section{
padding-left: 15px;
}
-li.slx-submenu {
+li.slx-submenu a {
font-size: 80%;
font-weight: bold;
- padding-left: 1em;
+ padding-left: 3em;
+}
+
+nav.navbar.sidebar {
+ color: #eee;
}
/*
--
cgit v1.2.3-55-g7522
From 1692a395d90e5ff4c9b826ab2b126b9572f05cd9 Mon Sep 17 00:00:00 2001
From: Simon Rettberg
Date: Tue, 14 Jun 2016 16:13:27 +0200
Subject: [citymanagement] Create new menu categories in cities module (mostly
as an example)
---
modules-available/citymanagement/config.json | 2 +-
modules-available/citymanagement/lang/de/categories.json | 3 +++
modules-available/citymanagement/lang/en/categories.json | 3 +++
3 files changed, 7 insertions(+), 1 deletion(-)
create mode 100644 modules-available/citymanagement/lang/de/categories.json
create mode 100644 modules-available/citymanagement/lang/en/categories.json
diff --git a/modules-available/citymanagement/config.json b/modules-available/citymanagement/config.json
index 2eb2d680..e87cbf7d 100644
--- a/modules-available/citymanagement/config.json
+++ b/modules-available/citymanagement/config.json
@@ -1,4 +1,4 @@
{
- "category":"main.settings-server",
+ "category":"citymanagement.cities",
"permission":"0"
}
diff --git a/modules-available/citymanagement/lang/de/categories.json b/modules-available/citymanagement/lang/de/categories.json
new file mode 100644
index 00000000..0c348a06
--- /dev/null
+++ b/modules-available/citymanagement/lang/de/categories.json
@@ -0,0 +1,3 @@
+{
+ "cities": "St\u00e4dte"
+}
\ No newline at end of file
diff --git a/modules-available/citymanagement/lang/en/categories.json b/modules-available/citymanagement/lang/en/categories.json
new file mode 100644
index 00000000..2233db93
--- /dev/null
+++ b/modules-available/citymanagement/lang/en/categories.json
@@ -0,0 +1,3 @@
+{
+ "cities": "Cities"
+}
\ No newline at end of file
--
cgit v1.2.3-55-g7522
From 1873fa94f309b4acc2c16eea2b26387d540ae55f Mon Sep 17 00:00:00 2001
From: Simon Rettberg
Date: Tue, 14 Jun 2016 17:13:54 +0200
Subject: Add documentation
---
doc/baseconfig_-_config-variables | 42 +++++++++++++++++++++++++++++++++++++++
doc/dashboard | 20 +++++++++++++++++++
doc/enabling_modules | 16 +++++++++++++++
doc/installation | 28 ++++++++++++++++++++++++++
doc/javascript_css | 19 ++++++++++++++++++
doc/main_page_warnings | 17 ++++++++++++++++
doc/module-dependencies | 31 +++++++++++++++++++++++++++++
7 files changed, 173 insertions(+)
create mode 100644 doc/baseconfig_-_config-variables
create mode 100644 doc/dashboard
create mode 100644 doc/enabling_modules
create mode 100644 doc/installation
create mode 100644 doc/javascript_css
create mode 100644 doc/main_page_warnings
create mode 100644 doc/module-dependencies
diff --git a/doc/baseconfig_-_config-variables b/doc/baseconfig_-_config-variables
new file mode 100644
index 00000000..6c85b7de
--- /dev/null
+++ b/doc/baseconfig_-_config-variables
@@ -0,0 +1,42 @@
+The baseconfig module (configuration variables) is now modularized in two
+ways.
+
+
+1) The definition of configuration variables has moved from the database to
+dedicated .json files, which can be defined by one or multiple additional
+modules. This means the database table "settings" is no longer in use.
+As an example, see the module "baseconfig_bwlp".
+If you only enable the module "baseconfig", you will find that visiting
+the "configuration variables" menu entry in slx-admin shows a pretty empty
+page. However, if you additionally enable the baseconfig_bwlp module, many
+configuration variables will be shown.
+baseconfig_bwlp doesn't contain any config.json or page.inc.php, as its
+sole purpose is to supply wanted configuration variables. This is achieved
+by supplying two .json files.
+
+./modules//baseconfig/categories.json: Defines categories for
+configuration variables. Syntax is :
+
+./modules//baseconfig/settings.json: Defines configuration variables
+to be shown by the baseconfig page. This has taken the place of the settings
+table from the database and contains pretty much the same information.
+
+Note that you can have multiple modules that supply categories.json or
+settings.json files. They will all be honored by the baseconfig module.
+
+2) You can hook into the baseconfig API mechanism (previously known as
+the "getconfig" API) which creates the plain text output intended for
+the clients. This way you can create more sophisticated output logic, or
+simply have a nicer guy for some values you want to generate.
+To hook into the API, you need a hook:
+./modules//baseconfig/getconfig.inc.php
+This code will run directly in the context of the baseconfig API request,
+so you write code straight away that should add any configuration variables
+to the associative array called $configVars, e.g.
+$configVars['SLX_FOO'] = 'bar';
+These values can be static, or queried from anywhere in the database, etc.
+For an example of this, see the module "baseconfig_partitions_cdn"
+Which is basically a normal slx-admin module with a GUI for creating a
+partitioning config that get stored in the database.
+It also contains the .../baseconfig/getconfig.inc.php hook that adds
+the partition configuration to the output of the baseconfig API.
diff --git a/doc/dashboard b/doc/dashboard
new file mode 100644
index 00000000..3040bb6f
--- /dev/null
+++ b/doc/dashboard
@@ -0,0 +1,20 @@
+The dashboard is usually created automatically and doesn't require any
+special setup. The order of the settings and categories in the menu
+can be influenced by the two variables $MENU_CAT_SORT_ORDER and
+$MENU_SETTING_SORT_ORDER in config.php (see config.php.example)
+
+Menu categories can be defined implicitly in the form of
+modulename.catname, i.e. main.content
+
+To assign an icon to the category, create a file called category-icons.json
+in the module's root dir (i.e. ./modules/main/category-icons.json)
+and add a key value pair of the form "catname":"glyphicon", i.e.
+{ "content":"th" }. Notice the module name is not prefixed again.
+
+To translate the category's name, visit the translation page and go
+to the module in which the category is defined (in this example, main).
+You'll see a panel dedicated to menu categories, it should contain the
+Note: The menu section will only appear in the translation list of the
+module if any active module is assigned to this category. However, you
+can still manually create the entry by using the "create tag" button.
+As an example, see the "main" or the "citymanagement" module.
diff --git a/doc/enabling_modules b/doc/enabling_modules
new file mode 100644
index 00000000..dd36d000
--- /dev/null
+++ b/doc/enabling_modules
@@ -0,0 +1,16 @@
+As a convention, modules should be placed in another directory and then
+get selectively enabled by symlinking.
+Currently, all modules are placed in ./modules-available, and the symlinks
+reside in ./modules
+Note that you can name the symlink differently. The name of the symlink
+will define by what identifier the module is referred to. This way
+you can have different implementations or versions of the same module
+and switch them out.
+An example of this is the module "serversetup-bwlp" which is symlinked
+as just "serversetup", so we can have "serversetup-cdn" in the future,
+as it seems the two locations have quite different requirements for this
+module's functionality.
+
+Note that a module identifier cannot contain dashes (-), so this is an
+easy way to hint that a module is supposed to be aliased when being
+activated.
diff --git a/doc/installation b/doc/installation
new file mode 100644
index 00000000..14fba625
--- /dev/null
+++ b/doc/installation
@@ -0,0 +1,28 @@
+Installation of slx-admin is modularized, that means there is no central,
+global SQL dump, but every module can provide an install hook, that is
+supposed to install everything it needs to the database (or anything else).
+
+The hook file is called install.inc.php and needs to reside in the module's
+root directory. Some modules might not have an install hook.
+
+A few simple helper functions are provided to make it easier to create
+tables, check for their existence, and create feedback of the installation
+process.
+
+It is important to make as little assumptions as possible about what is
+already present in the database, so try not to call functions like
+User::load() in your install hook. There might be no user table yet.
+
+The installation hook should be written in a way that it is non-destructive,
+and can recognize if an old version of the module's schema is already
+present in the database, in which case it should update the table(s)
+instead of erroring out or losing data. See the install hook of the
+'main' module for an example.
+
+Installation/Upgrading can be triggered manually through the browser
+by accessing "install.php" in slx-admin's root. Please note that this
+page does not require any form of authentication. While any actions
+this page can perform should not be destructive, you might want to
+consider moving the file away after each install/upgrade.
+The other way of triggering the process is running 'install-all' from
+the command line. This comes in handy for automated install scripts.
diff --git a/doc/javascript_css b/doc/javascript_css
new file mode 100644
index 00000000..de4896d5
--- /dev/null
+++ b/doc/javascript_css
@@ -0,0 +1,19 @@
+In order to prevent the global ./style/default.css from growing until
+it's a complete mess, it is also possible to modularize css stylesheets
+and javascript files.
+
+If a module contains a file called style.css, it is automatically included
+in the generated HTML page of the module, or any module that declared this
+module as a dependency.
+The same goes for a file called clientscript.js. Any module containing such
+a file will have this script included in the generated HTML.
+
+This way you can have module specific CSS definitions. Some of the
+definitions in ./style/default.css should be moved into modules over
+time (TODO :)), since they are only used in one module.
+
+Thanks to the dependency mechanism it is possible to have dedicated css/js
+modules, like "js_chart" or "js_circles". An example is the module
+"statistics", which defines js_chart as a dependency in its config.json.
+The result is that js_chart/clientscript.js is automatically included
+in the HTML output of the statistics module.
diff --git a/doc/main_page_warnings b/doc/main_page_warnings
new file mode 100644
index 00000000..e69a6125
--- /dev/null
+++ b/doc/main_page_warnings
@@ -0,0 +1,17 @@
+The warning messages that can appear on the main site (after logging in)
+can be added by hooks now, too, so the page.inc.php of the "main" module
+doesn't contain code specific to a dozen other modules.
+
+If you want to add a hook, create a file in your module:
+./modules//hooks/main-warning.inc.php
+The file contains flat code, no classes or functions. You should
+do your checks, and then call Message::addError (or the likes).
+You could also render your own template if you feel fancy.
+Remember you're running in the context of the main module, so your
+message ID should use the full syntax module.id, or add your
+module's name to the Render::addTemplate call.
+
+If you also want to enable the "configuration incomplete" global
+warning, set $needSetup to true.
+
+See modules "vmstore", "minilinux" or "sysconfig" for an example.
diff --git a/doc/module-dependencies b/doc/module-dependencies
new file mode 100644
index 00000000..3da27b16
--- /dev/null
+++ b/doc/module-dependencies
@@ -0,0 +1,31 @@
+Modules can define other modules as dependencies. You should do this
+whenever you require resources (like database tables) that belong
+to module A in module B, if you want to use automatic css/js
+inclusion (see javascript_css doc), or if you just feel like your
+module should not be accessible if another module is not present.
+
+"baseconfig_partitions_cdn" has "baseconfig" as a dependency; it
+does not directly access any tables of the module "baseconfig", but
+since it depends on the getconfig-API of the baseconfig module, one
+might argue that having the partition setup feature is of limited
+use if the clients can't fetch it.
+
+"statistics" module has "js_chart" as a dependency, since it
+makes use of the automatic clientscript.js inclusion. The statistics
+module uses the chart javascript library to draw, well, charts.
+
+
+You can write modules that can optionally interact or take advantage
+of other modules if they are present. The statistics module can
+make use of the locations module to show which location a client
+belongs to, but it would still work without the locations module
+being present. You can check for the availability of a module
+by calling Module::isAvailable('')
+If the module is available, the call will return true, and
+the class autoloader for the requested module is also installed,
+so you can use any classes from ./modules//inc/*.inc.php
+Again, see how the statistics module calls Location::getFromIp()
+and other functions after calling Module::isAvailable().
+If you'd try to access Location::* without doing so, you'd get
+a class not found error.
+
--
cgit v1.2.3-55-g7522
From 326fef724effa79b4a1900f7a155163f9cf50b7e Mon Sep 17 00:00:00 2001
From: Simon Rettberg
Date: Tue, 14 Jun 2016 17:50:56 +0200
Subject: [bootstrap_switch] New module for bootstrap-switch plugin
---
modules-available/bootstrap_switch/README | 19 ++++++++++++++++
modules-available/bootstrap_switch/clientscript.js | 25 ++++++++++++++++++++++
modules-available/bootstrap_switch/config.json | 1 +
modules-available/bootstrap_switch/style.css | 22 +++++++++++++++++++
4 files changed, 67 insertions(+)
create mode 100644 modules-available/bootstrap_switch/README
create mode 100644 modules-available/bootstrap_switch/clientscript.js
create mode 100644 modules-available/bootstrap_switch/config.json
create mode 100644 modules-available/bootstrap_switch/style.css
diff --git a/modules-available/bootstrap_switch/README b/modules-available/bootstrap_switch/README
new file mode 100644
index 00000000..405ce13a
--- /dev/null
+++ b/modules-available/bootstrap_switch/README
@@ -0,0 +1,19 @@
+This is basically just bootstrap-switch (js + css), with
+the addition of these three lines in the .js file:
+
+// SLX-Admin: Enable for class bs-switch
+$.fn.bootstrapSwitch.defaults.size = 'mini';
+$("input.bs-switch").bootstrapSwitch();
+
+
+This makes sure any checkboxes or radio buttons with the
+class "bs-switch" will automatically be turned into
+bootstrap switches.
+
+To apply bootstrap-switch to your checkboxes you need to
+a) give them the class bs-switch
+b) either make bootstrap_switch a dependency of your module (config.json)
+ or, as a "soft dependency", just call
+ Module::isAvailable('boostrap_switch')
+ somewhere in your code. If bootstrap_switch is not activated, your
+ page will still load and show old fashioned checkboxes
\ No newline at end of file
diff --git a/modules-available/bootstrap_switch/clientscript.js b/modules-available/bootstrap_switch/clientscript.js
new file mode 100644
index 00000000..43259451
--- /dev/null
+++ b/modules-available/bootstrap_switch/clientscript.js
@@ -0,0 +1,25 @@
+/* ========================================================================
+ * bootstrap-switch - v3.3.2
+ * http://www.bootstrap-switch.org
+ * ========================================================================
+ * Copyright 2012-2013 Mattia Larentis
+ *
+ * ========================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================================================================
+ */
+
+(function(){var t=[].slice;!function(e,i){"use strict";var n;return n=function(){function t(t,i){null==i&&(i={}),this.$element=e(t),this.options=e.extend({},e.fn.bootstrapSwitch.defaults,{state:this.$element.is(":checked"),size:this.$element.data("size"),animate:this.$element.data("animate"),disabled:this.$element.is(":disabled"),readonly:this.$element.is("[readonly]"),indeterminate:this.$element.data("indeterminate"),inverse:this.$element.data("inverse"),radioAllOff:this.$element.data("radio-all-off"),onColor:this.$element.data("on-color"),offColor:this.$element.data("off-color"),onText:this.$element.data("on-text"),offText:this.$element.data("off-text"),labelText:this.$element.data("label-text"),handleWidth:this.$element.data("handle-width"),labelWidth:this.$element.data("label-width"),baseClass:this.$element.data("base-class"),wrapperClass:this.$element.data("wrapper-class")},i),this.prevOptions={},this.$wrapper=e("