OperationConfig

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. lazy val baseConfig: Config

   

   Base configuration merged from all defined extension bundles that serves as a fallback for configuration files in the source directories and/or config headers in markup and template documents.

6. val bundleFilter: BundleFilter

   

   a filter that might deactivate some of the bundles based on user configuration

7. val bundles: Seq[ExtensionBundle]

   

   all extension bundles defined by this operation

8. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

9. lazy val configHeaderParser: (Path) ⇒ Parser[Either[InvalidElement, Config]]

   

   Provides the parser for configuration headers in text markup and template documents, obtained from merging the parsers defined in all extension bundles and adding a fallback that produces an empty configuration if all other parsers fail (or none are defined).

10. lazy val docTypeMatcher: (Path) ⇒ DocumentType

    

    Specifies the function to use for determining the document type of the input based on its path.

    Specifies the function to use for determining the document type of the input based on its path. The function represents the result of merging the partial functions from all defined bundles and adding a fallback (the Ignored document type) for all unhandled Path instances.

11. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

12. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

13. def forRawContent: OperationConfig

    

    Creates a new instance that is configured to allow raw content embedded in the host markup language.

    Creates a new instance that is configured to allow raw content embedded in the host markup language.

    These are disabled by default as Laika is designed to render to multiple output formats from a single input document. With raw content embedded the markup document is tied to a specific output format.

    Technically it activates all bundle instances which have the acceptRawContent flag set to true.

14. def forStrictMode: OperationConfig

    

    Creates a new instance that is configured to interpret text markup as defined by its specification, without any extensions.

    Creates a new instance that is configured to interpret text markup as defined by its specification, without any extensions. Technically this will exclude all bundles that do not have the useInStrictMode flag set.

15. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

16. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

17. lazy val markupExtensions: MarkupExtensions

    

    Provides all extensions for the text markup parser extracted from all defined bundles.

18. val minMessageLevel: MessageLevel

    

    specifies the minimum required level for a system message to get included into the output by a renderer

    specifies the minimum required level for a system message to get included into the output by a renderer

    Definition Classes

    OperationConfig → RenderConfig

19. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

20. final def notify(): Unit

    

    Definition Classes

    AnyRef

21. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

22. val parallelConfig: ParallelConfig

    

23. val renderFormatted: Boolean

    

    indicates whether rendering should include any formatting (line breaks or indentation)

    indicates whether rendering should include any formatting (line breaks or indentation)

    Definition Classes

    OperationConfig → RenderConfig

24. lazy val rewriteRule: (DocumentCursor) ⇒ RewriteRule

    

    The combined rewrite rule, obtained by merging the rewrite rules defined in all bundles.

    The combined rewrite rule, obtained by merging the rewrite rules defined in all bundles. This combined rule gets applied to the document between parse and render operations.

25. def rewriteRuleFor(doc: Document): RewriteRule

    

    The combined rewrite rule for the specified document, obtained by merging the rewrite rules defined in all bundles.

    The combined rewrite rule for the specified document, obtained by merging the rewrite rules defined in all bundles. This combined rule gets applied to the document between parse and render operations.

26. lazy val styleSheetParser: Parser[Set[StyleDeclaration]]

    

    Provides the parser for CSS documents, obtained by merging the parsers defined in all extension bundles and adding a fallback that produces an empty style declaration set if all other parsers fail (or none are defined).

27. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

28. lazy val templateParser: Option[Parser[TemplateRoot]]

    

    Provides the parser for template documents, obtained by merging the parsers defined in all extension bundles (or none if no bundle defines a parser).

    Provides the parser for template documents, obtained by merging the parsers defined in all extension bundles (or none if no bundle defines a parser). This method does not provide a fallback parser as the lack of any defined parser indicates that templates are not supported for this operation. The parse operation should therefore ignore all template documents in the input tree and use the default template from the merged theme for the renderer for its output.

29. def themeFor[W](format: RenderFormat[W]): Theme

    

    Provides the theme for the specified render format, obtained by merging all themes defined for this format and adding the default theme for the format and a fallback theme.

30. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

31. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

32. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

33. def withBundles(bundles: Seq[ExtensionBundle]): OperationConfig

    

    Returns a new instance with the specified extension bundles added to the bundles defined in this instance.

    Returns a new instance with the specified extension bundles added to the bundles defined in this instance. The new bundles are treated with higher precedence that the already defined bundles and may thus overwrite features.

34. def withBundlesFor(parser: MarkupParser): OperationConfig

    

    Returns a new instance with the extension bundles provided by the specified markup parser added to the bundles defined in this instance.