di reference: fix generation of multline default values + objectParameters

Author: seebi

docs/build/reference/customtask/cmem_plugin_llm-ExecuteInstructions.md

@@ -215,7 +215,9 @@ The entity path where the instruction result will be provided.
 A list of messages comprising the conversation compatible with OpenAI chat completion API message object.
 
 - Datatype: `code-json`
-- Default Value: `[
+- Default Value:
+``` json
+[
     {
         "role": "developer",
         "content": "You are a helpful assistant."
@@ -224,7 +226,8 @@ A list of messages comprising the conversation compatible with OpenAI chat compl
         "role": "user",
         "content": "{{ instruction_prompt }}"
     }
-]`
+]
+```
 
 
 
@@ -260,13 +263,16 @@ Specifying the format that the model must output.
 The Pydantic schema definition with a mandatory class named `StructuredOutput(BaseModel)`.
 
 - Datatype: `code-python`
-- Default Value: `from pydantic import BaseModel
+- Default Value:
+``` python
+from pydantic import BaseModel
 
 class StructuredOutput(BaseModel):
     title: str
     abstract: str
     keywords: list[str]
-`
+
+```
 
 
 

docs/build/reference/customtask/cmem_plugin_parameters-ParametersPlugin.md

@@ -48,7 +48,9 @@ limit: 5
 Your parameter configuration in YAML Syntax. One 'parameter: value' pair per line. url: http://example.org method: GET query: | SELECT ?s WHERE {{ ?s ?p ?o }} execute_once: True limit: 5
 
 - Datatype: `code-yaml`
-- Default Value: `url: http://example.org
+- Default Value:
+``` yaml
+url: http://example.org
 method: GET
 query: |
     SELECT ?s
@@ -57,7 +59,8 @@ query: |
     }}
 execute_once: True
 limit: 5
-`
+
+```
 
 
 

docs/build/reference/customtask/cmem_plugin_pdf_extract-pdf_extract-PdfExtract.md

@@ -195,7 +195,9 @@ Specifies how text is extracted from a PDF page. Options include "raw", "layout"
 Custom table extraction strategy in YAML format.
 
 - Datatype: `multiline string`
-- Default Value: `# edge_min_length: 3
+- Default Value:
+``` text
+# edge_min_length: 3
 # explicit_horizontal_lines: []
 # explicit_vertical_lines: []
 # horizontal_strategy: lines
@@ -218,7 +220,8 @@ Custom table extraction strategy in YAML format.
 #   vertical_ttb: true
 #   x_tolerance: 2
 #   y_tolerance: 2
-# vertical_strategy: lines`
+# vertical_strategy: lines
+```
 
 
 
@@ -227,7 +230,9 @@ Custom table extraction strategy in YAML format.
 Custom text extraction strategy in YAML format.
 
 - Datatype: `multiline string`
-- Default Value: `# extra_attrs: []
+- Default Value:
+``` text
+# extra_attrs: []
 # horizontal_ltr: true
 # keep_blank_chars: false
 # layout: false
@@ -237,7 +242,8 @@ Custom text extraction strategy in YAML format.
 # x_density: 7.25
 # x_tolerance: 1
 # y_density: 13
-# y_tolerance: 1`
+# y_tolerance: 1
+```
 
 
 

docs/build/reference/customtask/cmem_plugin_validation-validate-ValidateGraph.md

@@ -81,10 +81,13 @@ In this graph, the validation results are materialized. If left empty, results a
 The query to select the resources to validate. Use {{context_graph}} as a placeholder for the select context graph for validation.
 
 - Datatype: `code-sparql`
-- Default Value: `SELECT DISTINCT ?resource
+- Default Value:
+``` sparql
+SELECT DISTINCT ?resource
 FROM <{{context_graph}}>
 WHERE { ?resource a ?class . FILTER isIRI(?resource) }
-`
+
+```
 
 
 

docs/build/reference/customtask/ucumNormalizationTask.md

@@ -77,7 +77,9 @@ An absolute file path for a unit CSV configuration file (for syntax see 'configu
 While all SI units and decimal prefixes are supported by default, custom or obsolete units have to be added via this configuration. NOTE: when constructing formulae depending on other units defined in the configuration, make sure to order them dependently. ALSO: Rational numbers are not supported by the UCUM syntax, express them as a fraction (see 'grain' example below).
 
 - Datatype: `multiline string`
-- Default Value: `
+- Default Value:
+``` text
+
 # Example configuration, don't forget to remove the '#' in front of each row.
 #      CSV COLUMNS:
 #       * unit name - the human readable name of the unit
@@ -91,7 +93,8 @@ While all SI units and decimal prefixes are supported by default, custom or obso
 #       Denier  , true    , den   , g/(9.km)
 #       Grain   , true    , gr    , (45.g)/100
 #       Pound   , true    , lb    , (45359237.kg)/100000000 , # , lbm
-     `
+     
+```
 
 
 

docs/build/reference/dataset/SnowflakeJdbc.md

@@ -54,8 +54,7 @@ The names of the written tables are generated as follows:
 
 Connection parameters
 
-- Datatype: `objectParameter`
-- Default Value: `{'parameters': {'database': '', 'privateKeyPassword': '', 'host': '<orgname>-<account_name>.snowflakecomputing.com', 'privateKey': '', 'user': '', 'schema': '', 'port': '443', 'warehouse': '', 'table': '', 'password': '', 'additionalParameters': ''}}`
+
 
 
 #### Account URL hostname
@@ -151,8 +150,7 @@ Table name. Can be empty if the read-strategy is not set to read the full table.
 
 Parameters related to reading from the database.
 
-- Datatype: `objectParameter`
-- Default Value: `{'parameters': {'queryStrategy': 'access-complete-table', 'restriction': '', 'groupBy': '', 'orderBy': '', 'sourceQuery': '', 'limit': '10'}}`
+
 
 
 #### Source query
@@ -208,8 +206,7 @@ An SQL WHERE clause to filter the records to be retrieved.
 
 Parameters related to writing to the database.
 
-- Datatype: `objectParameter`
-- Default Value: `{'parameters': {'writeStrategy': 'default', 'multipleValuesStrategy': 'concatenateValuesStrategy'}}`
+
 
 
 #### Write strategy
@@ -233,8 +230,7 @@ How multiple values per entity property are written.
 
 Query execution parameters.
 
-- Datatype: `objectParameter`
-- Default Value: `{'parameters': {'retries': '0', 'pause': '2000'}}`
+
 
 
 #### Retries

tools/templates/parameter.md

@@ -2,8 +2,13 @@
 
 {{property.description}}
 
-- Datatype: `{{property.parameterType}}`
-- Default Value: `{{property.value if property.value != "" else "None"}}`
+{% if property.parameterType != "objectParameter" -%}- Datatype: `{{property.parameterType}}`
+{% if property.value and '\n' in property.value -%}- Default Value:
+``` {{ property.get_pygments_code() }}
+{{ property.value }}
+```
+{%- else %}- Default Value: `{{property.value if property.value != "" else "None"}}`
+{%- endif %}{%- endif %}
 
 {% for sub_property in property.properties.values() %}
 #### {{sub_property.title}}

tools/update_di_reference.py

@@ -47,6 +47,20 @@ class PropertyDescription(BaseModel):
     visibleInDialog: bool
     properties: dict[str, dict] = {}
 
+    def get_pygments_code(self) -> str:
+        """Get a markdown pygments code based on the parameterType
+
+        https://pygments.org/docs/lexers/
+        """
+        codes = {
+            "code-json": "json",
+            "code-python": "python",
+            "code-yaml": "yaml",
+            "code-sql": "sql",
+            "code-sparql": "sparql",
+        }
+        return codes.get(self.parameterType, "text")
+
 
 class PluginDescription(BaseModel):
     """Plugin description."""