This is an automated email from the ASF dual-hosted git repository. aradzinski pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git
The following commit(s) were added to refs/heads/master by this push: new 8491b62 WIP. 8491b62 is described below commit 8491b624e7b2547dd44c1e92e26be6031f4aaafa Author: Aaron Radzinski <aradizn...@apache.org> AuthorDate: Sat Jul 31 17:43:29 2021 -0700 WIP. --- _scss/example.scss | 22 ++++++++++++++++++++++ .../org/apache/nlpcraft/model/NCElement.html | 2 +- assets/css/style.scss | 1 + examples/alarm_clock.html | 13 +++++++------ examples/light_switch.html | 9 +++++---- examples/sql_model.html | 7 ++++--- examples/weather_bot.html | 12 ++++++------ 7 files changed, 46 insertions(+), 20 deletions(-) diff --git a/_scss/example.scss b/_scss/example.scss new file mode 100644 index 0000000..e866ad8 --- /dev/null +++ b/_scss/example.scss @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +.example { + span.ex-src, span.ex-review-all { + margin-left: 20px; + } +} \ No newline at end of file diff --git a/apis/javadoc-0.9.0/org/apache/nlpcraft/model/NCElement.html b/apis/javadoc-0.9.0/org/apache/nlpcraft/model/NCElement.html index 33794b6..6c7503a 100644 --- a/apis/javadoc-0.9.0/org/apache/nlpcraft/model/NCElement.html +++ b/apis/javadoc-0.9.0/org/apache/nlpcraft/model/NCElement.html @@ -553,7 +553,7 @@ extends <a href="NCMetadata.html" title="interface in org.apache.nlpcraft.model" <h4>getSynonyms</h4> <pre class="methodSignature">default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> getSynonyms()</pre> <div class="block">Gets the list of synonyms by which this model element will be recognized by. Read more about - many different forms of synonyms in <a target=_ href="https://nlpcraft.apache.org/data-model.html">Data Model</a> section + many forms of synonyms in <a target=_ href="https://nlpcraft.apache.org/data-model.html">Data Model</a> section and review <a target=_ href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples">examples</a>. <p> <b>JSON</b> diff --git a/assets/css/style.scss b/assets/css/style.scss index 61dc6bf..f4c699e 100644 --- a/assets/css/style.scss +++ b/assets/css/style.scss @@ -35,6 +35,7 @@ $default-font: "Helvetica Neue"; @import '404'; @import 'buttons'; @import 'download'; +@import 'example'; @import 'three-cols'; @import 'basic-concepts'; @import 'use-cases'; diff --git a/examples/alarm_clock.html b/examples/alarm_clock.html index 347f270..dc55dad 100644 --- a/examples/alarm_clock.html +++ b/examples/alarm_clock.html @@ -22,24 +22,25 @@ fa_icon: fa-cube limitations under the License. --> -<div class="col-md-8 second-column"> +<div class="col-md-8 second-column example"> <section id="overview"> <h2 class="section-title">Overview <a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2> <p> - This simple example provides a "alarm clock" implementation where you can ask to set the timer + This simple example provides an "alarm clock" implementation where you can ask to set the timer for a specific duration from now expressed in hours, minutes and/or seconds. You can say "ping me in 3 minutes", - "buzz me in an hour and 15 minutes", or "set my alarm for 30 secs". When the timers is up it will + "buzz me in an hour and 15 minutes", or "set my alarm for 30 secs". When the timer is up it will simply print out "BEEP BEEP BEEP" in the data probe console. </p> <p> - Complexity: <span class="complexity-one-star"><i class="fas fa-star"></i> <i class="far fa-star"></i> <i class="far fa-star"></i></span><br/> - Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples/alarm">GitHub</a> + <b>Complexity:</b> <span class="complexity-one-star"><i class="fas fa-star"></i> <i class="far fa-star"></i> <i class="far fa-star"></i></span><br/> + <span class="ex-src">Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples/alarm">GitHub <i class="fab fa-fw fa-github"></i></a><br/></span> + <span class="ex-review-all">Review: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples">All Examples at GitHub <i class="fab fa-fw fa-github"></i></a></span> </p> </section> <section id="new_project"> <h2 class="section-title">Create New Project <a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2> <p> - You can create new Java project in many different ways - we'll use <a href="/tools/script.html">NLPCraft CLI</a> + You can create new Java project in many ways - we'll use <a href="/tools/script.html">NLPCraft CLI</a> to accomplish this task: </p> <nav> diff --git a/examples/light_switch.html b/examples/light_switch.html index 2e64683..7c90134 100644 --- a/examples/light_switch.html +++ b/examples/light_switch.html @@ -22,7 +22,7 @@ fa_icon: fa-cube limitations under the License. --> -<div class="col-md-8 second-column"> +<div class="col-md-8 second-column example"> <section id="overview"> <h2 class="section-title">Overview <a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2> <p> @@ -32,14 +32,15 @@ fa_icon: fa-cube controllers. </p> <p> - Complexity: <span class="complexity-one-star"><i class="fas fa-star"></i> <i class="far fa-star"></i> <i class="far fa-star"></i></span><br/> - Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples/lightswitch">GitHub</a> + <b>Complexity:</b> <span class="complexity-one-star"><i class="fas fa-star"></i> <i class="far fa-star"></i> <i class="far fa-star"></i></span><br/> + <span class="ex-src">Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples/lightswitch">GitHub <i class="fab fa-fw fa-github"></i></a><br/></span> + <span class="ex-review-all">Review: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples">All Examples at GitHub <i class="fab fa-fw fa-github"></i></a></span> </p> </section> <section id="new_project"> <h2 class="section-title">Create New Project <a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2> <p> - You can create new Scala project in many different ways - we'll use <a href="/tools/script.html">NLPCraft CLI</a> + You can create new Scala projects in many ways - we'll use <a href="/tools/script.html">NLPCraft CLI</a> to accomplish this task: </p> <nav> diff --git a/examples/sql_model.html b/examples/sql_model.html index 7027eca..90eb96d 100644 --- a/examples/sql_model.html +++ b/examples/sql_model.html @@ -22,7 +22,7 @@ fa_icon: fa-cube limitations under the License. --> -<div class="col-md-8 second-column"> +<div class="col-md-8 second-column example"> <section id="overview"> <h2 class="section-title">Overview <a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2> <p> @@ -36,8 +36,9 @@ fa_icon: fa-cube show what can be done "from scratch". </p> <p> - Complexity: <span class="complexity-three-star"><i class="fas fa-gem"></i> <i class="fas fa-gem"></i> <i class="fas fa-gem"></i></span><br/> - Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples/sql">GitHub</a> + <b>Complexity:</b> <span class="complexity-three-star"><i class="fas fa-gem"></i> <i class="fas fa-gem"></i> <i class="fas fa-gem"></i></span><br/> + <span class="ex-src">Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples/sql">GitHub <i class="fab fa-fw fa-github"></i></a><br/></span> + <span class="ex-review-all">Review: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples">All Examples at GitHub <i class="fab fa-fw fa-github"></i></a></span> </p> </section> <section id="background"> diff --git a/examples/weather_bot.html b/examples/weather_bot.html index 7f3db62..f188701 100644 --- a/examples/weather_bot.html +++ b/examples/weather_bot.html @@ -22,7 +22,7 @@ fa_icon: fa-cube limitations under the License. --> -<div class="col-md-8 second-column"> +<div class="col-md-8 second-column example"> <section id="overview"> <h2 class="section-title">Overview <a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2> <p> @@ -37,14 +37,15 @@ fa_icon: fa-cube </p> </div> <p> - Complexity: <span class="complexity-two-star"><i class="fas fa-square"></i> <i class="fas fa-square"></i> <i class="far fa-square"></i></span><br/> - Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples/weather">GitHub</a> + <b>Complexity:</b> <span class="complexity-two-star"><i class="fas fa-square"></i> <i class="fas fa-square"></i> <i class="far fa-square"></i></span><br/> + <span class="ex-src">Source code: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples/weather">GitHub <i class="fab fa-fw fa-github"></i></a><br/></span> + <span class="ex-review-all">Review: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft-examples">All Examples at GitHub <i class="fab fa-fw fa-github"></i></a></span> </p> </section> <section id="new_project"> <h2 class="section-title">Create New Project <a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2> <p> - You can create new Java project in many different ways - we'll use <a href="/tools/script.html">NLPCraft CLI</a> + You can create new Java project in many ways - we'll use <a href="/tools/script.html">NLPCraft CLI</a> to accomplish this task: </p> <nav> @@ -166,7 +167,7 @@ fa_icon: fa-cube <h2 class="section-title">Model Class <a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2> <p> Below is a full source code for our implementation. Note that this code uses several - <a href="#tools">external tools</a> for IP-based geo-location and the weather information + external tools for IP-based geo-location and the weather information provider (<a target=_ href="https://openweathermap.org/api">OpenWeather</a>). Note also that despite its apparent simplicity the model logic implementation is non-trivial. Significant portion of the code deals with a complex <b>temporal and geographical ambiguity</b>, i.e. the sentences like the these: </p> @@ -566,7 +567,6 @@ public class WeatherModel extends NCModelFileAdapter { <li><a href="#overview">Overview</a></li> <li><a href="#new_project">New Project</a></li> <li><a href="#model">Data Model</a></li> - <li><a href="#tools">External Tools</a></li> <li><a href="#build_project">Build Project</a></li> <li><a href="#start_server">Start Server</a></li> <li><a href="#testing">Testing</a></li>