Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
CaosDB Crawler
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
CaosDB Crawler
Commits
a50579b4
Commit
a50579b4
authored
2 years ago
by
Henrik tom Wörden
Browse files
Options
Downloads
Patches
Plain Diff
DOC: enhance doc on converters
parent
d325bcbe
No related branches found
No related tags found
2 merge requests
!91
Release 0.3
,
!65
MAINT: make DictXYElements XYElements
Pipeline
#30409
passed
2 years ago
Stage: info
Stage: setup
Stage: cert
Stage: style
Stage: test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/doc/converters.rst
+22
-12
22 additions, 12 deletions
src/doc/converters.rst
with
22 additions
and
12 deletions
src/doc/converters.rst
+
22
−
12
View file @
a50579b4
...
...
@@ -15,8 +15,6 @@ Converters may define additional functions that create further values. For
example, a regular expresion could be used to get a date from a file name.
A converter is defined via a yml file or part of it. The definition states
what kind of StructureElement it treats (typically one).
Also, it defines how children of the current StructureElement are
...
...
@@ -64,31 +62,45 @@ Standard Converters
Directory Converter
===================
The Directory Converter creates StructureElements for each File and Directory
inside the current Directory. You can match a regular expression against the
directory name using the 'match' key.
Simple File Converter
=====================
The Simple File Converter does not create any children and is usually used if
A file shall be used as it is and be inserted and referenced by other entities.
Markdown File Converter
=======================
Reads a YAML header from Markdown files (if such a header exists) and creates
children elements according to the structure of the header.
Dict Converter
Dict
Element
Converter
==============
Creates a child StructureElement for each key in the dictionary.
Typical Subtree converters
--------------------------
The following StructureElement are typically created:
- DictBooleanElementConverter
- DictFloatElementConverter
- DictTextElementConverter
- DictIntegerElementConverter
- DictListElementConverter
- DictDictElementConverter
- BooleanElement
- FloatElement
- TextElement
- IntegerElement
- ListElement
- DictElement
Scalar Value Converters
=======================
`BooleanElementConverter`, `FloatElementConverter`, `TextElementConverter`, and
`IntegerElementConverter` behave very similarly.
These converters expect `match_name` and `match_value` in their definition
which allow to match the key and the value, respectively.
Note that there are defaults for accepting other types. For example,
Dict
FloatElementConverter also accepts
Dict
IntegerElements. The default
FloatElementConverter also accepts IntegerElements. The default
behavior can be adjusted with the fields `accept_text`, `accept_int`,
`accept_float`, and `accept_bool`.
...
...
@@ -106,8 +118,6 @@ JSONFileConverter
TextElementConverter
====================
TableConverter
==============
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment