Merge branch 'f-real-path' into f-prefix

CHANGELOG.md

@@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - DateElementConverter: allows to interpret text as a date object
 - the restricted_path argument allows to crawl only a subtree
 - You can now access the file system path of a structure element (if it has one) using the variable
-  name "<converter name>\_path"
+  name ``<converter name>.path``
 - added the arguments 'add-prefix' and 'remove-prefix' to the command line and `crawler_main`
 
 ### Changed ###

INSTALL.md

-
 # Installation ##
 
 
@@ -41,16 +40,18 @@ installation](#generic-installation).
 
 ## Generic installation ####
 
----
+The CaosDB crawler is available as [PyPi
+package](https://pypi.org/project/caoscrawler/) and can simply installed by
+
+```sh
+pip3 install caoscrawler
+```
 
-Obtain the sources from GitLab and install from there (`git` must be installed for
-this option):
+Alternatively, obtain the sources from GitLab and install from there (`git` must
+be installed for this option):
 
 ```sh
 git clone https://gitlab.com/caosdb/caosdb-crawler
 cd caosdb-crawler
 pip3 install --user .
 ```
-
-**Note**: In the near future, this package will also be made available on PyPi.
-

src/doc/cfood.rst

@@ -173,8 +173,8 @@ in a vairable with the same name (as it is the case for other Records).
         records:
           fileEntity:
             role: File           # necessary to create a File Entity
-            path: somefile_path  # defines the path in CaosDB
-            file: somefile_path  # path where the file is found locally
+            path: somefile.path  # defines the path in CaosDB
+            file: somefile.path  # path where the file is found locally
           SomeRecord:
             ParameterFile: $fileEntity  # creates a reference to the file