Description & Parameter Formatting: Difference between revisions

From Obsidian Scheduler
Jump to navigationJump to search
No edit summary
No edit summary
 
Line 1: Line 1:
As of version 4.3.0, Obsidian supports formatting of job [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/param/Description.html @Description] and [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/param/Parameter.html#description-- @Parameter.description], with default Markdown formatter support.
As of version 4.3.0, Obsidian supports formatting of job [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/param/Description.html @Description] and [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/param/Parameter.html#description() @Parameter.description], with default Markdown formatter support.





Latest revision as of 17:15, 30 May 2023

As of version 4.3.0, Obsidian supports formatting of job @Description and @Parameter.description, with default Markdown formatter support.


Formatter Interface

Formatter Javadoc.

This interface defines the formatting contract used by Obsidian in formatting all @Description and @Parameter.description values. An optional parameter, com.carfey.obsidian.formatterClass may be specified in your configuration to override the default class: MarkdownFormatter.

Implementing your own Formatter allows for alternate formatting implementations producing valid HTML.

MarkdownFormatter

MarkdownFormatter javadoc.

The default implementation using the flexmark-java library.