org.xwiki.lesscss.compiler

Interface LESSCompiler

@Role
public interface LESSCompiler

The Integrated LESS Compiler is a LESS compiler that take care of the wiki context (skin and color themes) to generate the appropriate CSS output.

Since:

6.4M2

Version:

$Id: aa472ed3de7e005bc9714970818a7f21d4d2cf2b $

Method Summary

Modifier and Type	Method and Description
String	compile(LESSResourceReference lessResourceReference, boolean includeSkinStyle, boolean useVelocity, boolean force) Compile a LESS resource.
String	compile(LESSResourceReference lessResourceReference, boolean includeSkinStyle, boolean useVelocity, String skin, boolean force) Compile a LESS resource.

Method Detail

compile

String compile(LESSResourceReference lessResourceReference,
               boolean includeSkinStyle,
               boolean useVelocity,
               boolean force)
        throws LESSCompilerException

Compile a LESS resource. Velocity will also be parsed on the resource, but not on the files included via the @import directive. Since the result is cached, do not put velocity code that needs to be always executed, unless you use the force parameter.

Parameters:

lessResourceReference - reference of the LESS resource to compile

includeSkinStyle - include the main LESS file of the skin in order to have variables and mix-ins defined there

useVelocity - either or not the resource be parsed by Velocity before compiling it

force - force the computation, even if the output is already in the cache (not recommended)

Returns:

the generated CSS

Throws:

LESSCompilerException - if problems occur

compile

String compile(LESSResourceReference lessResourceReference,
               boolean includeSkinStyle,
               boolean useVelocity,
               String skin,
               boolean force)
        throws LESSCompilerException

Compile a LESS resource. Velocity will also be parsed on the resource, but not on the files included via the @import directive. Since the result is cached, do not put velocity code that needs to be always executed, unless you use the force parameter.

Parameters:

lessResourceReference - reference of the LESS resource to compile

includeSkinStyle - include the main LESS file of the skin in order to have variables and mix-ins defined there

skin - name of the skin where the LESS file is located

useVelocity - either or not the resource be parsed by Velocity before compiling it

force - force the computation, even if the output is already in the cache (not recommended)

Returns:

the generated CSS

Throws:

LESSCompilerException - if problems occur