The intent with the change from HTML to Markdown was to ensure that the
developer producing the additional details didn't need to handle UI
concerns like theming and appearance (light/dark/mode). The Markdown should
be used to structure the content in a meaningful way. The UI takes that
content and converts it to markup with appropriate theming and appearance
mode applied.

On Tue, Feb 25, 2025 at 1:42 PM Russell Bateman <r...@windofkeltia.com>
wrote:

> I can now answer my postscript below, though some may wish to post
> caveats, warnings about bad practices, etc. which will be gladly received.
>
> The following seems to work in NiFi 1.28.1. This is
> /additionalDetails.html/ for a custom processor I wrote and it's
> accompanied in the usual (special) place by /additionalDetails.md/. The
> contents of the latter are displayed nicely. So, this was not a hard
> problem to solve.
>
>     <!DOCTYPE html><html lang="en"> <head> <meta charset="utf-8" />
>     <title>Processor name</title> <script type="module"
>     src="https://cdn.jsdelivr.net/npm/zero-md@3?register";></script>
>     </head> <body> <p> Here we attempt to display markdown from a local
>     file. </p> <zero-md src="additionalDetails.md"></zero-md>
>
>     </body>
>     </html>
>
>
> On 2/25/25 10:54, Russell Bateman wrote:
> > Just getting back to this now...
> >
> > The examples of markdown given by Matt [2, below] appear to exhibit
> > font weight bold, styles, headings, bulleted and numbered lists.
> >
> > Is there a conscious "markdown flavor" that we can adhere to in
> > composition or must we reduce /additionalDetails.html/ to the rather
> > low bar apparent in these examples? For example, will the NIFi UI
> > display anything that I can get the (e.g.:) IntelliJ IDEA Markdown
> > plug-in to do?
> >
> > I'm not trying to be impudent here. I'm just trying to gauge what my
> > HTML is going to have to be reduced to.
> >
> > Thanks,
> >
> > Russ
> >
> > P.S. Extra credit.
> >
> > I'm also looking for a way to support my new markdown from
> > /additionalDetails.html/ so that I can "single-source" this
> > documentation for both NiFi 1.x and 2.x. Any comments on this topic
> > would be welcome. I was hoping to avoid having to trick NiFi 1.x into
> > JavaScript libraries or other hacks. (I'm just at the beginning of
> > looking for a solution.)
> >
> >
> > On 11/20/24 15:56, Matt Gilman wrote:
> >> Russell,
> >>
> >> The additional details were migrated to markdown in NiFi 2.0.0. I've
> >> included a bullet point in the migration guidance for it [1]. You should
> >> just need to migrate the contents of additionalDetails.html to Markdown
> and
> >> update the file extension to .md. Here's an example from when the
> changes
> >> landed [2].
> >>
> >> [1]
> >>
> https://cwiki.apache.org/confluence/display/NIFI/Migration+Guidance#MigrationGuidance-Migratingto2.0.0
> >> [2]
> >>
> https://github.com/apache/nifi/pull/9288/files#diff-c8e06d10f3acbd99f183d317dfef2f4377a99904e322ee7f2f23af42196a4214
> >>
> >> On Wed, Nov 20, 2024 at 4:31 PM Russell Bateman<r...@windofkeltia.com>
> >> wrote:
> >>
> >>> Anciently (I mean in NiFi 1.x), there were View usage...and Additional
> >>> Details.
> >>>
> >>> Today, I downloaded NiFi 2.0.0, copied my NAR over and brought up the
> >>> canvas.
> >>>
> >>> Looking for documentation, I got this response for all my custom
> >>> processors:
> >>>
> >>>       Unable to find bundle [com.acme.pipeline:acme-pipeline:4.4.4]
> >>>
> >>> I googled with no results. Anyone know where to point me off the top of
> >>> their head?
> >>>
> >>> Thanks.
> >>>
> >>>
> >>>
> >
>

Reply via email to