Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/favicon.png b/favicon.png
new file mode 100644
index 0000000..a5b1aa1
Binary files /dev/null and b/favicon.png differ
diff --git a/favicon.svg b/favicon.svg
new file mode 100644
index 0000000..90e0ea5
--- /dev/null
+++ b/favicon.svg
@@ -0,0 +1,22 @@
+
+
diff --git a/fonts/OPEN-SANS-LICENSE.txt b/fonts/OPEN-SANS-LICENSE.txt
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/fonts/OPEN-SANS-LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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.
diff --git a/fonts/SOURCE-CODE-PRO-LICENSE.txt b/fonts/SOURCE-CODE-PRO-LICENSE.txt
new file mode 100644
index 0000000..366206f
--- /dev/null
+++ b/fonts/SOURCE-CODE-PRO-LICENSE.txt
@@ -0,0 +1,93 @@
+Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/fonts/fonts.css b/fonts/fonts.css
new file mode 100644
index 0000000..858efa5
--- /dev/null
+++ b/fonts/fonts.css
@@ -0,0 +1,100 @@
+/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
+/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
+
+/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 300;
+ src: local('Open Sans Light'), local('OpenSans-Light'),
+ url('open-sans-v17-all-charsets-300.woff2') format('woff2');
+}
+
+/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 300;
+ src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
+ url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
+}
+
+/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 400;
+ src: local('Open Sans Regular'), local('OpenSans-Regular'),
+ url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
+}
+
+/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 400;
+ src: local('Open Sans Italic'), local('OpenSans-Italic'),
+ url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
+}
+
+/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 600;
+ src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
+ url('open-sans-v17-all-charsets-600.woff2') format('woff2');
+}
+
+/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 600;
+ src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
+ url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
+}
+
+/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 700;
+ src: local('Open Sans Bold'), local('OpenSans-Bold'),
+ url('open-sans-v17-all-charsets-700.woff2') format('woff2');
+}
+
+/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 700;
+ src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
+ url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
+}
+
+/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
+ url('open-sans-v17-all-charsets-800.woff2') format('woff2');
+}
+
+/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
+ url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
+}
+
+/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Source Code Pro';
+ font-style: normal;
+ font-weight: 500;
+ src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
+}
diff --git a/fonts/open-sans-v17-all-charsets-300.woff2 b/fonts/open-sans-v17-all-charsets-300.woff2
new file mode 100644
index 0000000..9f51be3
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-300italic.woff2 b/fonts/open-sans-v17-all-charsets-300italic.woff2
new file mode 100644
index 0000000..2f54544
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600.woff2 b/fonts/open-sans-v17-all-charsets-600.woff2
new file mode 100644
index 0000000..f503d55
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600italic.woff2 b/fonts/open-sans-v17-all-charsets-600italic.woff2
new file mode 100644
index 0000000..c99aabe
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700.woff2 b/fonts/open-sans-v17-all-charsets-700.woff2
new file mode 100644
index 0000000..421a1ab
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700italic.woff2 b/fonts/open-sans-v17-all-charsets-700italic.woff2
new file mode 100644
index 0000000..12ce3d2
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800.woff2 b/fonts/open-sans-v17-all-charsets-800.woff2
new file mode 100644
index 0000000..c94a223
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800italic.woff2 b/fonts/open-sans-v17-all-charsets-800italic.woff2
new file mode 100644
index 0000000..eed7d3c
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-italic.woff2 b/fonts/open-sans-v17-all-charsets-italic.woff2
new file mode 100644
index 0000000..398b68a
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-regular.woff2 b/fonts/open-sans-v17-all-charsets-regular.woff2
new file mode 100644
index 0000000..8383e94
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-regular.woff2 differ
diff --git a/fonts/source-code-pro-v11-all-charsets-500.woff2 b/fonts/source-code-pro-v11-all-charsets-500.woff2
new file mode 100644
index 0000000..7222456
Binary files /dev/null and b/fonts/source-code-pro-v11-all-charsets-500.woff2 differ
diff --git a/highlight.css b/highlight.css
new file mode 100644
index 0000000..c234322
--- /dev/null
+++ b/highlight.css
@@ -0,0 +1,83 @@
+/*
+ * An increased contrast highlighting scheme loosely based on the
+ * "Base16 Atelier Dune Light" theme by Bram de Haan
+ * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
+ * Original Base16 color scheme by Chris Kempson
+ * (https://github.com/chriskempson/base16)
+ */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+ color: #575757;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-name,
+.hljs-regexp,
+.hljs-link,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #d70025;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-meta,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #b21e00;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet {
+ color: #008200;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+ color: #0030f2;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+ color: #9d00ec;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #f6f7f6;
+ color: #000;
+ padding: 0.5em;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #22863a;
+ background-color: #f0fff4;
+}
+
+.hljs-deletion {
+ color: #b31d28;
+ background-color: #ffeef0;
+}
diff --git a/highlight.js b/highlight.js
new file mode 100644
index 0000000..180385b
--- /dev/null
+++ b/highlight.js
@@ -0,0 +1,6 @@
+/*
+ Highlight.js 10.1.1 (93fd0d73)
+ License: BSD-3-Clause
+ Copyright (c) 2006-2020, Ivan Sagalaev
+*/
+var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ What Schnauzer UI knows
+Schnauzer UI tries to be smart about the way it interacts with HTML, so the person +writing the test rarely has to look the underlying HTML of a page. This page outlines +some of the strategies it takes to achieve that.
+Smart Swap
+Schnauzer UI tries to make it easy to locate and interact with web elements based +on only visible information on the page (i.e. without having to look at HTML). +One way it does this is by acknowledging that HTML elements are often used together +in common patterns (many are designed this way).
+When Schnauzer UI can, it will try to make a judgement call about the element you +actually want to interact with vs the element you were able to locate on the page, and +swap them out for appropriate commands.
+For input, textarea, and select elements, if you are able to locate
+-
+
- A span or label containing the element +
- A span or label directly preceding the element +
- A span or label roughly near the element +
then Schnauzer UI will swap the element on click and type commands
Additionally, select commands will do the same, as well as check to see if the currently located element is
+an option inside a select.
Clicking and Typing
+Often times, the real world components we're testing are fancy. +The produced HTML can have several layers that shift around while we interact with them. +Schnauzer UI tries to make these components easier to test by acting as closely to a person as possible.
+The click command does not click the located element. It registers a click event at the center of the elements
+location on the page. This helps to reduce headaches around which element should actually be clicked
+(in my experience, dealing with click intercepted errors is half of day to day selenium use).
Similarly, the type command doesn't type into the located element. It clicks the currently located element, and
+then types into the active element. This is what people do, and it helps with fancy search dropdowns and things
+that use javascript to swap out elements underneath you after registering a click.
Under
+HTML is fundamentally a tree structure, and it's structure isn't necessarily related to the way a webpage is +layed out (CSS and JavaScript have a tendency to move things around). +Often though, HTML elements are composed something like this.
+<div id="container">
+ <div id="header">
+ I am a heading of some section of this page
+ </div>
+ <div id="content">
+ <p>I am some content</p>
+ <div id="sub-content">
+ ... more html
+ </div>
+ </div>
+</div>
+Pieces of HTML that related to each other get wrapped up in a container, with some kind of title/heading +at the top followed by the content of the component. +Often the HTML is more deeply nested than this. For example, here's the sample HTML for a Bootstrap card
+<div class="card" style="width: 18rem;">
+ <img class="card-img-top" src="..." alt="Card image cap">
+ <div class="card-body">
+ <h5 class="card-title">Card title</h5>
+ <p class="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+ <ul class="list-group list-group-flush">
+ <li class="list-group-item">Cras justo odio</li>
+ <li class="list-group-item">Dapibus ac facilisis in</li>
+ <li class="list-group-item">Vestibulum at eros</li>
+ </ul>
+ <div class="card-body">
+ <a href="#" class="card-link">Card link</a>
+ <a href="#" class="card-link">Another link</a>
+ </div>
+</div>
+Schnauzer UI takes advantage of this common organization strategy when helping you locate elements with visual
+information. The under command changes the way locators work, so that the search for your element begins where
+you want it to.
One could type under "Card title" locate "Card link" and click, and expect the Card link to be correctly selected and clicked. Schnauzer UI will start with the h5 element and walk up the tree to the parent element, until the current element contains the one it's looking for.
+This is especially useful for buttons/labels/placeholders that get repeated several places on a page. Think "add to cart", "see more...", etc. on gallery type pages.
":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/introduction.html b/introduction.html
new file mode 100644
index 0000000..7688115
--- /dev/null
+++ b/introduction.html
@@ -0,0 +1,196 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction
+SchnauzerUI is a human readable DSL for performing automated UI testing in the browser. +The main goal of SchnauzerUI is to increase stakeholder visibility and participation in automated Quality Assurance testing.
+SchnauzerUI lets non-programmers create automated tests from start to finish, without +out ever needing to involve a developer. To demonstrate, lets look at the SchnauzerUI +code necessary to search for cats on youtube.
+url "https://youtube.com"
+locate "Search" and type "cats" and press "Enter"
+This is the only code necessary to write in order to run the test in a live +browser and generate a test report.
+About this document
+We are subscribing to the Divio documentation system, so this document is composed of four sections:
+-
+
- Tutorials: Focused on learning SchnauzerUI. Hands on and closely guided. +
- How-To Guides: Focused on solving specific problems with SchnauzerUI. We hope to accumulate a lot of these, so don't be afraid to submit a Github issue asking for help, it helps us as much as it does you. +
- Reference: A complete list of all available functionality of SchnauzerUI. +
- Explanation: Covers how SchanzuerUI works under the hood and why it was designed that way. Great place to start if you're considering forking or contributing to SchnauzerUI. +
To get started, checkout the quickstart tutorial
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/mark.min.js b/mark.min.js
new file mode 100644
index 0000000..1636231
--- /dev/null
+++ b/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction
+SchnauzerUI is a human readable DSL for performing automated UI testing in the browser. +The main goal of SchnauzerUI is to increase stakeholder visibility and participation in automated Quality Assurance testing.
+SchnauzerUI lets non-programmers create automated tests from start to finish, without +out ever needing to involve a developer. To demonstrate, lets look at the SchnauzerUI +code necessary to search for cats on youtube.
+url "https://youtube.com"
+locate "Search" and type "cats" and press "Enter"
+This is the only code necessary to write in order to run the test in a live +browser and generate a test report.
+About this document
+We are subscribing to the Divio documentation system, so this document is composed of four sections:
+-
+
- Tutorials: Focused on learning SchnauzerUI. Hands on and closely guided. +
- How-To Guides: Focused on solving specific problems with SchnauzerUI. We hope to accumulate a lot of these, so don't be afraid to submit a Github issue asking for help, it helps us as much as it does you. +
- Reference: A complete list of all available functionality of SchnauzerUI. +
- Explanation: Covers how SchanzuerUI works under the hood and why it was designed that way. Great place to start if you're considering forking or contributing to SchnauzerUI. +
To get started, checkout the quickstart tutorial
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/reference/statements_and_commands.html b/reference/statements_and_commands.html
new file mode 100644
index 0000000..c374d1d
--- /dev/null
+++ b/reference/statements_and_commands.html
@@ -0,0 +1,333 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction
+SchnauzerUI is a human readable DSL for performing automated UI testing in the browser. +The main goal of SchnauzerUI is to increase stakeholder visibility and participation in automated Quality Assurance testing.
+SchnauzerUI lets non-programmers create automated tests from start to finish, without +out ever needing to involve a developer. To demonstrate, lets look at the SchnauzerUI +code necessary to search for cats on youtube.
+url "https://youtube.com"
+locate "Search" and type "cats" and press "Enter"
+This is the only code necessary to write in order to run the test in a live +browser and generate a test report.
+About this document
+We are subscribing to the Divio documentation system, so this document is composed of four sections:
+-
+
- Tutorials: Focused on learning SchnauzerUI. Hands on and closely guided. +
- How-To Guides: Focused on solving specific problems with SchnauzerUI. We hope to accumulate a lot of these, so don't be afraid to submit a Github issue asking for help, it helps us as much as it does you. +
- Reference: A complete list of all available functionality of SchnauzerUI. +
- Explanation: Covers how SchanzuerUI works under the hood and why it was designed that way. Great place to start if you're considering forking or contributing to SchnauzerUI. +
To get started, checkout the quickstart tutorial
+Quickstart
+Installation
+Warning: The below install process is quite technical and involves using your computer's terminal.
+To install Schnauzer UI, you'll need the rust toolchain installed.
+Then run cargo install schnauzer_ui. After installing, type sui --help and take a quick look
+at the options.
You will also need a webdriver compliant process running to run your tests against. Schnauzer UI currently supports
+firefox and chrome. geckodriver, chromedriver, or a selenium standalone should work just fine.
+Make a note of what port you're running the process on.
If you've never worked with any of these before:
+-
+
- Try installing either
geckodriverorchromedriverhowever you normally install packages (brew, apt, etc.) depending on whether you want to test in Firefox or Chrome respectively.
+ - If that's not an option, you can manually download any of these as binaries, put them somwhere in your path, +and run them. +
- If that all sounds like too much, and you're okay using Firefox, you can build geckodriver from source with
+
cargo install geckodriverand then run it.
+
Running the REPL for the first time
+To start a REPL, first make sure your webdriver process is running.
+Then make yourself a folder called sui_tutorial (or whatever you like) and open a terminal there.
+Type sui -b <the browser> -p <the port>. For example, sui -b chrome -p 9515.
+(Note: Schnauzer UI defaults to using firefox on port 4444, so the commands sui and sui -b firefox -p 4444 are equivalent).
You should see 1. a browser launch and 2. a prompt appear on the terminal asking for the name of your test.
+Go through the start up options until you are prompted for a command. Then type url "https://youtube.com"
+and hit enter. The browser should navigate to YouTube.
+You will then be prompted for whether you want to save the command. The default is yes, so simply hit enter.
Congrats! You're up an running with Schnauzer UI. Feel free to try commands from the reference.
+When you're ready to quit, type exit as a command and hit enter. You will be asked if you want to save your script.
+Simply type yes and hit enter.
Running a saved script file
+There should now be a Schnauzer UI script saved as a file ending in .sui in your current directory.
+cat the file or open it up in your favorite text editor to take a look inside. You should see your saved commands
+there. This is your brand new Schnauzer UI test script!
To run the script, type sui -f <path-to-the-file> along
+with the port and browser arguments if they are not the default. The browser should launch again and run the entire script, then generate some test results. There should now also be an HTML file, a JSON file, and a screenshots folder
+with any screenshots taken during the test run.
-
+
- The HTML file is the standard formatting of the test report. You can open it in a browser to see the report. +
- The JSON file is the same information in JSON format, in case you want to create custom styled reports or use the +test result data programatically. +
Statements
+Don't see functionality you were looking for? File an issue on our github and we'll consider implementing it for you. Or feel free to file a pull request.
+Comment
+A comment statement is the simplest statement in Schnauzer UI. Create a comment by typing # and then the text you'd like.
+Comments are automatically added to the test run log for reference. It's good practice to separate chunks of a Schnauzer UI script with comments to keep it readable.
Ex. Commenting a chunk of code.
+# This part of the script performs x action
For programmers: Schnauzer UI doesn't have units of code that can be extracted and reused like "functions". +This makes good comments really important for keeping longer scripts organized and readable. +We don't have functions or modules because it's a priority that each script be a straightforward linear description +of a browser based process, which can be easily passed around via tools like Jira, Teams, Slack, etc.
+Save As
+The save as command will save some text as a variable for use later in the script.
+Ex. Begin a script with some important info
+save "test@test.com" as username
Command Statement
+A command statement consists of a one or more commands connected by the and keyword. This is
+the bread and butter of your scripts.
Ex. Locate and click a button
+locate "Submit" and click
If Statement
+An if statement is used for conditional actions. The statement takes a command as a predicate, and +executes the body only if the command succeeds without error.
+Ex. Dismissing a popup.
+if locate "Confirm" then click
Catch Error
+Schnauzer UI provides the catch-error statement for simple error handling. Whenever a command
+produces an error (except in an if condition), the script will jump ahead to the nearest catch-error:
+token. This lets you handle an error how you want. Some commands to keep in mind are screenshot, refresh, and try-again.
+If you don't make use of catch-error, scripts will simply exit when they encounter errors (which is good for a lot
+of testing use cases but not good for RPA use cases).
Ex. Taking a screenshot from a script that reproduces a bug.
+catch-error: screenshot
Under
+An under statement changes the way locators work for a single line of code. It lets the +locator start searching for html by radiating out from a given element rather than starting +at the top of the HTML document. It's especially useful for locating elements by visual text when +that text is present multiple places on the page. +The scope of the search is not restricted to elements contained by the located element. Locators +will still search the whole page, but they will start searching where you tell them. Consider the +following HTML
+<h1>Desired Text</h1>
+<div class="container">
+ <div class="nav-title">
+ <h3>Navigation</h3>
+ </div>
+ <div class="nav-body">
+ <a href="https://somesite.com">Desired Text</a>
+ ... more links
+ </div>
+</div>
+the command
+under "Navigation" locate "Desired Text" and click
+will click the navigation link, not the level one heading. This is not because the link is "under" the h3 element, +but because they are close together. The locate command searches children of the h3, then +children of the div with class nav-title, then children of the div with class container before succeeding.
+Under Active Element
+Works the same as the Under statement, but begins searching under the "active" element (the last +element interacted with).
+Ex. Locate an element near the last element interacted with.
+under-active-element locate subElement and click
Commands
+url
+The url command navigates to a spcific url. It can take either a full url or a slug as an argument
Ex. Navigate to complete url
+url "https://youtube.com"
Ex. Navigate to a slug /posts
+url "posts"
locate
+The locate command finds a web element and scrolls it to the top of the viewport to interact with.
Ex. Locate a submit button
+locate "Submit"
The locate command uses precedence to determine how to use the provided locator.
+-
+
- Match a placeholder or partial placeholder +
- Match text or partial text +
- Match title attribute +
- Match aria-label +
- Match id attribute +
- Match name attribute +
- Match class attribute or partial class attribute +
- Match an XPath +
locate-no-scroll
+The locate-no-scroll command is the same as the locate command, but does not scroll the element from where
+it is. Useful for when scrolling an element to the top of the viewport causes it to be covered by a navbar or
+some other element.
click
+The click command performs a click at the location of the located element. This helps to avoid
+click intercept issues with complex components.
Ex. Locate a button and click it
+locate "login-btn" and click
type
+In general, the type command will send text to the located element.
+In reality, the type command will click a located element then begin typing
+in the active element! This is usually the same thing, but better for complex UI components
+which switch the active element on their own.
Ex. Type in a username
+locate "Username" and type "test@test.com"
refresh
+The refresh command simply refreshes the page
screenshot
+The screenshot command will capture a screeshot of the current window
read-to
+The read-to command will save the text of a web element to a variable. Useful for things
+like dynamically generated names etc.
Ex. Read the number of search results to a variable
+locate "result-stats" and read-to mySearchResults
press
+The press command is used to perform keyboard actions. The kepresses are registered against
+the currently selected web element, so it's mainly useful for things like hitting Enter from a search box.
Ex. Press enter when logging in.
+locate "password" and type myPassword and press "Enter"
chill
+The chill command causes the script to pause for the provided number of seconds. Useful for waiting
+for some process to finish.
+(Note: Commands by default have a one second wait between execution. Explicitly managing waits is complicated,
+and we opted for a simpler approach. Generally this command will not be necessary. If you are waiting for some transition
+on the page to take place, consider using the locate command to automatically wait for an element to signal the page is ready.
+For example, after logging into a website, rather than using the chill command, use locate to find some element of the loaded dashboard to verify that the page has loaded.)
Ex. Wait 10 seconds.
+chill "10"
drag-to
+The drag-to command uses javascript to simulate a drag and drop event, dragging the currently located
+element to the element matching the provided locator.
Ex. Imagine mapping headers to the correct column of an uploaded file.
+locate "email" and drag-to "@"
select
+The select command will select (by text) one of the options in a select element.
+Note. This command will also work if the currently located element is an option in the given
+select element. This makes it much easier to locate and use select elements using only the displayed option
+text.
Ex. Login as an admin user.
+locate "Select Role" and select "Admin User"
upload
+The upload command performs a basic file upload on an html input element of type file.
+The located element must be an input element. Very often, custom component is used which performs
+the javascript to do the upload, which means you'll have to look in the html for the hidden input you
+actually want to upload to.
Ex. Upload file
+locate "//input[@id='file-input']" and upload "./screenshots/main_screenshot_2.png"
Note: We are locating the input by xpath because it's not actually displayed on the page. +Smart locators only return elements which are currently displayed.
+accept-alert and dismiss-alert
+The accept-alert and dismiss-alert commands accept and dismiss alerts.
Ex. Accept cookie alert
+# Accept cookie alert
+accept-alert
+What Schnauzer UI knows
+Schnauzer UI tries to be smart about the way it interacts with HTML, so the person +writing the test rarely has to look the underlying HTML of a page. This page outlines +some of the strategies it takes to achieve that.
+Smart Swap
+Schnauzer UI tries to make it easy to locate and interact with web elements based +on only visible information on the page (i.e. without having to look at HTML). +One way it does this is by acknowledging that HTML elements are often used together +in common patterns (many are designed this way).
+When Schnauzer UI can, it will try to make a judgement call about the element you +actually want to interact with vs the element you were able to locate on the page, and +swap them out for appropriate commands.
+For input, textarea, and select elements, if you are able to locate
+-
+
- A span or label containing the element +
- A span or label directly preceding the element +
- A span or label roughly near the element +
then Schnauzer UI will swap the element on click and type commands
Additionally, select commands will do the same, as well as check to see if the currently located element is
+an option inside a select.
Clicking and Typing
+Often times, the real world components we're testing are fancy. +The produced HTML can have several layers that shift around while we interact with them. +Schnauzer UI tries to make these components easier to test by acting as closely to a person as possible.
+The click command does not click the located element. It registers a click event at the center of the elements
+location on the page. This helps to reduce headaches around which element should actually be clicked
+(in my experience, dealing with click intercepted errors is half of day to day selenium use).
Similarly, the type command doesn't type into the located element. It clicks the currently located element, and
+then types into the active element. This is what people do, and it helps with fancy search dropdowns and things
+that use javascript to swap out elements underneath you after registering a click.
Under
+HTML is fundamentally a tree structure, and it's structure isn't necessarily related to the way a webpage is +layed out (CSS and JavaScript have a tendency to move things around). +Often though, HTML elements are composed something like this.
+<div id="container">
+ <div id="header">
+ I am a heading of some section of this page
+ </div>
+ <div id="content">
+ <p>I am some content</p>
+ <div id="sub-content">
+ ... more html
+ </div>
+ </div>
+</div>
+Pieces of HTML that related to each other get wrapped up in a container, with some kind of title/heading +at the top followed by the content of the component. +Often the HTML is more deeply nested than this. For example, here's the sample HTML for a Bootstrap card
+<div class="card" style="width: 18rem;">
+ <img class="card-img-top" src="..." alt="Card image cap">
+ <div class="card-body">
+ <h5 class="card-title">Card title</h5>
+ <p class="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+ <ul class="list-group list-group-flush">
+ <li class="list-group-item">Cras justo odio</li>
+ <li class="list-group-item">Dapibus ac facilisis in</li>
+ <li class="list-group-item">Vestibulum at eros</li>
+ </ul>
+ <div class="card-body">
+ <a href="#" class="card-link">Card link</a>
+ <a href="#" class="card-link">Another link</a>
+ </div>
+</div>
+Schnauzer UI takes advantage of this common organization strategy when helping you locate elements with visual
+information. The under command changes the way locators work, so that the search for your element begins where
+you want it to.
One could type under "Card title" locate "Card link" and click, and expect the Card link to be correctly selected and clicked. Schnauzer UI will start with the h5 element and walk up the tree to the parent element, until the current element contains the one it's looking for.
+This is especially useful for buttons/labels/placeholders that get repeated several places on a page. Think "add to cart", "see more...", etc. on gallery type pages.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/searcher.js b/searcher.js
new file mode 100644
index 0000000..d2b0aee
--- /dev/null
+++ b/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Statements
+Don't see functionality you were looking for? File an issue on our github and we'll consider implementing it for you. Or feel free to file a pull request.
+Comment
+A comment statement is the simplest statement in Schnauzer UI. Create a comment by typing # and then the text you'd like.
+Comments are automatically added to the test run log for reference. It's good practice to separate chunks of a Schnauzer UI script with comments to keep it readable.
Ex. Commenting a chunk of code.
+# This part of the script performs x action
For programmers: Schnauzer UI doesn't have units of code that can be extracted and reused like "functions". +This makes good comments really important for keeping longer scripts organized and readable. +We don't have functions or modules because it's a priority that each script be a straightforward linear description +of a browser based process, which can be easily passed around via tools like Jira, Teams, Slack, etc.
+Save As
+The save as command will save some text as a variable for use later in the script.
+Ex. Begin a script with some important info
+save "test@test.com" as username
Command Statement
+A command statement consists of a one or more commands connected by the and keyword. This is
+the bread and butter of your scripts.
Ex. Locate and click a button
+locate "Submit" and click
If Statement
+An if statement is used for conditional actions. The statement takes a command as a predicate, and +executes the body only if the command succeeds without error.
+Ex. Dismissing a popup.
+if locate "Confirm" then click
Catch Error
+Schnauzer UI provides the catch-error statement for simple error handling. Whenever a command
+produces an error (except in an if condition), the script will jump ahead to the nearest catch-error:
+token. This lets you handle an error how you want. Some commands to keep in mind are screenshot, refresh, and try-again.
+If you don't make use of catch-error, scripts will simply exit when they encounter errors (which is good for a lot
+of testing use cases but not good for RPA use cases).
Ex. Taking a screenshot from a script that reproduces a bug.
+catch-error: screenshot
Under
+An under statement changes the way locators work for a single line of code. It lets the +locator start searching for html by radiating out from a given element rather than starting +at the top of the HTML document. It's especially useful for locating elements by visual text when +that text is present multiple places on the page. +The scope of the search is not restricted to elements contained by the located element. Locators +will still search the whole page, but they will start searching where you tell them. Consider the +following HTML
+<h1>Desired Text</h1>
+<div class="container">
+ <div class="nav-title">
+ <h3>Navigation</h3>
+ </div>
+ <div class="nav-body">
+ <a href="https://somesite.com">Desired Text</a>
+ ... more links
+ </div>
+</div>
+the command
+under "Navigation" locate "Desired Text" and click
+will click the navigation link, not the level one heading. This is not because the link is "under" the h3 element, +but because they are close together. The locate command searches children of the h3, then +children of the div with class nav-title, then children of the div with class container before succeeding.
+Under Active Element
+Works the same as the Under statement, but begins searching under the "active" element (the last +element interacted with).
+Ex. Locate an element near the last element interacted with.
+under-active-element locate subElement and click
Commands
+url
+The url command navigates to a spcific url. It can take either a full url or a slug as an argument
Ex. Navigate to complete url
+url "https://youtube.com"
Ex. Navigate to a slug /posts
+url "posts"
locate
+The locate command finds a web element and scrolls it to the top of the viewport to interact with.
Ex. Locate a submit button
+locate "Submit"
The locate command uses precedence to determine how to use the provided locator.
+-
+
- Match a placeholder or partial placeholder +
- Match text or partial text +
- Match title attribute +
- Match aria-label +
- Match id attribute +
- Match name attribute +
- Match class attribute or partial class attribute +
- Match an XPath +
locate-no-scroll
+The locate-no-scroll command is the same as the locate command, but does not scroll the element from where
+it is. Useful for when scrolling an element to the top of the viewport causes it to be covered by a navbar or
+some other element.
click
+The click command performs a click at the location of the located element. This helps to avoid
+click intercept issues with complex components.
Ex. Locate a button and click it
+locate "login-btn" and click
type
+In general, the type command will send text to the located element.
+In reality, the type command will click a located element then begin typing
+in the active element! This is usually the same thing, but better for complex UI components
+which switch the active element on their own.
Ex. Type in a username
+locate "Username" and type "test@test.com"
refresh
+The refresh command simply refreshes the page
screenshot
+The screenshot command will capture a screeshot of the current window
read-to
+The read-to command will save the text of a web element to a variable. Useful for things
+like dynamically generated names etc.
Ex. Read the number of search results to a variable
+locate "result-stats" and read-to mySearchResults
press
+The press command is used to perform keyboard actions. The kepresses are registered against
+the currently selected web element, so it's mainly useful for things like hitting Enter from a search box.
Ex. Press enter when logging in.
+locate "password" and type myPassword and press "Enter"
chill
+The chill command causes the script to pause for the provided number of seconds. Useful for waiting
+for some process to finish.
+(Note: Commands by default have a one second wait between execution. Explicitly managing waits is complicated,
+and we opted for a simpler approach. Generally this command will not be necessary. If you are waiting for some transition
+on the page to take place, consider using the locate command to automatically wait for an element to signal the page is ready.
+For example, after logging into a website, rather than using the chill command, use locate to find some element of the loaded dashboard to verify that the page has loaded.)
Ex. Wait 10 seconds.
+chill "10"
drag-to
+The drag-to command uses javascript to simulate a drag and drop event, dragging the currently located
+element to the element matching the provided locator.
Ex. Imagine mapping headers to the correct column of an uploaded file.
+locate "email" and drag-to "@"
select
+The select command will select (by text) one of the options in a select element.
+Note. This command will also work if the currently located element is an option in the given
+select element. This makes it much easier to locate and use select elements using only the displayed option
+text.
Ex. Login as an admin user.
+locate "Select Role" and select "Admin User"
upload
+The upload command performs a basic file upload on an html input element of type file.
+The located element must be an input element. Very often, custom component is used which performs
+the javascript to do the upload, which means you'll have to look in the html for the hidden input you
+actually want to upload to.
Ex. Upload file
+locate "//input[@id='file-input']" and upload "./screenshots/main_screenshot_2.png"
Note: We are locating the input by xpath because it's not actually displayed on the page. +Smart locators only return elements which are currently displayed.
+accept-alert and dismiss-alert
+The accept-alert and dismiss-alert commands accept and dismiss alerts.
Ex. Accept cookie alert
+# Accept cookie alert
+accept-alert
+Desired Text
\nNavigation
Desired Text ... more links
\n I am a heading of some section of this page
I am some content
... more html
Card title
Some quick example text to build on the card title and make up the bulk of the card's content.
- Cras justo odio
- Dapibus ac facilisis in
- Vestibulum at eros
Desired Text
\nNavigation
Desired Text ... more links
\n I am a heading of some section of this page
I am some content
... more html
Card title
Some quick example text to build on the card title and make up the bulk of the card's content.
- Cras justo odio
- Dapibus ac facilisis in
- Vestibulum at eros
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Quickstart
+Installation
+Warning: The below install process is quite technical and involves using your computer's terminal.
+To install Schnauzer UI, you'll need the rust toolchain installed.
+Then run cargo install schnauzer_ui. After installing, type sui --help and take a quick look
+at the options.
You will also need a webdriver compliant process running to run your tests against. Schnauzer UI currently supports
+firefox and chrome. geckodriver, chromedriver, or a selenium standalone should work just fine.
+Make a note of what port you're running the process on.
If you've never worked with any of these before:
+-
+
- Try installing either
geckodriverorchromedriverhowever you normally install packages (brew, apt, etc.) depending on whether you want to test in Firefox or Chrome respectively.
+ - If that's not an option, you can manually download any of these as binaries, put them somwhere in your path, +and run them. +
- If that all sounds like too much, and you're okay using Firefox, you can build geckodriver from source with
+
cargo install geckodriverand then run it.
+
Running the REPL for the first time
+To start a REPL, first make sure your webdriver process is running.
+Then make yourself a folder called sui_tutorial (or whatever you like) and open a terminal there.
+Type sui -b <the browser> -p <the port>. For example, sui -b chrome -p 9515.
+(Note: Schnauzer UI defaults to using firefox on port 4444, so the commands sui and sui -b firefox -p 4444 are equivalent).
You should see 1. a browser launch and 2. a prompt appear on the terminal asking for the name of your test.
+Go through the start up options until you are prompted for a command. Then type url "https://youtube.com"
+and hit enter. The browser should navigate to YouTube.
+You will then be prompted for whether you want to save the command. The default is yes, so simply hit enter.
Congrats! You're up an running with Schnauzer UI. Feel free to try commands from the reference.
+When you're ready to quit, type exit as a command and hit enter. You will be asked if you want to save your script.
+Simply type yes and hit enter.
Running a saved script file
+There should now be a Schnauzer UI script saved as a file ending in .sui in your current directory.
+cat the file or open it up in your favorite text editor to take a look inside. You should see your saved commands
+there. This is your brand new Schnauzer UI test script!
To run the script, type sui -f <path-to-the-file> along
+with the port and browser arguments if they are not the default. The browser should launch again and run the entire script, then generate some test results. There should now also be an HTML file, a JSON file, and a screenshots folder
+with any screenshots taken during the test run.
-
+
- The HTML file is the standard formatting of the test report. You can open it in a browser to see the report. +
- The JSON file is the same information in JSON format, in case you want to create custom styled reports or use the +test result data programatically. +