Package org.concordion.api.option

Annotation Interface ConcordionOptions

@Retention(RUNTIME) @Target(TYPE) public @interface ConcordionOptions
Options that can be applied to specifications to configure aspects of Concordion.
Since:
2.0.0

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    copySourceHtmlToDir
    If set, a copy of the HTML specification source will be saved to the specified directory.
    String[]
    declareNamespaces
    Additional namespaces to be declared in the input specification.
    MarkdownExtensions[]
    markdownExtensions
    Provides the ability to extend the Markdown syntax, when using Markdown format specifications.

  • Element Details

    • markdownExtensions

      MarkdownExtensions[] markdownExtensions
      Provides the ability to extend the Markdown syntax, when using Markdown format specifications.
      Returns:
      list of extensions to be applied
      Default:
      {}

    • copySourceHtmlToDir

      String copySourceHtmlToDir
      If set, a copy of the HTML specification source will be saved to the specified directory.

      The target directory can include system property values in the path, by wrapping the system property key in `${` and `}`. For example: @ConcordionOptions(copySourceHtmlToDir="${java.io.tmpdir}/output") will write to the output directory under the system temp folder.

      This is useful when investigating the output of converters, such as when using Markdown format, and you want to see the generated HTML.

      Returns:
      the directory to log a copy of the HTML source to, optionally including system properties wrapped in `${` and `}`
      Default:
      ""

    • declareNamespaces

      String[] declareNamespaces
      Additional namespaces to be declared in the input specification. This is used when the specification uses commands from extensions that have different namespaces to the normal Concordion commands. Currently this only applies to the Markdown format, since namespaces are declared directly in the HTML when using HTML specifications.
      Returns:
      list of pairs of Strings to be applied, where each pair contains a namespace prefix followed by the namespace
      Default:
      {}