Package org.xwiki.rendering.configuration

Interface ExtendedRenderingConfiguration

  • @Role
public interface ExtendedRenderingConfiguration
    Extends RenderingConfiguration with XWiki-specific configuration properties.
    Since:
    8.2M1
    Version:
    $Id: 503d79b75cdec6f3e92d0865af8b8b45ccaff3e9 $

    • Method Detail

      • isImageDimensionsIncludedInImageURL

        boolean isImageDimensionsIncludedInImageURL()
        Returns:
        true to include the image dimensions extracted from the image parameters in the image URL, false otherwise; when image dimensions are included in the image URL the image can be resized on the server side before being downloaded.

      • getImageWidthLimit

        int getImageWidthLimit()
        One way to improve page load speed is to resize images on the server side just before rendering the page. The rendering module can use the image width provided by the user to scale the image. When the user doesn't specify the image width the rendering module can limit the width of the image based on this configuration parameter.

        The default value is -1 which means image width is not limited by default. Use a value greater than 0 to limit the image width (pixels). Note that the aspect ratio is kept even when both the width and the height of the image are limited.

        Returns:
        the maximum image width when there's no user supplied width
        See Also:
        isImageDimensionsIncludedInImageURL()

      • getImageHeightLimit

        int getImageHeightLimit()
        One way to improve page load speed is to resize images on the server side just before rendering the page. The rendering module can use the image height provided by the user to scale the image. When the user doesn't specify the image height the rendering module can limit the height of the image based on this configuration parameter.

        The default value is -1 which means image height is not limited by default. Use a value greater than 0 to limit the image height (pixels). Note that the aspect ratio is kept even when both the width and the height of the image are limited.

        Returns:
        the maximum image height when there's no user supplied height
        See Also:
        isImageDimensionsIncludedInImageURL()

      • getConfiguredSyntaxes

        List<org.xwiki.rendering.syntax.Syntax> getConfiguredSyntaxes()
        Returns:
        the list of Rendering Syntaxes that should be used for the current wiki (i.e. that should be proposed to the user when editing wiki pages). These are input Syntaxes only (i.e. Syntaxes having a Parser for them).

      • getDisabledSyntaxes

        List<org.xwiki.rendering.syntax.Syntax> getDisabledSyntaxes()
        Returns:
        the list of Rendering Syntaxes that should not be used for the current wiki (i.e. that should not be proposed to the user when editing wiki pages). The reason is that we want by default that all syntaxes are enabled (for example so that when installing a new Syntax through the Extension Manager it's active by default)

      • getDefaultContentSyntax

        default org.xwiki.rendering.syntax.Syntax getDefaultContentSyntax()
        Returns:
        the default Syntax to use when creating new content (Documents, etc).
        Since:
        11.0, 10.11.9