Package net.sf.okapi.filters.markdown

Class Parameters

    • Constructor Detail

      • Parameters

        public Parameters()

    • Method Detail

      • getHtmlSubfilter

        public String getHtmlSubfilter()
        The configuration that the HTML subfilter uses, if set.
        Returns:
        The configuration file path, or null if Markdown filter's default HTML configuration is used.

      • setHtmlSubfilter

        public void setHtmlSubfilter​(String htmlSubfilter)
        Uses the user-supplied HTML sub-filter configuration rather than Markdown's default.
        Parameters:
        htmlSubfilter - The path of the configuration yml file which typically has the .fprm suffix.

      • getUseCodeFinder

        public boolean getUseCodeFinder()

      • setUseCodeFinder

        public void setUseCodeFinder​(boolean useCodeFinder)

      • getTranslateUrls

        public boolean getTranslateUrls()

      • setTranslateUrls

        public void setTranslateUrls​(boolean translateUrls)

      • getUrlToTranslatePattern

        public String getUrlToTranslatePattern()

      • setUrlToTranslatePattern

        public void setUrlToTranslatePattern​(String urlToTranslatePattern)

      • getTranslateFencedCodeBlocks

        public boolean getTranslateFencedCodeBlocks()

      • setTranslateFencedCodeBlocks

        public void setTranslateFencedCodeBlocks​(boolean translateCodeBlocks)

      • getTranslateIndentedCodeBlocks

        public boolean getTranslateIndentedCodeBlocks()

      • setTranslateIndentedCodeBlocks

        public void setTranslateIndentedCodeBlocks​(boolean translateIndentedCodeBlocks)

      • getTranslateInlineCodeBlocks

        public boolean getTranslateInlineCodeBlocks()

      • setTranslateInlineCodeBlocks

        public void setTranslateInlineCodeBlocks​(boolean translateInlineCodeBlocks)

      • getTranslateHeaderMetadata

        public boolean getTranslateHeaderMetadata()

      • setTranslateHeaderMetadata

        public void setTranslateHeaderMetadata​(boolean translateHeaderMetadata)

      • getTranslateImageAltText

        public boolean getTranslateImageAltText()

      • setTranslateImageAltText

        public void setTranslateImageAltText​(boolean translateImageAltText)

      • getHtmlEntitiesToEscape

        public String getHtmlEntitiesToEscape()

      • setHtmlEntitiesToEscape

        public void setHtmlEntitiesToEscape​(String htmlEntitiesToEscape)

      • getUnescapeBackslashCharacters

        public boolean getUnescapeBackslashCharacters()

      • setUnescapeBackslashCharacters

        public void setUnescapeBackslashCharacters​(boolean unescapeBackslashCharacters)

      • getCharactersToEscape

        public String getCharactersToEscape()

      • setCharactersToEscape

        public void setCharactersToEscape​(String charactersToEscape)

      • getNonTranslateBlocks

        public String getNonTranslateBlocks()

      • setNonTranslateBlocks

        public void setNonTranslateBlocks​(String nonTranslatableBlocks)

      • getYamlSubfilter

        public String getYamlSubfilter()

      • setYamlSubfilter

        public void setYamlSubfilter​(String yamlSubfilter)

      • getGenerateHeaderAnchors

        public boolean getGenerateHeaderAnchors()

      • setGenerateHeaderAnchors

        public void setGenerateHeaderAnchors​(boolean generateHeaderAnchors)

      • getParseMdx

        public boolean getParseMdx()

      • setParseMdx

        public void setParseMdx​(boolean parseMdx)

      • reset

        public void reset()
        Description copied from class: StringParameters
        Reset this parameters object to its default values.

        Subclasses should override this method to set any initial values and instantiate any objects that require allocation. It is recommended that subclasses also call super.reset() in the override to ensure that the buffer is empty.

        Specified by:
        reset in interface IParameters
        Overrides:
        reset in class StringParameters

      • fromString

        public void fromString​(String data)
        Description copied from class: StringParameters
        Reset this parameters object to its default values and then load additional parameters from the provided data.

        Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra initialization as part of their parameter state.

        Specified by:
        fromString in interface IParameters
        Overrides:
        fromString in class StringParameters
        Parameters:
        data - the string holding the parameters. It must be formatted as the string generated by toString(). Line-breaks must be normalized to '\n'. It can also be null or empty, in such case the parameters are left with their current values. Use reset() to reset the parameters to their defaults.

      • toString

        public String toString()
        Description copied from class: StringParameters
        Serialize this parameters object to a string.

        Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra serialization as part of their parameter state.

        Specified by:
        toString in interface IParameters
        Overrides:
        toString in class StringParameters
        Returns:
        the string holding all the parameters.