diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 1377c8060..41da19872 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -9,6 +9,7 @@ body: label: Contribution guidelines description: Please read the contribution guidelines before proceeding. options: + # yamllint disable-line rule:line-length - label: I've read the [contribution guidelines](https://github.com/eccenca/documentation.eccenca.com/blob/main/CONTRIBUTING.md) and wholeheartedly agree. required: true - type: textarea diff --git a/.gitpod.yml b/.gitpod.yml index 73b8b88a8..febb42f06 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,3 +1,4 @@ +--- ports: - port: 8000 tasks: @@ -13,7 +14,7 @@ github: # enable for the default branch (defaults to true) main: true # enable for all branches in this repo (defaults to false) - branches: true # change it to false + branches: true # change it to false # enable for pull requests coming from this repo (defaults to true) pullRequests: true # enable for pull requests coming from forks (defaults to false) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3185eaac9..8d65eecd0 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,4 +1,3 @@ - --- repos: - repo: local @@ -10,6 +9,13 @@ repos: language: python pass_filenames: false + - id: yamllint + name: check:yamllint + entry: task check:yamllint + language: python + pass_filenames: false + files: '\.(yml|yaml)$|(^|/)\.pages$|^\.yamllint$' + - id: nav-drift name: check:navigation entry: task check:navigation diff --git a/.yamllint b/.yamllint new file mode 100644 index 000000000..3b07cd901 --- /dev/null +++ b/.yamllint @@ -0,0 +1,26 @@ +--- +# Mirrors ~/.config/yamllint/config so `task check:yamllint` behaves identically +# for a local run and on CI, where no user-level yamllint config exists and the +# stricter upstream defaults (notably line-length 80) would otherwise apply. +extends: default + +# The navigation source files are YAML but carry no extension yamllint knows +# about, so they have to be named explicitly alongside the built-in globs. +yaml-files: + - '*.yaml' + - '*.yml' + - '.yamllint' + - '.pages' + +rules: + empty-lines: + max-end: 1 # allow for one empty line at the end + line-length: + max: 120 + # `on:` in a GitHub workflow is a mapping key, not the boolean `on` + truthy: + check-keys: false + +ignore: | + /site/ + /.venv/ diff --git a/README.md b/README.md index 7f4fc3954..df3b747cc 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,11 @@ fail the build. `task check:navigation` additionally fails if `nav.yml` no longer matches the `docs/**/.pages` files, which remain the source of truth for navigation (`task update:navigation` regenerates it). +`task check:yamllint` lints every YAML file in the repository, including the extensionless +`.pages` navigation sources, against the committed `.yamllint`. That config is committed rather +than left to a user-level one so a local run and a CI run apply the same rules - without it CI +would fall back to yamllint's stricter upstream defaults. + See `tasks/handoff.md` for the full migration notes. ## License diff --git a/Taskfile.yml b/Taskfile.yml index fe0ae0589..0d7c20673 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -59,7 +59,7 @@ tasks: - poetry install check: - desc: Check documentation links, Markdown style, nav drift and build output + desc: Check documentation links, Markdown and YAML style, nav drift and build output # Sequential (`cmds`, not `deps`) on purpose. Task resolves `deps` in # parallel, which ran several `poetry install` invocations at once and, worse, # ran `zensical build` alongside the link and style checks - under that load @@ -69,9 +69,19 @@ tasks: cmds: - task: check:links - task: check:rumdl + - task: check:yamllint - task: check:navigation - task: check:output + check:yamllint: + desc: Fail if any YAML file deviates from the style in .yamllint + deps: + - install + cmds: + # `.` picks up the repo .yamllint, which is what makes a local run and a + # CI run agree: GitHub runners have no user-level yamllint config. + - poetry run yamllint . + check:navigation: desc: Fail if nav.yml is out of sync with the docs/**/.pages files deps: diff --git a/docs/.pages b/docs/.pages index 907da7166..41abd5958 100644 --- a/docs/.pages +++ b/docs/.pages @@ -1,3 +1,4 @@ +--- nav: - Build: build - Explore: explore-and-author diff --git a/docs/automate/.pages b/docs/automate/.pages index e3634d7e3..90bd2dc9a 100644 --- a/docs/automate/.pages +++ b/docs/automate/.pages @@ -1,3 +1,4 @@ +--- nav: - Automate: index.md - cmemc: cmemc-command-line-interface diff --git a/docs/automate/cmemc-command-line-interface/.pages b/docs/automate/cmemc-command-line-interface/.pages index 70b5a361a..958d4170c 100644 --- a/docs/automate/cmemc-command-line-interface/.pages +++ b/docs/automate/cmemc-command-line-interface/.pages @@ -1,3 +1,4 @@ +--- nav: - cmemc - Command Line Interface: index.md - Installation: installation diff --git a/docs/automate/cmemc-command-line-interface/configuration/.pages b/docs/automate/cmemc-command-line-interface/configuration/.pages index 83af0f757..447f10b5c 100644 --- a/docs/automate/cmemc-command-line-interface/configuration/.pages +++ b/docs/automate/cmemc-command-line-interface/configuration/.pages @@ -1,3 +1,4 @@ +--- nav: - Configuration: index.md - File-based: file-based-configuration diff --git a/docs/automate/cmemc-command-line-interface/invocation/.pages b/docs/automate/cmemc-command-line-interface/invocation/.pages index d02f59c00..50b5c0349 100644 --- a/docs/automate/cmemc-command-line-interface/invocation/.pages +++ b/docs/automate/cmemc-command-line-interface/invocation/.pages @@ -1,3 +1,4 @@ +--- nav: - Invocation: index.md - Docker Image: docker-image diff --git a/docs/build/.pages b/docs/build/.pages index f40abcc3b..028434fdd 100644 --- a/docs/build/.pages +++ b/docs/build/.pages @@ -1,3 +1,4 @@ +--- nav: - Build: index.md - Introduction to the User Interface: introduction-to-the-user-interface diff --git a/docs/build/reference/.pages b/docs/build/reference/.pages index d7e693ba7..f1ec4c53c 100644 --- a/docs/build/reference/.pages +++ b/docs/build/reference/.pages @@ -1,7 +1,8 @@ +--- nav: - "Task and Operator Reference": index.md - "Aggregators": aggregator - "Custom Workflow Tasks": customtask - "Datasets": dataset - "Distance Measures": distancemeasure - - "Transformers": transformer \ No newline at end of file + - "Transformers": transformer diff --git a/docs/build/reference/aggregator/.pages b/docs/build/reference/aggregator/.pages index 77d39f480..2037ea3d7 100644 --- a/docs/build/reference/aggregator/.pages +++ b/docs/build/reference/aggregator/.pages @@ -1,3 +1,4 @@ +--- nav: - index.md - "And": min.md @@ -8,4 +9,4 @@ nav: - "Handle missing values": handleMissingValues.md - "Negate": negate.md - "Or": max.md - - "Scale": scale.md \ No newline at end of file + - "Scale": scale.md diff --git a/docs/build/reference/customtask/.pages b/docs/build/reference/customtask/.pages index 95bf454e1..e347f8a6f 100644 --- a/docs/build/reference/customtask/.pages +++ b/docs/build/reference/customtask/.pages @@ -1,3 +1,4 @@ +--- nav: - index.md - "Add project files": addProjectFiles.md @@ -88,4 +89,4 @@ nav: - "Validate Knowledge Graph": cmem_plugin_validation-validate-ValidateGraph.md - "Validate OWL consistency": cmem_plugin_reason-plugin_validate-ValidatePlugin.md - "Validate XML": validateXsdOperator.md - - "XSLT": xsltOperator.md \ No newline at end of file + - "XSLT": xsltOperator.md diff --git a/docs/build/reference/dataset/.pages b/docs/build/reference/dataset/.pages index d9a440848..eae785f02 100644 --- a/docs/build/reference/dataset/.pages +++ b/docs/build/reference/dataset/.pages @@ -1,3 +1,4 @@ +--- nav: - index.md - "Alignment": alignment.md @@ -24,4 +25,4 @@ nav: - "Snowflake SQL endpoint": SnowflakeJdbc.md - "SPARQL endpoint": sparqlEndpoint.md - "Text": text.md - - "XML": xml.md \ No newline at end of file + - "XML": xml.md diff --git a/docs/build/reference/distancemeasure/.pages b/docs/build/reference/distancemeasure/.pages index 0717ce79b..1c95827a7 100644 --- a/docs/build/reference/distancemeasure/.pages +++ b/docs/build/reference/distancemeasure/.pages @@ -1,3 +1,4 @@ +--- nav: - index.md - "CJK reading distance": cjkReadingDistance.md @@ -28,4 +29,4 @@ nav: - "Starts with": startsWith.md - "String equality": equality.md - "Substring comparison": substringDistance.md - - "Token-wise distance": tokenwiseDistance.md \ No newline at end of file + - "Token-wise distance": tokenwiseDistance.md diff --git a/docs/build/reference/transformer/.pages b/docs/build/reference/transformer/.pages index 476f8db4c..83e1b028e 100644 --- a/docs/build/reference/transformer/.pages +++ b/docs/build/reference/transformer/.pages @@ -1,3 +1,4 @@ +--- nav: - index.md - "Combine": Combine @@ -23,4 +24,4 @@ nav: - "Uncategorized": Uncategorized - "Validation": Validation - "Value": Value - - "Variables": Variables \ No newline at end of file + - "Variables": Variables diff --git a/docs/build/reference/transformer/Combine/.pages b/docs/build/reference/transformer/Combine/.pages index 93bc14b8d..762e1d5d7 100644 --- a/docs/build/reference/transformer/Combine/.pages +++ b/docs/build/reference/transformer/Combine/.pages @@ -1,6 +1,7 @@ +--- nav: - "Concatenate": concat.md - "Concatenate multiple values": concatMultiValues.md - "Concatenate pairwise": concatPairwise.md - "Merge": merge.md - - "Zip": zip.md \ No newline at end of file + - "Zip": zip.md diff --git a/docs/build/reference/transformer/Conditional/.pages b/docs/build/reference/transformer/Conditional/.pages index 78cf5e3c0..a2385a91e 100644 --- a/docs/build/reference/transformer/Conditional/.pages +++ b/docs/build/reference/transformer/Conditional/.pages @@ -1,7 +1,8 @@ +--- nav: - "Contains all of": containsAllOf.md - "Contains any of": containsAnyOf.md - "If contains": ifContains.md - "If exists": ifExists.md - "If matches regex": ifMatchesRegex.md - - "Negate binary (NOT)": negateTransformer.md \ No newline at end of file + - "Negate binary (NOT)": negateTransformer.md diff --git a/docs/build/reference/transformer/Conversion/.pages b/docs/build/reference/transformer/Conversion/.pages index 7d50a8fd1..7bf7a8cc2 100644 --- a/docs/build/reference/transformer/Conversion/.pages +++ b/docs/build/reference/transformer/Conversion/.pages @@ -1,2 +1,3 @@ +--- nav: - - "Convert charset": convertCharset.md \ No newline at end of file + - "Convert charset": convertCharset.md diff --git a/docs/build/reference/transformer/Date/.pages b/docs/build/reference/transformer/Date/.pages index c8d9ce52f..2c1979ad1 100644 --- a/docs/build/reference/transformer/Date/.pages +++ b/docs/build/reference/transformer/Date/.pages @@ -1,3 +1,4 @@ +--- nav: - "Compare dates": compareDates.md - "Current date": currentDate.md @@ -8,4 +9,4 @@ nav: - "Duration in years": durationInYears.md - "Number to duration": numberToDuration.md - "Parse date pattern": parseDate.md - - "Timestamp to date": timeToDate.md \ No newline at end of file + - "Timestamp to date": timeToDate.md diff --git a/docs/build/reference/transformer/Excel/.pages b/docs/build/reference/transformer/Excel/.pages index dc2b605f7..1f8ea6385 100644 --- a/docs/build/reference/transformer/Excel/.pages +++ b/docs/build/reference/transformer/Excel/.pages @@ -1,3 +1,4 @@ +--- nav: - "Excel Abs": Excel_ABS.md - "Excel Acos": Excel_ACOS.md @@ -111,4 +112,4 @@ nav: - "Excel Var": Excel_VAR.md - "Excel Vara": Excel_VARA.md - "Excel Varp": Excel_VARP.md - - "Excel Varpa": Excel_VARPA.md \ No newline at end of file + - "Excel Varpa": Excel_VARPA.md diff --git a/docs/build/reference/transformer/Extract/.pages b/docs/build/reference/transformer/Extract/.pages index 6d07ceee1..03ae4fdf2 100644 --- a/docs/build/reference/transformer/Extract/.pages +++ b/docs/build/reference/transformer/Extract/.pages @@ -1,2 +1,3 @@ +--- nav: - - "Regex extract": regexExtract.md \ No newline at end of file + - "Regex extract": regexExtract.md diff --git a/docs/build/reference/transformer/Filter/.pages b/docs/build/reference/transformer/Filter/.pages index 4b0957cfd..edee90bdc 100644 --- a/docs/build/reference/transformer/Filter/.pages +++ b/docs/build/reference/transformer/Filter/.pages @@ -1,3 +1,4 @@ +--- nav: - "Filter by length": filterByLength.md - "Filter by regex": filterByRegex.md @@ -5,4 +6,4 @@ nav: - "Remove empty values": removeEmptyValues.md - "Remove remote stop words": removeRemoteStopWords.md - "Remove stop words": removeStopWords.md - - "Remove values": removeValues.md \ No newline at end of file + - "Remove values": removeValues.md diff --git a/docs/build/reference/transformer/Geo/.pages b/docs/build/reference/transformer/Geo/.pages index 2cb24b669..85b037eed 100644 --- a/docs/build/reference/transformer/Geo/.pages +++ b/docs/build/reference/transformer/Geo/.pages @@ -1,4 +1,5 @@ +--- nav: - "Retrieve coordinates": RetrieveCoordinates.md - "Retrieve latitude": RetrieveLatitude.md - - "Retrieve longitude": RetrieveLongitude.md \ No newline at end of file + - "Retrieve longitude": RetrieveLongitude.md diff --git a/docs/build/reference/transformer/Linguistic/.pages b/docs/build/reference/transformer/Linguistic/.pages index eebadc8ed..860d4f163 100644 --- a/docs/build/reference/transformer/Linguistic/.pages +++ b/docs/build/reference/transformer/Linguistic/.pages @@ -1,6 +1,7 @@ +--- nav: - "Metaphone": metaphone.md - "Normalize chars": normalizeChars.md - "NYSIIS": NYSIIS.md - "Soundex": soundex.md - - "Stem": stem.md \ No newline at end of file + - "Stem": stem.md diff --git a/docs/build/reference/transformer/Metadata/.pages b/docs/build/reference/transformer/Metadata/.pages index 61a7ff692..2f6df58ce 100644 --- a/docs/build/reference/transformer/Metadata/.pages +++ b/docs/build/reference/transformer/Metadata/.pages @@ -1,4 +1,5 @@ +--- nav: - "File hash": fileHash.md - "Input file attributes": inputFileAttributes.md - - "Input task attributes": inputTaskAttributes.md \ No newline at end of file + - "Input task attributes": inputTaskAttributes.md diff --git a/docs/build/reference/transformer/Normalize/.pages b/docs/build/reference/transformer/Normalize/.pages index 0ce34aaa9..ee80bc4d1 100644 --- a/docs/build/reference/transformer/Normalize/.pages +++ b/docs/build/reference/transformer/Normalize/.pages @@ -1,3 +1,4 @@ +--- nav: - "Camel case": camelCase.md - "Capitalize": capitalize.md @@ -12,4 +13,4 @@ nav: - "Sort words": sortWords.md - "Strip non-alphabetic characters": alphaReduce.md - "Trim": trim.md - - "Upper case": upperCase.md \ No newline at end of file + - "Upper case": upperCase.md diff --git a/docs/build/reference/transformer/Numeric/.pages b/docs/build/reference/transformer/Numeric/.pages index 0587d7730..27f2180b6 100644 --- a/docs/build/reference/transformer/Numeric/.pages +++ b/docs/build/reference/transformer/Numeric/.pages @@ -1,3 +1,4 @@ +--- nav: - "Aggregate numbers": aggregateNumbers.md - "Compare numbers": compareNumbers.md @@ -7,4 +8,4 @@ nav: - "Logarithm": log.md - "Normalize physical quantity": PhysicalQuantitiesNormalizer.md - "Numeric operation": numOperation.md - - "Numeric reduce": numReduce.md \ No newline at end of file + - "Numeric reduce": numReduce.md diff --git a/docs/build/reference/transformer/Parser/.pages b/docs/build/reference/transformer/Parser/.pages index eb8b76e95..a86918d99 100644 --- a/docs/build/reference/transformer/Parser/.pages +++ b/docs/build/reference/transformer/Parser/.pages @@ -1,3 +1,4 @@ +--- nav: - "Parse date": DateTypeParser.md - "Parse float": FloatTypeParser.md @@ -6,4 +7,4 @@ nav: - "Parse integer": IntegerParser.md - "Parse ISIN": IsinParser.md - "Parse SKOS term": SkosTypeParser.md - - "Parse string": StringParser.md \ No newline at end of file + - "Parse string": StringParser.md diff --git a/docs/build/reference/transformer/Replace/.pages b/docs/build/reference/transformer/Replace/.pages index 7f18e579f..9a0676613 100644 --- a/docs/build/reference/transformer/Replace/.pages +++ b/docs/build/reference/transformer/Replace/.pages @@ -1,6 +1,7 @@ +--- nav: - "Excel map": excelMap.md - "Map": map.md - "Map with default": mapWithDefaultInput.md - "Regex replace": regexReplace.md - - "Replace": replace.md \ No newline at end of file + - "Replace": replace.md diff --git a/docs/build/reference/transformer/SPARQL/.pages b/docs/build/reference/transformer/SPARQL/.pages index 44ad1fcdf..8d7c74ffb 100644 --- a/docs/build/reference/transformer/SPARQL/.pages +++ b/docs/build/reference/transformer/SPARQL/.pages @@ -1,3 +1,4 @@ +--- nav: - "Escape SPARQL multiline literal": escape_multiline_literal.md - - "Escape SPARQL plain literal": escape_literal.md \ No newline at end of file + - "Escape SPARQL plain literal": escape_literal.md diff --git a/docs/build/reference/transformer/Selection/.pages b/docs/build/reference/transformer/Selection/.pages index 61f94b6ba..3c1cda99e 100644 --- a/docs/build/reference/transformer/Selection/.pages +++ b/docs/build/reference/transformer/Selection/.pages @@ -1,3 +1,4 @@ +--- nav: - "Coalesce (first non-empty input)": coalesce.md - - "Regex selection": regexSelect.md \ No newline at end of file + - "Regex selection": regexSelect.md diff --git a/docs/build/reference/transformer/Sequence/.pages b/docs/build/reference/transformer/Sequence/.pages index f1a78840d..f51de48ea 100644 --- a/docs/build/reference/transformer/Sequence/.pages +++ b/docs/build/reference/transformer/Sequence/.pages @@ -1,5 +1,6 @@ +--- nav: - "Count values": count.md - "Get value by index": getValueByIndex.md - "Sequence values to indexes": toSequenceIndex.md - - "Sort": sort.md \ No newline at end of file + - "Sort": sort.md diff --git a/docs/build/reference/transformer/Substring/.pages b/docs/build/reference/transformer/Substring/.pages index 6bef13f4b..f8d42c0f9 100644 --- a/docs/build/reference/transformer/Substring/.pages +++ b/docs/build/reference/transformer/Substring/.pages @@ -1,6 +1,7 @@ +--- nav: - "Strip postfix": stripPostfix.md - "Strip prefix": stripPrefix.md - "Strip URI prefix": stripUriPrefix.md - "Substring": substring.md - - "Until character": untilCharacter.md \ No newline at end of file + - "Until character": untilCharacter.md diff --git a/docs/build/reference/transformer/Template/.pages b/docs/build/reference/transformer/Template/.pages index dc5478c9d..9ed0afd64 100644 --- a/docs/build/reference/transformer/Template/.pages +++ b/docs/build/reference/transformer/Template/.pages @@ -1,2 +1,3 @@ +--- nav: - - "Evaluate template": TemplateTransformer.md \ No newline at end of file + - "Evaluate template": TemplateTransformer.md diff --git a/docs/build/reference/transformer/Tokenization/.pages b/docs/build/reference/transformer/Tokenization/.pages index eb9ec62a3..5be9c2df1 100644 --- a/docs/build/reference/transformer/Tokenization/.pages +++ b/docs/build/reference/transformer/Tokenization/.pages @@ -1,3 +1,4 @@ +--- nav: - "Camel case tokenizer": camelcasetokenizer.md - - "Tokenize": tokenize.md \ No newline at end of file + - "Tokenize": tokenize.md diff --git a/docs/build/reference/transformer/Uncategorized/.pages b/docs/build/reference/transformer/Uncategorized/.pages index f8049f252..917a76862 100644 --- a/docs/build/reference/transformer/Uncategorized/.pages +++ b/docs/build/reference/transformer/Uncategorized/.pages @@ -1,4 +1,5 @@ +--- nav: - "Convert currency values": cmem_plugin_currencies-transform.md - "jq": cmem-plugin-jq-transform.md - - "Random value": cmem_plugin_random-GenerateValues.md \ No newline at end of file + - "Random value": cmem_plugin_random-GenerateValues.md diff --git a/docs/build/reference/transformer/Validation/.pages b/docs/build/reference/transformer/Validation/.pages index a80388570..701dacca9 100644 --- a/docs/build/reference/transformer/Validation/.pages +++ b/docs/build/reference/transformer/Validation/.pages @@ -1,7 +1,8 @@ +--- nav: - "Validate date after": validateDateAfter.md - "Validate date range": validateDateRange.md - "Validate number of values": validateNumberOfValues.md - "Validate numeric range": validateNumericRange.md - "Validate regex": validateRegex.md - - "Validate URI": validate_uri.md \ No newline at end of file + - "Validate URI": validate_uri.md diff --git a/docs/build/reference/transformer/Value/.pages b/docs/build/reference/transformer/Value/.pages index b76cc91fc..89d2b903b 100644 --- a/docs/build/reference/transformer/Value/.pages +++ b/docs/build/reference/transformer/Value/.pages @@ -1,3 +1,4 @@ +--- nav: - "Combined input hash": inputHash.md - "Constant": constant.md @@ -19,4 +20,4 @@ nav: - "UUIDv5": cmem_plugin_uuid-plugin_uuid-UUID5.md - "UUIDv6": cmem_plugin_uuid-plugin_uuid-UUID6.md - "UUIDv7": cmem_plugin_uuid-plugin_uuid-UUID7.md - - "UUIDv8": cmem_plugin_uuid-plugin_uuid-UUID8.md \ No newline at end of file + - "UUIDv8": cmem_plugin_uuid-plugin_uuid-UUID8.md diff --git a/docs/build/reference/transformer/Variables/.pages b/docs/build/reference/transformer/Variables/.pages index f9b8f14f4..13c2f2190 100644 --- a/docs/build/reference/transformer/Variables/.pages +++ b/docs/build/reference/transformer/Variables/.pages @@ -1,2 +1,3 @@ +--- nav: - - "Set execution variable": setExecutionVariable.md \ No newline at end of file + - "Set execution variable": setExecutionVariable.md diff --git a/docs/consume/.pages b/docs/consume/.pages index c8187a05c..64ee0927a 100644 --- a/docs/consume/.pages +++ b/docs/consume/.pages @@ -1,3 +1,4 @@ +--- nav: - Consume: index.md - Consuming Graphs in Power BI: consuming-graphs-in-power-bi diff --git a/docs/deploy-and-configure/.pages b/docs/deploy-and-configure/.pages index f9245d901..ef4a319dc 100644 --- a/docs/deploy-and-configure/.pages +++ b/docs/deploy-and-configure/.pages @@ -1,3 +1,4 @@ +--- nav: - Deploy and Configure: index.md - System Architecture: system-architecture diff --git a/docs/deploy-and-configure/configuration/.pages b/docs/deploy-and-configure/configuration/.pages index 191743b7b..24235bea2 100644 --- a/docs/deploy-and-configure/configuration/.pages +++ b/docs/deploy-and-configure/configuration/.pages @@ -1,3 +1,4 @@ +--- nav: - Configuration: index.md - Docker Orchestration: docker-orchestration diff --git a/docs/deploy-and-configure/configuration/dataintegration/.pages b/docs/deploy-and-configure/configuration/dataintegration/.pages index e2345b5d6..1719c8e4f 100644 --- a/docs/deploy-and-configure/configuration/dataintegration/.pages +++ b/docs/deploy-and-configure/configuration/dataintegration/.pages @@ -1,3 +1,4 @@ +--- nav: - Build (DataIntegration): index.md - Adding JDBC drivers: jdbc diff --git a/docs/deploy-and-configure/configuration/explore/.pages b/docs/deploy-and-configure/configuration/explore/.pages index 461c39f9b..2b79a4730 100644 --- a/docs/deploy-and-configure/configuration/explore/.pages +++ b/docs/deploy-and-configure/configuration/explore/.pages @@ -1,3 +1,4 @@ +--- nav: - Explore: index.md - Explore backend: dataplatform diff --git a/docs/deploy-and-configure/configuration/explore/dataplatform/.pages b/docs/deploy-and-configure/configuration/explore/dataplatform/.pages index 0d8764759..b6be1f83d 100644 --- a/docs/deploy-and-configure/configuration/explore/dataplatform/.pages +++ b/docs/deploy-and-configure/configuration/explore/dataplatform/.pages @@ -1,10 +1,11 @@ +--- nav: - Explore backend: index.md - General: application-full.md - OAuth: application-oauth-full.md - Store: - - GraphDB: application-graphdb-full.md - - HTTP: application-http-full.md - - In-Memory: application-inmemory-full.md - - Virtuoso: application-virtuoso-full.md + - GraphDB: application-graphdb-full.md + - HTTP: application-http-full.md + - In-Memory: application-inmemory-full.md + - Virtuoso: application-virtuoso-full.md diff --git a/docs/deploy-and-configure/configuration/keycloak/.pages b/docs/deploy-and-configure/configuration/keycloak/.pages index fc8fb4e6d..0f0979357 100644 --- a/docs/deploy-and-configure/configuration/keycloak/.pages +++ b/docs/deploy-and-configure/configuration/keycloak/.pages @@ -1,3 +1,4 @@ +--- nav: - Keycloak: index.md - Changing Passwords and Keys: change-passwords-and-keys diff --git a/docs/deploy-and-configure/installation/.pages b/docs/deploy-and-configure/installation/.pages index 4584e7dd9..fb663cb35 100644 --- a/docs/deploy-and-configure/installation/.pages +++ b/docs/deploy-and-configure/installation/.pages @@ -1,3 +1,4 @@ +--- nav: - Installation: index.md - "Scenario: Single Node Cloud Installation": scenario-single-node-cloud-installation diff --git a/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/cmem-values.yaml b/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/cmem-values.yaml index d6fcba163..318fcfdba 100644 --- a/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/cmem-values.yaml +++ b/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/cmem-values.yaml @@ -1,3 +1,4 @@ +--- # Default values for cmem. nameOverride: "" @@ -5,7 +6,7 @@ ingress: enabled: true className: nginx annotations: - #kubernetes.io/tls-acme: "true" + # kubernetes.io/tls-acme: "true" cert-manager.io/cluster-issuer: OVERRIDDEN_BY_TASKFILE hosts: @@ -21,13 +22,14 @@ ingress: servicePort: 8080 tls: - hosts: - - "OVERRIDDEN_BY_TASKFILE" - secretName: cmem-ingress-cert + - "OVERRIDDEN_BY_TASKFILE" + secretName: cmem-ingress-cert global: # The OAuth client that will be used to load the workspace initially and run the schedulers. # In order to enable that feature, you have to enable the service account feature in the Keycloak - # OIDC client "cmem-service-client". Furthermore, an AccessCondition that maps with `eccauth:requiresClient :cmem-service-account` + # OIDC client "cmem-service-client". Furthermore, an AccessCondition that + # maps with `eccauth:requiresClient :cmem-service-account` # is required. protocol: "https" @@ -53,7 +55,7 @@ marketplace: explore: config: # disabeld by default - # create Objects of kind Pod- or SeviceMonitor see + # create Objects of kind Pod- or SeviceMonitor see # https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/developer/getting-started.md#deploying-a-sample-application serviceMonitorEnabaled: false podMonitorEnabled: true diff --git a/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/graphdb-values.yaml b/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/graphdb-values.yaml index 005fe607c..2e95afd03 100644 --- a/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/graphdb-values.yaml +++ b/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/graphdb-values.yaml @@ -31,7 +31,7 @@ persistence: volumeClaimTemplate: name: "storage" spec: - accessModes: [ "ReadWriteOnce" ] + accessModes: ["ReadWriteOnce"] resources: requests: - storage: 5Gi \ No newline at end of file + storage: 5Gi diff --git a/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/keycloak-values.yaml b/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/keycloak-values.yaml index 537be2cfc..9fdf8465d 100644 --- a/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/keycloak-values.yaml +++ b/docs/deploy-and-configure/installation/scenario-k8s-deployment/files/keycloak-values.yaml @@ -20,8 +20,8 @@ ingress: servicePort: 8080 tls: - hosts: - - "kc.docker.localhost" - secretName: keycloak-ingress-cert + - "kc.docker.localhost" + secretName: keycloak-ingress-cert tests: # Change this to your ingress controller IP in case you are using diff --git a/docs/develop/.pages b/docs/develop/.pages index eeba980ef..3dc2f5841 100644 --- a/docs/develop/.pages +++ b/docs/develop/.pages @@ -1,3 +1,4 @@ +--- nav: - Develop: index.md - Accessing Graphs with Java Applications: accessing-graphs-with-java-applications diff --git a/docs/develop/cmem-client-api/.pages b/docs/develop/cmem-client-api/.pages index 3d0c5af52..6a3d22ae4 100644 --- a/docs/develop/cmem-client-api/.pages +++ b/docs/develop/cmem-client-api/.pages @@ -1,3 +1,4 @@ +--- nav: - "cmem-client: Python API": index.md - API Reference: api-reference diff --git a/docs/develop/cmem-client-api/api-reference/.pages b/docs/develop/cmem-client-api/api-reference/.pages index c6a314b2a..9f466ff65 100644 --- a/docs/develop/cmem-client-api/api-reference/.pages +++ b/docs/develop/cmem-client-api/api-reference/.pages @@ -1,3 +1,4 @@ +--- nav: - API Reference: index.md - client: client diff --git a/docs/develop/cmem-client-api/api-reference/auth_provider/.pages b/docs/develop/cmem-client-api/api-reference/auth_provider/.pages index 071e5508f..6644b7004 100644 --- a/docs/develop/cmem-client-api/api-reference/auth_provider/.pages +++ b/docs/develop/cmem-client-api/api-reference/auth_provider/.pages @@ -1,3 +1,4 @@ +--- title: auth_provider nav: - abc: abc diff --git a/docs/develop/cmem-client-api/api-reference/components/.pages b/docs/develop/cmem-client-api/api-reference/components/.pages index ce5f13fc5..2c8383fd4 100644 --- a/docs/develop/cmem-client-api/api-reference/components/.pages +++ b/docs/develop/cmem-client-api/api-reference/components/.pages @@ -1,3 +1,4 @@ +--- title: components nav: - deployment: deployment diff --git a/docs/develop/cmem-client-api/api-reference/models/.pages b/docs/develop/cmem-client-api/api-reference/models/.pages index de3351af2..07f79b7d6 100644 --- a/docs/develop/cmem-client-api/api-reference/models/.pages +++ b/docs/develop/cmem-client-api/api-reference/models/.pages @@ -1,3 +1,4 @@ +--- title: models nav: - access_condition: access_condition diff --git a/docs/develop/cmem-client-api/api-reference/repositories/.pages b/docs/develop/cmem-client-api/api-reference/repositories/.pages index fe4583929..57601e94d 100644 --- a/docs/develop/cmem-client-api/api-reference/repositories/.pages +++ b/docs/develop/cmem-client-api/api-reference/repositories/.pages @@ -1,3 +1,4 @@ +--- title: repositories nav: - access_conditions: access_conditions diff --git a/docs/develop/cmem-client-api/api-reference/repositories/base/.pages b/docs/develop/cmem-client-api/api-reference/repositories/base/.pages index 60103137e..015318e80 100644 --- a/docs/develop/cmem-client-api/api-reference/repositories/base/.pages +++ b/docs/develop/cmem-client-api/api-reference/repositories/base/.pages @@ -1,3 +1,4 @@ +--- title: base nav: - abc: abc diff --git a/docs/develop/cmem-client-api/api-reference/repositories/protocols/.pages b/docs/develop/cmem-client-api/api-reference/repositories/protocols/.pages index 48fc0f9c4..de8c1e27a 100644 --- a/docs/develop/cmem-client-api/api-reference/repositories/protocols/.pages +++ b/docs/develop/cmem-client-api/api-reference/repositories/protocols/.pages @@ -1,3 +1,4 @@ +--- title: protocols nav: - create_item: create_item diff --git a/docs/develop/marketplace-packages/.pages b/docs/develop/marketplace-packages/.pages index 1f4c61800..d83fb5cd5 100644 --- a/docs/develop/marketplace-packages/.pages +++ b/docs/develop/marketplace-packages/.pages @@ -1,3 +1,4 @@ +--- nav: - Marketplace Packages: index.md - Installation and Management: installation diff --git a/docs/develop/packages/.pages b/docs/develop/packages/.pages index 1f4c61800..d83fb5cd5 100644 --- a/docs/develop/packages/.pages +++ b/docs/develop/packages/.pages @@ -1,3 +1,4 @@ +--- nav: - Marketplace Packages: index.md - Installation and Management: installation diff --git a/docs/develop/packages/development/.pages b/docs/develop/packages/development/.pages index 48c0722db..b759316f5 100644 --- a/docs/develop/packages/development/.pages +++ b/docs/develop/packages/development/.pages @@ -1,3 +1,4 @@ +--- nav: - Development and Publication: index.md - Tutorial: tutorial diff --git a/docs/develop/python-plugins/.pages b/docs/develop/python-plugins/.pages index e18d7448b..d76c3a01e 100644 --- a/docs/develop/python-plugins/.pages +++ b/docs/develop/python-plugins/.pages @@ -1,3 +1,4 @@ +--- nav: - Python Plugins: index.md - Installation and Usage: installation diff --git a/docs/distribution/.pages b/docs/distribution/.pages index 716b2d80b..f90a98a6a 100644 --- a/docs/distribution/.pages +++ b/docs/distribution/.pages @@ -1,3 +1,4 @@ +--- nav: - Distribution: index.md - Marketplace: marketplace diff --git a/docs/explore-and-author/.pages b/docs/explore-and-author/.pages index cf419ec53..cf3132983 100644 --- a/docs/explore-and-author/.pages +++ b/docs/explore-and-author/.pages @@ -1,3 +1,4 @@ +--- nav: - Explore: index.md - Knowledge graphs: graph-exploration diff --git a/docs/explore-and-author/graph-exploration/.pages b/docs/explore-and-author/graph-exploration/.pages index 2add03afe..ac380f572 100644 --- a/docs/explore-and-author/graph-exploration/.pages +++ b/docs/explore-and-author/graph-exploration/.pages @@ -1,3 +1,4 @@ +--- nav: - Graph Exploration: index.md - Building a Customized User Interface: building-a-customized-user-interface diff --git a/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/.pages b/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/.pages index 1140fccc4..84bff7981 100644 --- a/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/.pages +++ b/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/.pages @@ -1,3 +1,4 @@ +--- nav: - Building a Customized User Interface: index.md - Workflow Trigger: workflow-trigger diff --git a/docs/explore-and-author/graph-exploration/graph-insights/.pages b/docs/explore-and-author/graph-exploration/graph-insights/.pages index a2918e752..00aae9d9e 100644 --- a/docs/explore-and-author/graph-exploration/graph-insights/.pages +++ b/docs/explore-and-author/graph-exploration/graph-insights/.pages @@ -1,3 +1,4 @@ +--- nav: - index.md - Core Concepts: concepts.md diff --git a/docs/explore-and-author/graph-exploration/graph-insights/features/.pages b/docs/explore-and-author/graph-exploration/graph-insights/features/.pages index 3afbf3237..bf4266713 100644 --- a/docs/explore-and-author/graph-exploration/graph-insights/features/.pages +++ b/docs/explore-and-author/graph-exploration/graph-insights/features/.pages @@ -1,3 +1,4 @@ +--- title: Features nav: - index.md diff --git a/docs/release-notes/.pages b/docs/release-notes/.pages index b12a57b11..2acaca9d5 100644 --- a/docs/release-notes/.pages +++ b/docs/release-notes/.pages @@ -1,3 +1,4 @@ +--- nav: - Corporate Memory 26.2.0: corporate-memory-26-2 - Corporate Memory 26.1.3: corporate-memory-26-1 diff --git a/mkdocs.yml b/mkdocs.yml index 314747b73..afe2b717b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -306,12 +306,10 @@ plugins: - tags: listings_tags_sort_by: !!python/name:material.plugins.tags.tag_name_casefold listings_sort_by: !!python/name:material.plugins.tags.item_title - # https://github.com/byrnereese/mkdocs-swagger-ui - # - swagger-ui-tag # }}} # {{{ Less important mkdocs configuration # https://zensical.org/docs/setup/basics/#watch -#watch: +# watch: # - overrides # }}} diff --git a/nav.yml b/nav.yml index 6745cf325..cac81bf9a 100644 --- a/nav.yml +++ b/nav.yml @@ -1,936 +1,940 @@ +--- +# Generated by tools/build_navigation.py from the docs/**/.pages files. +# Do not edit by hand - run `task update:navigation` instead. +# yamllint disable rule:line-length nav: -- Build: - - Build: build/index.md - - Introduction to the User Interface: - - build/introduction-to-the-user-interface/index.md - - Integrations: - - build/integrations/index.md - - Task and Operator Reference: - - Task and Operator Reference: build/reference/index.md - - Aggregators: - - build/reference/aggregator/index.md - - And: build/reference/aggregator/min.md - - Average: build/reference/aggregator/average.md - - Euclidian distance: build/reference/aggregator/quadraticMean.md - - First non-empty score: build/reference/aggregator/firstNonEmpty.md - - Geometric mean: build/reference/aggregator/geometricMean.md - - Handle missing values: build/reference/aggregator/handleMissingValues.md - - Negate: build/reference/aggregator/negate.md - - Or: build/reference/aggregator/max.md - - Scale: build/reference/aggregator/scale.md - - Custom Workflow Tasks: - - build/reference/customtask/index.md - - Add project files: build/reference/customtask/addProjectFiles.md - - Build Packages: build/reference/customtask/cmem_plugin_packages-BuildPackages.md - - Bump Version in Package Manifest: build/reference/customtask/cmem_plugin_packages-BumpVersions.md - - Cancel Workflow: build/reference/customtask/CancelWorkflow.md - - Clear dataset: build/reference/customtask/clearDataset.md - - Combine CSV files: build/reference/customtask/combine-csv.md - - Concatenate to file: build/reference/customtask/ConcatenateToFile.md - - Create Embeddings: build/reference/customtask/cmem_plugin_llm-CreateEmbeddings.md - - Create or Update Graph Insights Snapshots: build/reference/customtask/cmem_plugin_graph_insights-Update.md - - Create/Update Salesforce Objects: build/reference/customtask/cmem_plugin_salesforce-workflow-operations-SobjectCreate.md - - Delete project files: build/reference/customtask/deleteProjectFiles.md - - Distinct by: build/reference/customtask/DistinctBy.md - - Download CKAN files: build/reference/customtask/cmem_plugin_ckan-Download.md - - Download file: build/reference/customtask/downloadFile.md - - Download Git files: build/reference/customtask/cmem_plugin_git-Download.md - - Download Nextcloud files: build/reference/customtask/cmem_plugin_nextcloud-Download.md - - Download Office 365 Files: build/reference/customtask/cmem_plugin_office365-Download.md - - Download SSH files: build/reference/customtask/cmem_plugin_ssh-Download.md - - Evaluate template: build/reference/customtask/Template.md - - Execute a command in a kubernetes pod: build/reference/customtask/cmem_plugin_kubernetes-Execute.md - - Execute commands via SSH: build/reference/customtask/cmem_plugin_ssh-Execute.md - - Execute Instructions: build/reference/customtask/cmem_plugin_llm-ExecuteInstructions.md - - Execute REST requests: build/reference/customtask/eccencaRestOperator.md - - Execute Spark function: build/reference/customtask/SparkFunction.md - - Extract from PDF files: build/reference/customtask/cmem_plugin_pdf_extract-pdf_extract-PdfExtract.md - - Generate base36 IRDIs: build/reference/customtask/cmem_plugin_irdi-workflow-irdi_plugin-IrdiPlugin.md - - Generate random values: build/reference/customtask/cmem_plugin_random-GenerateEntities.md - - Generate SHACL shapes from data: build/reference/customtask/cmem_plugin_shapes-plugin_shapes-ShapesPlugin.md - - Get emails: build/reference/customtask/cmem-plugin-email-GetEmails.md - - Get project files: build/reference/customtask/getProjectFiles.md - - Get workflow report: build/reference/customtask/cmem_plugin_wfreports_get_report.md - - GraphQL query: build/reference/customtask/cmem_plugin_graphql-workflow-graphql-GraphQLPlugin.md - - Install Packages: build/reference/customtask/cmem_plugin_packages-InstallPackages.md - - Join tables: build/reference/customtask/Merge.md - - jq: build/reference/customtask/cmem-plugin-jq-workflow.md - - JQL query: build/reference/customtask/cmem_plugin_jira-JqlQuery.md - - JSON to File: build/reference/customtask/jsonToFile.md - - Kafka Consumer (Receive Messages): build/reference/customtask/cmem_plugin_kafka-ReceiveMessages.md - - Kafka Producer (Send Messages): build/reference/customtask/cmem_plugin_kafka-SendMessages.md - - List Git files: build/reference/customtask/cmem_plugin_git-List.md - - List Nextcloud files: build/reference/customtask/cmem_plugin_nextcloud-List.md - - List Office 365 Files: build/reference/customtask/cmem_plugin_office365-List.md - - List project files: build/reference/customtask/cmem_plugin_project_resources-List.md - - List SSH files: build/reference/customtask/cmem_plugin_ssh-List.md - - Merge tables: build/reference/customtask/MultiTableMerge.md - - Normalize units of measurement: build/reference/customtask/ucumNormalizationTask.md - - OAuth2 Authentication: build/reference/customtask/cmem_plugin_auth-workflow-auth-OAuth2.md - - Office 365 Upload Files: build/reference/customtask/cmem_plugin_office365-Upload.md - - Parse JSON: build/reference/customtask/JsonParserOperator.md - - Parse XML: build/reference/customtask/XmlParserOperator.md - - Parse YAML: build/reference/customtask/cmem_plugin_yaml-parse.md - - Pivot: build/reference/customtask/Pivot.md - - Publish Packages: build/reference/customtask/cmem_plugin_packages-PublishPackages.md - - Reason: build/reference/customtask/cmem_plugin_reason-plugin_reason-ReasonPlugin.md - - Request RDF triples: build/reference/customtask/tripleRequestOperator.md - - Run Apify actor: build/reference/customtask/cmem_plugin_apify-RunActor.md - - Scheduler: build/reference/customtask/Scheduler.md - - Search addresses: build/reference/customtask/SearchAddresses.md - - Search for Logs: build/reference/customtask/cmem_plugin_logpoint-search_logs_task-RetrieveLogs.md - - Search Vector Embeddings: build/reference/customtask/cmem_plugin_pgvector-Search.md - - Select random entities: build/reference/customtask/cmem_plugin_random-SelectEntities.md - - Send email: build/reference/customtask/SendEMail.md - - Send Mattermost messages: build/reference/customtask/cmem_plugin_mattermost.md - - Set execution variable: build/reference/customtask/setExecutionVariableOperator.md - - Set or Overwrite parameters: build/reference/customtask/cmem_plugin_parameters-ParametersPlugin.md - - Set parameters: build/reference/customtask/setParameters.md - - SHACL validation with pySHACL: build/reference/customtask/shacl-pyshacl.md - - SOQL query (Salesforce): build/reference/customtask/cmem_plugin_salesforce-SoqlQuery.md - - Spark SQL query: build/reference/customtask/CustomSQLExecution.md - - SPARQL Construct query: build/reference/customtask/sparqlCopyOperator.md - - SPARQL Select query: build/reference/customtask/sparqlSelectOperator.md - - SPARQL Update query: build/reference/customtask/sparqlUpdateOperator.md - - Split file: build/reference/customtask/cmem_plugin_splitfile-plugin_splitfile-SplitFilePlugin.md - - SQL Update query: build/reference/customtask/sqlUpdateQueryOperator.md - - Start Workflow per Entity: build/reference/customtask/cmem_plugin_loopwf-task-StartWorkflow.md - - Store Vector Embeddings: build/reference/customtask/cmem_plugin_pgvector-Store.md - - Uninstall Packages: build/reference/customtask/cmem_plugin_packages-UninstallPackages.md - - Unpivot: build/reference/customtask/Unpivot.md - - Upload File to Knowledge Graph: build/reference/customtask/eccencaDataPlatformGraphStoreFileUploadOperator.md - - Upload files to CKAN: build/reference/customtask/cmem_plugin_ckan-Upload.md - - Upload files to Nextcloud: build/reference/customtask/cmem_plugin_nextcloud-Upload.md - - Upload Git files: build/reference/customtask/cmem_plugin_git-Upload.md - - Upload local files: build/reference/customtask/cmem_plugin_project_resources-UploadLocalFiles.md - - Upload SSH files: build/reference/customtask/cmem_plugin_ssh-Upload.md - - Validate Entities: build/reference/customtask/cmem_plugin_validation-validate-ValidateEntities.md - - Validate Knowledge Graph: build/reference/customtask/cmem_plugin_validation-validate-ValidateGraph.md - - Validate OWL consistency: build/reference/customtask/cmem_plugin_reason-plugin_validate-ValidatePlugin.md - - Validate XML: build/reference/customtask/validateXsdOperator.md - - XSLT: build/reference/customtask/xsltOperator.md - - Datasets: - - build/reference/dataset/index.md - - Alignment: build/reference/dataset/alignment.md - - Avro: build/reference/dataset/avro.md - - Binary file: build/reference/dataset/binaryFile.md - - CSV: build/reference/dataset/csv.md - - Embedded Spark SQL view: build/reference/dataset/sparkView.md - - Embedded SQL endpoint: build/reference/dataset/sqlEndpoint.md - - Excel: build/reference/dataset/excel.md - - Excel (Google Drive): build/reference/dataset/googlespreadsheet.md - - Excel (OneDrive, Office365): build/reference/dataset/office365preadsheet.md - - Hive database: build/reference/dataset/Hive.md - - In-memory Knowledge Graph: build/reference/dataset/inMemory.md - - Internal dataset: build/reference/dataset/internal.md - - Internal dataset (single graph): build/reference/dataset/LocalInternalDataset.md - - JSON: build/reference/dataset/json.md - - Knowledge Graph: build/reference/dataset/eccencaDataPlatform.md - - Multi CSV ZIP: build/reference/dataset/multiCsv.md - - Neo4j: build/reference/dataset/neo4j.md - - ORC: build/reference/dataset/orc.md - - Parquet: build/reference/dataset/parquet.md - - RDF file: build/reference/dataset/file.md - - Remote SQL endpoint: build/reference/dataset/Jdbc.md - - Snowflake SQL endpoint: build/reference/dataset/SnowflakeJdbc.md - - SPARQL endpoint: build/reference/dataset/sparqlEndpoint.md - - Text: build/reference/dataset/text.md - - XML: build/reference/dataset/xml.md - - Distance Measures: - - build/reference/distancemeasure/index.md - - CJK reading distance: build/reference/distancemeasure/cjkReadingDistance.md - - Compare physical quantities: build/reference/distancemeasure/PhysicalQuantitiesDistance.md - - Constant similarity value: build/reference/distancemeasure/constantDistance.md - - Cosine: build/reference/distancemeasure/cosine.md - - Date: build/reference/distancemeasure/date.md - - DateTime: build/reference/distancemeasure/dateTime.md - - Dice coefficient: build/reference/distancemeasure/dice.md - - Geographical distance: build/reference/distancemeasure/wgs84.md - - Greater than: build/reference/distancemeasure/greaterThan.md - - Inequality: build/reference/distancemeasure/inequality.md - - Inside numeric interval: build/reference/distancemeasure/insideNumericInterval.md - - Is substring: build/reference/distancemeasure/isSubstring.md - - Jaccard: build/reference/distancemeasure/jaccard.md - - Jaro distance: build/reference/distancemeasure/jaro.md - - Jaro-Winkler distance: build/reference/distancemeasure/jaroWinkler.md - - Korean phoneme distance: build/reference/distancemeasure/koreanPhonemeDistance.md - - Korean translit distance: build/reference/distancemeasure/koreanTranslitDistance.md - - Levenshtein distance: build/reference/distancemeasure/levenshteinDistance.md - - Lower than: build/reference/distancemeasure/lowerThan.md - - Normalized Levenshtein distance: build/reference/distancemeasure/levenshtein.md - - Numeric equality: build/reference/distancemeasure/numericEquality.md - - Numeric similarity: build/reference/distancemeasure/num.md - - qGrams: build/reference/distancemeasure/qGrams.md - - Relaxed equality: build/reference/distancemeasure/relaxedEquality.md - - Soft Jaccard: build/reference/distancemeasure/softjaccard.md - - Starts with: build/reference/distancemeasure/startsWith.md - - String equality: build/reference/distancemeasure/equality.md - - Substring comparison: build/reference/distancemeasure/substringDistance.md - - Token-wise distance: build/reference/distancemeasure/tokenwiseDistance.md - - Transformers: - - build/reference/transformer/index.md - - Combine: - - Concatenate: build/reference/transformer/Combine/concat.md - - Concatenate multiple values: build/reference/transformer/Combine/concatMultiValues.md - - Concatenate pairwise: build/reference/transformer/Combine/concatPairwise.md - - Merge: build/reference/transformer/Combine/merge.md - - Zip: build/reference/transformer/Combine/zip.md - - Conditional: - - Contains all of: build/reference/transformer/Conditional/containsAllOf.md - - Contains any of: build/reference/transformer/Conditional/containsAnyOf.md - - If contains: build/reference/transformer/Conditional/ifContains.md - - If exists: build/reference/transformer/Conditional/ifExists.md - - If matches regex: build/reference/transformer/Conditional/ifMatchesRegex.md - - Negate binary (NOT): build/reference/transformer/Conditional/negateTransformer.md - - Conversion: - - Convert charset: build/reference/transformer/Conversion/convertCharset.md - - Date: - - Compare dates: build/reference/transformer/Date/compareDates.md - - Current date: build/reference/transformer/Date/currentDate.md - - Date to timestamp: build/reference/transformer/Date/datetoTimestamp.md - - Duration: build/reference/transformer/Date/duration.md - - Duration in days: build/reference/transformer/Date/durationInDays.md - - Duration in seconds: build/reference/transformer/Date/durationInSeconds.md - - Duration in years: build/reference/transformer/Date/durationInYears.md - - Number to duration: build/reference/transformer/Date/numberToDuration.md - - Parse date pattern: build/reference/transformer/Date/parseDate.md - - Timestamp to date: build/reference/transformer/Date/timeToDate.md - - Excel: - - Excel Abs: build/reference/transformer/Excel/Excel_ABS.md - - Excel Acos: build/reference/transformer/Excel/Excel_ACOS.md - - Excel Acosh: build/reference/transformer/Excel/Excel_ACOSH.md - - Excel And: build/reference/transformer/Excel/Excel_AND.md - - Excel Asin: build/reference/transformer/Excel/Excel_ASIN.md - - Excel Asinh: build/reference/transformer/Excel/Excel_ASINH.md - - Excel Atan: build/reference/transformer/Excel/Excel_ATAN.md - - Excel Atan2: build/reference/transformer/Excel/Excel_ATAN2.md - - Excel Atanh: build/reference/transformer/Excel/Excel_ATANH.md - - Excel Avedev: build/reference/transformer/Excel/Excel_AVEDEV.md - - Excel Average: build/reference/transformer/Excel/Excel_AVERAGE.md - - Excel Averagea: build/reference/transformer/Excel/Excel_AVERAGEA.md - - Excel Ceiling: build/reference/transformer/Excel/Excel_CEILING.md - - Excel Choose: build/reference/transformer/Excel/Excel_CHOOSE.md - - Excel Clean: build/reference/transformer/Excel/Excel_CLEAN.md - - Excel Code: build/reference/transformer/Excel/Excel_CODE.md - - Excel Combin: build/reference/transformer/Excel/Excel_COMBIN.md - - Excel Correl: build/reference/transformer/Excel/Excel_CORREL.md - - Excel Cos: build/reference/transformer/Excel/Excel_COS.md - - Excel Cosh: build/reference/transformer/Excel/Excel_COSH.md - - Excel Count: build/reference/transformer/Excel/Excel_COUNT.md - - Excel Counta: build/reference/transformer/Excel/Excel_COUNTA.md - - Excel Covar: build/reference/transformer/Excel/Excel_COVAR.md - - Excel Degrees: build/reference/transformer/Excel/Excel_DEGREES.md - - Excel Devsq: build/reference/transformer/Excel/Excel_DEVSQ.md - - Excel Even: build/reference/transformer/Excel/Excel_EVEN.md - - Excel Exact: build/reference/transformer/Excel/Excel_EXACT.md - - Excel Exp: build/reference/transformer/Excel/Excel_EXP.md - - Excel Fact: build/reference/transformer/Excel/Excel_FACT.md - - Excel False: build/reference/transformer/Excel/Excel_FALSE.md - - Excel Find: build/reference/transformer/Excel/Excel_FIND.md - - Excel Floor: build/reference/transformer/Excel/Excel_FLOOR.md - - Excel Forecast: build/reference/transformer/Excel/Excel_FORECAST.md - - Excel Fv: build/reference/transformer/Excel/Excel_FV.md - - Excel Geomean: build/reference/transformer/Excel/Excel_GEOMEAN.md - - Excel If: build/reference/transformer/Excel/Excel_IF.md - - Excel Int: build/reference/transformer/Excel/Excel_INT.md - - Excel Intercept: build/reference/transformer/Excel/Excel_INTERCEPT.md - - Excel Ipmt: build/reference/transformer/Excel/Excel_IPMT.md - - Excel Irr: build/reference/transformer/Excel/Excel_IRR.md - - Excel Large: build/reference/transformer/Excel/Excel_LARGE.md - - Excel Left: build/reference/transformer/Excel/Excel_LEFT.md - - Excel Ln: build/reference/transformer/Excel/Excel_LN.md - - Excel Log: build/reference/transformer/Excel/Excel_LOG.md - - Excel Log10: build/reference/transformer/Excel/Excel_LOG10.md - - Excel Max: build/reference/transformer/Excel/Excel_MAX.md - - Excel Maxa: build/reference/transformer/Excel/Excel_MAXA.md - - Excel Median: build/reference/transformer/Excel/Excel_MEDIAN.md - - Excel Mid: build/reference/transformer/Excel/Excel_MID.md - - Excel Min: build/reference/transformer/Excel/Excel_MIN.md - - Excel Mina: build/reference/transformer/Excel/Excel_MINA.md - - Excel Mirr: build/reference/transformer/Excel/Excel_MIRR.md - - Excel Mod: build/reference/transformer/Excel/Excel_MOD.md - - Excel Mode: build/reference/transformer/Excel/Excel_MODE.md - - Excel Normdist: build/reference/transformer/Excel/Excel_NORMDIST.md - - Excel Norminv: build/reference/transformer/Excel/Excel_NORMINV.md - - Excel Normsdist: build/reference/transformer/Excel/Excel_NORMSDIST.md - - Excel Normsinv: build/reference/transformer/Excel/Excel_NORMSINV.md - - Excel Not: build/reference/transformer/Excel/Excel_NOT.md - - Excel Nper: build/reference/transformer/Excel/Excel_NPER.md - - Excel Npv: build/reference/transformer/Excel/Excel_NPV.md - - Excel Odd: build/reference/transformer/Excel/Excel_ODD.md - - Excel Or: build/reference/transformer/Excel/Excel_OR.md - - Excel Pearson: build/reference/transformer/Excel/Excel_PEARSON.md - - Excel Percentile: build/reference/transformer/Excel/Excel_PERCENTILE.md - - Excel Percentrank: build/reference/transformer/Excel/Excel_PERCENTRANK.md - - Excel Pi: build/reference/transformer/Excel/Excel_PI.md - - Excel Pmt: build/reference/transformer/Excel/Excel_PMT.md - - Excel Poisson: build/reference/transformer/Excel/Excel_POISSON.md - - Excel Power: build/reference/transformer/Excel/Excel_POWER.md - - Excel Ppmt: build/reference/transformer/Excel/Excel_PPMT.md - - Excel Product: build/reference/transformer/Excel/Excel_PRODUCT.md - - Excel Proper: build/reference/transformer/Excel/Excel_PROPER.md - - Excel Pv: build/reference/transformer/Excel/Excel_PV.md - - Excel Radians: build/reference/transformer/Excel/Excel_RADIANS.md - - Excel Rand: build/reference/transformer/Excel/Excel_RAND.md - - Excel Rank: build/reference/transformer/Excel/Excel_RANK.md - - Excel Rate: build/reference/transformer/Excel/Excel_RATE.md - - Excel Replace: build/reference/transformer/Excel/Excel_REPLACE.md - - Excel Rept: build/reference/transformer/Excel/Excel_REPT.md - - Excel Right: build/reference/transformer/Excel/Excel_RIGHT.md - - Excel Roman: build/reference/transformer/Excel/Excel_ROMAN.md - - Excel Round: build/reference/transformer/Excel/Excel_ROUND.md - - Excel Rounddown: build/reference/transformer/Excel/Excel_ROUNDDOWN.md - - Excel Roundup: build/reference/transformer/Excel/Excel_ROUNDUP.md - - Excel Search: build/reference/transformer/Excel/Excel_SEARCH.md - - Excel Sign: build/reference/transformer/Excel/Excel_SIGN.md - - Excel Sin: build/reference/transformer/Excel/Excel_SIN.md - - Excel Sinh: build/reference/transformer/Excel/Excel_SINH.md - - Excel Slope: build/reference/transformer/Excel/Excel_SLOPE.md - - Excel Small: build/reference/transformer/Excel/Excel_SMALL.md - - Excel Sqrt: build/reference/transformer/Excel/Excel_SQRT.md - - Excel Standardize: build/reference/transformer/Excel/Excel_STANDARDIZE.md - - Excel Stdev: build/reference/transformer/Excel/Excel_STDEV.md - - Excel Stdeva: build/reference/transformer/Excel/Excel_STDEVA.md - - Excel Stdevp: build/reference/transformer/Excel/Excel_STDEVP.md - - Excel Stdevpa: build/reference/transformer/Excel/Excel_STDEVPA.md - - Excel Substitute: build/reference/transformer/Excel/Excel_SUBSTITUTE.md - - Excel Sum: build/reference/transformer/Excel/Excel_SUM.md - - Excel Sumproduct: build/reference/transformer/Excel/Excel_SUMPRODUCT.md - - Excel Sumsq: build/reference/transformer/Excel/Excel_SUMSQ.md - - Excel Sumx2my2: build/reference/transformer/Excel/Excel_SUMX2MY2.md - - Excel Sumx2py2: build/reference/transformer/Excel/Excel_SUMX2PY2.md - - Excel Sumxmy2: build/reference/transformer/Excel/Excel_SUMXMY2.md - - Excel Tan: build/reference/transformer/Excel/Excel_TAN.md - - Excel Tanh: build/reference/transformer/Excel/Excel_TANH.md - - Excel Tdist: build/reference/transformer/Excel/Excel_TDIST.md - - Excel True: build/reference/transformer/Excel/Excel_TRUE.md - - Excel Trunc: build/reference/transformer/Excel/Excel_TRUNC.md - - Excel Var: build/reference/transformer/Excel/Excel_VAR.md - - Excel Vara: build/reference/transformer/Excel/Excel_VARA.md - - Excel Varp: build/reference/transformer/Excel/Excel_VARP.md - - Excel Varpa: build/reference/transformer/Excel/Excel_VARPA.md - - Extract: - - Regex extract: build/reference/transformer/Extract/regexExtract.md - - Filter: - - Filter by length: build/reference/transformer/Filter/filterByLength.md - - Filter by regex: build/reference/transformer/Filter/filterByRegex.md - - Remove default stop words: build/reference/transformer/Filter/removeDefaultStopWords.md - - Remove empty values: build/reference/transformer/Filter/removeEmptyValues.md - - Remove remote stop words: build/reference/transformer/Filter/removeRemoteStopWords.md - - Remove stop words: build/reference/transformer/Filter/removeStopWords.md - - Remove values: build/reference/transformer/Filter/removeValues.md - - Geo: - - Retrieve coordinates: build/reference/transformer/Geo/RetrieveCoordinates.md - - Retrieve latitude: build/reference/transformer/Geo/RetrieveLatitude.md - - Retrieve longitude: build/reference/transformer/Geo/RetrieveLongitude.md - - Linguistic: - - Metaphone: build/reference/transformer/Linguistic/metaphone.md - - Normalize chars: build/reference/transformer/Linguistic/normalizeChars.md - - NYSIIS: build/reference/transformer/Linguistic/NYSIIS.md - - Soundex: build/reference/transformer/Linguistic/soundex.md - - Stem: build/reference/transformer/Linguistic/stem.md - - Metadata: - - File hash: build/reference/transformer/Metadata/fileHash.md - - Input file attributes: build/reference/transformer/Metadata/inputFileAttributes.md - - Input task attributes: build/reference/transformer/Metadata/inputTaskAttributes.md - - Normalize: - - Camel case: build/reference/transformer/Normalize/camelCase.md - - Capitalize: build/reference/transformer/Normalize/capitalize.md - - Clean HTML: build/reference/transformer/Normalize/htmlCleaner.md - - Encode URL: build/reference/transformer/Normalize/urlEncode.md - - Fix URI: build/reference/transformer/Normalize/uriFix.md - - Lower case: build/reference/transformer/Normalize/lowerCase.md - - Remove blanks: build/reference/transformer/Normalize/removeBlanks.md - - Remove duplicates: build/reference/transformer/Normalize/removeDuplicates.md - - Remove parentheses: build/reference/transformer/Normalize/removeParentheses.md - - Remove special chars: build/reference/transformer/Normalize/removeSpecialChars.md - - Sort words: build/reference/transformer/Normalize/sortWords.md - - Strip non-alphabetic characters: build/reference/transformer/Normalize/alphaReduce.md - - Trim: build/reference/transformer/Normalize/trim.md - - Upper case: build/reference/transformer/Normalize/upperCase.md - - Numeric: - - Aggregate numbers: build/reference/transformer/Numeric/aggregateNumbers.md - - Compare numbers: build/reference/transformer/Numeric/compareNumbers.md - - Convert Number Base: build/reference/transformer/Numeric/cmem-plugin-number-conversion.md - - Extract physical quantity: build/reference/transformer/Numeric/extractPhysicalQuantity.md - - Format number: build/reference/transformer/Numeric/formatNumber.md - - Logarithm: build/reference/transformer/Numeric/log.md - - Normalize physical quantity: build/reference/transformer/Numeric/PhysicalQuantitiesNormalizer.md - - Numeric operation: build/reference/transformer/Numeric/numOperation.md - - Numeric reduce: build/reference/transformer/Numeric/numReduce.md - - Parser: - - Parse date: build/reference/transformer/Parser/DateTypeParser.md - - Parse float: build/reference/transformer/Parser/FloatTypeParser.md - - Parse geo coordinate: build/reference/transformer/Parser/GeoCoordinateParser.md - - Parse geo location: build/reference/transformer/Parser/GeoLocationParser.md - - Parse integer: build/reference/transformer/Parser/IntegerParser.md - - Parse ISIN: build/reference/transformer/Parser/IsinParser.md - - Parse SKOS term: build/reference/transformer/Parser/SkosTypeParser.md - - Parse string: build/reference/transformer/Parser/StringParser.md - - Replace: - - Excel map: build/reference/transformer/Replace/excelMap.md - - Map: build/reference/transformer/Replace/map.md - - Map with default: build/reference/transformer/Replace/mapWithDefaultInput.md - - Regex replace: build/reference/transformer/Replace/regexReplace.md - - Replace: build/reference/transformer/Replace/replace.md - - SPARQL: - - Escape SPARQL multiline literal: build/reference/transformer/SPARQL/escape_multiline_literal.md - - Escape SPARQL plain literal: build/reference/transformer/SPARQL/escape_literal.md - - Selection: - - Coalesce (first non-empty input): build/reference/transformer/Selection/coalesce.md - - Regex selection: build/reference/transformer/Selection/regexSelect.md - - Sequence: - - Count values: build/reference/transformer/Sequence/count.md - - Get value by index: build/reference/transformer/Sequence/getValueByIndex.md - - Sequence values to indexes: build/reference/transformer/Sequence/toSequenceIndex.md - - Sort: build/reference/transformer/Sequence/sort.md - - Substring: - - Strip postfix: build/reference/transformer/Substring/stripPostfix.md - - Strip prefix: build/reference/transformer/Substring/stripPrefix.md - - Strip URI prefix: build/reference/transformer/Substring/stripUriPrefix.md - - Substring: build/reference/transformer/Substring/substring.md - - Until character: build/reference/transformer/Substring/untilCharacter.md - - Template: - - Evaluate template: build/reference/transformer/Template/TemplateTransformer.md - - Tokenization: - - Camel case tokenizer: build/reference/transformer/Tokenization/camelcasetokenizer.md - - Tokenize: build/reference/transformer/Tokenization/tokenize.md - - Uncategorized: - - Convert currency values: build/reference/transformer/Uncategorized/cmem_plugin_currencies-transform.md - - jq: build/reference/transformer/Uncategorized/cmem-plugin-jq-transform.md - - Random value: build/reference/transformer/Uncategorized/cmem_plugin_random-GenerateValues.md - - Validation: - - Validate date after: build/reference/transformer/Validation/validateDateAfter.md - - Validate date range: build/reference/transformer/Validation/validateDateRange.md - - Validate number of values: build/reference/transformer/Validation/validateNumberOfValues.md - - Validate numeric range: build/reference/transformer/Validation/validateNumericRange.md - - Validate regex: build/reference/transformer/Validation/validateRegex.md - - Validate URI: build/reference/transformer/Validation/validate_uri.md - - Value: - - Combined input hash: build/reference/transformer/Value/inputHash.md - - Constant: build/reference/transformer/Value/constant.md - - Constant URI: build/reference/transformer/Value/constantUri.md - - Dataset parameter: build/reference/transformer/Value/datasetParameter.md - - Default Value: build/reference/transformer/Value/defaultValue.md - - Empty value: build/reference/transformer/Value/emptyValue.md - - Per-value hash: build/reference/transformer/Value/perValueHash.md - - Random number: build/reference/transformer/Value/randomNumber.md - - Read parameter: build/reference/transformer/Value/readParameter.md - - ULID: build/reference/transformer/Value/cmem-plugin-ulid.md - - UUID: build/reference/transformer/Value/uuid.md - - UUID Convert: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUIDConvert.md - - UUID Version: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUIDVersion.md - - UUIDv1: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID1.md - - UUIDv1 to UUIDv6: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID1ToUUID6.md - - UUIDv3: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID3.md - - UUIDv4: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID4.md - - UUIDv5: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID5.md - - UUIDv6: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID6.md - - UUIDv7: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID7.md - - UUIDv8: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID8.md - - Variables: - - Set execution variable: build/reference/transformer/Variables/setExecutionVariable.md - - Mapping Creator: - - build/mapping-creator/index.md - - Rule Operators: - - build/rule-operators/index.md - - Rule Blocks: - - build/rule-blocks/index.md - - Define Prefixes / Namespaces: - - build/define-prefixes-namespaces/index.md - - Cool IRIs: - - build/cool-iris/index.md - - Lift Tabular Data: - - build/lift-data-from-tabular-data-such-as-csv-xslx-or-database-tables/index.md - - Lift Hierarchical Data: - - build/lift-data-from-json-and-xml-sources/index.md - - Lift Web API Data: - - build/extracting-data-from-a-web-api/index.md - - Workflows: - - build/workflows/index.md - - Incremental Database Loading: - - build/loading-jdbc-datasets-incrementally/index.md - - Connect to Snowflake: - - build/snowflake-tutorial/index.md - - Active learning: - - build/active-learning/index.md - - Link Intrusion Detection Systems to Open-Source INTelligence: - - build/tutorial-how-to-link-ids-to-osint/index.md - - Define the interfaces: - - build/tutorial-how-to-link-ids-to-osint/define-the-interfaces/index.md - - Define the need: - - build/tutorial-how-to-link-ids-to-osint/define-the-need/index.md - - lift data from STIX 2.1 data of mitre attack: - - build/tutorial-how-to-link-ids-to-osint/lift-data-from-STIX-2.1-data-of-mitre-attack/index.md - - lift data from YAML data of hayabusa sigma: - - build/tutorial-how-to-link-ids-to-osint/lift-data-from-YAML-data-of-hayabusa-sigma/index.md - - link IDS event to KG: - - build/tutorial-how-to-link-ids-to-osint/link-IDS-event-to-KG/index.md - - link IDS event to KG via cmem: - - build/tutorial-how-to-link-ids-to-osint/link-IDS-event-to-KG-via-cmem/index.md - - Project and Global Variables: - - build/variables/index.md - - Evaluate Template Operator: - - build/evaluate-template/index.md - - Build Knowledge Graphs from Kafka Topics: - - build/kafka-consumer/index.md - - Spark: - - build/spark/index.md -- Explore: - - Explore: explore-and-author/index.md - - Knowledge graphs: - - Graph Exploration: explore-and-author/graph-exploration/index.md - - Building a Customized User Interface: - - Building a Customized User Interface: explore-and-author/graph-exploration/building-a-customized-user-interface/index.md - - Workflow Trigger: - - explore-and-author/graph-exploration/building-a-customized-user-interface/workflow-trigger/index.md - - Node Shapes: - - explore-and-author/graph-exploration/building-a-customized-user-interface/node-shapes/index.md - - Property Shapes: - - explore-and-author/graph-exploration/building-a-customized-user-interface/property-shapes/index.md - - Datatypes: - - explore-and-author/graph-exploration/building-a-customized-user-interface/datatype-reference/index.md - - SPARQL Constraints: - - explore-and-author/graph-exploration/building-a-customized-user-interface/sparql-constraints/index.md - - Graph Insights: - - explore-and-author/graph-exploration/graph-insights/index.md - - Core Concepts: explore-and-author/graph-exploration/graph-insights/concepts.md - - Graph Insights Tutorial – Supply Chain Risk Analysis: explore-and-author/graph-exploration/graph-insights/tutorial.md - - Features: - - explore-and-author/graph-exploration/graph-insights/features/index.md - - Application & Settings: explore-and-author/graph-exploration/graph-insights/features/application-settings.md - - Exploration Canvas: explore-and-author/graph-exploration/graph-insights/features/canvas-ui.md - - Class Tree: explore-and-author/graph-exploration/graph-insights/features/category-tree.md - - Groups: explore-and-author/graph-exploration/graph-insights/features/groups.md - - Resource Table: explore-and-author/graph-exploration/graph-insights/features/objects-table.md - - Resources: explore-and-author/graph-exploration/graph-insights/features/objects.md - - Connections: explore-and-author/graph-exploration/graph-insights/features/connections.md - - Persistence: explore-and-author/graph-exploration/graph-insights/features/persistence.md - - Navigating to Corporate Memory: explore-and-author/graph-exploration/graph-insights/navigating-to-cmem.md - - Statement Annotations: - - explore-and-author/graph-exploration/statement-annotations/index.md - - Versioning of Graph Changes: - - explore-and-author/graph-exploration/versioning-of-graph-changes/index.md - - Business knowledge editor: - - explore-and-author/bke-module/index.md - - Visually authoring ontologies: - - explore-and-author/bke-module/visually-authoring-ontologies/index.md - - Queries: - - explore-and-author/query-module/index.md - - Thesauri: - - explore-and-author/thesauri-management/index.md - - Charts: - - explore-and-author/charts-catalog/index.md - - Companion AI chat: - - explore-and-author/companion/index.md - - Services integrations: - - explore-and-author/embedding-services-via-the-integrations-module/index.md - - Link rules: - - explore-and-author/link-rules/index.md - - Application view: - - explore-and-author/workspace-configuration/index.md -- Consume: - - Consume: consume/index.md - - Consuming Graphs in Power BI: - - consume/consuming-graphs-in-power-bi/index.md - - Consuming Graphs in Redash: - - consume/consuming-graphs-with-redash/index.md - - Consuming Graphs with SQL Databases: - - consume/consuming-graphs-with-sql-databases/index.md - - Provide Data in any Format via a Custom API: - - consume/provide-data-in-any-format-via-a-custom-api/index.md - - Populate Data to Neo4j: - - consume/populate-data-to-neo4j/index.md - - Populate Data to Apache Kafka: - - consume/consume-graphs-in-apache-kafka/index.md -- Distribution: - - Distribution: distribution/index.md - - Marketplace: - - distribution/marketplace/index.md -- Deploy and Configure: - - Deploy and Configure: deploy-and-configure/index.md - - System Architecture: - - deploy-and-configure/system-architecture/index.md - - Requirements: - - deploy-and-configure/requirements/index.md - - deploy-and-configure/requirements/graph-insights-sizing.md - - deploy-and-configure/requirements/triple-store-hardware-sizing.md - - Installation: - - Installation: deploy-and-configure/installation/index.md - - 'Scenario: Single Node Cloud Installation': - - deploy-and-configure/installation/scenario-single-node-cloud-installation/index.md - - 'Scenario: Local Installation': - - deploy-and-configure/installation/scenario-local-installation/index.md - - 'Scenario: Kubernetes Deployment': - - deploy-and-configure/installation/scenario-k8s-deployment/index.md - - Migrating Stores: - - deploy-and-configure/installation/migrating-stores/index.md - - Configuration: - - Configuration: deploy-and-configure/configuration/index.md - - Docker Orchestration: - - deploy-and-configure/configuration/docker-orchestration/index.md - - Build: - - Build (DataIntegration): deploy-and-configure/configuration/dataintegration/index.md - - Adding JDBC drivers: - - deploy-and-configure/configuration/dataintegration/jdbc/index.md - - Activity Reference: - - deploy-and-configure/configuration/dataintegration/activity-reference/index.md - - Explore: - - Explore: deploy-and-configure/configuration/explore/index.md - - Explore backend: - - Explore backend: deploy-and-configure/configuration/explore/dataplatform/index.md - - General: deploy-and-configure/configuration/explore/dataplatform/application-full.md - - OAuth: deploy-and-configure/configuration/explore/dataplatform/application-oauth-full.md - - Store: - - GraphDB: deploy-and-configure/configuration/explore/dataplatform/application-graphdb-full.md - - HTTP: deploy-and-configure/configuration/explore/dataplatform/application-http-full.md - - In-Memory: deploy-and-configure/configuration/explore/dataplatform/application-inmemory-full.md - - Virtuoso: deploy-and-configure/configuration/explore/dataplatform/application-virtuoso-full.md - - deploy-and-configure/configuration/explore/graph-resource-pattern/index.md - - Graph Insights: - - deploy-and-configure/configuration/graphinsights/index.md - - Keycloak: - - Keycloak: deploy-and-configure/configuration/keycloak/index.md - - Changing Passwords and Keys: - - deploy-and-configure/configuration/keycloak/change-passwords-and-keys/index.md - - Using an external Keycloak: - - deploy-and-configure/configuration/keycloak/using-external-keycloak/index.md - - Quad-Store: - - deploy-and-configure/configuration/quad-store-configuration/index.md - - Reverse Proxy: - - deploy-and-configure/configuration/reverse-proxy/index.md - - Access Conditions: - - deploy-and-configure/configuration/access-conditions/index.md - - Label Resolution and Full-Text Search: - - deploy-and-configure/configuration/label-resolution-and-full-text-search/index.md - - Production-Ready Settings: - - deploy-and-configure/configuration/production-ready-settings/index.md - - Caveats: - - deploy-and-configure/configuration/caveats/index.md -- Automate: - - Automate: automate/index.md - - cmemc: - - cmemc - Command Line Interface: automate/cmemc-command-line-interface/index.md - - Installation: - - automate/cmemc-command-line-interface/installation/index.md - - Configuration: - - Configuration: automate/cmemc-command-line-interface/configuration/index.md - - File-based: - - automate/cmemc-command-line-interface/configuration/file-based-configuration/index.md - - Environment-based: - - automate/cmemc-command-line-interface/configuration/environment-based-configuration/index.md - - Completion Setup: - - automate/cmemc-command-line-interface/configuration/completion-setup/index.md - - Getting Credentials: - - automate/cmemc-command-line-interface/configuration/getting-credentials-from-external-processes/index.md - - Certificate Handling: - - automate/cmemc-command-line-interface/configuration/certificate-handling-and-ssl-verification/index.md - - Invocation: - - Invocation: automate/cmemc-command-line-interface/invocation/index.md - - Docker Image: - - automate/cmemc-command-line-interface/invocation/docker-image/index.md - - Github Action: - - automate/cmemc-command-line-interface/invocation/github-action/index.md - - Gitlab Pipeline: - - automate/cmemc-command-line-interface/invocation/gitlab-pipeline/index.md - - SPARQL Scripts: - - automate/cmemc-command-line-interface/invocation/sparql-scripts/index.md - - Finding and Filtering Objects: - - automate/cmemc-command-line-interface/finding-and-filtering-objects/index.md - - Scripting with cmemc: - - automate/cmemc-command-line-interface/scripting-with-cmemc/index.md - - Workflow Execution: - - automate/cmemc-command-line-interface/workflow-execution-and-orchestration/index.md - - Backup and Restore: - - automate/cmemc-command-line-interface/backup-and-restore/index.md - - Troubleshooting: - - automate/cmemc-command-line-interface/troubleshooting-and-caveats/index.md - - Command Reference: - - automate/cmemc-command-line-interface/command-reference/index.md - - Admin: - - automate/cmemc-command-line-interface/command-reference/admin/index.md - - Acl: - - automate/cmemc-command-line-interface/command-reference/admin/acl/index.md - - Client: - - automate/cmemc-command-line-interface/command-reference/admin/client/index.md - - Metrics: - - automate/cmemc-command-line-interface/command-reference/admin/metrics/index.md - - Migration: - - automate/cmemc-command-line-interface/command-reference/admin/migration/index.md - - Store: - - automate/cmemc-command-line-interface/command-reference/admin/store/index.md - - User: - - automate/cmemc-command-line-interface/command-reference/admin/user/index.md - - View: - - automate/cmemc-command-line-interface/command-reference/admin/view/index.md - - Workspace: - - automate/cmemc-command-line-interface/command-reference/admin/workspace/index.md - - Python: - - automate/cmemc-command-line-interface/command-reference/admin/workspace/python/index.md - - Config: - - automate/cmemc-command-line-interface/command-reference/config/index.md - - Dataset: - - automate/cmemc-command-line-interface/command-reference/dataset/index.md - - Graph: - - automate/cmemc-command-line-interface/command-reference/graph/index.md - - Imports: - - automate/cmemc-command-line-interface/command-reference/graph/imports/index.md - - Insights: - - automate/cmemc-command-line-interface/command-reference/graph/insights/index.md - - Validation: - - automate/cmemc-command-line-interface/command-reference/graph/validation/index.md - - Package: - - automate/cmemc-command-line-interface/command-reference/package/index.md - - Project: - - automate/cmemc-command-line-interface/command-reference/project/index.md - - File: - - automate/cmemc-command-line-interface/command-reference/project/file/index.md - - Variable: - - automate/cmemc-command-line-interface/command-reference/project/variable/index.md - - Query: - - automate/cmemc-command-line-interface/command-reference/query/index.md - - Vocabulary: - - automate/cmemc-command-line-interface/command-reference/vocabulary/index.md - - Cache: - - automate/cmemc-command-line-interface/command-reference/vocabulary/cache/index.md - - Workflow: - - automate/cmemc-command-line-interface/command-reference/workflow/index.md - - Scheduler: - - automate/cmemc-command-line-interface/command-reference/workflow/scheduler/index.md - - Processing Data with variable input Workflows: - - automate/processing-data-with-variable-input-workflows/index.md - - Scheduling Workflows: - - automate/scheduling-workflows/index.md - - Continuous Integration: - - automate/continuous-integration/index.md -- Develop: - - Develop: develop/index.md - - Accessing Graphs with Java Applications: - - develop/accessing-graphs-with-java-applications/index.md - - Python Plugins: - - Python Plugins: develop/python-plugins/index.md - - Installation and Usage: - - develop/python-plugins/installation/index.md - - Development: - - develop/python-plugins/development/index.md - - Setup and Configuration: - - develop/python-plugins/setup/index.md - - Marketplace Packages: - - Marketplace Packages: develop/packages/index.md - - Installation and Management: - - develop/packages/installation/index.md - - Development and Publication: - - Development and Publication: develop/packages/development/index.md - - Tutorial: - - develop/packages/development/tutorial/index.md - - cmempy - Python API: - - develop/cmempy-python-api/index.md - - cmem-client - Python API: - - 'cmem-client: Python API': develop/cmem-client-api/index.md - - API Reference: - - API Reference: develop/cmem-client-api/api-reference/index.md - - client: - - develop/cmem-client-api/api-reference/client/index.md - - config: - - develop/cmem-client-api/api-reference/config/index.md - - exceptions: - - develop/cmem-client-api/api-reference/exceptions/index.md - - logging_utils: - - develop/cmem-client-api/api-reference/logging_utils/index.md - - auth_provider: - - abc: - - develop/cmem-client-api/api-reference/auth_provider/abc/index.md - - client_credentials: - - develop/cmem-client-api/api-reference/auth_provider/client_credentials/index.md - - password: - - develop/cmem-client-api/api-reference/auth_provider/password/index.md - - prefetched_token: - - develop/cmem-client-api/api-reference/auth_provider/prefetched_token/index.md - - provided_token: - - develop/cmem-client-api/api-reference/auth_provider/provided_token/index.md - - components: - - deployment: - - develop/cmem-client-api/api-reference/components/deployment/index.md - - graph_store: - - develop/cmem-client-api/api-reference/components/graph_store/index.md - - marketplace: - - develop/cmem-client-api/api-reference/components/marketplace/index.md - - sparql_wrapper: - - develop/cmem-client-api/api-reference/components/sparql_wrapper/index.md - - workspace: - - develop/cmem-client-api/api-reference/components/workspace/index.md - - models: - - access_condition: - - develop/cmem-client-api/api-reference/models/access_condition/index.md - - base: - - develop/cmem-client-api/api-reference/models/base/index.md - - common: - - develop/cmem-client-api/api-reference/models/common/index.md - - credentials: - - develop/cmem-client-api/api-reference/models/credentials/index.md - - dataset: - - develop/cmem-client-api/api-reference/models/dataset/index.md - - error: - - develop/cmem-client-api/api-reference/models/error/index.md - - graph: - - develop/cmem-client-api/api-reference/models/graph/index.md - - graph_import: - - develop/cmem-client-api/api-reference/models/graph_import/index.md - - graph_insight: - - develop/cmem-client-api/api-reference/models/graph_insight/index.md - - item: - - develop/cmem-client-api/api-reference/models/item/index.md - - keycloak_client: - - develop/cmem-client-api/api-reference/models/keycloak_client/index.md - - logging_config: - - develop/cmem-client-api/api-reference/models/logging_config/index.md - - marshalling_plugins: - - develop/cmem-client-api/api-reference/models/marshalling_plugins/index.md - - package: - - develop/cmem-client-api/api-reference/models/package/index.md - - project: - - develop/cmem-client-api/api-reference/models/project/index.md - - python_install: - - develop/cmem-client-api/api-reference/models/python_install/index.md - - python_package: - - develop/cmem-client-api/api-reference/models/python_package/index.md - - query_catalog: - - develop/cmem-client-api/api-reference/models/query_catalog/index.md - - resource: - - develop/cmem-client-api/api-reference/models/resource/index.md - - scheduler: - - develop/cmem-client-api/api-reference/models/scheduler/index.md - - status: - - develop/cmem-client-api/api-reference/models/status/index.md - - task: - - develop/cmem-client-api/api-reference/models/task/index.md - - token: - - develop/cmem-client-api/api-reference/models/token/index.md - - url: - - develop/cmem-client-api/api-reference/models/url/index.md - - user: - - develop/cmem-client-api/api-reference/models/user/index.md - - validation: - - develop/cmem-client-api/api-reference/models/validation/index.md - - variable: - - develop/cmem-client-api/api-reference/models/variable/index.md - - vocabulary: - - develop/cmem-client-api/api-reference/models/vocabulary/index.md - - workflow: - - develop/cmem-client-api/api-reference/models/workflow/index.md - - workspace_config: - - develop/cmem-client-api/api-reference/models/workspace_config/index.md - - workspace_plugin: - - develop/cmem-client-api/api-reference/models/workspace_plugin/index.md - - workspace_status: - - develop/cmem-client-api/api-reference/models/workspace_status/index.md - - repositories: - - access_conditions: - - develop/cmem-client-api/api-reference/repositories/access_conditions/index.md - - client_accounts: - - develop/cmem-client-api/api-reference/repositories/client_accounts/index.md - - datasets: - - develop/cmem-client-api/api-reference/repositories/datasets/index.md - - files: - - develop/cmem-client-api/api-reference/repositories/files/index.md - - graph_imports: - - develop/cmem-client-api/api-reference/repositories/graph_imports/index.md - - graph_insights: - - develop/cmem-client-api/api-reference/repositories/graph_insights/index.md - - graphs: - - develop/cmem-client-api/api-reference/repositories/graphs/index.md - - marketplace_packages: - - develop/cmem-client-api/api-reference/repositories/marketplace_packages/index.md - - projects: - - develop/cmem-client-api/api-reference/repositories/projects/index.md - - python_packages: - - develop/cmem-client-api/api-reference/repositories/python_packages/index.md - - queries: - - develop/cmem-client-api/api-reference/repositories/queries/index.md - - schedulers: - - develop/cmem-client-api/api-reference/repositories/schedulers/index.md - - user_accounts: - - develop/cmem-client-api/api-reference/repositories/user_accounts/index.md - - validations: - - develop/cmem-client-api/api-reference/repositories/validations/index.md - - variables: - - develop/cmem-client-api/api-reference/repositories/variables/index.md - - vocabularies: - - develop/cmem-client-api/api-reference/repositories/vocabularies/index.md - - workflows: - - develop/cmem-client-api/api-reference/repositories/workflows/index.md - - workspace_configs: - - develop/cmem-client-api/api-reference/repositories/workspace_configs/index.md - - base: - - abc: - - develop/cmem-client-api/api-reference/repositories/base/abc/index.md - - paged_list: - - develop/cmem-client-api/api-reference/repositories/base/paged_list/index.md - - plain_list: - - develop/cmem-client-api/api-reference/repositories/base/plain_list/index.md - - task_search: - - develop/cmem-client-api/api-reference/repositories/base/task_search/index.md - - protocols: - - create_item: - - develop/cmem-client-api/api-reference/repositories/protocols/create_item/index.md - - delete_item: - - develop/cmem-client-api/api-reference/repositories/protocols/delete_item/index.md - - export_item: - - develop/cmem-client-api/api-reference/repositories/protocols/export_item/index.md - - import_item: - - develop/cmem-client-api/api-reference/repositories/protocols/import_item/index.md - - update_item: - - develop/cmem-client-api/api-reference/repositories/protocols/update_item/index.md - - cmemc - Python Scripts: - - develop/cmemc-scripts/index.md - - Build (DataIntegration) APIs: - - develop/dataintegration-apis/index.md - - Explore backend APIs: - - develop/dataplatform-apis/index.md -- Release Notes: - - Corporate Memory 26.2.0: - - release-notes/corporate-memory-26-2/index.md - - Corporate Memory 26.1.3: - - release-notes/corporate-memory-26-1/index.md - - Corporate Memory 25.3.4: - - release-notes/corporate-memory-25-3/index.md - - Corporate Memory 25.2.7: - - release-notes/corporate-memory-25-2/index.md - - Corporate Memory 25.1.2: - - release-notes/corporate-memory-25-1/index.md - - Corporate Memory 24.3.2: - - release-notes/corporate-memory-24-3/index.md - - Corporate Memory 24.2.1: - - release-notes/corporate-memory-24-2/index.md - - Corporate Memory 24.1.3: - - release-notes/corporate-memory-24-1/index.md - - Corporate Memory 23.3.2: - - release-notes/corporate-memory-23-3/index.md - - Corporate Memory 23.2.1: - - release-notes/corporate-memory-23-2/index.md - - Corporate Memory 23.1.3: - - release-notes/corporate-memory-23-1/index.md - - Corporate Memory 22.2.3: - - release-notes/corporate-memory-22-2/index.md - - Corporate Memory 22.1: - - release-notes/corporate-memory-22-1/index.md - - Corporate Memory 21.11: - - release-notes/corporate-memory-21-11/index.md - - Corporate Memory 21.06: - - release-notes/corporate-memory-21-06/index.md - - Corporate Memory 21.04: - - release-notes/corporate-memory-21-04/index.md - - Corporate Memory 21.02: - - release-notes/corporate-memory-21-02/index.md - - Corporate Memory 20.12: - - release-notes/corporate-memory-20-12/index.md - - Corporate Memory 20.10: - - release-notes/corporate-memory-20-10/index.md - - Corporate Memory 20.06: - - release-notes/corporate-memory-20-06/index.md - - Corporate Memory 20.03: - - release-notes/corporate-memory-20-03/index.md - - Corporate Memory 19.10: - - release-notes/corporate-memory-19-10/index.md -- Tutorials: - - tutorials/index.md + - Build: + - Build: build/index.md + - Introduction to the User Interface: + - build/introduction-to-the-user-interface/index.md + - Integrations: + - build/integrations/index.md + - Task and Operator Reference: + - Task and Operator Reference: build/reference/index.md + - Aggregators: + - build/reference/aggregator/index.md + - And: build/reference/aggregator/min.md + - Average: build/reference/aggregator/average.md + - Euclidian distance: build/reference/aggregator/quadraticMean.md + - First non-empty score: build/reference/aggregator/firstNonEmpty.md + - Geometric mean: build/reference/aggregator/geometricMean.md + - Handle missing values: build/reference/aggregator/handleMissingValues.md + - Negate: build/reference/aggregator/negate.md + - Or: build/reference/aggregator/max.md + - Scale: build/reference/aggregator/scale.md + - Custom Workflow Tasks: + - build/reference/customtask/index.md + - Add project files: build/reference/customtask/addProjectFiles.md + - Build Packages: build/reference/customtask/cmem_plugin_packages-BuildPackages.md + - Bump Version in Package Manifest: build/reference/customtask/cmem_plugin_packages-BumpVersions.md + - Cancel Workflow: build/reference/customtask/CancelWorkflow.md + - Clear dataset: build/reference/customtask/clearDataset.md + - Combine CSV files: build/reference/customtask/combine-csv.md + - Concatenate to file: build/reference/customtask/ConcatenateToFile.md + - Create Embeddings: build/reference/customtask/cmem_plugin_llm-CreateEmbeddings.md + - Create or Update Graph Insights Snapshots: build/reference/customtask/cmem_plugin_graph_insights-Update.md + - Create/Update Salesforce Objects: build/reference/customtask/cmem_plugin_salesforce-workflow-operations-SobjectCreate.md + - Delete project files: build/reference/customtask/deleteProjectFiles.md + - Distinct by: build/reference/customtask/DistinctBy.md + - Download CKAN files: build/reference/customtask/cmem_plugin_ckan-Download.md + - Download file: build/reference/customtask/downloadFile.md + - Download Git files: build/reference/customtask/cmem_plugin_git-Download.md + - Download Nextcloud files: build/reference/customtask/cmem_plugin_nextcloud-Download.md + - Download Office 365 Files: build/reference/customtask/cmem_plugin_office365-Download.md + - Download SSH files: build/reference/customtask/cmem_plugin_ssh-Download.md + - Evaluate template: build/reference/customtask/Template.md + - Execute a command in a kubernetes pod: build/reference/customtask/cmem_plugin_kubernetes-Execute.md + - Execute commands via SSH: build/reference/customtask/cmem_plugin_ssh-Execute.md + - Execute Instructions: build/reference/customtask/cmem_plugin_llm-ExecuteInstructions.md + - Execute REST requests: build/reference/customtask/eccencaRestOperator.md + - Execute Spark function: build/reference/customtask/SparkFunction.md + - Extract from PDF files: build/reference/customtask/cmem_plugin_pdf_extract-pdf_extract-PdfExtract.md + - Generate base36 IRDIs: build/reference/customtask/cmem_plugin_irdi-workflow-irdi_plugin-IrdiPlugin.md + - Generate random values: build/reference/customtask/cmem_plugin_random-GenerateEntities.md + - Generate SHACL shapes from data: build/reference/customtask/cmem_plugin_shapes-plugin_shapes-ShapesPlugin.md + - Get emails: build/reference/customtask/cmem-plugin-email-GetEmails.md + - Get project files: build/reference/customtask/getProjectFiles.md + - Get workflow report: build/reference/customtask/cmem_plugin_wfreports_get_report.md + - GraphQL query: build/reference/customtask/cmem_plugin_graphql-workflow-graphql-GraphQLPlugin.md + - Install Packages: build/reference/customtask/cmem_plugin_packages-InstallPackages.md + - Join tables: build/reference/customtask/Merge.md + - jq: build/reference/customtask/cmem-plugin-jq-workflow.md + - JQL query: build/reference/customtask/cmem_plugin_jira-JqlQuery.md + - JSON to File: build/reference/customtask/jsonToFile.md + - Kafka Consumer (Receive Messages): build/reference/customtask/cmem_plugin_kafka-ReceiveMessages.md + - Kafka Producer (Send Messages): build/reference/customtask/cmem_plugin_kafka-SendMessages.md + - List Git files: build/reference/customtask/cmem_plugin_git-List.md + - List Nextcloud files: build/reference/customtask/cmem_plugin_nextcloud-List.md + - List Office 365 Files: build/reference/customtask/cmem_plugin_office365-List.md + - List project files: build/reference/customtask/cmem_plugin_project_resources-List.md + - List SSH files: build/reference/customtask/cmem_plugin_ssh-List.md + - Merge tables: build/reference/customtask/MultiTableMerge.md + - Normalize units of measurement: build/reference/customtask/ucumNormalizationTask.md + - OAuth2 Authentication: build/reference/customtask/cmem_plugin_auth-workflow-auth-OAuth2.md + - Office 365 Upload Files: build/reference/customtask/cmem_plugin_office365-Upload.md + - Parse JSON: build/reference/customtask/JsonParserOperator.md + - Parse XML: build/reference/customtask/XmlParserOperator.md + - Parse YAML: build/reference/customtask/cmem_plugin_yaml-parse.md + - Pivot: build/reference/customtask/Pivot.md + - Publish Packages: build/reference/customtask/cmem_plugin_packages-PublishPackages.md + - Reason: build/reference/customtask/cmem_plugin_reason-plugin_reason-ReasonPlugin.md + - Request RDF triples: build/reference/customtask/tripleRequestOperator.md + - Run Apify actor: build/reference/customtask/cmem_plugin_apify-RunActor.md + - Scheduler: build/reference/customtask/Scheduler.md + - Search addresses: build/reference/customtask/SearchAddresses.md + - Search for Logs: build/reference/customtask/cmem_plugin_logpoint-search_logs_task-RetrieveLogs.md + - Search Vector Embeddings: build/reference/customtask/cmem_plugin_pgvector-Search.md + - Select random entities: build/reference/customtask/cmem_plugin_random-SelectEntities.md + - Send email: build/reference/customtask/SendEMail.md + - Send Mattermost messages: build/reference/customtask/cmem_plugin_mattermost.md + - Set execution variable: build/reference/customtask/setExecutionVariableOperator.md + - Set or Overwrite parameters: build/reference/customtask/cmem_plugin_parameters-ParametersPlugin.md + - Set parameters: build/reference/customtask/setParameters.md + - SHACL validation with pySHACL: build/reference/customtask/shacl-pyshacl.md + - SOQL query (Salesforce): build/reference/customtask/cmem_plugin_salesforce-SoqlQuery.md + - Spark SQL query: build/reference/customtask/CustomSQLExecution.md + - SPARQL Construct query: build/reference/customtask/sparqlCopyOperator.md + - SPARQL Select query: build/reference/customtask/sparqlSelectOperator.md + - SPARQL Update query: build/reference/customtask/sparqlUpdateOperator.md + - Split file: build/reference/customtask/cmem_plugin_splitfile-plugin_splitfile-SplitFilePlugin.md + - SQL Update query: build/reference/customtask/sqlUpdateQueryOperator.md + - Start Workflow per Entity: build/reference/customtask/cmem_plugin_loopwf-task-StartWorkflow.md + - Store Vector Embeddings: build/reference/customtask/cmem_plugin_pgvector-Store.md + - Uninstall Packages: build/reference/customtask/cmem_plugin_packages-UninstallPackages.md + - Unpivot: build/reference/customtask/Unpivot.md + - Upload File to Knowledge Graph: build/reference/customtask/eccencaDataPlatformGraphStoreFileUploadOperator.md + - Upload files to CKAN: build/reference/customtask/cmem_plugin_ckan-Upload.md + - Upload files to Nextcloud: build/reference/customtask/cmem_plugin_nextcloud-Upload.md + - Upload Git files: build/reference/customtask/cmem_plugin_git-Upload.md + - Upload local files: build/reference/customtask/cmem_plugin_project_resources-UploadLocalFiles.md + - Upload SSH files: build/reference/customtask/cmem_plugin_ssh-Upload.md + - Validate Entities: build/reference/customtask/cmem_plugin_validation-validate-ValidateEntities.md + - Validate Knowledge Graph: build/reference/customtask/cmem_plugin_validation-validate-ValidateGraph.md + - Validate OWL consistency: build/reference/customtask/cmem_plugin_reason-plugin_validate-ValidatePlugin.md + - Validate XML: build/reference/customtask/validateXsdOperator.md + - XSLT: build/reference/customtask/xsltOperator.md + - Datasets: + - build/reference/dataset/index.md + - Alignment: build/reference/dataset/alignment.md + - Avro: build/reference/dataset/avro.md + - Binary file: build/reference/dataset/binaryFile.md + - CSV: build/reference/dataset/csv.md + - Embedded Spark SQL view: build/reference/dataset/sparkView.md + - Embedded SQL endpoint: build/reference/dataset/sqlEndpoint.md + - Excel: build/reference/dataset/excel.md + - Excel (Google Drive): build/reference/dataset/googlespreadsheet.md + - Excel (OneDrive, Office365): build/reference/dataset/office365preadsheet.md + - Hive database: build/reference/dataset/Hive.md + - In-memory Knowledge Graph: build/reference/dataset/inMemory.md + - Internal dataset: build/reference/dataset/internal.md + - Internal dataset (single graph): build/reference/dataset/LocalInternalDataset.md + - JSON: build/reference/dataset/json.md + - Knowledge Graph: build/reference/dataset/eccencaDataPlatform.md + - Multi CSV ZIP: build/reference/dataset/multiCsv.md + - Neo4j: build/reference/dataset/neo4j.md + - ORC: build/reference/dataset/orc.md + - Parquet: build/reference/dataset/parquet.md + - RDF file: build/reference/dataset/file.md + - Remote SQL endpoint: build/reference/dataset/Jdbc.md + - Snowflake SQL endpoint: build/reference/dataset/SnowflakeJdbc.md + - SPARQL endpoint: build/reference/dataset/sparqlEndpoint.md + - Text: build/reference/dataset/text.md + - XML: build/reference/dataset/xml.md + - Distance Measures: + - build/reference/distancemeasure/index.md + - CJK reading distance: build/reference/distancemeasure/cjkReadingDistance.md + - Compare physical quantities: build/reference/distancemeasure/PhysicalQuantitiesDistance.md + - Constant similarity value: build/reference/distancemeasure/constantDistance.md + - Cosine: build/reference/distancemeasure/cosine.md + - Date: build/reference/distancemeasure/date.md + - DateTime: build/reference/distancemeasure/dateTime.md + - Dice coefficient: build/reference/distancemeasure/dice.md + - Geographical distance: build/reference/distancemeasure/wgs84.md + - Greater than: build/reference/distancemeasure/greaterThan.md + - Inequality: build/reference/distancemeasure/inequality.md + - Inside numeric interval: build/reference/distancemeasure/insideNumericInterval.md + - Is substring: build/reference/distancemeasure/isSubstring.md + - Jaccard: build/reference/distancemeasure/jaccard.md + - Jaro distance: build/reference/distancemeasure/jaro.md + - Jaro-Winkler distance: build/reference/distancemeasure/jaroWinkler.md + - Korean phoneme distance: build/reference/distancemeasure/koreanPhonemeDistance.md + - Korean translit distance: build/reference/distancemeasure/koreanTranslitDistance.md + - Levenshtein distance: build/reference/distancemeasure/levenshteinDistance.md + - Lower than: build/reference/distancemeasure/lowerThan.md + - Normalized Levenshtein distance: build/reference/distancemeasure/levenshtein.md + - Numeric equality: build/reference/distancemeasure/numericEquality.md + - Numeric similarity: build/reference/distancemeasure/num.md + - qGrams: build/reference/distancemeasure/qGrams.md + - Relaxed equality: build/reference/distancemeasure/relaxedEquality.md + - Soft Jaccard: build/reference/distancemeasure/softjaccard.md + - Starts with: build/reference/distancemeasure/startsWith.md + - String equality: build/reference/distancemeasure/equality.md + - Substring comparison: build/reference/distancemeasure/substringDistance.md + - Token-wise distance: build/reference/distancemeasure/tokenwiseDistance.md + - Transformers: + - build/reference/transformer/index.md + - Combine: + - Concatenate: build/reference/transformer/Combine/concat.md + - Concatenate multiple values: build/reference/transformer/Combine/concatMultiValues.md + - Concatenate pairwise: build/reference/transformer/Combine/concatPairwise.md + - Merge: build/reference/transformer/Combine/merge.md + - Zip: build/reference/transformer/Combine/zip.md + - Conditional: + - Contains all of: build/reference/transformer/Conditional/containsAllOf.md + - Contains any of: build/reference/transformer/Conditional/containsAnyOf.md + - If contains: build/reference/transformer/Conditional/ifContains.md + - If exists: build/reference/transformer/Conditional/ifExists.md + - If matches regex: build/reference/transformer/Conditional/ifMatchesRegex.md + - Negate binary (NOT): build/reference/transformer/Conditional/negateTransformer.md + - Conversion: + - Convert charset: build/reference/transformer/Conversion/convertCharset.md + - Date: + - Compare dates: build/reference/transformer/Date/compareDates.md + - Current date: build/reference/transformer/Date/currentDate.md + - Date to timestamp: build/reference/transformer/Date/datetoTimestamp.md + - Duration: build/reference/transformer/Date/duration.md + - Duration in days: build/reference/transformer/Date/durationInDays.md + - Duration in seconds: build/reference/transformer/Date/durationInSeconds.md + - Duration in years: build/reference/transformer/Date/durationInYears.md + - Number to duration: build/reference/transformer/Date/numberToDuration.md + - Parse date pattern: build/reference/transformer/Date/parseDate.md + - Timestamp to date: build/reference/transformer/Date/timeToDate.md + - Excel: + - Excel Abs: build/reference/transformer/Excel/Excel_ABS.md + - Excel Acos: build/reference/transformer/Excel/Excel_ACOS.md + - Excel Acosh: build/reference/transformer/Excel/Excel_ACOSH.md + - Excel And: build/reference/transformer/Excel/Excel_AND.md + - Excel Asin: build/reference/transformer/Excel/Excel_ASIN.md + - Excel Asinh: build/reference/transformer/Excel/Excel_ASINH.md + - Excel Atan: build/reference/transformer/Excel/Excel_ATAN.md + - Excel Atan2: build/reference/transformer/Excel/Excel_ATAN2.md + - Excel Atanh: build/reference/transformer/Excel/Excel_ATANH.md + - Excel Avedev: build/reference/transformer/Excel/Excel_AVEDEV.md + - Excel Average: build/reference/transformer/Excel/Excel_AVERAGE.md + - Excel Averagea: build/reference/transformer/Excel/Excel_AVERAGEA.md + - Excel Ceiling: build/reference/transformer/Excel/Excel_CEILING.md + - Excel Choose: build/reference/transformer/Excel/Excel_CHOOSE.md + - Excel Clean: build/reference/transformer/Excel/Excel_CLEAN.md + - Excel Code: build/reference/transformer/Excel/Excel_CODE.md + - Excel Combin: build/reference/transformer/Excel/Excel_COMBIN.md + - Excel Correl: build/reference/transformer/Excel/Excel_CORREL.md + - Excel Cos: build/reference/transformer/Excel/Excel_COS.md + - Excel Cosh: build/reference/transformer/Excel/Excel_COSH.md + - Excel Count: build/reference/transformer/Excel/Excel_COUNT.md + - Excel Counta: build/reference/transformer/Excel/Excel_COUNTA.md + - Excel Covar: build/reference/transformer/Excel/Excel_COVAR.md + - Excel Degrees: build/reference/transformer/Excel/Excel_DEGREES.md + - Excel Devsq: build/reference/transformer/Excel/Excel_DEVSQ.md + - Excel Even: build/reference/transformer/Excel/Excel_EVEN.md + - Excel Exact: build/reference/transformer/Excel/Excel_EXACT.md + - Excel Exp: build/reference/transformer/Excel/Excel_EXP.md + - Excel Fact: build/reference/transformer/Excel/Excel_FACT.md + - Excel False: build/reference/transformer/Excel/Excel_FALSE.md + - Excel Find: build/reference/transformer/Excel/Excel_FIND.md + - Excel Floor: build/reference/transformer/Excel/Excel_FLOOR.md + - Excel Forecast: build/reference/transformer/Excel/Excel_FORECAST.md + - Excel Fv: build/reference/transformer/Excel/Excel_FV.md + - Excel Geomean: build/reference/transformer/Excel/Excel_GEOMEAN.md + - Excel If: build/reference/transformer/Excel/Excel_IF.md + - Excel Int: build/reference/transformer/Excel/Excel_INT.md + - Excel Intercept: build/reference/transformer/Excel/Excel_INTERCEPT.md + - Excel Ipmt: build/reference/transformer/Excel/Excel_IPMT.md + - Excel Irr: build/reference/transformer/Excel/Excel_IRR.md + - Excel Large: build/reference/transformer/Excel/Excel_LARGE.md + - Excel Left: build/reference/transformer/Excel/Excel_LEFT.md + - Excel Ln: build/reference/transformer/Excel/Excel_LN.md + - Excel Log: build/reference/transformer/Excel/Excel_LOG.md + - Excel Log10: build/reference/transformer/Excel/Excel_LOG10.md + - Excel Max: build/reference/transformer/Excel/Excel_MAX.md + - Excel Maxa: build/reference/transformer/Excel/Excel_MAXA.md + - Excel Median: build/reference/transformer/Excel/Excel_MEDIAN.md + - Excel Mid: build/reference/transformer/Excel/Excel_MID.md + - Excel Min: build/reference/transformer/Excel/Excel_MIN.md + - Excel Mina: build/reference/transformer/Excel/Excel_MINA.md + - Excel Mirr: build/reference/transformer/Excel/Excel_MIRR.md + - Excel Mod: build/reference/transformer/Excel/Excel_MOD.md + - Excel Mode: build/reference/transformer/Excel/Excel_MODE.md + - Excel Normdist: build/reference/transformer/Excel/Excel_NORMDIST.md + - Excel Norminv: build/reference/transformer/Excel/Excel_NORMINV.md + - Excel Normsdist: build/reference/transformer/Excel/Excel_NORMSDIST.md + - Excel Normsinv: build/reference/transformer/Excel/Excel_NORMSINV.md + - Excel Not: build/reference/transformer/Excel/Excel_NOT.md + - Excel Nper: build/reference/transformer/Excel/Excel_NPER.md + - Excel Npv: build/reference/transformer/Excel/Excel_NPV.md + - Excel Odd: build/reference/transformer/Excel/Excel_ODD.md + - Excel Or: build/reference/transformer/Excel/Excel_OR.md + - Excel Pearson: build/reference/transformer/Excel/Excel_PEARSON.md + - Excel Percentile: build/reference/transformer/Excel/Excel_PERCENTILE.md + - Excel Percentrank: build/reference/transformer/Excel/Excel_PERCENTRANK.md + - Excel Pi: build/reference/transformer/Excel/Excel_PI.md + - Excel Pmt: build/reference/transformer/Excel/Excel_PMT.md + - Excel Poisson: build/reference/transformer/Excel/Excel_POISSON.md + - Excel Power: build/reference/transformer/Excel/Excel_POWER.md + - Excel Ppmt: build/reference/transformer/Excel/Excel_PPMT.md + - Excel Product: build/reference/transformer/Excel/Excel_PRODUCT.md + - Excel Proper: build/reference/transformer/Excel/Excel_PROPER.md + - Excel Pv: build/reference/transformer/Excel/Excel_PV.md + - Excel Radians: build/reference/transformer/Excel/Excel_RADIANS.md + - Excel Rand: build/reference/transformer/Excel/Excel_RAND.md + - Excel Rank: build/reference/transformer/Excel/Excel_RANK.md + - Excel Rate: build/reference/transformer/Excel/Excel_RATE.md + - Excel Replace: build/reference/transformer/Excel/Excel_REPLACE.md + - Excel Rept: build/reference/transformer/Excel/Excel_REPT.md + - Excel Right: build/reference/transformer/Excel/Excel_RIGHT.md + - Excel Roman: build/reference/transformer/Excel/Excel_ROMAN.md + - Excel Round: build/reference/transformer/Excel/Excel_ROUND.md + - Excel Rounddown: build/reference/transformer/Excel/Excel_ROUNDDOWN.md + - Excel Roundup: build/reference/transformer/Excel/Excel_ROUNDUP.md + - Excel Search: build/reference/transformer/Excel/Excel_SEARCH.md + - Excel Sign: build/reference/transformer/Excel/Excel_SIGN.md + - Excel Sin: build/reference/transformer/Excel/Excel_SIN.md + - Excel Sinh: build/reference/transformer/Excel/Excel_SINH.md + - Excel Slope: build/reference/transformer/Excel/Excel_SLOPE.md + - Excel Small: build/reference/transformer/Excel/Excel_SMALL.md + - Excel Sqrt: build/reference/transformer/Excel/Excel_SQRT.md + - Excel Standardize: build/reference/transformer/Excel/Excel_STANDARDIZE.md + - Excel Stdev: build/reference/transformer/Excel/Excel_STDEV.md + - Excel Stdeva: build/reference/transformer/Excel/Excel_STDEVA.md + - Excel Stdevp: build/reference/transformer/Excel/Excel_STDEVP.md + - Excel Stdevpa: build/reference/transformer/Excel/Excel_STDEVPA.md + - Excel Substitute: build/reference/transformer/Excel/Excel_SUBSTITUTE.md + - Excel Sum: build/reference/transformer/Excel/Excel_SUM.md + - Excel Sumproduct: build/reference/transformer/Excel/Excel_SUMPRODUCT.md + - Excel Sumsq: build/reference/transformer/Excel/Excel_SUMSQ.md + - Excel Sumx2my2: build/reference/transformer/Excel/Excel_SUMX2MY2.md + - Excel Sumx2py2: build/reference/transformer/Excel/Excel_SUMX2PY2.md + - Excel Sumxmy2: build/reference/transformer/Excel/Excel_SUMXMY2.md + - Excel Tan: build/reference/transformer/Excel/Excel_TAN.md + - Excel Tanh: build/reference/transformer/Excel/Excel_TANH.md + - Excel Tdist: build/reference/transformer/Excel/Excel_TDIST.md + - Excel True: build/reference/transformer/Excel/Excel_TRUE.md + - Excel Trunc: build/reference/transformer/Excel/Excel_TRUNC.md + - Excel Var: build/reference/transformer/Excel/Excel_VAR.md + - Excel Vara: build/reference/transformer/Excel/Excel_VARA.md + - Excel Varp: build/reference/transformer/Excel/Excel_VARP.md + - Excel Varpa: build/reference/transformer/Excel/Excel_VARPA.md + - Extract: + - Regex extract: build/reference/transformer/Extract/regexExtract.md + - Filter: + - Filter by length: build/reference/transformer/Filter/filterByLength.md + - Filter by regex: build/reference/transformer/Filter/filterByRegex.md + - Remove default stop words: build/reference/transformer/Filter/removeDefaultStopWords.md + - Remove empty values: build/reference/transformer/Filter/removeEmptyValues.md + - Remove remote stop words: build/reference/transformer/Filter/removeRemoteStopWords.md + - Remove stop words: build/reference/transformer/Filter/removeStopWords.md + - Remove values: build/reference/transformer/Filter/removeValues.md + - Geo: + - Retrieve coordinates: build/reference/transformer/Geo/RetrieveCoordinates.md + - Retrieve latitude: build/reference/transformer/Geo/RetrieveLatitude.md + - Retrieve longitude: build/reference/transformer/Geo/RetrieveLongitude.md + - Linguistic: + - Metaphone: build/reference/transformer/Linguistic/metaphone.md + - Normalize chars: build/reference/transformer/Linguistic/normalizeChars.md + - NYSIIS: build/reference/transformer/Linguistic/NYSIIS.md + - Soundex: build/reference/transformer/Linguistic/soundex.md + - Stem: build/reference/transformer/Linguistic/stem.md + - Metadata: + - File hash: build/reference/transformer/Metadata/fileHash.md + - Input file attributes: build/reference/transformer/Metadata/inputFileAttributes.md + - Input task attributes: build/reference/transformer/Metadata/inputTaskAttributes.md + - Normalize: + - Camel case: build/reference/transformer/Normalize/camelCase.md + - Capitalize: build/reference/transformer/Normalize/capitalize.md + - Clean HTML: build/reference/transformer/Normalize/htmlCleaner.md + - Encode URL: build/reference/transformer/Normalize/urlEncode.md + - Fix URI: build/reference/transformer/Normalize/uriFix.md + - Lower case: build/reference/transformer/Normalize/lowerCase.md + - Remove blanks: build/reference/transformer/Normalize/removeBlanks.md + - Remove duplicates: build/reference/transformer/Normalize/removeDuplicates.md + - Remove parentheses: build/reference/transformer/Normalize/removeParentheses.md + - Remove special chars: build/reference/transformer/Normalize/removeSpecialChars.md + - Sort words: build/reference/transformer/Normalize/sortWords.md + - Strip non-alphabetic characters: build/reference/transformer/Normalize/alphaReduce.md + - Trim: build/reference/transformer/Normalize/trim.md + - Upper case: build/reference/transformer/Normalize/upperCase.md + - Numeric: + - Aggregate numbers: build/reference/transformer/Numeric/aggregateNumbers.md + - Compare numbers: build/reference/transformer/Numeric/compareNumbers.md + - Convert Number Base: build/reference/transformer/Numeric/cmem-plugin-number-conversion.md + - Extract physical quantity: build/reference/transformer/Numeric/extractPhysicalQuantity.md + - Format number: build/reference/transformer/Numeric/formatNumber.md + - Logarithm: build/reference/transformer/Numeric/log.md + - Normalize physical quantity: build/reference/transformer/Numeric/PhysicalQuantitiesNormalizer.md + - Numeric operation: build/reference/transformer/Numeric/numOperation.md + - Numeric reduce: build/reference/transformer/Numeric/numReduce.md + - Parser: + - Parse date: build/reference/transformer/Parser/DateTypeParser.md + - Parse float: build/reference/transformer/Parser/FloatTypeParser.md + - Parse geo coordinate: build/reference/transformer/Parser/GeoCoordinateParser.md + - Parse geo location: build/reference/transformer/Parser/GeoLocationParser.md + - Parse integer: build/reference/transformer/Parser/IntegerParser.md + - Parse ISIN: build/reference/transformer/Parser/IsinParser.md + - Parse SKOS term: build/reference/transformer/Parser/SkosTypeParser.md + - Parse string: build/reference/transformer/Parser/StringParser.md + - Replace: + - Excel map: build/reference/transformer/Replace/excelMap.md + - Map: build/reference/transformer/Replace/map.md + - Map with default: build/reference/transformer/Replace/mapWithDefaultInput.md + - Regex replace: build/reference/transformer/Replace/regexReplace.md + - Replace: build/reference/transformer/Replace/replace.md + - SPARQL: + - Escape SPARQL multiline literal: build/reference/transformer/SPARQL/escape_multiline_literal.md + - Escape SPARQL plain literal: build/reference/transformer/SPARQL/escape_literal.md + - Selection: + - Coalesce (first non-empty input): build/reference/transformer/Selection/coalesce.md + - Regex selection: build/reference/transformer/Selection/regexSelect.md + - Sequence: + - Count values: build/reference/transformer/Sequence/count.md + - Get value by index: build/reference/transformer/Sequence/getValueByIndex.md + - Sequence values to indexes: build/reference/transformer/Sequence/toSequenceIndex.md + - Sort: build/reference/transformer/Sequence/sort.md + - Substring: + - Strip postfix: build/reference/transformer/Substring/stripPostfix.md + - Strip prefix: build/reference/transformer/Substring/stripPrefix.md + - Strip URI prefix: build/reference/transformer/Substring/stripUriPrefix.md + - Substring: build/reference/transformer/Substring/substring.md + - Until character: build/reference/transformer/Substring/untilCharacter.md + - Template: + - Evaluate template: build/reference/transformer/Template/TemplateTransformer.md + - Tokenization: + - Camel case tokenizer: build/reference/transformer/Tokenization/camelcasetokenizer.md + - Tokenize: build/reference/transformer/Tokenization/tokenize.md + - Uncategorized: + - Convert currency values: build/reference/transformer/Uncategorized/cmem_plugin_currencies-transform.md + - jq: build/reference/transformer/Uncategorized/cmem-plugin-jq-transform.md + - Random value: build/reference/transformer/Uncategorized/cmem_plugin_random-GenerateValues.md + - Validation: + - Validate date after: build/reference/transformer/Validation/validateDateAfter.md + - Validate date range: build/reference/transformer/Validation/validateDateRange.md + - Validate number of values: build/reference/transformer/Validation/validateNumberOfValues.md + - Validate numeric range: build/reference/transformer/Validation/validateNumericRange.md + - Validate regex: build/reference/transformer/Validation/validateRegex.md + - Validate URI: build/reference/transformer/Validation/validate_uri.md + - Value: + - Combined input hash: build/reference/transformer/Value/inputHash.md + - Constant: build/reference/transformer/Value/constant.md + - Constant URI: build/reference/transformer/Value/constantUri.md + - Dataset parameter: build/reference/transformer/Value/datasetParameter.md + - Default Value: build/reference/transformer/Value/defaultValue.md + - Empty value: build/reference/transformer/Value/emptyValue.md + - Per-value hash: build/reference/transformer/Value/perValueHash.md + - Random number: build/reference/transformer/Value/randomNumber.md + - Read parameter: build/reference/transformer/Value/readParameter.md + - ULID: build/reference/transformer/Value/cmem-plugin-ulid.md + - UUID: build/reference/transformer/Value/uuid.md + - UUID Convert: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUIDConvert.md + - UUID Version: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUIDVersion.md + - UUIDv1: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID1.md + - UUIDv1 to UUIDv6: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID1ToUUID6.md + - UUIDv3: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID3.md + - UUIDv4: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID4.md + - UUIDv5: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID5.md + - UUIDv6: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID6.md + - UUIDv7: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID7.md + - UUIDv8: build/reference/transformer/Value/cmem_plugin_uuid-plugin_uuid-UUID8.md + - Variables: + - Set execution variable: build/reference/transformer/Variables/setExecutionVariable.md + - Mapping Creator: + - build/mapping-creator/index.md + - Rule Operators: + - build/rule-operators/index.md + - Rule Blocks: + - build/rule-blocks/index.md + - Define Prefixes / Namespaces: + - build/define-prefixes-namespaces/index.md + - Cool IRIs: + - build/cool-iris/index.md + - Lift Tabular Data: + - build/lift-data-from-tabular-data-such-as-csv-xslx-or-database-tables/index.md + - Lift Hierarchical Data: + - build/lift-data-from-json-and-xml-sources/index.md + - Lift Web API Data: + - build/extracting-data-from-a-web-api/index.md + - Workflows: + - build/workflows/index.md + - Incremental Database Loading: + - build/loading-jdbc-datasets-incrementally/index.md + - Connect to Snowflake: + - build/snowflake-tutorial/index.md + - Active learning: + - build/active-learning/index.md + - Link Intrusion Detection Systems to Open-Source INTelligence: + - build/tutorial-how-to-link-ids-to-osint/index.md + - Define the interfaces: + - build/tutorial-how-to-link-ids-to-osint/define-the-interfaces/index.md + - Define the need: + - build/tutorial-how-to-link-ids-to-osint/define-the-need/index.md + - lift data from STIX 2.1 data of mitre attack: + - build/tutorial-how-to-link-ids-to-osint/lift-data-from-STIX-2.1-data-of-mitre-attack/index.md + - lift data from YAML data of hayabusa sigma: + - build/tutorial-how-to-link-ids-to-osint/lift-data-from-YAML-data-of-hayabusa-sigma/index.md + - link IDS event to KG: + - build/tutorial-how-to-link-ids-to-osint/link-IDS-event-to-KG/index.md + - link IDS event to KG via cmem: + - build/tutorial-how-to-link-ids-to-osint/link-IDS-event-to-KG-via-cmem/index.md + - Project and Global Variables: + - build/variables/index.md + - Evaluate Template Operator: + - build/evaluate-template/index.md + - Build Knowledge Graphs from Kafka Topics: + - build/kafka-consumer/index.md + - Spark: + - build/spark/index.md + - Explore: + - Explore: explore-and-author/index.md + - Knowledge graphs: + - Graph Exploration: explore-and-author/graph-exploration/index.md + - Building a Customized User Interface: + - Building a Customized User Interface: explore-and-author/graph-exploration/building-a-customized-user-interface/index.md + - Workflow Trigger: + - explore-and-author/graph-exploration/building-a-customized-user-interface/workflow-trigger/index.md + - Node Shapes: + - explore-and-author/graph-exploration/building-a-customized-user-interface/node-shapes/index.md + - Property Shapes: + - explore-and-author/graph-exploration/building-a-customized-user-interface/property-shapes/index.md + - Datatypes: + - explore-and-author/graph-exploration/building-a-customized-user-interface/datatype-reference/index.md + - SPARQL Constraints: + - explore-and-author/graph-exploration/building-a-customized-user-interface/sparql-constraints/index.md + - Graph Insights: + - explore-and-author/graph-exploration/graph-insights/index.md + - Core Concepts: explore-and-author/graph-exploration/graph-insights/concepts.md + - Graph Insights Tutorial – Supply Chain Risk Analysis: explore-and-author/graph-exploration/graph-insights/tutorial.md + - Features: + - explore-and-author/graph-exploration/graph-insights/features/index.md + - Application & Settings: explore-and-author/graph-exploration/graph-insights/features/application-settings.md + - Exploration Canvas: explore-and-author/graph-exploration/graph-insights/features/canvas-ui.md + - Class Tree: explore-and-author/graph-exploration/graph-insights/features/category-tree.md + - Groups: explore-and-author/graph-exploration/graph-insights/features/groups.md + - Resource Table: explore-and-author/graph-exploration/graph-insights/features/objects-table.md + - Resources: explore-and-author/graph-exploration/graph-insights/features/objects.md + - Connections: explore-and-author/graph-exploration/graph-insights/features/connections.md + - Persistence: explore-and-author/graph-exploration/graph-insights/features/persistence.md + - Navigating to Corporate Memory: explore-and-author/graph-exploration/graph-insights/navigating-to-cmem.md + - Statement Annotations: + - explore-and-author/graph-exploration/statement-annotations/index.md + - Versioning of Graph Changes: + - explore-and-author/graph-exploration/versioning-of-graph-changes/index.md + - Business knowledge editor: + - explore-and-author/bke-module/index.md + - Visually authoring ontologies: + - explore-and-author/bke-module/visually-authoring-ontologies/index.md + - Queries: + - explore-and-author/query-module/index.md + - Thesauri: + - explore-and-author/thesauri-management/index.md + - Charts: + - explore-and-author/charts-catalog/index.md + - Companion AI chat: + - explore-and-author/companion/index.md + - Services integrations: + - explore-and-author/embedding-services-via-the-integrations-module/index.md + - Link rules: + - explore-and-author/link-rules/index.md + - Application view: + - explore-and-author/workspace-configuration/index.md + - Consume: + - Consume: consume/index.md + - Consuming Graphs in Power BI: + - consume/consuming-graphs-in-power-bi/index.md + - Consuming Graphs in Redash: + - consume/consuming-graphs-with-redash/index.md + - Consuming Graphs with SQL Databases: + - consume/consuming-graphs-with-sql-databases/index.md + - Provide Data in any Format via a Custom API: + - consume/provide-data-in-any-format-via-a-custom-api/index.md + - Populate Data to Neo4j: + - consume/populate-data-to-neo4j/index.md + - Populate Data to Apache Kafka: + - consume/consume-graphs-in-apache-kafka/index.md + - Distribution: + - Distribution: distribution/index.md + - Marketplace: + - distribution/marketplace/index.md + - Deploy and Configure: + - Deploy and Configure: deploy-and-configure/index.md + - System Architecture: + - deploy-and-configure/system-architecture/index.md + - Requirements: + - deploy-and-configure/requirements/index.md + - deploy-and-configure/requirements/graph-insights-sizing.md + - deploy-and-configure/requirements/triple-store-hardware-sizing.md + - Installation: + - Installation: deploy-and-configure/installation/index.md + - 'Scenario: Single Node Cloud Installation': + - deploy-and-configure/installation/scenario-single-node-cloud-installation/index.md + - 'Scenario: Local Installation': + - deploy-and-configure/installation/scenario-local-installation/index.md + - 'Scenario: Kubernetes Deployment': + - deploy-and-configure/installation/scenario-k8s-deployment/index.md + - Migrating Stores: + - deploy-and-configure/installation/migrating-stores/index.md + - Configuration: + - Configuration: deploy-and-configure/configuration/index.md + - Docker Orchestration: + - deploy-and-configure/configuration/docker-orchestration/index.md + - Build: + - Build (DataIntegration): deploy-and-configure/configuration/dataintegration/index.md + - Adding JDBC drivers: + - deploy-and-configure/configuration/dataintegration/jdbc/index.md + - Activity Reference: + - deploy-and-configure/configuration/dataintegration/activity-reference/index.md + - Explore: + - Explore: deploy-and-configure/configuration/explore/index.md + - Explore backend: + - Explore backend: deploy-and-configure/configuration/explore/dataplatform/index.md + - General: deploy-and-configure/configuration/explore/dataplatform/application-full.md + - OAuth: deploy-and-configure/configuration/explore/dataplatform/application-oauth-full.md + - Store: + - GraphDB: deploy-and-configure/configuration/explore/dataplatform/application-graphdb-full.md + - HTTP: deploy-and-configure/configuration/explore/dataplatform/application-http-full.md + - In-Memory: deploy-and-configure/configuration/explore/dataplatform/application-inmemory-full.md + - Virtuoso: deploy-and-configure/configuration/explore/dataplatform/application-virtuoso-full.md + - deploy-and-configure/configuration/explore/graph-resource-pattern/index.md + - Graph Insights: + - deploy-and-configure/configuration/graphinsights/index.md + - Keycloak: + - Keycloak: deploy-and-configure/configuration/keycloak/index.md + - Changing Passwords and Keys: + - deploy-and-configure/configuration/keycloak/change-passwords-and-keys/index.md + - Using an external Keycloak: + - deploy-and-configure/configuration/keycloak/using-external-keycloak/index.md + - Quad-Store: + - deploy-and-configure/configuration/quad-store-configuration/index.md + - Reverse Proxy: + - deploy-and-configure/configuration/reverse-proxy/index.md + - Access Conditions: + - deploy-and-configure/configuration/access-conditions/index.md + - Label Resolution and Full-Text Search: + - deploy-and-configure/configuration/label-resolution-and-full-text-search/index.md + - Production-Ready Settings: + - deploy-and-configure/configuration/production-ready-settings/index.md + - Caveats: + - deploy-and-configure/configuration/caveats/index.md + - Automate: + - Automate: automate/index.md + - cmemc: + - cmemc - Command Line Interface: automate/cmemc-command-line-interface/index.md + - Installation: + - automate/cmemc-command-line-interface/installation/index.md + - Configuration: + - Configuration: automate/cmemc-command-line-interface/configuration/index.md + - File-based: + - automate/cmemc-command-line-interface/configuration/file-based-configuration/index.md + - Environment-based: + - automate/cmemc-command-line-interface/configuration/environment-based-configuration/index.md + - Completion Setup: + - automate/cmemc-command-line-interface/configuration/completion-setup/index.md + - Getting Credentials: + - automate/cmemc-command-line-interface/configuration/getting-credentials-from-external-processes/index.md + - Certificate Handling: + - automate/cmemc-command-line-interface/configuration/certificate-handling-and-ssl-verification/index.md + - Invocation: + - Invocation: automate/cmemc-command-line-interface/invocation/index.md + - Docker Image: + - automate/cmemc-command-line-interface/invocation/docker-image/index.md + - Github Action: + - automate/cmemc-command-line-interface/invocation/github-action/index.md + - Gitlab Pipeline: + - automate/cmemc-command-line-interface/invocation/gitlab-pipeline/index.md + - SPARQL Scripts: + - automate/cmemc-command-line-interface/invocation/sparql-scripts/index.md + - Finding and Filtering Objects: + - automate/cmemc-command-line-interface/finding-and-filtering-objects/index.md + - Scripting with cmemc: + - automate/cmemc-command-line-interface/scripting-with-cmemc/index.md + - Workflow Execution: + - automate/cmemc-command-line-interface/workflow-execution-and-orchestration/index.md + - Backup and Restore: + - automate/cmemc-command-line-interface/backup-and-restore/index.md + - Troubleshooting: + - automate/cmemc-command-line-interface/troubleshooting-and-caveats/index.md + - Command Reference: + - automate/cmemc-command-line-interface/command-reference/index.md + - Admin: + - automate/cmemc-command-line-interface/command-reference/admin/index.md + - Acl: + - automate/cmemc-command-line-interface/command-reference/admin/acl/index.md + - Client: + - automate/cmemc-command-line-interface/command-reference/admin/client/index.md + - Metrics: + - automate/cmemc-command-line-interface/command-reference/admin/metrics/index.md + - Migration: + - automate/cmemc-command-line-interface/command-reference/admin/migration/index.md + - Store: + - automate/cmemc-command-line-interface/command-reference/admin/store/index.md + - User: + - automate/cmemc-command-line-interface/command-reference/admin/user/index.md + - View: + - automate/cmemc-command-line-interface/command-reference/admin/view/index.md + - Workspace: + - automate/cmemc-command-line-interface/command-reference/admin/workspace/index.md + - Python: + - automate/cmemc-command-line-interface/command-reference/admin/workspace/python/index.md + - Config: + - automate/cmemc-command-line-interface/command-reference/config/index.md + - Dataset: + - automate/cmemc-command-line-interface/command-reference/dataset/index.md + - Graph: + - automate/cmemc-command-line-interface/command-reference/graph/index.md + - Imports: + - automate/cmemc-command-line-interface/command-reference/graph/imports/index.md + - Insights: + - automate/cmemc-command-line-interface/command-reference/graph/insights/index.md + - Validation: + - automate/cmemc-command-line-interface/command-reference/graph/validation/index.md + - Package: + - automate/cmemc-command-line-interface/command-reference/package/index.md + - Project: + - automate/cmemc-command-line-interface/command-reference/project/index.md + - File: + - automate/cmemc-command-line-interface/command-reference/project/file/index.md + - Variable: + - automate/cmemc-command-line-interface/command-reference/project/variable/index.md + - Query: + - automate/cmemc-command-line-interface/command-reference/query/index.md + - Vocabulary: + - automate/cmemc-command-line-interface/command-reference/vocabulary/index.md + - Cache: + - automate/cmemc-command-line-interface/command-reference/vocabulary/cache/index.md + - Workflow: + - automate/cmemc-command-line-interface/command-reference/workflow/index.md + - Scheduler: + - automate/cmemc-command-line-interface/command-reference/workflow/scheduler/index.md + - Processing Data with variable input Workflows: + - automate/processing-data-with-variable-input-workflows/index.md + - Scheduling Workflows: + - automate/scheduling-workflows/index.md + - Continuous Integration: + - automate/continuous-integration/index.md + - Develop: + - Develop: develop/index.md + - Accessing Graphs with Java Applications: + - develop/accessing-graphs-with-java-applications/index.md + - Python Plugins: + - Python Plugins: develop/python-plugins/index.md + - Installation and Usage: + - develop/python-plugins/installation/index.md + - Development: + - develop/python-plugins/development/index.md + - Setup and Configuration: + - develop/python-plugins/setup/index.md + - Marketplace Packages: + - Marketplace Packages: develop/packages/index.md + - Installation and Management: + - develop/packages/installation/index.md + - Development and Publication: + - Development and Publication: develop/packages/development/index.md + - Tutorial: + - develop/packages/development/tutorial/index.md + - cmempy - Python API: + - develop/cmempy-python-api/index.md + - cmem-client - Python API: + - 'cmem-client: Python API': develop/cmem-client-api/index.md + - API Reference: + - API Reference: develop/cmem-client-api/api-reference/index.md + - client: + - develop/cmem-client-api/api-reference/client/index.md + - config: + - develop/cmem-client-api/api-reference/config/index.md + - exceptions: + - develop/cmem-client-api/api-reference/exceptions/index.md + - logging_utils: + - develop/cmem-client-api/api-reference/logging_utils/index.md + - auth_provider: + - abc: + - develop/cmem-client-api/api-reference/auth_provider/abc/index.md + - client_credentials: + - develop/cmem-client-api/api-reference/auth_provider/client_credentials/index.md + - password: + - develop/cmem-client-api/api-reference/auth_provider/password/index.md + - prefetched_token: + - develop/cmem-client-api/api-reference/auth_provider/prefetched_token/index.md + - provided_token: + - develop/cmem-client-api/api-reference/auth_provider/provided_token/index.md + - components: + - deployment: + - develop/cmem-client-api/api-reference/components/deployment/index.md + - graph_store: + - develop/cmem-client-api/api-reference/components/graph_store/index.md + - marketplace: + - develop/cmem-client-api/api-reference/components/marketplace/index.md + - sparql_wrapper: + - develop/cmem-client-api/api-reference/components/sparql_wrapper/index.md + - workspace: + - develop/cmem-client-api/api-reference/components/workspace/index.md + - models: + - access_condition: + - develop/cmem-client-api/api-reference/models/access_condition/index.md + - base: + - develop/cmem-client-api/api-reference/models/base/index.md + - common: + - develop/cmem-client-api/api-reference/models/common/index.md + - credentials: + - develop/cmem-client-api/api-reference/models/credentials/index.md + - dataset: + - develop/cmem-client-api/api-reference/models/dataset/index.md + - error: + - develop/cmem-client-api/api-reference/models/error/index.md + - graph: + - develop/cmem-client-api/api-reference/models/graph/index.md + - graph_import: + - develop/cmem-client-api/api-reference/models/graph_import/index.md + - graph_insight: + - develop/cmem-client-api/api-reference/models/graph_insight/index.md + - item: + - develop/cmem-client-api/api-reference/models/item/index.md + - keycloak_client: + - develop/cmem-client-api/api-reference/models/keycloak_client/index.md + - logging_config: + - develop/cmem-client-api/api-reference/models/logging_config/index.md + - marshalling_plugins: + - develop/cmem-client-api/api-reference/models/marshalling_plugins/index.md + - package: + - develop/cmem-client-api/api-reference/models/package/index.md + - project: + - develop/cmem-client-api/api-reference/models/project/index.md + - python_install: + - develop/cmem-client-api/api-reference/models/python_install/index.md + - python_package: + - develop/cmem-client-api/api-reference/models/python_package/index.md + - query_catalog: + - develop/cmem-client-api/api-reference/models/query_catalog/index.md + - resource: + - develop/cmem-client-api/api-reference/models/resource/index.md + - scheduler: + - develop/cmem-client-api/api-reference/models/scheduler/index.md + - status: + - develop/cmem-client-api/api-reference/models/status/index.md + - task: + - develop/cmem-client-api/api-reference/models/task/index.md + - token: + - develop/cmem-client-api/api-reference/models/token/index.md + - url: + - develop/cmem-client-api/api-reference/models/url/index.md + - user: + - develop/cmem-client-api/api-reference/models/user/index.md + - validation: + - develop/cmem-client-api/api-reference/models/validation/index.md + - variable: + - develop/cmem-client-api/api-reference/models/variable/index.md + - vocabulary: + - develop/cmem-client-api/api-reference/models/vocabulary/index.md + - workflow: + - develop/cmem-client-api/api-reference/models/workflow/index.md + - workspace_config: + - develop/cmem-client-api/api-reference/models/workspace_config/index.md + - workspace_plugin: + - develop/cmem-client-api/api-reference/models/workspace_plugin/index.md + - workspace_status: + - develop/cmem-client-api/api-reference/models/workspace_status/index.md + - repositories: + - access_conditions: + - develop/cmem-client-api/api-reference/repositories/access_conditions/index.md + - client_accounts: + - develop/cmem-client-api/api-reference/repositories/client_accounts/index.md + - datasets: + - develop/cmem-client-api/api-reference/repositories/datasets/index.md + - files: + - develop/cmem-client-api/api-reference/repositories/files/index.md + - graph_imports: + - develop/cmem-client-api/api-reference/repositories/graph_imports/index.md + - graph_insights: + - develop/cmem-client-api/api-reference/repositories/graph_insights/index.md + - graphs: + - develop/cmem-client-api/api-reference/repositories/graphs/index.md + - marketplace_packages: + - develop/cmem-client-api/api-reference/repositories/marketplace_packages/index.md + - projects: + - develop/cmem-client-api/api-reference/repositories/projects/index.md + - python_packages: + - develop/cmem-client-api/api-reference/repositories/python_packages/index.md + - queries: + - develop/cmem-client-api/api-reference/repositories/queries/index.md + - schedulers: + - develop/cmem-client-api/api-reference/repositories/schedulers/index.md + - user_accounts: + - develop/cmem-client-api/api-reference/repositories/user_accounts/index.md + - validations: + - develop/cmem-client-api/api-reference/repositories/validations/index.md + - variables: + - develop/cmem-client-api/api-reference/repositories/variables/index.md + - vocabularies: + - develop/cmem-client-api/api-reference/repositories/vocabularies/index.md + - workflows: + - develop/cmem-client-api/api-reference/repositories/workflows/index.md + - workspace_configs: + - develop/cmem-client-api/api-reference/repositories/workspace_configs/index.md + - base: + - abc: + - develop/cmem-client-api/api-reference/repositories/base/abc/index.md + - paged_list: + - develop/cmem-client-api/api-reference/repositories/base/paged_list/index.md + - plain_list: + - develop/cmem-client-api/api-reference/repositories/base/plain_list/index.md + - task_search: + - develop/cmem-client-api/api-reference/repositories/base/task_search/index.md + - protocols: + - create_item: + - develop/cmem-client-api/api-reference/repositories/protocols/create_item/index.md + - delete_item: + - develop/cmem-client-api/api-reference/repositories/protocols/delete_item/index.md + - export_item: + - develop/cmem-client-api/api-reference/repositories/protocols/export_item/index.md + - import_item: + - develop/cmem-client-api/api-reference/repositories/protocols/import_item/index.md + - update_item: + - develop/cmem-client-api/api-reference/repositories/protocols/update_item/index.md + - cmemc - Python Scripts: + - develop/cmemc-scripts/index.md + - Build (DataIntegration) APIs: + - develop/dataintegration-apis/index.md + - Explore backend APIs: + - develop/dataplatform-apis/index.md + - Release Notes: + - Corporate Memory 26.2.0: + - release-notes/corporate-memory-26-2/index.md + - Corporate Memory 26.1.3: + - release-notes/corporate-memory-26-1/index.md + - Corporate Memory 25.3.4: + - release-notes/corporate-memory-25-3/index.md + - Corporate Memory 25.2.7: + - release-notes/corporate-memory-25-2/index.md + - Corporate Memory 25.1.2: + - release-notes/corporate-memory-25-1/index.md + - Corporate Memory 24.3.2: + - release-notes/corporate-memory-24-3/index.md + - Corporate Memory 24.2.1: + - release-notes/corporate-memory-24-2/index.md + - Corporate Memory 24.1.3: + - release-notes/corporate-memory-24-1/index.md + - Corporate Memory 23.3.2: + - release-notes/corporate-memory-23-3/index.md + - Corporate Memory 23.2.1: + - release-notes/corporate-memory-23-2/index.md + - Corporate Memory 23.1.3: + - release-notes/corporate-memory-23-1/index.md + - Corporate Memory 22.2.3: + - release-notes/corporate-memory-22-2/index.md + - Corporate Memory 22.1: + - release-notes/corporate-memory-22-1/index.md + - Corporate Memory 21.11: + - release-notes/corporate-memory-21-11/index.md + - Corporate Memory 21.06: + - release-notes/corporate-memory-21-06/index.md + - Corporate Memory 21.04: + - release-notes/corporate-memory-21-04/index.md + - Corporate Memory 21.02: + - release-notes/corporate-memory-21-02/index.md + - Corporate Memory 20.12: + - release-notes/corporate-memory-20-12/index.md + - Corporate Memory 20.10: + - release-notes/corporate-memory-20-10/index.md + - Corporate Memory 20.06: + - release-notes/corporate-memory-20-06/index.md + - Corporate Memory 20.03: + - release-notes/corporate-memory-20-03/index.md + - Corporate Memory 19.10: + - release-notes/corporate-memory-19-10/index.md + - Tutorials: + - tutorials/index.md diff --git a/poetry.lock b/poetry.lock index e4af08e7a..c8d117412 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1135,7 +1135,7 @@ version = "1.1.1" description = "Utility library for gitignore style pattern matching of file paths." optional = false python-versions = ">=3.9" -groups = ["main"] +groups = ["main", "dev"] files = [ {file = "pathspec-1.1.1-py3-none-any.whl", hash = "sha256:a00ce642f577bf7f473932318056212bc4f8bfdf53128c78bbd5af0b9b20b189"}, {file = "pathspec-1.1.1.tar.gz", hash = "sha256:17db5ecd524104a120e173814c90367a96a98d07c45b2e10c2f3919fff91bf5a"}, @@ -1552,7 +1552,7 @@ version = "6.0.3" description = "YAML parser and emitter for Python" optional = false python-versions = ">=3.8" -groups = ["main"] +groups = ["main", "dev"] files = [ {file = "PyYAML-6.0.3-cp38-cp38-macosx_10_13_x86_64.whl", hash = "sha256:c2514fceb77bc5e7a2f7adfaa1feb2fb311607c9cb518dbc378688ec73d8292f"}, {file = "PyYAML-6.0.3-cp38-cp38-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9c57bb8c96f6d1808c030b1687b9b5fb476abaa47f0db9c0101f5e9f394e97f4"}, @@ -1896,6 +1896,25 @@ files = [ [package.extras] watchmedo = ["PyYAML (>=3.10)"] +[[package]] +name = "yamllint" +version = "1.38.0" +description = "A linter for YAML files." +optional = false +python-versions = ">=3.10" +groups = ["dev"] +files = [ + {file = "yamllint-1.38.0-py3-none-any.whl", hash = "sha256:fc394a5b3be980a4062607b8fdddc0843f4fa394152b6da21722f5d59013c220"}, + {file = "yamllint-1.38.0.tar.gz", hash = "sha256:09e5f29531daab93366bb061e76019d5e91691ef0a40328f04c927387d1d364d"}, +] + +[package.dependencies] +pathspec = ">=1.0.0" +pyyaml = "*" + +[package.extras] +dev = ["doc8", "flake8", "flake8-import-order", "rstcheck[sphinx]", "ruff", "sphinx"] + [[package]] name = "yarl" version = "1.24.5" @@ -2048,4 +2067,4 @@ tomli = ">=2.4.0" [metadata] lock-version = "2.1" python-versions = "^3.11" -content-hash = "b8fa91699244932cf2c833301daf28c8d2e8047c153211ccf9f577d1246220bc" +content-hash = "e507c3bba00f96806424baecb11aec62362aec96addd3e245dbfceec92bb4825" diff --git a/pyproject.toml b/pyproject.toml index 0f77f9ad1..1f45e9431 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,6 +41,7 @@ zensical = "^0.0.59" linkcheckmd = "^1.4.0" rumdl = "^0.0.194" pytest = "^9.1.1" +yamllint = "^1.38.0" [tool.pytest.ini_options] markers = [ diff --git a/tests/test_build_navigation.py b/tests/test_build_navigation.py index 1476ce1d8..4ddd4b114 100644 --- a/tests/test_build_navigation.py +++ b/tests/test_build_navigation.py @@ -6,6 +6,7 @@ from click.testing import CliRunner from tools.build_navigation import ( + NAV_HEADER, build_nav_list, build_navigation, dir_title, @@ -235,6 +236,28 @@ def test_render_nav_keeps_unicode_unescaped(tmp_path): assert "\u00dcberblick" in render_nav(docs) +def test_render_nav_is_yamllint_clean(tmp_path): + """The rendered file carries the header and indents sequences under their key + + This is the shape yamllint's default rules accept: a `---` document start, + sequences indented beneath their parent mapping key (`indent-sequences`), + a single space after each hyphen (`hyphens`), and a consistent two-column + step throughout (`indentation` with `spaces: consistent`). + """ + docs = make_docs(tmp_path, { + ".pages": "nav:\n - Section: sub\n", + "sub/index.md": "# Sub", + "sub/page.md": "# Page", + }) + + assert render_nav(docs) == NAV_HEADER + ( + "nav:\n" + " - Section:\n" + " - sub/index.md\n" + " - sub/page.md\n" + ) + + def test_check_passes_when_in_sync(tmp_path): """A nav file matching the .pages files exits 0""" docs = make_docs(tmp_path, {".pages": "nav:\n - index.md\n", "index.md": "# Home"}) @@ -243,7 +266,7 @@ def test_check_passes_when_in_sync(tmp_path): runner = CliRunner() written = runner.invoke(build_navigation, ["--docs-dir", str(docs), "-o", str(nav)]) assert written.exit_code == 0 - assert nav.read_text() == "nav:\n- index.md\n" + assert nav.read_text() == NAV_HEADER + "nav:\n - index.md\n" checked = runner.invoke( build_navigation, ["--docs-dir", str(docs), "-o", str(nav), "--check"] @@ -263,7 +286,7 @@ def test_check_fails_and_diffs_on_drift(tmp_path): ) assert result.exit_code == 1 assert "-- outdated.md" in result.output - assert "+- index.md" in result.output + assert "+ - index.md" in result.output assert "Run 'task update:navigation' and commit the result." in result.output # the stale file is left untouched, so the diff stays reproducible assert nav.read_text() == "nav:\n- outdated.md\n" diff --git a/tools/build_navigation.py b/tools/build_navigation.py index 827dfdad7..a3a008bc3 100644 --- a/tools/build_navigation.py +++ b/tools/build_navigation.py @@ -142,6 +142,32 @@ def build_nav_list(nav: list, abs_dir: Path, docs_rel: Path) -> list: return result +class _IndentedDumper(yaml.Dumper): + """Dumper that indents block sequences beneath their parent mapping key. + + PyYAML emits `key:` followed by items at the *same* column. yamllint rejects + that under its default `indentation` rule, which sets `indent-sequences: + true`. Forcing `indentless` off yields `key:` with the items indented under + it, which is what the rule expects. + """ + + def increase_indent(self, flow: bool = False, indentless: bool = False): # noqa: ARG002, FBT001, FBT002 + return super().increase_indent(flow, False) + + +# Prepended to the generated file. The `---` satisfies yamllint's +# `document-start` rule. The disable directive covers the handful of entries +# that pair a long title with a long docs-relative path: YAML folds plain +# scalars only at internal spaces, never after the `: `, so those lines cannot +# be wrapped and the rule can only ever be noise here. +NAV_HEADER = """\ +--- +# Generated by tools/build_navigation.py from the docs/**/.pages files. +# Do not edit by hand - run `task update:navigation` instead. +# yamllint disable rule:line-length +""" + + def render_nav(docs_dir: Path) -> str: """Render the nav.yml body for a docs tree.""" pages = read_pages(docs_dir) @@ -150,15 +176,25 @@ def render_nav(docs_dir: Path) -> str: nav = build_nav_list(pages["nav"], docs_dir, Path("")) - # Dump with a custom representer that keeps strings unquoted where safe - # and preserves unicode (e.g.   in titles) - return yaml.dump( + # `allow_unicode` keeps characters as characters rather than \uXXXX escapes, + # which matters for titles carrying entities such as  . + # + # The indent stays at 2 because yamllint's `indentation` rule defaults to + # `spaces: consistent`, which requires every indentation step in the file to + # be the same width. A `- ` item prefix already costs two columns, so the + # mapping key inside a sequence item sits two in from the dash; the sequence + # step therefore has to be two as well. Four is unreachable: PyYAML's + # `indent=4` pads the dash to `- key:` and trips the `hyphens` rule, while + # re-indenting by hand to ` - key:` trips `indentation` instead. + body = yaml.dump( {"nav": nav}, + Dumper=_IndentedDumper, default_flow_style=False, allow_unicode=True, width=120, indent=2, ) + return NAV_HEADER + body @click.command()