diff --git a/README.md b/README.md index c29c214b0d345db66ff8bf619ccbcbbe8e33cd63..32177b17d6e60f85f554bb596c8395898e636685 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,26 @@ -# Admintool -### Software: +# Frontend + +## Software + +### Admintool: * ```ubuntu /14.04.1``` * ```nginx /1.4.6``` +### Website: +* undef. + +# Admintool ### Dependecies: * ```jQuery /2.2.2``` * ```bootstrap /3.3.6``` * ```amivaccess /1.0``` -### File Structure: +# Structure * admin (Admintool) * lib (Libraries) * bootstrap * jquery - * amiv (amivcore) + * amiv (amivaccess) * cust (custom files) * main.js (our js file) * main.css (our css file) @@ -26,12 +33,14 @@ * main.tool * users.tool * ... -* public (Website) +* public (Website) + + -## Library ```tools```: -The JS library ```tools``` is the backbone of the single tools. It enables the tool itself to take actions, such as store data, customize the menu, spawn alert boxes, load new tools and more. +### Library ```tools```: +The JS library ```tools``` is the backbone of the single tools. It enables the tool itself to take actions, such as store data, spawn alert boxes, load new tools and more. -### log(msg, type, timeout) +#### log(msg, type, timeout) ######Displays an alert box to the user. * ```msg /text,HTML``` The message or html to be displayed in the alert box * ```type /('s', 'i', 'w', 'e')``` Specifies the type of message. Displays different colors for each type. @@ -40,65 +49,22 @@ The JS library ```tools``` is the backbone of the single tools. It enables the t * w: warning * e: error * ```timeout (optional)/int``` Number of milliseconds that the message will be displayed. If not specified the default time is 5s, or 5000ms. - ##### Example: * ``` tools.log('User updated!', 's'); ``` Creates a green alert box with the message specified that will disappear after 5000ms. * ``` tools.log('Error!', 'e', 10000); ``` Creates a gred alert box with the message specified that will disappear after 10s. -### getTool(tool) +#### tools.getTool(tool) ###### Loads the specified tool. If no tool is specified the tool in the navigaton bar (hashtag) will be choesn. * ```tool (optional)/text``` Specifies the tool. - ##### Example: * ``` tools.getTool('home'); ``` Will get the /res/tools/```home```.tool and loads it into the site. -### ui -###### The ```ui``` element allows you to access ui components (menu) and take actions (login, logout, toggleSideMenu) - #### toggleSideMenu() +###### Toggles the sidebar ##### Example: -* ```tools.ui.toggleSideMenu();``` Toggles the sidebar +* ```tools.toggleSideMenu();``` Toggles the sidebar -#### menu(object) -###### Allows a tool to access the top menu and have custom links and callbacks -* ```object /js object``` Menu structured element from which the menu is generated - -##### Example: -```javascript -tools.ui.menu({ - 'Foo':{} -}); -// Creates a single link element named 'Foo' without a href or callback - -tools.ui.menu({ - 'Foo':{ - link:'google.com' - } -}); -// Creates a link named 'Foo' without a callback, but is linked to google.com - -tools.ui.menu({ - 'Foo':{ - callback: function (){ - console.log('I was pressed!!'); - } - } -}); -// Creates a link 'Foo' and calles the function once the link is called - -tools.ui.menu({ - 'Foo':{ - link: '#trololo', - callback: function (){ - console.log('I was pressed!!'); - } - } -}); -// Creates a link 'Foo' and calles the function once the link is called and the user gets redirected to #trololo. -``` - - -### mem.local & mem.session +#### mem.local & mem.session ######The mem element can store data for the tools, used for multiple cases. There are 2 tyoes of storage: ```local``` hast no expiration and ```session``` is stored until you close the window or tab. Every tool has separated storage, so you don't need to worry about conflicting with other tools. The subfunctions are the same, a so only ```session``` wil be demonstraded here. local works identically. #### set(name, value)