Update documentation to markdown (Build number: 10)

Author: orocrmdeployer

_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}

_static/jquery.js

@@ -0,0 +1,225 @@
+<a id="advanced-search-api"></a>
+
+# Advanced Search API
+
+REST API allows to create advanced search queries.
+
+Parameters for APIs requests:
+
+- **query** - search string
+
+REST API url: `http://domail.com/api/rest/latest/search/advanced`
+
+REST API works with the get request only.
+
+## Result
+
+Request returns an array with data:
+
+- **records_count** - the total number of results (without `offset`
+  and `max_results`) parameters
+- **count** - count of records in the current request
+- **data** - array with data. Data consists of the following values:
+  - **entity_name** - class name of entity
+  - **record_id** - id of record from this entity
+  - **record_string** - the title of this record
+  - **record_url** - the given URL for this record
+  - **selected_data** - data from fields that have been explicitly
+    selected in the select clause (optional)
+
+## Query Language
+
+### Keywords
+
+#### select
+
+Includes field values, taken from the search index, as an additional
+“selected_data” section in the search result items. You can select one
+or more fields to be attached to search results. The name of the field
+should consist the type prefix, otherwise the default `text` type will
+be used.
+
+```none
+select text.field_name
+select (text.first_field_name, text.second_field_name)
+```
+
+You can use fieldname aliasing, as known in SQL, for example:
+
+```none
+select text.field_1 as name, text.field_2 as author
+```
+
+You can use fieldname aliasing, as known in SQL, for example:
+
+```none
+select (text.field_1 as name, text.field_2 as author)
+```
+
+Note that parentheses are mandatory.
+
+#### from
+
+A list of entity aliases to search from. It can be one alias or group.
+Examples:
+
+```none
+from one_alias
+from (first_alias, second_alias)
+```
+
+#### where
+
+The `where` clause defines the search parameters.
+
+#### and, or
+
+`And` and `or` operators are used to combine multiple clauses, allowing you to refine your search.
+
+Syntax:
+
+```none
+and field_type field_name operator value
+or field_type field_name operator value
+```
+
+If the field type is not set, then text field type will be used.
+
+#### offset
+
+The offset clause allows to set the offset of the first result.
+
+#### max_results
+
+The set results count for the query.
+
+#### order_by
+
+The `order_by` clause allows to sort results in ascending or descending order.
+
+Syntax:
+
+```none
+order_by field_type field_name direction
+```
+
+If the field type is set, the text field will be assigned. Direction -
+`ASC`, `DESC`. If the direction is not assigned, the
+`ASC` direction will be used.
+
+## Field Types
+
+User should specify field type in query string. By default, if type is
+not set, it will be used text type. Supported field types: \* **text**
+\* **integer** \* **decimal** \* **datetime**
+
+## Operators
+
+Different field types support different operators in the `where` block.
+
+### For String Fields
+
+- **~ (CONTAINS)** - operator `~` is used for set text field value.
+  If search value is string, it must be quoted. Examples:
+  ```none
+  name ~ value
+  name ~ "string value"
+  ```
+- **!~ (NOT CONTAINS)** - operator `!~` is used for search strings
+  without value. If the search value is a string, it must be quoted.
+  Examples:
+  ```none
+  name !~ value
+  name !~ "string value"
+  ```
+- **like** - operator `like` is used to finding records with a
+  specified substring in any position (`LIKE %value%` statement
+  behaviour). If the search value is a multi-word string that contains
+  whitespaces, it should be enclosed in quotes. Examples:
+  ```none
+  name like value
+  name like "string value"
+  ```
+- **notlike** - operator `notlike` is used to find records
+  without a specified substring in any position (`NOT LIKE %value%`
+  statement behaviour). If the search value is a multi-word string that
+  contains whitespaces, it should be enclosed in quotes. Examples:
+  ```none
+  name notlike value
+  name notlike "string value"
+  ```
+
+### For Numeric Fields
+
+- **= (EQUALS)** - operator `=` is used to search for records where the
+  field value matches the specified value. Examples:
+  ```none
+  integer count = 100
+  decimal price = 12.5
+  datetime create_date = "2013-01-01 00:00:00"
+  ```
+- **!= (NOT EQUALS)** - operator `!=` is used to search for records
+  where the field value does not match the specified value. Examples:
+  ```none
+  integer count != 5
+  decimal price != 45
+  datetime create_date != "2012-01-01 00:00:00"
+  ```
+- **>, <, <=, >=** - Operators are used to search for the records where the field value is `greater`, `less`,
+  `less than or equals` or `greater than or equals` of the
+  specified value. Examples:
+  ```none
+  integer count >= 5
+  decimal price < 45
+  datetime create_date > "2012-01-01 00:00:00"
+  ```
+- **in** - operator `in` is used to search for the records where the value is in
+  the specified set of data. Examples:
+  ```none
+  integer count in (5, 10, 15, 20)
+  decimal price in (12.2, 55.25)
+  ```
+- **!in** - operator `!in` is used to search for records where the field value is not
+  in the specified set of data. Examples:
+  ```none
+  integer count !in (1, 3, 5)
+  decimal price !in (2.1, 55, 45.4)
+  ```
+
+### Query Brackets
+
+User can combined operators in the search query with brackets.
+
+Examples:
+
+```none
+from oro_test where (owner ~ john and (integer count > 10 or float price = 10)) or (owner ~ mary and (integer count > 5 or float price = 150))
+```
+
+## Query Examples
+
+- Search by demo products where the name contains the `opportunity` string
+  and where the price is greater than `100`.
+  ```none
+  from demo_product where name ~ opportunity and double price > 100
+  ```
+- Search and return entity data plus the name and the description of demo
+  products.
+  ```none
+  select (name, description) from demo_product
+  ```
+- Search by all entities where the integer field count is not equal `10`.
+  ```none
+  integer count != 10
+  ```
+- Search by all entities where text field `all_text` does not contain the
+  `opportunity` string.
+  ```none
+  all_text !~ "opportunity"
+  ```
+- Select `10` results from the `demo_products` and `demo_categories`
+  entities where the text field description contains `test`, order
+  `ASC` by text field name and offset first result to `5`.
+  ```none
+  from (demo_products, demo_categories) where description ~ test order_by name offset 5 max_results 10
+  ```

api/advanced-search.md

@@ -0,0 +1,15 @@
+<a id="web-services-api-authentication"></a>
+
+# Authentication
+
+A RESTful API should be stateless. This means that request authentication should not depend on cookies or sessions.
+Instead, each request should come with some authentication credentials.
+
+Out-of-the-box, OroPlatform provides the following authentication mechanism:
+
+* [OAuth Authentication](oauth.md)
+
+#### BUSINESS TIP
+# Business Tip
+
+Looking to make a digital commerce investment? Evaluate the <a href="https://oroinc.com/b2b-ecommerce/b2b-ecommerce-comparison" target="_blank">best B2B eCommerce platforms</a> on our comparison page.