This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to annotated tag org.apache.sling.scripting.sightly.compiler-1.0.0 in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-sightly-compiler.git
commit ac72027b914f8ee4b387f5bbdeff591c1863a5cb Author: Radu Cotescu <[email protected]> AuthorDate: Fri Sep 2 14:51:07 2016 +0000 SLING-6028 - Replace Sightly references with HTL in both code and documentation git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/scripting/sightly/compiler@1758968 13f79535-47bb-0310-9956-ffa450edef68 --- README.md | 4 ++-- pom.xml | 14 ++++---------- .../scripting/sightly/compiler/RuntimeFunction.java | 20 ++++++++++---------- .../scripting/sightly/compiler/SightlyCompiler.java | 2 +- .../sightly/compiler/backend/BackendCompiler.java | 2 +- .../sightly/compiler/backend/package-info.java | 4 ++-- .../scripting/sightly/compiler/commands/Command.java | 2 +- .../sightly/compiler/commands/CommandStream.java | 2 +- .../sightly/compiler/commands/Procedure.java | 2 +- .../sightly/compiler/expression/Expression.java | 2 +- .../sightly/compiler/expression/ExpressionNode.java | 2 +- .../compiler/expression/nodes/TernaryOperator.java | 2 +- .../sightly/compiler/util/VariableTracker.java | 2 +- .../sightly/impl/compiler/CompilerFrontend.java | 2 +- .../scripting/sightly/impl/compiler/Syntax.java | 6 +++--- .../impl/compiler/frontend/ExpressionParser.java | 2 +- .../impl/compiler/frontend/Interpolation.java | 2 +- .../sightly/impl/filter/URIManipulationFilter.java | 2 +- .../sightly/impl/html/dom/DocumentParser.java | 2 +- .../sling/scripting/sightly/impl/TestUtils.java | 2 +- 20 files changed, 36 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 4dee861..63860da 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ -Apache Sling Scripting Sightly Compiler +Apache Sling Scripting HTL Compiler ==== -The Apache Sling Scripting Sightly Compiler provides support for compiling Sightly scripts into an Abstract Syntax Tree. +The Apache Sling Scripting HTL Compiler provides support for compiling [HTML Template Language](https://github.com/Adobe-Marketing-Cloud/htl-spec) scripts into an Abstract Syntax Tree. diff --git a/pom.xml b/pom.xml index 1ea803c..f18fa59 100644 --- a/pom.xml +++ b/pom.xml @@ -36,10 +36,10 @@ <version>0.0.1-SNAPSHOT</version> <packaging>bundle</packaging> - <name>Apache Sling Scripting Sightly Compiler</name> + <name>Apache Sling Scripting HTL Compiler</name> <description> - The Apache Sling Scripting Sightly Compiler provides support for compiling Sightly scripts into an Abstract + The Apache Sling Scripting HTL Compiler provides support for compiling HTML Template Language scripts into an Abstract Syntax Tree. </description> @@ -156,14 +156,8 @@ <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> - <groups> - <group> - <title>Sightly Template Engine Compiler</title> - <packages>org.apache.sling.scripting.sightly</packages> - </group> - </groups> - <doctitle>${project.name} Documentation (Version: ${project.version})</doctitle> - <windowtitle>${project.name} Documentation (Version: ${project.version})</windowtitle> + <stylesheet>maven</stylesheet> + <excludePackageNames>*.impl:*.internal:${site.javadoc.exclude}</excludePackageNames> </configuration> </plugin> </plugins> diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/RuntimeFunction.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/RuntimeFunction.java index e88022c..46208e4 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/RuntimeFunction.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/RuntimeFunction.java @@ -22,10 +22,10 @@ import java.util.Locale; * <p> * This class documents what runtime functions (abstracted by * {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall} expression nodes) will need to be available in a - * Sightly runtime. + * HTL runtime. * </p> * <p> - * A Sightly runtime can only be defined through a {@link org.apache.sling.scripting.sightly.compiler.backend.BackendCompiler} + * A HTL runtime can only be defined through a {@link org.apache.sling.scripting.sightly.compiler.backend.BackendCompiler} * that can transpile {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall}s to specific runtime function * implementations. * </p> @@ -43,7 +43,7 @@ public final class RuntimeFunction { * </ol> * </p> * <p> - * For more details check https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/1.2/SPECIFICATION.md#122-format. + * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#122-format. * </p> */ public static final String FORMAT = "format"; @@ -62,7 +62,7 @@ public final class RuntimeFunction { * </ol> * </p> * <p> - * For more details check https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/1.2/SPECIFICATION.md#123-i18n. + * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#123-i18n. * </p> */ public static final String I18N = "i18n"; @@ -78,7 +78,7 @@ public final class RuntimeFunction { * </ol> * </p> * <p> - * For more details check https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/1.2/SPECIFICATION.md#124-array-join. + * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#124-array-join. * </p> */ public static final String JOIN = "join"; @@ -94,7 +94,7 @@ public final class RuntimeFunction { * </ol> * </p> * <p> - * For more details check https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/1.2/SPECIFICATION.md#125-uri-manipulation. + * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#125-uri-manipulation. * </p> */ public static final String URI_MANIPULATION = "uriManipulation"; @@ -110,7 +110,7 @@ public final class RuntimeFunction { * </ol> * </p> * <p> - * For more details check https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/1.2/SPECIFICATION.md#121-display-context. + * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#121-display-context. * </p> */ public static final String XSS = "xss"; @@ -127,7 +127,7 @@ public final class RuntimeFunction { * </p> * <p> * For more details about the supported options check - * https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/1.2/SPECIFICATION.md#228-include. + * https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#228-include. * </p> */ public static final String INCLUDE = "include"; @@ -144,7 +144,7 @@ public final class RuntimeFunction { * </p> * <p> * For more details about the supported options check - * https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/1.2/SPECIFICATION.md#229-resource. + * https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#229-resource. * </p> */ public static final String RESOURCE = "includeResource"; @@ -160,7 +160,7 @@ public final class RuntimeFunction { * </ol> * </p> * <p> - * For more details check https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/1.2/SPECIFICATION.md#221-use. + * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#221-use. * </p> */ public static final String USE = "use"; diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/SightlyCompiler.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/SightlyCompiler.java index 2025ad9..508d93b 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/SightlyCompiler.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/SightlyCompiler.java @@ -64,7 +64,7 @@ import org.apache.sling.scripting.sightly.impl.plugin.UsePlugin; /** * <p> - * The {@link SightlyCompiler} interprets a Sightly script and transforms it internally into a {@link CommandStream}. The + * The {@link SightlyCompiler} interprets a HTL script and transforms it internally into a {@link CommandStream}. The * {@link CommandStream} can be fed to a {@link BackendCompiler} for transforming the stream into executable code, either by * transpiling the commands to a JVM supported language or by directly executing them. * </p> diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/backend/BackendCompiler.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/backend/BackendCompiler.java index a5cb512..228665b 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/backend/BackendCompiler.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/backend/BackendCompiler.java @@ -28,7 +28,7 @@ import aQute.bnd.annotation.ConsumerType; /** * <p> - * A {@link BackendCompiler} can be hooked in into the {@link SightlyCompiler} in order to transpile Sightly {@link Command}s into other + * A {@link BackendCompiler} can be hooked in into the {@link SightlyCompiler} in order to transpile HTL {@link Command}s into other * JVM supported languages. The transpilation can be performed with the help of specific {@link CommandVisitor} implementations that are * attached to the {@link Command}s from the {@link CommandStream}. * </p> diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/backend/package-info.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/backend/package-info.java index 4d1fc00..e444231 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/backend/package-info.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/backend/package-info.java @@ -18,8 +18,8 @@ ******************************************************************************/ /** - * The {@code org.apache.sling.scripting.sightly.compiler.backend} defines the API that can be used by Sightly Backend Compilers, used to - * compile Sightly {@link org.apache.sling.scripting.sightly.compiler.commands.Command}s into executable code for other languages. + * The {@code org.apache.sling.scripting.sightly.compiler.backend} defines the API that can be used by HTL Backend Compilers, used to + * compile HTL {@link org.apache.sling.scripting.sightly.compiler.commands.Command}s into executable code for other languages. */ @Version("1.0.0") package org.apache.sling.scripting.sightly.compiler.backend; diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/Command.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/Command.java index 686d869..d142bb8 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/Command.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/Command.java @@ -21,7 +21,7 @@ package org.apache.sling.scripting.sightly.compiler.commands; import aQute.bnd.annotation.ProviderType; /** - * A {@code Command} represents the type of instruction a certain Sightly expression or block element should execute. Commands are immutable + * A {@code Command} represents the type of instruction a certain HTL expression or block element should execute. Commands are immutable * and can only be processed through a {@link CommandVisitor}. */ @ProviderType diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/CommandStream.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/CommandStream.java index c92a3bd..819fcd6 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/CommandStream.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/CommandStream.java @@ -24,7 +24,7 @@ import aQute.bnd.annotation.ProviderType; /** * <p> - * This interface defines a stream to which {@link Command}s are pushed during the compilation of a Sightly script by the {@link + * This interface defines a stream to which {@link Command}s are pushed during the compilation of a HTL script by the {@link * org.apache.sling.scripting.sightly.compiler.SightlyCompiler}. Depending on how a consumer wants to use the stream there are several * options: * <ul> diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/Procedure.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/Procedure.java index 56bb6cc..d29863c 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/Procedure.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/Procedure.java @@ -23,7 +23,7 @@ import java.util.HashSet; import java.util.Set; /** - * This {@link Command} allows defining a Sightly template - the only functional construct of the language. + * This {@link Command} allows defining a HTL template - the only functional construct of the language. */ public class Procedure { diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/Expression.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/Expression.java index c04a8bc..cb5bc79 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/Expression.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/Expression.java @@ -25,7 +25,7 @@ import java.util.Map; import org.apache.sling.scripting.sightly.compiler.expression.nodes.BinaryOperation; /** - * This class represents a Sightly Expression. + * This class represents a HTL Expression. */ public final class Expression { diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/ExpressionNode.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/ExpressionNode.java index 08a7d1b..edad0f6 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/ExpressionNode.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/ExpressionNode.java @@ -21,7 +21,7 @@ package org.apache.sling.scripting.sightly.compiler.expression; import aQute.bnd.annotation.ProviderType; /** - * Defines a node in a Sightly expression tree. + * Defines a node in a HTL expression tree. */ @ProviderType public interface ExpressionNode { diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/nodes/TernaryOperator.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/nodes/TernaryOperator.java index ab3fa46..b3a68b7 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/nodes/TernaryOperator.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/expression/nodes/TernaryOperator.java @@ -23,7 +23,7 @@ import org.apache.sling.scripting.sightly.compiler.expression.ExpressionNode; import org.apache.sling.scripting.sightly.compiler.expression.NodeVisitor; /** - * Defines the Sightly ternary operator (e.g. {@code condition ? then : else}). + * Defines the HTL ternary operator (e.g. {@code condition ? then : else}). */ public final class TernaryOperator implements ExpressionNode { diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/util/VariableTracker.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/util/VariableTracker.java index 421431d..54c4189 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/util/VariableTracker.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/util/VariableTracker.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Stack; /** - * Tracks information related to Sightly variables, at different levels of the compiler. + * Tracks information related to HTL variables, at different levels of the compiler. */ public final class VariableTracker<T> { diff --git a/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/CompilerFrontend.java b/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/CompilerFrontend.java index e70f29f..d3cfd52 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/CompilerFrontend.java +++ b/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/CompilerFrontend.java @@ -19,7 +19,7 @@ package org.apache.sling.scripting.sightly.impl.compiler; /** - * Sightly compiler frontend. + * HTL compiler frontend. */ public interface CompilerFrontend { diff --git a/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/Syntax.java b/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/Syntax.java index 748b8ec..59a8a45 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/Syntax.java +++ b/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/Syntax.java @@ -23,7 +23,7 @@ import java.util.Arrays; import org.apache.sling.scripting.sightly.impl.plugin.PluginCallInfo; /** - * Sightly Syntax specific elements. + * HTL Syntax specific elements. */ public class Syntax { @@ -40,9 +40,9 @@ public class Syntax { public static final String CONTEXT_OPTION = "context"; /** - * Checks whether a piece of text represents a Sightly comment + * Checks whether a piece of text represents a HTL comment * @param text - the text - * @return - true if it is a Sightly comment, false otherwise + * @return - true if it is a HTL comment, false otherwise */ public static boolean isSightlyComment(String text) { String trimmed = text.trim(); diff --git a/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/ExpressionParser.java b/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/ExpressionParser.java index 05ef860..a3f24b4 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/ExpressionParser.java +++ b/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/ExpressionParser.java @@ -30,7 +30,7 @@ public class ExpressionParser { /** * Parses the expression string. * - * @param expressionString as defined by the Sightly spec (https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/master/SPECIFICATION.md) + * @param expressionString as defined by the HTL spec (https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/master/SPECIFICATION.md) * @return Parsed Expression object * @throws NullPointerException is the given exprString is null * @throws SightlyCompilerException if an error occurs while parsing the expression diff --git a/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/Interpolation.java b/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/Interpolation.java index a6edc7e..d8d33a2 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/Interpolation.java +++ b/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/Interpolation.java @@ -24,7 +24,7 @@ import java.util.List; import org.apache.sling.scripting.sightly.compiler.expression.Expression; /** - * A sequence with alternating string fragments and Sightly expressions. These result from parsing HTML attributes or string nodes. For + * A sequence with alternating string fragments and HTL expressions. These result from parsing HTML attributes or string nodes. For * instance "Hello ${World}!" would result in 3 fragments: "Hello ", ${World} and "!" */ public class Interpolation { diff --git a/src/main/java/org/apache/sling/scripting/sightly/impl/filter/URIManipulationFilter.java b/src/main/java/org/apache/sling/scripting/sightly/impl/filter/URIManipulationFilter.java index ef8d0f5..21ae1e0 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/impl/filter/URIManipulationFilter.java +++ b/src/main/java/org/apache/sling/scripting/sightly/impl/filter/URIManipulationFilter.java @@ -28,7 +28,7 @@ import org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall; /** * The {@code URIManipulationFilter} provides support for Sightly's URI Manipulation options according to the - * <a href="https://github.com/Adobe-Marketing-Cloud/sightly-spec/blob/1.2/SPECIFICATION.md";>language specification</a> + * <a href="https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md";>language specification</a> */ public class URIManipulationFilter extends AbstractFilter { diff --git a/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/DocumentParser.java b/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/DocumentParser.java index a0d4080..1c2eb4b 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/DocumentParser.java +++ b/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/DocumentParser.java @@ -46,7 +46,7 @@ public class DocumentParser { TreeTraverser tree = new TreeTraverser(handler); tree.traverse(template); } catch (IOException e) { - LOGGER.error("Failed to parse Sightly template", e); + LOGGER.error("Failed to parse HTL template", e); } } } diff --git a/src/test/java/org/apache/sling/scripting/sightly/impl/TestUtils.java b/src/test/java/org/apache/sling/scripting/sightly/impl/TestUtils.java index 3c8d01e..bcc014a 100644 --- a/src/test/java/org/apache/sling/scripting/sightly/impl/TestUtils.java +++ b/src/test/java/org/apache/sling/scripting/sightly/impl/TestUtils.java @@ -25,7 +25,7 @@ import java.io.Reader; import org.apache.sling.scripting.sightly.compiler.CompilationUnit; /** - * Testing static utilities that simplify writing tests for the Sightly compiler. + * Testing static utilities that simplify writing tests for the HTL compiler. */ public class TestUtils { -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
