45 | <%= image_tag "logo.png" %>
46 | <% if language_tabs %>
47 |
73 |
48 | <% language_tabs.each do |lang| %>
49 | <% if lang.is_a? Hash %>
50 | <%= lang.values.first %>
51 | <% else %>
52 | <%= lang %>
53 | <% end %>
54 | <% end %>
55 |
56 | <% end %>
57 | <% if current_page.data.search %>
58 |
59 |
60 |
61 |
64 |
65 | <% if current_page.data.toc_footers %>
66 |
71 | <% end %>
72 |
74 |
75 |
95 |
96 |
97 |
--------------------------------------------------------------------------------
/docs/slate/source/stylesheets/_variables.scss:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2008-2013 Concur Technologies, Inc.
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License"); you may
5 | not use this file except in compliance with the License. You may obtain
6 | a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 | License for the specific language governing permissions and limitations
14 | under the License.
15 | */
16 |
17 |
18 | ////////////////////////////////////////////////////////////////////////////////
19 | // CUSTOMIZE SLATE
20 | ////////////////////////////////////////////////////////////////////////////////
21 | // Use these settings to help adjust the appearance of Slate
22 |
23 |
24 | // BACKGROUND COLORS
25 | ////////////////////
26 | $nav-bg: #393939;
27 | $examples-bg: #393939;
28 | $code-bg: #292929;
29 | $code-annotation-bg: #1c1c1c;
30 | $nav-subitem-bg: #262626;
31 | $nav-active-bg: #2467af;
32 | $lang-select-border: #000;
33 | $lang-select-bg: #222;
34 | $lang-select-active-bg: $examples-bg; // feel free to change this to blue or something
35 | $lang-select-pressed-bg: #111; // color of language tab bg when mouse is pressed
36 | $main-bg: #eaf2f6;
37 | $aside-notice-bg: #8fbcd4;
38 | $aside-warning-bg: #c97a7e;
39 | $aside-success-bg: #6ac174;
40 | $search-notice-bg: #c97a7e;
41 |
42 |
43 | // TEXT COLORS
44 | ////////////////////
45 | $main-text: #333; // main content text color
46 | $nav-text: #fff;
47 | $nav-active-text: #fff;
48 | $lang-select-text: #fff; // color of unselected language tab text
49 | $lang-select-active-text: #fff; // color of selected language tab text
50 | $lang-select-pressed-text: #fff; // color of language tab text when mouse is pressed
51 |
52 |
53 | // SIZES
54 | ////////////////////
55 | $nav-width: 230px; // width of the navbar
56 | $examples-width: 50%; // portion of the screen taken up by code examples
57 | $logo-margin: 20px; // margin between nav items and logo, ignored if search is active
58 | $main-padding: 28px; // padding to left and right of content & examples
59 | $nav-padding: 15px; // padding to left and right of navbar
60 | $nav-v-padding: 10px; // padding used vertically around search boxes and results
61 | $nav-indent: 10px; // extra padding for ToC subitems
62 | $code-annotation-padding: 13px; // padding inside code annotations
63 | $h1-margin-bottom: 21px; // padding under the largest header tags
64 | $tablet-width: 930px; // min width before reverting to tablet size
65 | $phone-width: $tablet-width - $nav-width; // min width before reverting to mobile size
66 |
67 |
68 | // FONTS
69 | ////////////////////
70 | %default-font {
71 | font-family: "Helvetica Neue", Helvetica, Arial, "Microsoft Yahei","微软雅黑", STXihei, "华文细黑", sans-serif;
72 | font-size: 13px;
73 | }
74 |
75 | %header-font {
76 | @extend %default-font;
77 | font-weight: bold;
78 | }
79 |
80 | %code-font {
81 | font-family: Consolas, Menlo, Monaco, "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace, serif;
82 | font-size: 12px;
83 | line-height: 1.5;
84 | }
85 |
86 |
87 | // OTHER
88 | ////////////////////
89 | $nav-active-shadow: #000;
90 | $nav-footer-border-color: #666;
91 | $nav-embossed-border-top: #000;
92 | $nav-embossed-border-bottom: #939393;
93 | $main-embossed-text-shadow: 0px 1px 0px #fff;
94 | $search-box-border-color: #666;
95 |
96 |
97 | ////////////////////////////////////////////////////////////////////////////////
98 | // INTERNAL
99 | ////////////////////////////////////////////////////////////////////////////////
100 | // These settings are probably best left alone.
101 |
102 | %break-words {
103 | word-break: break-all;
104 | hyphens: auto;
105 | }
106 |
--------------------------------------------------------------------------------
/docs/slate/Gemfile.lock:
--------------------------------------------------------------------------------
1 | GEM
2 | remote: https://rubygems.org/
3 | specs:
4 | activesupport (4.2.5.1)
5 | i18n (~> 0.7)
6 | json (~> 1.7, >= 1.7.7)
7 | minitest (~> 5.1)
8 | thread_safe (~> 0.3, >= 0.3.4)
9 | tzinfo (~> 1.1)
10 | addressable (2.4.0)
11 | autoprefixer-rails (6.3.1)
12 | execjs
13 | json
14 | backports (3.6.7)
15 | capybara (2.5.0)
16 | mime-types (>= 1.16)
17 | nokogiri (>= 1.3.3)
18 | rack (>= 1.0.0)
19 | rack-test (>= 0.5.4)
20 | xpath (~> 2.0)
21 | coffee-script (2.4.1)
22 | coffee-script-source
23 | execjs
24 | coffee-script-source (1.10.0)
25 | compass-import-once (1.0.5)
26 | sass (>= 3.2, < 3.5)
27 | concurrent-ruby (0.9.2)
28 | contracts (0.12.0)
29 | erubis (2.7.0)
30 | execjs (2.6.0)
31 | fastimage (1.8.1)
32 | addressable (~> 2.3, >= 2.3.5)
33 | ffi (1.9.10)
34 | ffi (1.9.10-x64-mingw32)
35 | ffi (1.9.10-x86-mingw32)
36 | haml (4.0.7)
37 | tilt
38 | hamster (2.0.0)
39 | concurrent-ruby (~> 0.8)
40 | hashie (3.4.3)
41 | i18n (0.7.0)
42 | json (1.8.3)
43 | kramdown (1.9.0)
44 | listen (3.0.5)
45 | rb-fsevent (>= 0.9.3)
46 | rb-inotify (>= 0.9)
47 | middleman (4.0.0)
48 | coffee-script (~> 2.2)
49 | compass-import-once (= 1.0.5)
50 | haml (>= 4.0.5)
51 | kramdown (~> 1.2)
52 | middleman-cli (= 4.0.0)
53 | middleman-core (= 4.0.0)
54 | sass (>= 3.4.0, < 4.0)
55 | middleman-autoprefixer (2.7.0)
56 | autoprefixer-rails (>= 6.3.1, < 7.0.0)
57 | middleman-core (>= 3.3.3)
58 | middleman-cli (4.0.0)
59 | thor (>= 0.17.0, < 2.0)
60 | middleman-core (4.0.0)
61 | activesupport (~> 4.2)
62 | addressable (~> 2.4.0)
63 | backports (~> 3.6)
64 | bundler (~> 1.1)
65 | capybara (~> 2.5.0)
66 | contracts (~> 0.12.0)
67 | erubis
68 | execjs (~> 2.0)
69 | fastimage (~> 1.8)
70 | hamster (~> 2.0)
71 | hashie (~> 3.4)
72 | i18n (~> 0.7.0)
73 | listen (~> 3.0)
74 | padrino-helpers (~> 0.13.0)
75 | rack (>= 1.4.5, < 2.0)
76 | sass (>= 3.4)
77 | tilt (~> 1.4.1)
78 | uglifier (~> 2.6)
79 | middleman-gh-pages (0.0.3)
80 | rake (> 0.9.3)
81 | middleman-sprockets (4.0.0.rc.1)
82 | middleman-core (>= 4.0.0.rc.1)
83 | sprockets (~> 3.0)
84 | middleman-syntax (2.1.0)
85 | middleman-core (>= 3.2)
86 | rouge (~> 1.0)
87 | mime-types (3.0)
88 | mime-types-data (~> 3.2015)
89 | mime-types-data (3.2015.1120)
90 | mini_portile2 (2.1.0)
91 | minitest (5.8.4)
92 | nokogiri (1.8.2)
93 | mini_portile2 (~> 2.1.0)
94 | nokogiri (1.8.2-x64-mingw32)
95 | mini_portile2 (~> 2.1.0)
96 | nokogiri (1.8.2-x86-mingw32)
97 | mini_portile2 (~> 2.1.0)
98 | padrino-helpers (0.13.1)
99 | i18n (~> 0.6, >= 0.6.7)
100 | padrino-support (= 0.13.1)
101 | tilt (~> 1.4.1)
102 | padrino-support (0.13.1)
103 | activesupport (>= 3.1)
104 | rack (1.6.4)
105 | rack-test (0.6.3)
106 | rack (>= 1.0)
107 | rake (10.4.2)
108 | rb-fsevent (0.9.7)
109 | rb-inotify (0.9.5)
110 | ffi (>= 0.5.0)
111 | redcarpet (3.3.4)
112 | rouge (1.10.1)
113 | sass (3.4.21)
114 | sprockets (3.7.2)
115 | rack (> 1, < 3)
116 | thor (0.19.1)
117 | thread_safe (0.3.5)
118 | tilt (1.4.1)
119 | tzinfo (1.2.2)
120 | thread_safe (~> 0.1)
121 | uglifier (2.7.2)
122 | execjs (>= 0.3.0)
123 | json (>= 1.8.0)
124 | xpath (2.0.0)
125 | nokogiri (~> 1.3)
126 |
127 | PLATFORMS
128 | ruby
129 | x64-mingw32
130 | x86-mingw32
131 |
132 | DEPENDENCIES
133 | middleman (~> 4.0.0)
134 | middleman-autoprefixer (~> 2.7.0)
135 | middleman-gh-pages (~> 0.0.3)
136 | middleman-sprockets (~> 4.0.0.rc)
137 | middleman-syntax (~> 2.1.0)
138 | redcarpet (~> 3.3.2)
139 | rouge (~> 1.10.1)
140 |
141 | BUNDLED WITH
142 | 1.13.6
143 |
--------------------------------------------------------------------------------
/docs/slate/source/javascripts/lib/_jquery.highlight.js:
--------------------------------------------------------------------------------
1 | /*
2 | * jQuery Highlight plugin
3 | *
4 | * Based on highlight v3 by Johann Burkard
5 | * http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
6 | *
7 | * Code a little bit refactored and cleaned (in my humble opinion).
8 | * Most important changes:
9 | * - has an option to highlight only entire words (wordsOnly - false by default),
10 | * - has an option to be case sensitive (caseSensitive - false by default)
11 | * - highlight element tag and class names can be specified in options
12 | *
13 | * Usage:
14 | * // wrap every occurrance of text 'lorem' in content
15 | * // with (default options)
16 | * $('#content').highlight('lorem');
17 | *
18 | * // search for and highlight more terms at once
19 | * // so you can save some time on traversing DOM
20 | * $('#content').highlight(['lorem', 'ipsum']);
21 | * $('#content').highlight('lorem ipsum');
22 | *
23 | * // search only for entire word 'lorem'
24 | * $('#content').highlight('lorem', { wordsOnly: true });
25 | *
26 | * // don't ignore case during search of term 'lorem'
27 | * $('#content').highlight('lorem', { caseSensitive: true });
28 | *
29 | * // wrap every occurrance of term 'ipsum' in content
30 | * // with
31 | * $('#content').highlight('ipsum', { element: 'em', className: 'important' });
32 | *
33 | * // remove default highlight
34 | * $('#content').unhighlight();
35 | *
36 | * // remove custom highlight
37 | * $('#content').unhighlight({ element: 'em', className: 'important' });
38 | *
39 | *
40 | * Copyright (c) 2009 Bartek Szopka
41 | *
42 | * Licensed under MIT license.
43 | *
44 | */
45 |
46 | jQuery.extend({
47 | highlight: function (node, re, nodeName, className) {
48 | if (node.nodeType === 3) {
49 | var match = node.data.match(re);
50 | if (match) {
51 | var highlight = document.createElement(nodeName || 'span');
52 | highlight.className = className || 'highlight';
53 | var wordNode = node.splitText(match.index);
54 | wordNode.splitText(match[0].length);
55 | var wordClone = wordNode.cloneNode(true);
56 | highlight.appendChild(wordClone);
57 | wordNode.parentNode.replaceChild(highlight, wordNode);
58 | return 1; //skip added node in parent
59 | }
60 | } else if ((node.nodeType === 1 && node.childNodes) && // only element nodes that have children
61 | !/(script|style)/i.test(node.tagName) && // ignore script and style nodes
62 | !(node.tagName === nodeName.toUpperCase() && node.className === className)) { // skip if already highlighted
63 | for (var i = 0; i < node.childNodes.length; i++) {
64 | i += jQuery.highlight(node.childNodes[i], re, nodeName, className);
65 | }
66 | }
67 | return 0;
68 | }
69 | });
70 |
71 | jQuery.fn.unhighlight = function (options) {
72 | var settings = { className: 'highlight', element: 'span' };
73 | jQuery.extend(settings, options);
74 |
75 | return this.find(settings.element + "." + settings.className).each(function () {
76 | var parent = this.parentNode;
77 | parent.replaceChild(this.firstChild, this);
78 | parent.normalize();
79 | }).end();
80 | };
81 |
82 | jQuery.fn.highlight = function (words, options) {
83 | var settings = { className: 'highlight', element: 'span', caseSensitive: false, wordsOnly: false };
84 | jQuery.extend(settings, options);
85 |
86 | if (words.constructor === String) {
87 | words = [words];
88 | }
89 | words = jQuery.grep(words, function(word, i){
90 | return word != '';
91 | });
92 | words = jQuery.map(words, function(word, i) {
93 | return word.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
94 | });
95 | if (words.length == 0) { return this; };
96 |
97 | var flag = settings.caseSensitive ? "" : "i";
98 | var pattern = "(" + words.join("|") + ")";
99 | if (settings.wordsOnly) {
100 | pattern = "\\b" + pattern + "\\b";
101 | }
102 | var re = new RegExp(pattern, flag);
103 |
104 | return this.each(function () {
105 | jQuery.highlight(this, re, settings.element, settings.className);
106 | });
107 | };
108 |
109 |
--------------------------------------------------------------------------------
/docs/slate/font-selection.json:
--------------------------------------------------------------------------------
1 | {
2 | "IcoMoonType": "selection",
3 | "icons": [
4 | {
5 | "icon": {
6 | "paths": [
7 | "M438.857 73.143q119.429 0 220.286 58.857t159.714 159.714 58.857 220.286-58.857 220.286-159.714 159.714-220.286 58.857-220.286-58.857-159.714-159.714-58.857-220.286 58.857-220.286 159.714-159.714 220.286-58.857zM512 785.714v-108.571q0-8-5.143-13.429t-12.571-5.429h-109.714q-7.429 0-13.143 5.714t-5.714 13.143v108.571q0 7.429 5.714 13.143t13.143 5.714h109.714q7.429 0 12.571-5.429t5.143-13.429zM510.857 589.143l10.286-354.857q0-6.857-5.714-10.286-5.714-4.571-13.714-4.571h-125.714q-8 0-13.714 4.571-5.714 3.429-5.714 10.286l9.714 354.857q0 5.714 5.714 10t13.714 4.286h105.714q8 0 13.429-4.286t6-10z"
8 | ],
9 | "attrs": [],
10 | "isMulticolor": false,
11 | "tags": [
12 | "exclamation-circle"
13 | ],
14 | "defaultCode": 61546,
15 | "grid": 14
16 | },
17 | "attrs": [],
18 | "properties": {
19 | "id": 100,
20 | "order": 4,
21 | "prevSize": 28,
22 | "code": 58880,
23 | "name": "exclamation-sign",
24 | "ligatures": ""
25 | },
26 | "setIdx": 0,
27 | "iconIdx": 0
28 | },
29 | {
30 | "icon": {
31 | "paths": [
32 | "M585.143 786.286v-91.429q0-8-5.143-13.143t-13.143-5.143h-54.857v-292.571q0-8-5.143-13.143t-13.143-5.143h-182.857q-8 0-13.143 5.143t-5.143 13.143v91.429q0 8 5.143 13.143t13.143 5.143h54.857v182.857h-54.857q-8 0-13.143 5.143t-5.143 13.143v91.429q0 8 5.143 13.143t13.143 5.143h256q8 0 13.143-5.143t5.143-13.143zM512 274.286v-91.429q0-8-5.143-13.143t-13.143-5.143h-109.714q-8 0-13.143 5.143t-5.143 13.143v91.429q0 8 5.143 13.143t13.143 5.143h109.714q8 0 13.143-5.143t5.143-13.143zM877.714 512q0 119.429-58.857 220.286t-159.714 159.714-220.286 58.857-220.286-58.857-159.714-159.714-58.857-220.286 58.857-220.286 159.714-159.714 220.286-58.857 220.286 58.857 159.714 159.714 58.857 220.286z"
33 | ],
34 | "attrs": [],
35 | "isMulticolor": false,
36 | "tags": [
37 | "info-circle"
38 | ],
39 | "defaultCode": 61530,
40 | "grid": 14
41 | },
42 | "attrs": [],
43 | "properties": {
44 | "id": 85,
45 | "order": 3,
46 | "name": "info-sign",
47 | "prevSize": 28,
48 | "code": 58882
49 | },
50 | "setIdx": 0,
51 | "iconIdx": 2
52 | },
53 | {
54 | "icon": {
55 | "paths": [
56 | "M733.714 419.429q0-16-10.286-26.286l-52-51.429q-10.857-10.857-25.714-10.857t-25.714 10.857l-233.143 232.571-129.143-129.143q-10.857-10.857-25.714-10.857t-25.714 10.857l-52 51.429q-10.286 10.286-10.286 26.286 0 15.429 10.286 25.714l206.857 206.857q10.857 10.857 25.714 10.857 15.429 0 26.286-10.857l310.286-310.286q10.286-10.286 10.286-25.714zM877.714 512q0 119.429-58.857 220.286t-159.714 159.714-220.286 58.857-220.286-58.857-159.714-159.714-58.857-220.286 58.857-220.286 159.714-159.714 220.286-58.857 220.286 58.857 159.714 159.714 58.857 220.286z"
57 | ],
58 | "attrs": [],
59 | "isMulticolor": false,
60 | "tags": [
61 | "check-circle"
62 | ],
63 | "defaultCode": 61528,
64 | "grid": 14
65 | },
66 | "attrs": [],
67 | "properties": {
68 | "id": 83,
69 | "order": 9,
70 | "prevSize": 28,
71 | "code": 58886,
72 | "name": "ok-sign"
73 | },
74 | "setIdx": 0,
75 | "iconIdx": 6
76 | },
77 | {
78 | "icon": {
79 | "paths": [
80 | "M658.286 475.429q0-105.714-75.143-180.857t-180.857-75.143-180.857 75.143-75.143 180.857 75.143 180.857 180.857 75.143 180.857-75.143 75.143-180.857zM950.857 950.857q0 29.714-21.714 51.429t-51.429 21.714q-30.857 0-51.429-21.714l-196-195.429q-102.286 70.857-228 70.857-81.714 0-156.286-31.714t-128.571-85.714-85.714-128.571-31.714-156.286 31.714-156.286 85.714-128.571 128.571-85.714 156.286-31.714 156.286 31.714 128.571 85.714 85.714 128.571 31.714 156.286q0 125.714-70.857 228l196 196q21.143 21.143 21.143 51.429z"
81 | ],
82 | "width": 951,
83 | "attrs": [],
84 | "isMulticolor": false,
85 | "tags": [
86 | "search"
87 | ],
88 | "defaultCode": 61442,
89 | "grid": 14
90 | },
91 | "attrs": [],
92 | "properties": {
93 | "id": 2,
94 | "order": 1,
95 | "prevSize": 28,
96 | "code": 58887,
97 | "name": "icon-search"
98 | },
99 | "setIdx": 0,
100 | "iconIdx": 7
101 | }
102 | ],
103 | "height": 1024,
104 | "metadata": {
105 | "name": "slate",
106 | "license": "SIL OFL 1.1"
107 | },
108 | "preferences": {
109 | "showGlyphs": true,
110 | "showQuickUse": true,
111 | "showQuickUse2": true,
112 | "showSVGs": true,
113 | "fontPref": {
114 | "prefix": "icon-",
115 | "metadata": {
116 | "fontFamily": "slate",
117 | "majorVersion": 1,
118 | "minorVersion": 0,
119 | "description": "Based on FontAwesome",
120 | "license": "SIL OFL 1.1"
121 | },
122 | "metrics": {
123 | "emSize": 1024,
124 | "baseline": 6.25,
125 | "whitespace": 50
126 | },
127 | "resetPoint": 58880,
128 | "showSelector": false,
129 | "selector": "class",
130 | "classSelector": ".icon",
131 | "showMetrics": false,
132 | "showMetadata": true,
133 | "showVersion": true,
134 | "ie7": false
135 | },
136 | "imagePref": {
137 | "prefix": "icon-",
138 | "png": true,
139 | "useClassSelector": true,
140 | "color": 4473924,
141 | "bgColor": 16777215
142 | },
143 | "historySize": 100,
144 | "showCodes": true,
145 | "gridSize": 16,
146 | "showLiga": false
147 | }
148 | }
149 |
--------------------------------------------------------------------------------
/docs/slate/source/javascripts/app/_lang.js:
--------------------------------------------------------------------------------
1 | //= require ../lib/_jquery
2 |
3 | /*
4 | Copyright 2008-2013 Concur Technologies, Inc.
5 |
6 | Licensed under the Apache License, Version 2.0 (the "License"); you may
7 | not use this file except in compliance with the License. You may obtain
8 | a copy of the License at
9 |
10 | http://www.apache.org/licenses/LICENSE-2.0
11 |
12 | Unless required by applicable law or agreed to in writing, software
13 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 | License for the specific language governing permissions and limitations
16 | under the License.
17 | */
18 | (function (global) {
19 | 'use strict';
20 |
21 | var languages = [];
22 |
23 | global.setupLanguages = setupLanguages;
24 | global.activateLanguage = activateLanguage;
25 |
26 | function activateLanguage(language) {
27 | if (!language) return;
28 | if (language === "") return;
29 |
30 | $(".lang-selector a").removeClass('active');
31 | $(".lang-selector a[data-language-name='" + language + "']").addClass('active');
32 | for (var i=0; i < languages.length; i++) {
33 | $(".highlight." + languages[i]).hide();
34 | $(".lang-specific." + languages[i]).hide();
35 | }
36 | $(".highlight." + language).show();
37 | $(".lang-specific." + language).show();
38 |
39 | global.toc.calculateHeights();
40 |
41 | // scroll to the new location of the position
42 | if ($(window.location.hash).get(0)) {
43 | $(window.location.hash).get(0).scrollIntoView(true);
44 | }
45 | }
46 |
47 | // parseURL and stringifyURL are from https://github.com/sindresorhus/query-string
48 | // MIT licensed
49 | // https://github.com/sindresorhus/query-string/blob/7bee64c16f2da1a326579e96977b9227bf6da9e6/license
50 | function parseURL(str) {
51 | if (typeof str !== 'string') {
52 | return {};
53 | }
54 |
55 | str = str.trim().replace(/^(\?|#|&)/, '');
56 |
57 | if (!str) {
58 | return {};
59 | }
60 |
61 | return str.split('&').reduce(function (ret, param) {
62 | var parts = param.replace(/\+/g, ' ').split('=');
63 | var key = parts[0];
64 | var val = parts[1];
65 |
66 | key = decodeURIComponent(key);
67 | // missing `=` should be `null`:
68 | // http://w3.org/TR/2012/WD-url-20120524/#collect-url-parameters
69 | val = val === undefined ? null : decodeURIComponent(val);
70 |
71 | if (!ret.hasOwnProperty(key)) {
72 | ret[key] = val;
73 | } else if (Array.isArray(ret[key])) {
74 | ret[key].push(val);
75 | } else {
76 | ret[key] = [ret[key], val];
77 | }
78 |
79 | return ret;
80 | }, {});
81 | };
82 |
83 | function stringifyURL(obj) {
84 | return obj ? Object.keys(obj).sort().map(function (key) {
85 | var val = obj[key];
86 |
87 | if (Array.isArray(val)) {
88 | return val.sort().map(function (val2) {
89 | return encodeURIComponent(key) + '=' + encodeURIComponent(val2);
90 | }).join('&');
91 | }
92 |
93 | return encodeURIComponent(key) + '=' + encodeURIComponent(val);
94 | }).join('&') : '';
95 | };
96 |
97 | // gets the language set in the query string
98 | function getLanguageFromQueryString() {
99 | if (location.search.length >= 1) {
100 | var language = parseURL(location.search).language
101 | if (language) {
102 | return language;
103 | } else if (jQuery.inArray(location.search.substr(1), languages) != -1) {
104 | return location.search.substr(1);
105 | }
106 | }
107 |
108 | return false;
109 | }
110 |
111 | // returns a new query string with the new language in it
112 | function generateNewQueryString(language) {
113 | var url = parseURL(location.search);
114 | if (url.language) {
115 | url.language = language;
116 | return stringifyURL(url);
117 | }
118 | return language;
119 | }
120 |
121 | // if a button is clicked, add the state to the history
122 | function pushURL(language) {
123 | if (!history) { return; }
124 | var hash = window.location.hash;
125 | if (hash) {
126 | hash = hash.replace(/^#+/, '');
127 | }
128 | history.pushState({}, '', '?' + generateNewQueryString(language) + '#' + hash);
129 |
130 | // save language as next default
131 | localStorage.setItem("language", language);
132 | }
133 |
134 | function setupLanguages(l) {
135 | var defaultLanguage = localStorage.getItem("language");
136 |
137 | languages = l;
138 |
139 | var presetLanguage = getLanguageFromQueryString();
140 | if (presetLanguage) {
141 | // the language is in the URL, so use that language!
142 | activateLanguage(presetLanguage);
143 |
144 | localStorage.setItem("language", presetLanguage);
145 | } else if ((defaultLanguage !== null) && (jQuery.inArray(defaultLanguage, languages) != -1)) {
146 | // the language was the last selected one saved in localstorage, so use that language!
147 | activateLanguage(defaultLanguage);
148 | } else {
149 | // no language selected, so use the default
150 | activateLanguage(languages[0]);
151 | }
152 | }
153 |
154 | // if we click on a language tab, activate that language
155 | $(function() {
156 | $(".lang-selector a").on("click", function() {
157 | var language = $(this).data("language-name");
158 | pushURL(language);
159 | activateLanguage(language);
160 | return false;
161 | });
162 | window.onpopstate = function() {
163 | activateLanguage(getLanguageFromQueryString());
164 | };
165 | });
166 | })(window);
167 |
--------------------------------------------------------------------------------
/docs/slate/source/javascripts/lib/_energize.js:
--------------------------------------------------------------------------------
1 | /**
2 | * energize.js v0.1.0
3 | *
4 | * Speeds up click events on mobile devices.
5 | * https://github.com/davidcalhoun/energize.js
6 | */
7 |
8 | (function() { // Sandbox
9 | /**
10 | * Don't add to non-touch devices, which don't need to be sped up
11 | */
12 | if(!('ontouchstart' in window)) return;
13 |
14 | var lastClick = {},
15 | isThresholdReached, touchstart, touchmove, touchend,
16 | click, closest;
17 |
18 | /**
19 | * isThresholdReached
20 | *
21 | * Compare touchstart with touchend xy coordinates,
22 | * and only fire simulated click event if the coordinates
23 | * are nearby. (don't want clicking to be confused with a swipe)
24 | */
25 | isThresholdReached = function(startXY, xy) {
26 | return Math.abs(startXY[0] - xy[0]) > 5 || Math.abs(startXY[1] - xy[1]) > 5;
27 | };
28 |
29 | /**
30 | * touchstart
31 | *
32 | * Save xy coordinates when the user starts touching the screen
33 | */
34 | touchstart = function(e) {
35 | this.startXY = [e.touches[0].clientX, e.touches[0].clientY];
36 | this.threshold = false;
37 | };
38 |
39 | /**
40 | * touchmove
41 | *
42 | * Check if the user is scrolling past the threshold.
43 | * Have to check here because touchend will not always fire
44 | * on some tested devices (Kindle Fire?)
45 | */
46 | touchmove = function(e) {
47 | // NOOP if the threshold has already been reached
48 | if(this.threshold) return false;
49 |
50 | this.threshold = isThresholdReached(this.startXY, [e.touches[0].clientX, e.touches[0].clientY]);
51 | };
52 |
53 | /**
54 | * touchend
55 | *
56 | * If the user didn't scroll past the threshold between
57 | * touchstart and touchend, fire a simulated click.
58 | *
59 | * (This will fire before a native click)
60 | */
61 | touchend = function(e) {
62 | // Don't fire a click if the user scrolled past the threshold
63 | if(this.threshold || isThresholdReached(this.startXY, [e.changedTouches[0].clientX, e.changedTouches[0].clientY])) {
64 | return;
65 | }
66 |
67 | /**
68 | * Create and fire a click event on the target element
69 | * https://developer.mozilla.org/en/DOM/event.initMouseEvent
70 | */
71 | var touch = e.changedTouches[0],
72 | evt = document.createEvent('MouseEvents');
73 | evt.initMouseEvent('click', true, true, window, 0, touch.screenX, touch.screenY, touch.clientX, touch.clientY, false, false, false, false, 0, null);
74 | evt.simulated = true; // distinguish from a normal (nonsimulated) click
75 | e.target.dispatchEvent(evt);
76 | };
77 |
78 | /**
79 | * click
80 | *
81 | * Because we've already fired a click event in touchend,
82 | * we need to listed for all native click events here
83 | * and suppress them as necessary.
84 | */
85 | click = function(e) {
86 | /**
87 | * Prevent ghost clicks by only allowing clicks we created
88 | * in the click event we fired (look for e.simulated)
89 | */
90 | var time = Date.now(),
91 | timeDiff = time - lastClick.time,
92 | x = e.clientX,
93 | y = e.clientY,
94 | xyDiff = [Math.abs(lastClick.x - x), Math.abs(lastClick.y - y)],
95 | target = closest(e.target, 'A') || e.target, // needed for standalone apps
96 | nodeName = target.nodeName,
97 | isLink = nodeName === 'A',
98 | standAlone = window.navigator.standalone && isLink && e.target.getAttribute("href");
99 |
100 | lastClick.time = time;
101 | lastClick.x = x;
102 | lastClick.y = y;
103 |
104 | /**
105 | * Unfortunately Android sometimes fires click events without touch events (seen on Kindle Fire),
106 | * so we have to add more logic to determine the time of the last click. Not perfect...
107 | *
108 | * Older, simpler check: if((!e.simulated) || standAlone)
109 | */
110 | if((!e.simulated && (timeDiff < 500 || (timeDiff < 1500 && xyDiff[0] < 50 && xyDiff[1] < 50))) || standAlone) {
111 | e.preventDefault();
112 | e.stopPropagation();
113 | if(!standAlone) return false;
114 | }
115 |
116 | /**
117 | * Special logic for standalone web apps
118 | * See http://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
119 | */
120 | if(standAlone) {
121 | window.location = target.getAttribute("href");
122 | }
123 |
124 | /**
125 | * Add an energize-focus class to the targeted link (mimics :focus behavior)
126 | * TODO: test and/or remove? Does this work?
127 | */
128 | if(!target || !target.classList) return;
129 | target.classList.add("energize-focus");
130 | window.setTimeout(function(){
131 | target.classList.remove("energize-focus");
132 | }, 150);
133 | };
134 |
135 | /**
136 | * closest
137 | * @param {HTMLElement} node current node to start searching from.
138 | * @param {string} tagName the (uppercase) name of the tag you're looking for.
139 | *
140 | * Find the closest ancestor tag of a given node.
141 | *
142 | * Starts at node and goes up the DOM tree looking for a
143 | * matching nodeName, continuing until hitting document.body
144 | */
145 | closest = function(node, tagName){
146 | var curNode = node;
147 |
148 | while(curNode !== document.body) { // go up the dom until we find the tag we're after
149 | if(!curNode || curNode.nodeName === tagName) { return curNode; } // found
150 | curNode = curNode.parentNode; // not found, so keep going up
151 | }
152 |
153 | return null; // not found
154 | };
155 |
156 | /**
157 | * Add all delegated event listeners
158 | *
159 | * All the events we care about bubble up to document,
160 | * so we can take advantage of event delegation.
161 | *
162 | * Note: no need to wait for DOMContentLoaded here
163 | */
164 | document.addEventListener('touchstart', touchstart, false);
165 | document.addEventListener('touchmove', touchmove, false);
166 | document.addEventListener('touchend', touchend, false);
167 | document.addEventListener('click', click, true); // TODO: why does this use capture?
168 |
169 | })();
--------------------------------------------------------------------------------
/docs/slate/README.md:
--------------------------------------------------------------------------------
1 |
76 | <%= yield %>
77 | <% current_page.data.includes && current_page.data.includes.each do |include| %>
78 | <%= partial "includes/#{include}" %>
79 | <% end %>
80 |
81 |
82 | <% if language_tabs %>
83 |
94 |
84 | <% language_tabs.each do |lang| %>
85 | <% if lang.is_a? Hash %>
86 | <%= lang.values.first %>
87 | <% else %>
88 | <%= lang %>
89 | <% end %>
90 | <% end %>
91 |
92 | <% end %>
93 |
2 | 
3 |
4 | 
5 |
Slate helps you create beautiful, intelligent, responsive API documentation.
8 | 9 |
The example above was created with Slate. Check it out at lord.github.io/slate.
12 | 13 | Features 14 | ------------ 15 | 16 | * **Clean, intuitive design** — With Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by [Stripe's](https://stripe.com/docs/api) and [Paypal's](https://developer.paypal.com/webapps/developer/docs/api/) API docs. Slate is responsive, so it looks great on tablets, phones, and even in print. 17 | 18 | * **Everything on a single page** — Gone are the days when your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy. 19 | 20 | * **Slate is just Markdown** — When you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks. 21 | 22 | * **Write code samples in multiple languages** — If your API has bindings in multiple programming languages, you can easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with Github Flavored Markdown. 23 | 24 | * **Out-of-the-box syntax highlighting** for [almost 100 languages](http://rouge.jneen.net/), no configuration required. 25 | 26 | * **Automatic, smoothly scrolling table of contents** on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents. 27 | 28 | * **Let your users update your documentation for you** — By default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to use GitHub, you're also welcome to host your docs elsewhere. 29 | 30 | Getting started with Slate is super easy! Simply fork this repository and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](http://lord.github.io/slate). 31 | 32 | Getting Started with Slate 33 | ------------------------------ 34 | 35 | ### Prerequisites 36 | 37 | You're going to need: 38 | 39 | - **Linux or OS X** — Windows may work, but is unsupported. 40 | - **Ruby, version 2.0 or newer** 41 | - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal. 42 | 43 | ### Getting Set Up 44 | 45 | 1. Fork this repository on Github. 46 | 2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git` 47 | 3. `cd slate` 48 | 4. Initialize and start Slate. You can either do this locally, or with Vagrant: 49 | 50 | ```shell 51 | # either run this to run locally 52 | bundle install 53 | bundle exec middleman server 54 | 55 | # OR run this to run with vagrant 56 | vagrant up 57 | ``` 58 | 59 | You can now see the docs at http://localhost:4567. Whoa! That was fast! 60 | 61 | Now that Slate is all set up your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/lord/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/lord/slate/wiki/Deploying-Slate). 62 | 63 | If you'd prefer to use Docker, instructions are available [in the wiki](https://github.com/lord/slate/wiki/Docker). 64 | 65 | Companies Using Slate 66 | --------------------------------- 67 | 68 | * [NASA](https://api.nasa.gov) 69 | * [IBM Cloudant](https://docs.cloudant.com/api.html) 70 | * [Travis-CI](https://docs.travis-ci.com/api/) 71 | * [Mozilla](http://mozilla.github.io/localForage/) 72 | * [Appium](http://appium.io/slate/en/master) 73 | * [Dwolla](https://docs.dwolla.com/) 74 | * [Clearbit](https://clearbit.com/docs) 75 | * [Coinbase](https://developers.coinbase.com/api) 76 | * [Parrot Drones](http://developer.parrot.com/docs/bebop/) 77 | * [Fidor Bank](http://docs.fidor.de/) 78 | 79 | You can view more in [the list on the wiki](https://github.com/lord/slate/wiki/Slate-in-the-Wild). 80 | 81 | Need Help? Found a bug? 82 | -------------------- 83 | 84 | [Submit an issue](https://github.com/lord/slate/issues) to the Slate Github if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes. 85 | 86 | Contributors 87 | -------------------- 88 | 89 | Slate was built by [Robert Lord](https://lord.io) while interning at [TripIt](https://www.tripit.com/). 90 | 91 | Thanks to the following people who have submitted major pull requests: 92 | 93 | - [@chrissrogers](https://github.com/chrissrogers) 94 | - [@bootstraponline](https://github.com/bootstraponline) 95 | - [@realityking](https://github.com/realityking) 96 | - [@cvkef](https://github.com/cvkef) 97 | 98 | Also, thanks to [Sauce Labs](http://saucelabs.com) for helping sponsor the project. 99 | 100 | Special Thanks 101 | -------------------- 102 | - [Middleman](https://github.com/middleman/middleman) 103 | - [jquery.tocify.js](https://github.com/gfranko/jquery.tocify.js) 104 | - [middleman-syntax](https://github.com/middleman/middleman-syntax) 105 | - [middleman-gh-pages](https://github.com/edgecase/middleman-gh-pages) 106 | - [Font Awesome](http://fortawesome.github.io/Font-Awesome/) 107 | -------------------------------------------------------------------------------- /src/extensions/COMMANDS/StatusCommand.py: -------------------------------------------------------------------------------- 1 | ### 2 | # Copyright Notice: 3 | # Copyright 2016 Distributed Management Task Force, Inc. All rights reserved. 4 | # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/python-redfish-utility/blob/main/LICENSE.md 5 | ### 6 | 7 | """ Status Command for RDMC """ 8 | 9 | import sys 10 | 11 | from optparse import OptionParser 12 | from rdmc_helper import ReturnCodes, \ 13 | InvalidCommandLineErrorOPTS 14 | 15 | from rdmc_base_classes import RdmcCommandBase 16 | from rdmc_helper import NoCurrentSessionEstablished 17 | 18 | class StatusCommand(RdmcCommandBase): 19 | """ Constructor """ 20 | def __init__(self, rdmcObj): 21 | RdmcCommandBase.__init__(self,\ 22 | name='status',\ 23 | usage='status\n\n\tRun to display all pending changes within'\ 24 | ' the currently\n\tselected type and that need to be' \ 25 | ' committed\n\texample: status',\ 26 | summary='Displays all pending changes within a selected type'\ 27 | ' that need to be committed.',\ 28 | aliases=[],\ 29 | optparser=OptionParser()) 30 | self.definearguments(self.parser) 31 | self._rdmc = rdmcObj 32 | self.selobj = rdmcObj.commandsDict["SelectCommand"](rdmcObj) 33 | 34 | def run(self, line): 35 | """ Main status worker function 36 | 37 | :param line: command line input 38 | :type line: string. 39 | """ 40 | try: 41 | (_, _) = self._parse_arglist(line) 42 | except: 43 | if ("-h" in line) or ("--help" in line): 44 | return ReturnCodes.SUCCESS 45 | else: 46 | raise InvalidCommandLineErrorOPTS("") 47 | 48 | self.statusvalidation() 49 | contents = self._rdmc.app.status() 50 | selector = self._rdmc.app.get_selector() 51 | 52 | if contents: 53 | self.outputpatches(contents, selector) 54 | else: 55 | sys.stdout.write("No changes found\n") 56 | 57 | #Return code 58 | return ReturnCodes.SUCCESS 59 | 60 | def outputpatches(self, contents, selector): 61 | """ Helper function for status for use in patches 62 | 63 | :param contents: contents for the selection 64 | :type contents: string. 65 | :param selector: type selected 66 | :type selector: string. 67 | """ 68 | sys.stdout.write("Current changes found:\n") 69 | for item in contents: 70 | for key, value in item.items(): 71 | if selector and key.lower().startswith(selector.lower()): 72 | sys.stdout.write("%s (Currently selected)\n" % key) 73 | else: 74 | sys.stdout.write("%s\n" % key) 75 | for content in value: 76 | try: 77 | if isinstance(content[0]["value"], int): 78 | sys.stdout.write('\t%s=%s' % \ 79 | (content[0]["path"][1:], content[0]["value"])) 80 | elif not isinstance(content[0]["value"], bool) and \ 81 | not len(content[0]["value"]) == 0: 82 | if content[0]["value"][0] == '"' and \ 83 | content[0]["value"][-1] == '"': 84 | sys.stdout.write('\t%s=%s' % \ 85 | (content[0]["path"][1:], \ 86 | content[0]["value"][1:-1])) 87 | else: 88 | sys.stdout.write('\t%s=%s' % \ 89 | (content[0]["path"][1:], \ 90 | content[0]["value"])) 91 | else: 92 | output = content[0]["value"] 93 | 94 | if not isinstance(output, bool): 95 | if len(output) == 0: 96 | output = '""' 97 | 98 | sys.stdout.write('\t%s=%s' % \ 99 | (content[0]["path"][1:], output)) 100 | except: 101 | if isinstance(content["value"], int): 102 | sys.stdout.write('\t%s=%s' % \ 103 | (content["path"][1:], content["value"])) 104 | elif not isinstance(content["value"], bool) and \ 105 | not len(content["value"]) == 0: 106 | if content["value"][0] == '"' and \ 107 | content["value"][-1] == '"': 108 | sys.stdout.write('\t%s=%s' % \ 109 | (content["path"][1:], \ 110 | content["value"])) 111 | else: 112 | sys.stdout.write('\t%s=%s' % \ 113 | (content["path"][1:], \ 114 | content["value"])) 115 | else: 116 | output = content["value"] 117 | 118 | if not isinstance(output, bool): 119 | if len(output) == 0: 120 | output = '""' 121 | 122 | sys.stdout.write('\t%s=%s' % \ 123 | (content["path"][1:], output)) 124 | sys.stdout.write('\n') 125 | 126 | 127 | def statusvalidation(self): 128 | """ Status method validation function """ 129 | try: 130 | self._rdmc.app.get_current_client() 131 | except: 132 | raise NoCurrentSessionEstablished("Please login and make setting" \ 133 | " changes before using status command.") 134 | 135 | def definearguments(self, customparser): 136 | """ Wrapper function for new command main function 137 | 138 | :param customparser: command line input 139 | :type customparser: parser. 140 | """ 141 | if not customparser: 142 | return 143 | 144 | -------------------------------------------------------------------------------- /docs/slate/source/javascripts/lib/_imagesloaded.min.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * imagesLoaded PACKAGED v3.1.8 3 | * JavaScript is all like "You images are done yet or what?" 4 | * MIT License 5 | */ 6 | 7 | (function(){function e(){}function t(e,t){for(var n=e.length;n--;)if(e[n].listener===t)return n;return-1}function n(e){return function(){return this[e].apply(this,arguments)}}var i=e.prototype,r=this,o=r.EventEmitter;i.getListeners=function(e){var t,n,i=this._getEvents();if("object"==typeof e){t={};for(n in i)i.hasOwnProperty(n)&&e.test(n)&&(t[n]=i[n])}else t=i[e]||(i[e]=[]);return t},i.flattenListeners=function(e){var t,n=[];for(t=0;e.length>t;t+=1)n.push(e[t].listener);return n},i.getListenersAsObject=function(e){var t,n=this.getListeners(e);return n instanceof Array&&(t={},t[e]=n),t||n},i.addListener=function(e,n){var i,r=this.getListenersAsObject(e),o="object"==typeof n;for(i in r)r.hasOwnProperty(i)&&-1===t(r[i],n)&&r[i].push(o?n:{listener:n,once:!1});return this},i.on=n("addListener"),i.addOnceListener=function(e,t){return this.addListener(e,{listener:t,once:!0})},i.once=n("addOnceListener"),i.defineEvent=function(e){return this.getListeners(e),this},i.defineEvents=function(e){for(var t=0;e.length>t;t+=1)this.defineEvent(e[t]);return this},i.removeListener=function(e,n){var i,r,o=this.getListenersAsObject(e);for(r in o)o.hasOwnProperty(r)&&(i=t(o[r],n),-1!==i&&o[r].splice(i,1));return this},i.off=n("removeListener"),i.addListeners=function(e,t){return this.manipulateListeners(!1,e,t)},i.removeListeners=function(e,t){return this.manipulateListeners(!0,e,t)},i.manipulateListeners=function(e,t,n){var i,r,o=e?this.removeListener:this.addListener,s=e?this.removeListeners:this.addListeners;if("object"!=typeof t||t instanceof RegExp)for(i=n.length;i--;)o.call(this,t,n[i]);else for(i in t)t.hasOwnProperty(i)&&(r=t[i])&&("function"==typeof r?o.call(this,i,r):s.call(this,i,r));return this},i.removeEvent=function(e){var t,n=typeof e,i=this._getEvents();if("string"===n)delete i[e];else if("object"===n)for(t in i)i.hasOwnProperty(t)&&e.test(t)&&delete i[t];else delete this._events;return this},i.removeAllListeners=n("removeEvent"),i.emitEvent=function(e,t){var n,i,r,o,s=this.getListenersAsObject(e);for(r in s)if(s.hasOwnProperty(r))for(i=s[r].length;i--;)n=s[r][i],n.once===!0&&this.removeListener(e,n.listener),o=n.listener.apply(this,t||[]),o===this._getOnceReturnValue()&&this.removeListener(e,n.listener);return this},i.trigger=n("emitEvent"),i.emit=function(e){var t=Array.prototype.slice.call(arguments,1);return this.emitEvent(e,t)},i.setOnceReturnValue=function(e){return this._onceReturnValue=e,this},i._getOnceReturnValue=function(){return this.hasOwnProperty("_onceReturnValue")?this._onceReturnValue:!0},i._getEvents=function(){return this._events||(this._events={})},e.noConflict=function(){return r.EventEmitter=o,e},"function"==typeof define&&define.amd?define("eventEmitter/EventEmitter",[],function(){return e}):"object"==typeof module&&module.exports?module.exports=e:this.EventEmitter=e}).call(this),function(e){function t(t){var n=e.event;return n.target=n.target||n.srcElement||t,n}var n=document.documentElement,i=function(){};n.addEventListener?i=function(e,t,n){e.addEventListener(t,n,!1)}:n.attachEvent&&(i=function(e,n,i){e[n+i]=i.handleEvent?function(){var n=t(e);i.handleEvent.call(i,n)}:function(){var n=t(e);i.call(e,n)},e.attachEvent("on"+n,e[n+i])});var r=function(){};n.removeEventListener?r=function(e,t,n){e.removeEventListener(t,n,!1)}:n.detachEvent&&(r=function(e,t,n){e.detachEvent("on"+t,e[t+n]);try{delete e[t+n]}catch(i){e[t+n]=void 0}});var o={bind:i,unbind:r};"function"==typeof define&&define.amd?define("eventie/eventie",o):e.eventie=o}(this),function(e,t){"function"==typeof define&&define.amd?define(["eventEmitter/EventEmitter","eventie/eventie"],function(n,i){return t(e,n,i)}):"object"==typeof exports?module.exports=t(e,require("wolfy87-eventemitter"),require("eventie")):e.imagesLoaded=t(e,e.EventEmitter,e.eventie)}(window,function(e,t,n){function i(e,t){for(var n in t)e[n]=t[n];return e}function r(e){return"[object Array]"===d.call(e)}function o(e){var t=[];if(r(e))t=e;else if("number"==typeof e.length)for(var n=0,i=e.length;i>n;n++)t.push(e[n]);else t.push(e);return t}function s(e,t,n){if(!(this instanceof s))return new s(e,t);"string"==typeof e&&(e=document.querySelectorAll(e)),this.elements=o(e),this.options=i({},this.options),"function"==typeof t?n=t:i(this.options,t),n&&this.on("always",n),this.getImages(),a&&(this.jqDeferred=new a.Deferred);var r=this;setTimeout(function(){r.check()})}function f(e){this.img=e}function c(e){this.src=e,v[e]=this}var a=e.jQuery,u=e.console,h=u!==void 0,d=Object.prototype.toString;s.prototype=new t,s.prototype.options={},s.prototype.getImages=function(){this.images=[];for(var e=0,t=this.elements.length;t>e;e++){var n=this.elements[e];"IMG"===n.nodeName&&this.addImage(n);var i=n.nodeType;if(i&&(1===i||9===i||11===i))for(var r=n.querySelectorAll("img"),o=0,s=r.length;s>o;o++){var f=r[o];this.addImage(f)}}},s.prototype.addImage=function(e){var t=new f(e);this.images.push(t)},s.prototype.check=function(){function e(e,r){return t.options.debug&&h&&u.log("confirm",e,r),t.progress(e),n++,n===i&&t.complete(),!0}var t=this,n=0,i=this.images.length;if(this.hasAnyBroken=!1,!i)return this.complete(),void 0;for(var r=0;i>r;r++){var o=this.images[r];o.on("confirm",e),o.check()}},s.prototype.progress=function(e){this.hasAnyBroken=this.hasAnyBroken||!e.isLoaded;var t=this;setTimeout(function(){t.emit("progress",t,e),t.jqDeferred&&t.jqDeferred.notify&&t.jqDeferred.notify(t,e)})},s.prototype.complete=function(){var e=this.hasAnyBroken?"fail":"done";this.isComplete=!0;var t=this;setTimeout(function(){if(t.emit(e,t),t.emit("always",t),t.jqDeferred){var n=t.hasAnyBroken?"reject":"resolve";t.jqDeferred[n](t)}})},a&&(a.fn.imagesLoaded=function(e,t){var n=new s(this,e,t);return n.jqDeferred.promise(a(this))}),f.prototype=new t,f.prototype.check=function(){var e=v[this.img.src]||new c(this.img.src);if(e.isConfirmed)return this.confirm(e.isLoaded,"cached was confirmed"),void 0;if(this.img.complete&&void 0!==this.img.naturalWidth)return this.confirm(0!==this.img.naturalWidth,"naturalWidth"),void 0;var t=this;e.on("confirm",function(e,n){return t.confirm(e.isLoaded,n),!0}),e.check()},f.prototype.confirm=function(e,t){this.isLoaded=e,this.emit("confirm",this,t)};var v={};return c.prototype=new t,c.prototype.check=function(){if(!this.isChecked){var e=new Image;n.bind(e,"load",this),n.bind(e,"error",this),e.src=this.src,this.isChecked=!0}},c.prototype.handleEvent=function(e){var t="on"+e.type;this[t]&&this[t](e)},c.prototype.onload=function(e){this.confirm(!0,"onload"),this.unbindProxyEvents(e)},c.prototype.onerror=function(e){this.confirm(!1,"onerror"),this.unbindProxyEvents(e)},c.prototype.confirm=function(e,t){this.isConfirmed=!0,this.isLoaded=e,this.emit("confirm",this,t)},c.prototype.unbindProxyEvents=function(e){n.unbind(e.target,"load",this),n.unbind(e.target,"error",this)},s}); -------------------------------------------------------------------------------- /docs/slate/source/includes/_usage.md: -------------------------------------------------------------------------------- 1 | # Using the Redfish Utility 2 | 3 | ## Redfish Utility Modes of operation 4 | 5 | The Redfish Utility has three modes of operation. By default, the interactive mode is utilized when you start the Redfish Utility. With Scriptable Mode, you can use a script that gives commands to the Redfish Utility. File-Based mode allows you to use a script that gives commands to the Redfish Utility and use a file to load and save settings. 6 | 7 | ### Interactive mode 8 | 9 | Interactive mode is started when you run the Redfish Utility without any command line parameters. The `redfish>` prompt is displayed and you can enter commands one at a time. You can exit the interactive mode by entering the `exit` command at the prompt. On Windows systems, double-click `redfish.exe` to start an interactive session. You must be an administrator to run `redfish.exe`. 10 | 11 |  12 | 13 | ### Scriptable mode 14 | 15 | > The following script can be called to retrieve information regarding the **ComputerSystem** type: 16 | 17 | ``` 18 | :: This is a batch file that logs into a remote server, 19 | :: selects the ComputerSystem type, and gets the AssetTag value 20 | 21 | :: Usage :: 22 | :: selectget.bat [URI] [USERNAME] [PASSWORD] 23 | @echo off 24 | 25 | set argC=0 26 | for %%x in (%*) do Set /A argC+=1 27 | if %argC% LSS 3 goto :failCondition 28 | goto :main 29 | 30 | :failCondition 31 | @echo Usage: 32 | @echo selectget.bat [URI] [USERNAME] [PASSWORD] 33 | goto :EOF 34 | 35 | :main 36 | @echo ***************************************** 37 | @echo ************* Logging in... ************* 38 | @echo ***************************************** 39 | redfish.exe login %1 -u %2 -p %3 40 | @echo ***************************************** 41 | @echo *** selecting ComputerSystem type... **** 42 | @echo ***************************************** 43 | redfish.exe select ComputerSystem. 44 | @echo ***************************************** 45 | @echo ********** getting AssetTag... ********** 46 | @echo ***************************************** 47 | redfish.exe get AssetTag 48 | pause 49 | ``` 50 | 51 | Scriptable mode is used if you want to script all the commands with the use of an external input file. The script contains a list of the Redfish Utility command lines that let users get and set properties of server objects. 52 | 53 | In our example, first the `ComputerSystem` type is selected, and then the **get** command is used to retrieve information about the `AssetTag` property of `ComputerSystem` 54 | 55 | ### File-based mode 56 | 57 | > The following script allows you to save, edit, and load a file to the server. 58 | 59 | ``` 60 | :: This a file-based edit mode helper for the Redfish Utility 61 | :: 1. Run to download selected type to a file called redfish.json 62 | :: 2. Edit the redfish.json file to make changes. 63 | :: 3. Press any key running batch program to continue with program, 64 | :: uploading the newly edited program to the server. 65 | 66 | :: Usage :: 67 | :: saveload.bat [SELECTOR] [FILENAME] 68 | :: Specify a type with the SELECTOR tag, and 69 | :: save to a file called FILENAME 70 | @echo off 71 | set argC=0 72 | for %%x in (%*) do Set /A argC+=1 73 | if %argC% LSS 2 goto :failCondition 74 | goto :main 75 | 76 | :failCondition 77 | @echo Usage: 78 | @echo saveload.bat [SELECTOR] [FILENAME] 79 | @echo specify a type with the SELECTOR tag, and 80 | @echo save to a file called FILENAME 81 | goto :EOF 82 | 83 | :main 84 | redfish.exe login 85 | redfish.exe save --selector=%1 --json -f %2 86 | @echo Edit the file, then: 87 | pause 88 | redfish.exe load -f %2 89 | 90 | ``` 91 | 92 | File-based mode allows you to save and load settings from a file. File-based mode supports the JSON format. 93 | 94 | When the example script is run, the following result is produced: 95 | 96 |  97 | 98 | Here, the `ComputerSystem` type is saved to a file called `redfish1.json`. Then, after you modify any properties, the **load** command is used to make these changes on the server. 99 | 100 | The properties of `ComputerSystem` can be edited here, and then loaded on the server. When the file is loaded on the server, the Redfish Utility will attempt to patch all values in the file. 101 | 102 | > After saving this configuration, the **redfish1.json** file looks like this: 103 | 104 | ``` 105 | { 106 | "#ComputerSystem.v1_2_0.ComputerSystem": { 107 | "/redfish/v1/Systems/1/": { 108 | "AssetTag": "newassettag" 109 | } 110 | } 111 | } 112 | ``` 113 | 114 | ## Configuration file (redfish.conf) 115 | 116 | > default configuration file 117 | 118 | ``` 119 | [redfish] 120 | #The Redfish Utility reads the following environment variables, and applies them at runtime. 121 | #Note that they can be overridden by command line switches. 122 | 123 | ##### Cache Settings ##### 124 | ########################################## 125 | # option to disable caching of all data 126 | #cache = False 127 | 128 | ##### Credential Settings ##### 129 | ########################################## 130 | # option to use the provided url to login 131 | #url = https://127.0.0.1 132 | 133 | # option to use the provided username to login 134 | #username = admin 135 | 136 | # option to use the provided password to login 137 | #password = password 138 | 139 | ##### Commit Settings ##### 140 | ########################################## 141 | # flag to commit in all places where applicable 142 | #commit = True 143 | 144 | ##### Output Default Settings ##### 145 | ########################################## 146 | # flag to change output format in all places where applicable 147 | #format = json 148 | 149 | ##### Default Save/Load Settings ##### 150 | ########################################## 151 | # option to set default save output file 152 | #savefile = redfish.json 153 | 154 | # option to set default load input file 155 | #loadfile = redfish.json 156 | 157 | ``` 158 | 159 | The configuration file contains the default settings for the utility. You can use a text editor to change the behavior of the utility such as adding a server IP address, username, and password so you do not need to type this each time when you use the utility. 160 | 161 | Configuration file locations: 162 | 163 | - Windows OS: The same location as the executable file that starts the utility. 164 | - Linux OS: `/etc/redfish/redfish.conf` 165 | -------------------------------------------------------------------------------- /src/extensions/COMMANDS/TypesCommand.py: -------------------------------------------------------------------------------- 1 | ### 2 | # Copyright Notice: 3 | # Copyright 2016 Distributed Management Task Force, Inc. All rights reserved. 4 | # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/python-redfish-utility/blob/main/LICENSE.md 5 | ### 6 | 7 | # -*- coding: utf-8 -*- 8 | """ Types Command for RDMC """ 9 | 10 | import sys 11 | import redfish.ris 12 | 13 | from optparse import OptionParser 14 | from rdmc_base_classes import RdmcCommandBase 15 | from rdmc_helper import ReturnCodes, InvalidCommandLineError, \ 16 | InvalidCommandLineErrorOPTS 17 | 18 | class TypesCommand(RdmcCommandBase): 19 | """ Constructor """ 20 | def __init__(self, rdmcObj): 21 | RdmcCommandBase.__init__(self,\ 22 | name='types',\ 23 | usage='types [TYPE] [OPTIONS]\n\n\tRun to display currently ' \ 24 | 'available selectable types\n\texample: types',\ 25 | summary='Displays all selectable types within the currently'\ 26 | ' logged in server.',\ 27 | aliases=['types'],\ 28 | optparser=OptionParser()) 29 | self.definearguments(self.parser) 30 | self._rdmc = rdmcObj 31 | self.lobobj = rdmcObj.commandsDict["LoginCommand"](rdmcObj) 32 | 33 | def typesfunction(self, line, returntypes=False): 34 | """ Main types worker function 35 | 36 | :param line: command line input 37 | :type line: string. 38 | :param returntypes: flag to determine if types should be printed 39 | :type returntypes: boolean. 40 | """ 41 | try: 42 | (options, args) = self._parse_arglist(line) 43 | except: 44 | if ("-h" in line) or ("--help" in line): 45 | return ReturnCodes.SUCCESS 46 | else: 47 | raise InvalidCommandLineErrorOPTS("") 48 | 49 | self.typesvalidation(options) 50 | 51 | try: 52 | if len(args) == 0: 53 | typeslist = list() 54 | typeslist = sorted(set(self._rdmc.app.types())) 55 | 56 | if not returntypes: 57 | sys.stdout.write("Type options:") 58 | sys.stdout.write('\n') 59 | 60 | for item in typeslist: 61 | sys.stdout.write(item) 62 | sys.stdout.write('\n') 63 | else: 64 | return typeslist 65 | else: 66 | raise InvalidCommandLineError("The 'types' command does not "\ 67 | "take any arguments.") 68 | 69 | except redfish.ris.InstanceNotFoundError as infe: 70 | raise redfish.ris.InstanceNotFoundError(infe) 71 | 72 | def run(self, line): 73 | """ Wrapper function for types main function 74 | 75 | :param line: command line input 76 | :type line: string. 77 | """ 78 | self.typesfunction(line) 79 | 80 | #Return code 81 | return ReturnCodes.SUCCESS 82 | 83 | def typesvalidation(self, options): 84 | """ types method validation function 85 | 86 | :param options: command line options 87 | :type options: list. 88 | """ 89 | client = None 90 | inputline = list() 91 | runlogin = False 92 | 93 | try: 94 | client = self._rdmc.app.get_current_client() 95 | except: 96 | if options.user or options.password or options.url: 97 | if options.url: 98 | inputline.extend([options.url]) 99 | if options.user: 100 | inputline.extend(["-u", options.user]) 101 | if options.password: 102 | inputline.extend(["-p", options.password]) 103 | else: 104 | if self._rdmc.app.config.get_url(): 105 | inputline.extend([self._rdmc.app.config.get_url()]) 106 | if self._rdmc.app.config.get_username(): 107 | inputline.extend(["-u", \ 108 | self._rdmc.app.config.get_username()]) 109 | if self._rdmc.app.config.get_password(): 110 | inputline.extend(["-p", \ 111 | self._rdmc.app.config.get_password()]) 112 | 113 | if len(inputline) or not client: 114 | runlogin = True 115 | if options.includelogs: 116 | inputline.extend(["--includelogs"]) 117 | if options.path: 118 | inputline.extend(["--path", options.path]) 119 | 120 | if runlogin: 121 | self.lobobj.loginfunction(inputline) 122 | 123 | def definearguments(self, customparser): 124 | """ Wrapper function for new command main function 125 | 126 | :param customparser: command line input 127 | :type customparser: parser. 128 | """ 129 | if not customparser: 130 | return 131 | 132 | customparser.add_option( 133 | '--url', 134 | dest='url', 135 | help="Use the provided URL to login.", 136 | default=None, 137 | ) 138 | customparser.add_option( 139 | '-u', 140 | '--user', 141 | dest='user', 142 | help="If you are not logged in yet, including this flag along"\ 143 | " with the password and URL flags can be used to log into a"\ 144 | " server in the same command.""", 145 | default=None, 146 | ) 147 | customparser.add_option( 148 | '-p', 149 | '--password', 150 | dest='password', 151 | help="""Use the provided password to log in.""", 152 | default=None, 153 | ) 154 | customparser.add_option( 155 | '--includelogs', 156 | dest='includelogs', 157 | action="store_true", 158 | help="Optionally include logs in the data retrieval process.", 159 | default=False, 160 | ) 161 | customparser.add_option( 162 | '--path', 163 | dest='path', 164 | help="Optionally set a starting point for data collection."\ 165 | " If you do not specify a starting point, the default path"\ 166 | " will be /redfish/v1/. Note: The path flag can only be specified"\ 167 | " at the time of login, so if you are already logged into the"\ 168 | " server, the path flag will not change the path. If you are"\ 169 | " entering a command that isn't the login command, but include"\ 170 | " your login information, you can still specify the path flag"\ 171 | " there. ", 172 | default=None, 173 | ) 174 | -------------------------------------------------------------------------------- /docs/slate/deploy.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -o errexit #abort if any command fails 3 | me=$(basename "$0") 4 | 5 | help_message="\ 6 | Usage: $me [-c FILE] [