Merge pull request #22 from UlfBj/master

Example files and documentation update

docs-gen/content/configuration_rule_set/basics.md

@@ -7,20 +7,20 @@ weight: 1
 HIM supports structuring information into different trees instead of bundling it all into one tree.
 This is likely to lead to that e. g. a server that manages a super domain of somewhat heterogeneous information
 will have that information represented by multiple trees.
-HIM enables this "forest of trees" to be accessed in a homogeneous manner by using the paths of the nodes of the trees to address theinformation contained in the trees.
+HIM enables this "forest of trees" to be accessed in a uniform manner by using the paths of the nodes of the trees to address the information contained in the trees.
 To support the server in managing this forest of trees, a HIM configuration tree provides a representation of the key parameters of this forest.
 The server may also share this configuration file on request from clients, in order for them to discover the information available by the forest.
+
 The HIM model is not restricted to client/server models.
 
-A file containing this configuration shall have a name starting with "HIM_configuration",
-with an optional suffix that might describe the domain, information type, or version.
-The file may have the extension ".him", which typically would indicate that it is YAML formatted.
-Any file extension can be used that indicates it has been transformed from its YAML source format to a different format like ".json".
+A file containing this configuration may have any name, but it is recommended that it contains version or date-time information.
+The file shall have the extension ".him", which indicates that it is a HIM configuration file.
+Its format shall be YAML or any other text format that is compatible with YAML.
 
-The configuration tree root node shall have a name starting with "HIM_config", which may be followed by additional information
-such as a descriptive domain name, version, etc.
+The configuration tree root node shall have the name "HIM".
 
 A server may share the information of this file with a client that wants to discover what information the server manages.
+It shall however not share the "local" metadata that is private to the server.
 
 A HIM compliant server shall be able to read a HIM configuration file and from that access the forest of trees it defines.
 
@@ -29,7 +29,7 @@ The project specifying this tree must also define the `domain` metadata for this
 and it may provide a `public` URL to a file containing the complete tree,
 possible also multiple `public` URLs to renditions of the tree in different formats such as YAML, JSON, etc.
 
-The creation of a HIM configuration file is the responsibility of the HIM server implementor.
+The creation of a HIM configuration file is the responsibility of the  "manager" of the HIM server.
 
 ## Configuration node types
 

docs-gen/content/service_data_rule_set/basics.md

@@ -8,7 +8,7 @@ weight: 1
 A HIM service data tree contains a taxonomy of microservice declarations.
 The tree structure is used to create a sets of microservices.
 Such as set is named `Service`, or `Service Group` for larger sets where a set of Service Groups would then form a Service,
-see the figure below, or the [example service data tree](https://github.com/COVESA/hierarchical_information_model/blob/master/examples/HIM_Service.v1.0.0.him).
+see the figure below, or the [example service data tree](https://github.com/COVESA/hierarchical_information_model/blob/master/examples/HIM_Service_example.v1.0.0.yaml).
 
 ![HIM service tree structure](/hierarchical_information_model/images/service_tree_structure.png?width=50pc)
 *Figure x. HIM service tree structure

examples/HIM_Resource_example.v1.0.0.him → examples/HIM_Resource_example.v1.0.0.vspec

@@ -58,4 +58,3 @@ Vehicle.VehicleIdentification.Year:
   datatype: uint16
   type: attribute
   description: Model year of the vehicle.
-

examples/HIM_Service.v1.0.0.him → examples/HIM_Service_example.v1.0.0.yaml

@@ -8,7 +8,7 @@ VehicleService.ExteriorLighting:
 
 VehicleService.ExteriorLighting.HeadLampsOnOff:
   type: procedure
-  description: Microservice name: HeadLampsOnOff, Input: Switch, Output: None.
+  description: Microservice name=HeadLampsOnOff, Input=Switch, Output=None.
 
 VehicleService.ExteriorLighting.HeadLampsOnOff.Input:
   type: iostruct

examples/HIM_config_example.v1.0.0.him

@@ -34,9 +34,3 @@ ChargingStationData:
   version: X.Y.Z
   public: https://himrepo.energyco.com?instance=ChargingStation.Vehicle.ResourceData.X.Y.Z
   description:  ….
-
-HIM.Version:
-  type: branch
-  description: Supported Version.
-
-# Here follows the mandatory Major, Minor, and Patch nodes

examples/README.md

@@ -1,13 +1,12 @@
 # HIM example files
 
 This directory contains an example file of each of the information types that HIM currently defines:
-- Resource data: HIM_Resource_example.v1.0.0.him
-- Service data: HIM_Service.v1.0.0.him
-- Type definition data: TypeDefinition_example.v1.0.0.him
+- Resource data: HIM_Resource_example.v1.0.0.vspec
+- Service data: HIM_Service_example.v1.0.0.yaml
+- Type definition data: TypeDefinition_example.v1.0.0.yaml
 
 It also contains an example file of a HIM configuration file: HIM_config_example.v1.0.0.him
 
-The examples are expressed in YAML as it is the mandatory format for HIM files.
-However, HIM does not prevent translation from original HIM files into other formats such as JSON, etc.
-
-The examples do not make use of the neither the include nor the instances directives that HIM supports.
+The resource data example uses the vspec format that is inherited from the VSS project.
+The service data and type definition data examples are expressed in YAML as it is the primary format for HIM files.
+However, HIM also inherits the pattern from VSS to allow translation from the primary format into other formats such as JSON, etc.

examples/TypeDefinition_example.v1.0.0.him → examples/TypeDefinition_example.v1.0.0.yaml

@@ -40,4 +40,3 @@ Types.Version.Patch:
   datatype: uint32
   type: attribute
   description: Patch version number.
-