Description & Parameter Formatting: Difference between revisions
From Obsidian Scheduler
Jump to navigationJump to search
Created page with "As of version 4.3.0, Obsidian supports formatting of job [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/job/param/Description.html @Description] and [http://obsidian..." |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
As of version 4.3.0, Obsidian supports formatting of job [ | 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. | ||
| Line 6: | Line 6: | ||
= Formatter Interface = | = Formatter Interface = | ||
[ | [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/config/formatter/Formatter.html Formatter Javadoc]. | ||
This interface defines the formatting contract used by Obsidian in formatting all <code>@Description</code> and <code>@Parameter.description</code> values. | This interface defines the formatting contract used by Obsidian in formatting all <code>@Description</code> and <code>@Parameter.description</code> values. | ||
| Line 15: | Line 15: | ||
= MarkdownFormatter = | = MarkdownFormatter = | ||
[ | [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/config/formatter/MarkdownFormatter.html MarkdownFormatter javadoc]. | ||
The default implementation using the [https://github.com/vsch/flexmark-java flexmark-java] library. | The default implementation using the [https://github.com/vsch/flexmark-java flexmark-java] library. | ||
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
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
The default implementation using the flexmark-java library.
