Show the ff.parameters if present

[evandongen]

Added a block to the parameters section and modified the checks on whether to display this on the presence of this

closes #491

[Matthbo]

Is it just me or does the parameters description not actually show? The div does seem to exist, hence the white space but no actual content seems to be put on the screen

[evandongen]

Is it just me or does the parameters description not actually show? The div does seem to exist, hence the white space but no actual content seems to be put on the screen

ZipWriterPipe does not have a parametersDescription:

"org.frankframework.compression.ZipWriterPipe": {
            "name": "ZipWriterPipe",
            "description": "Pipe that creates a ZIP archive (on action close).\n<p>\nA chain of zipWriterPipes can be used to create a ZIP archive. You can use the pipe with different actions (see specified below).\nAction <code>CLOSE</code> will generate the ZIP archive which is returned as the pipe ouput.\n</p>",
            "parent": "org.frankframework.collection.AbstractCollectorPipe",
            "attributes": {
                "completeFileHeader": {
                    "description": "Only for action='write': If set to <code>true</code>, the fields 'crc-32', 'compressed size' and 'uncompressed size' in the zip entry file header are set explicitly (note: compression ratio is zero)",
                    "default": "false",
                    "type": "bool"
                }
            },
            "parameters": {
                "filename": {
                    "description": "only for <code>action=WRITE</code>: the filename of the zip-entry"
                },
                "contents": {
                    "description": "only for <code>action=WRITE</code>: contents of the zip-entry, If not specified, the input is used."
                }
            }
        }

Take a look at XslErrorMessageFormatter or FrankSender.

edit: you're right about the always rendering the div - the !== null check wasn't working as I expected.

[Matthbo]

The parameters description text does not match the text colour of other descriptions.
If an element does not have parameters or a description it'll still show the parameters section.
For some reason it also always seems to show the description div even if element.parametersDescription is empty

[Matthbo]

Small addition to also have the table of contents on the right side showing when parameter description is available.
Everything else looks good 😄

diff --git a/frank-doc-frontend/src/app/views/details/details.component.ts b/frank-doc-frontend/src/app/views/details/details.component.ts
index 020335e..bf4f3b9 100644
--- a/frank-doc-frontend/src/app/views/details/details.component.ts
+++ b/frank-doc-frontend/src/app/views/details/details.component.ts
@@ -136,7 +136,8 @@ export class DetailsComponent implements OnInit, OnDestroy {
       }
       tableOfContents[index].children!.push({ name: 'Optional', anchor: '#attributes-optional', active: false });
     }
-    if (element.parameters) tableOfContents.push({ name: 'Parameters', anchor: '#parameters', active: false });
+    if (element.parameters || element.parametersDescription)
+      tableOfContents.push({ name: 'Parameters', anchor: '#parameters', active: false });
     if (element.children) tableOfContents.push({ name: 'Nested Elements', anchor: '#nested-elements', active: false });
     if ((element.forwards && Object.keys(element.forwards).length > 0) || this.hasInheritedProperties.forwards)
       tableOfContents.push({ name: 'Forwards', anchor: '#forwards', active: false });

[evandongen]

Small addition to also have the table of contents on the right side showing when parameter description is available. Everything else looks good 😄

diff --git a/frank-doc-frontend/src/app/views/details/details.component.ts b/frank-doc-frontend/src/app/views/details/details.component.ts
index 020335e..bf4f3b9 100644
--- a/frank-doc-frontend/src/app/views/details/details.component.ts
+++ b/frank-doc-frontend/src/app/views/details/details.component.ts
@@ -136,7 +136,8 @@ export class DetailsComponent implements OnInit, OnDestroy {
       }
       tableOfContents[index].children!.push({ name: 'Optional', anchor: '#attributes-optional', active: false });
     }
-    if (element.parameters) tableOfContents.push({ name: 'Parameters', anchor: '#parameters', active: false });
+    if (element.parameters || element.parametersDescription)
+      tableOfContents.push({ name: 'Parameters', anchor: '#parameters', active: false });
     if (element.children) tableOfContents.push({ name: 'Nested Elements', anchor: '#nested-elements', active: false });
     if ((element.forwards && Object.keys(element.forwards).length > 0) || this.hasInheritedProperties.forwards)
       tableOfContents.push({ name: 'Forwards', anchor: '#forwards', active: false });

Thank you! I'll push your suggestion!