Formatting texts

Author: jason-fox

README.md

@@ -4,28 +4,27 @@
 [![License: MIT](https://img.shields.io/github/license/fiware/tutorials.Step-by-Step.svg)](https://opensource.org/licenses/MIT)
 [![Support badge](https://img.shields.io/badge/tag-fiware-orange.svg?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/fiware)
 [![Docker](https://img.shields.io/docker/pulls/fiware/tutorials.context-provider.svg)](https://hub.docker.com/r/fiware/tutorials.context-provider/)
-<br>
-[![Documentation](https://img.shields.io/readthedocs/fiware-tutorials.svg)](https://fiware-tutorials.rtfd.io)
+<br> [![Documentation](https://img.shields.io/readthedocs/fiware-tutorials.svg)](https://fiware-tutorials.rtfd.io)
 [![CI](https://github.com/FIWARE/tutorials.Step-by-Step/workflows/CI/badge.svg)](https://github.com/FIWARE/tutorials.Step-by-Step/actions?query=workflow%3ACI)
 
 This is a collection of tutorials for the FIWARE ecosystem designed for **NGSI-v2** developers. Each tutorial consists
 of a series of exercises to demonstrate the correct use of individual FIWARE components and shows the flow of context
 data within a simple Smart Solution either by connecting to a series of dummy IoT devices or manipulating the context
 directly or programmatically.
 
-| :books: [NGSI-v2<br>Documentation](https://fiware-tutorials.rtfd.io) | <img src="https://assets.getpostman.com/common-share/postman-logo-stacked.svg" align="center" height="25"> [Postman<br>Collections](https://explore.postman.com/team/3mM5EY6ChBYp9D) |  [![Docker Hub](https://nexus.lab.fiware.org/repository/raw/public/badges/docker/fiware.svg)](https://hub.docker.com/u/fiware) <br> [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/fiware)](https://artifacthub.io/packages/search?repo=fiware) |  <img src="https://fiware.github.io/catalogue/img/fiware-emoji.png" height="20px" width="20px"/><br/> [**developer&ZeroWidthSpace;.fiware.org**](https://www.fiware.org/developers/) |
-| --------------------------------------------------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-
+| :books: [NGSI-v2<br>Documentation](https://fiware-tutorials.rtfd.io) | <img src="https://assets.getpostman.com/common-share/postman-logo-stacked.svg" align="center" height="25"> [Postman<br>Collections](https://explore.postman.com/team/3mM5EY6ChBYp9D) | [![Docker Hub](https://nexus.lab.fiware.org/repository/raw/public/badges/docker/fiware.svg)](https://hub.docker.com/u/fiware) <br> [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/fiware)](https://artifacthub.io/packages/search?repo=fiware) | <img src="https://fiware.github.io/catalogue/img/fiware-emoji.png" height="20px" width="20px"/><br/> [**developer&ZeroWidthSpace;.fiware.org**](https://www.fiware.org/developers/) |
+| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
 🇯🇵 このチュートリアルは[日本語](https://fiware-tutorials.letsfiware.jp/)でもご覧いただけます。<br/>
 
 <h3>Data models</h3>
 
 The following NGSI-v2 and NGSI-LD Data models are used within the tutorials:
 
--   <img src="https://json-ld.org/favicon.ico" align="center" height="25"> [Tutorial-specific Data Models](https://fiware.github.io/tutorials.Step-by-Step/schema/)
--   <img src="https://json-ld.org/favicon.ico" align="center" height="25"> [Smart Data Models](https://smartdatamodels.org)
-
+-   <img src="https://json-ld.org/favicon.ico" align="center" height="25">
+    [Tutorial-specific Data Models](https://fiware.github.io/tutorials.Step-by-Step/schema/)
+-   <img src="https://json-ld.org/favicon.ico" align="center" height="25">
+    [Smart Data Models](https://smartdatamodels.org)
 
 ## Install
 

docs/accessing-context.md

@@ -81,7 +81,7 @@ const options = {
     qs: { options: "keyValues" }
 };
 
-request(options, function(error, response, body) {
+request(options, function (error, response, body) {
     if (error) throw new Error(error);
     console.log(body);
 });
@@ -307,7 +307,7 @@ GET request and make the necessary HTTP call:
 
 ```javascript
 function retrieveEntity(entityId, opts) {
-    return new Promise(function(resolve, reject) {
+    return new Promise(function (resolve, reject) {
         const apiInstance = new NgsiV2.EntitiesApi();
         apiInstance.retrieveEntity(entityId, opts, (error, data) => {
             return error ? reject(error) : resolve(data);
@@ -321,11 +321,11 @@ This enables us to wrap the requests in `Promises` as shown:
 ```javascript
 function displayStore(req, res) {
     retrieveEntity(req.params.storeId, { options: "keyValues", type: "Store" })
-        .then(store => {
+        .then((store) => {
             // If a store has been found display it on screen
             return res.render("store", { title: store.name, store });
         })
-        .catch(error => {
+        .catch((error) => {
             debug(error);
             // If no store has been found, display an error screen
             return res.render("store-error", { title: "Error", error });
@@ -427,22 +427,22 @@ function displayTillInfo(req, res) {
             type: "InventoryItem"
         })
     ])
-        .then(values => {
+        .then((values) => {
             // If values have been found display it on screen
             return res.render("till", {
                 products: values[0],
                 inventory: values[1]
             });
         })
-        .catch(error => {
+        .catch((error) => {
             debug(error);
             // An error occurred, return with no results
             return res.render("till", { products: {}, inventory: {} });
         });
 }
 
 function listEntities(opts) {
-    return new Promise(function(resolve, reject) {
+    return new Promise(function (resolve, reject) {
         const apiInstance = new NgsiV2.EntitiesApi();
         apiInstance.listEntities(opts, (error, data) => {
             return error ? reject(error) : resolve(data);
@@ -516,7 +516,7 @@ async function buyItem(req, res) {
 }
 
 function updateExistingEntityAttributes(entityId, body, opts) {
-    return new Promise(function(resolve, reject) {
+    return new Promise(function (resolve, reject) {
         const apiInstance = new NgsiV2.EntitiesApi();
         apiInstance.updateExistingEntityAttributes(entityId, body, opts, (error, data) => {
             return error ? reject(error) : resolve(data);

docs/administrating-xacml.md

@@ -1036,7 +1036,7 @@ function authorizeAdvancedXACML(req, res, next, resource = req.url) {
 
     return oa
         .get(keyrockUserUrl)
-        .then(response => {
+        .then((response) => {
             const user = JSON.parse(response);
             return azf.policyDomainRequest(
                 user.app_azf_domain,
@@ -1047,11 +1047,11 @@ function authorizeAdvancedXACML(req, res, next, resource = req.url) {
                 user.email
             );
         })
-        .then(authzforceResponse => {
+        .then((authzforceResponse) => {
             res.locals.authorized = authzforceResponse === "Permit";
             return next();
         })
-        .catch(error => {
+        .catch((error) => {
             debug(error);
             res.locals.authorized = false;
             return next();
@@ -1082,9 +1082,9 @@ function policyDomainRequest(domain, roles, resource, action, username, email) {
     };
 
     return new Promise((resolve, reject) => {
-        request(options, function(error, response, body) {
+        request(options, function (error, response, body) {
             let decision;
-            xml2js.parseString(body, { tagNameProcessors: [xml2js.processors.stripPrefix] }, function(err, jsonRes) {
+            xml2js.parseString(body, { tagNameProcessors: [xml2js.processors.stripPrefix] }, function (err, jsonRes) {
                 // The decision is found within the /Response/Result[0]/Decision[0] XPath
                 decision = jsonRes.Response.Result[0].Decision[0];
             });

docs/application-mashups.md

@@ -426,10 +426,9 @@ Amend the coordinates setting as shown below and click accept.
 
 ![](https://fiware.github.io/tutorials.Application-Mashup/img/ngsi-to-poi-settings.png)
 
-According to the Smart Data Models
-[Guidelines](https://smartdatamodels.org/) an attribute
-called `location` should be used for geographical coordinates. Coordinates should be encoded using GeoJSON. Since this
-convention has been used for the tutorial data, the widget knows how to extract a location from the `Store` entity.
+According to the Smart Data Models [Guidelines](https://smartdatamodels.org/) an attribute called `location` should be
+used for geographical coordinates. Coordinates should be encoded using GeoJSON. Since this convention has been used for
+the tutorial data, the widget knows how to extract a location from the `Store` entity.
 
 ### Open Layers Map Widget
 
@@ -463,5 +462,5 @@ Clicking on the POIs retrieves additional data from each stores.
 
 Currently the data is displayed as unformatted JSON. This is because the `Store` context data entities with the tutorial
 example are not using a standard FIWARE data model. If a standard data model such as
-[Building](https://github.com/smart-data-models/dataModel.Building) had been used the
-data would be formatted in an appropriate manner and a **Building** specific icon would be used.
+[Building](https://github.com/smart-data-models/dataModel.Building) had been used the data would be formatted in an
+appropriate manner and a **Building** specific icon would be used.

docs/crud-operations.md

@@ -759,12 +759,11 @@ Context data for a specified entity type can be retrieved by making a GET reques
 supplying the `type` parameter. Combine this with `options=count` and `attrs=__NONE` to return the `id` attributes of
 the given `type`.
 
-> **Note:** The NGSIv2 specification specifies that `attrs=` has to be a "comma-separated list of attribute names
-> whose data are to be included in the response". `id` and `type` are not allowed to be used as attribute names. If you
+> **Note:** The NGSIv2 specification specifies that `attrs=` has to be a "comma-separated list of attribute names whose
+> data are to be included in the response". `id` and `type` are not allowed to be used as attribute names. If you
 > specify a name that does not exist in attributes, such as `__NONE` to the `attrs=` parameter, No attribute will match
 > and you will always retrieve only the `id` and `type` of the entity.
 
-
 ## Update Operations
 
 Overwrite operations are mapped to HTTP PUT. HTTP PATCH can be used to update several attributes at once.

docs/custom-iot-agent.md

@@ -377,7 +377,7 @@ This means that attributes from the XML request can be accessed using the square
 
 ```javascript
 function checkMandatoryParams(queryPayload) {
-    return function(req, res, next) {
+    return function (req, res, next) {
         var notFoundParams = [],
             error;
 
@@ -681,7 +681,7 @@ function createCommandPayload(device, command, attributes) {
     if (typeof attributes === "object") {
         let payload = "<" + command + '  device="' + device.id + '">';
 
-        Object.keys(attributes).forEach(function(key, value) {
+        Object.keys(attributes).forEach(function (key, value) {
             payload = payload + "<" + key + ">" + value + "</" + key + ">";
         });
         payload = payload + "</" + command + ">";

docs/edge-computing.md

@@ -1,9 +1,9 @@
 [![FIWARE Context processing, analysis and visualisation](https://nexus.lab.fiware.org/static/badges/chapters/processing.svg)](https://github.com/FIWARE/catalogue/blob/master/processing/README.md)
 
-**Description:** This is an introductory tutorial for [FIWARE FogFlow](https://fogflow.readthedocs.io/en/latest/) that allows its users
-to dynamically orchestrate the processing flows on edges. It explains how to enable FogFlow on a distributed or a single
-node system, register user defined workload patterns and orchestrate them on the edges in the form of running tasks. For
-better understanding, examples have been included in the tutorial.
+**Description:** This is an introductory tutorial for [FIWARE FogFlow](https://fogflow.readthedocs.io/en/latest/) that
+allows its users to dynamically orchestrate the processing flows on edges. It explains how to enable FogFlow on a
+distributed or a single node system, register user defined workload patterns and orchestrate them on the edges in the
+form of running tasks. For better understanding, examples have been included in the tutorial.
 
 <hr class="processing"/>
 
@@ -569,10 +569,9 @@ other FIWARE GEs.
     [tutorial](https://fogflow.readthedocs.io/en/latest/quantumleapIntegration.html).
 
 -   **Integrate FogFlow with WireCloud**: FogFlow has pitched in with different and versatile edge platform technology.
-    WireCloud builds on cutting-edge end user development, RIA and semantic technologies to offer a next-generation
-    end user centred web application mashup platform aimed at leveraging the long tail of the Internet of Services. For
-    more on Fogflow and WireCloud, follow the
-    [tutorial](https://fogflow.readthedocs.io/en/latest/wirecloudIntegration.html).
+    WireCloud builds on cutting-edge end user development, RIA and semantic technologies to offer a next-generation end
+    user centred web application mashup platform aimed at leveraging the long tail of the Internet of Services. For more
+    on Fogflow and WireCloud, follow the [tutorial](https://fogflow.readthedocs.io/en/latest/wirecloudIntegration.html).
 
 ---
 

docs/entity-relationships.md

@@ -321,10 +321,8 @@ In databases, foreign keys are often used to designate a one-to-many relationshi
 a single store and a single store can hold many shelving units. In order to remember this information we need to add an
 association relationship similar to a foreign key. Batch processing can again be used to amend the existing the
 **Shelf** entities to add a `refStore` attribute holding the relationship to each store. According to the Smart Data
-Models Guidelines on
-[linked data](https://smartdatamodels.org/), when an
-entity attribute is used as a link to other entities it should be named with the prefix `ref` plus the name of the
-target (linked) entity type.
+Models Guidelines on [linked data](https://smartdatamodels.org/), when an entity attribute is used as a link to other
+entities it should be named with the prefix `ref` plus the name of the target (linked) entity type.
 
 The value of the `refStore` attribute corresponds to a URN associated to a **Store** entity itself.
 

docs/getting-started.md

@@ -264,8 +264,7 @@ curl -iX POST \
 
 Although the each data entity within your context will vary according to your use case, the common structure within each
 data entity should be standardized order to promote reuse. The full FIWARE data model guidelines can be found
-[here](https://smartdatamodels.org/). This tutorial demonstrates the usage
-of the following recommendations:
+[here](https://smartdatamodels.org/). This tutorial demonstrates the usage of the following recommendations:
 
 #### All terms are defined in American English
 

docs/index.md

@@ -91,8 +91,10 @@ Scala code into a JAR file.
 
 The following NGSI-v2 and NGSI-LD Data models are used within the tutorials:
 
--   <img src="https://json-ld.org/favicon.ico" align="center" height="30" width="30" style="border-right-style:solid; border-right-width:10px; border-color:transparent; background: transparent"> [Tutorial-specific Data Models](https://fiware.github.io/tutorials.Step-by-Step/schema/)
--   <img src="https://json-ld.org/favicon.ico" align="center" height="30" width="30" style="border-right-style:solid; border-right-width:10px; border-color:transparent; background: transparent"> [Smart Data Models](https://smartdatamodels.org)
+-   <img src="https://json-ld.org/favicon.ico" align="center" height="30" width="30" style="border-right-style:solid; border-right-width:10px; border-color:transparent; background: transparent">
+    [Tutorial-specific Data Models](https://fiware.github.io/tutorials.Step-by-Step/schema/)
+-   <img src="https://json-ld.org/favicon.ico" align="center" height="30" width="30" style="border-right-style:solid; border-right-width:10px; border-color:transparent; background: transparent">
+    [Smart Data Models](https://smartdatamodels.org)
 
 ## List of Tutorials