Boilerplate Spec for EE4J_8 Branch (#46)
diff --git a/api/pom.xml b/api/pom.xml new file mode 100644 index 0000000..f0e3681 --- /dev/null +++ b/api/pom.xml
@@ -0,0 +1,371 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved. + + This program and the accompanying materials are made available under the + terms of the Eclipse Public License v. 2.0, which is available at + http://www.eclipse.org/legal/epl-2.0. + + This Source Code may also be made available under the following Secondary + Licenses when the conditions for such availability set forth in the + Eclipse Public License v. 2.0 are satisfied: GNU General Public License, + version 2 with the GNU Classpath Exception, which is available at + https://www.gnu.org/software/classpath/license.html. + + SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 + +--> + +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.eclipse.ee4j</groupId> + <artifactId>project</artifactId> + <version>1.0.5</version> + </parent> + + <groupId>jakarta.annotation</groupId> + <artifactId>jakarta.annotation-api</artifactId> + <version>1.3.5-SNAPSHOT</version> + + <properties> + <non.final>false</non.final> + <spec.version>1.3</spec.version> + <extension.name>jakarta.annotation</extension.name> + <vendor.name>Oracle Corporation</vendor.name> + <implementation.vendor.id>org.glassfish</implementation.vendor.id> + <findbugs.version>3.0.5</findbugs.version> + <findbugs.exclude>exclude.xml</findbugs.exclude> + <findbugs.threshold>Low</findbugs.threshold> + </properties> + + <name>${extension.name} API</name> + <description>Common Annotations for the JavaTM Platform API</description> + + <url>https://projects.eclipse.org/projects/ee4j.ca</url> + + <developers> + <developer> + <name>Linda De Michiel</name> + <organization>Oracle Corp.</organization> + </developer> + </developers> + + <licenses> + <license> + <name>EPL 2.0</name> + <url>http://www.eclipse.org/legal/epl-2.0</url> + <distribution>repo</distribution> + </license> + <license> + <name>GPL2 w/ CPE</name> + <url>https://www.gnu.org/software/classpath/license.html</url> + <distribution>repo</distribution> + </license> + </licenses> + + <scm> + <connection>scm:git:https://github.com/eclipse-ee4j/common-annotations-api.git</connection> + <developerConnection>scm:git:git@github.com:eclipse-ee4j/common-annotations-api.git</developerConnection> + <url>https://github.com/eclipse-ee4j/common-annotations-api</url> + <tag>HEAD</tag> + </scm> + + <issueManagement> + <system>github</system> + <url>https://github.com/eclipse-ee4j/common-annotations-api/issues</url> + </issueManagement> + + <mailingLists> + <mailingList> + <name>Common Annotations mailing list</name> + <post>ca-dev@eclipse.org</post> + <subscribe>https://dev.eclipse.org/mailman/listinfo/ca-dev</subscribe> + <unsubscribe>https://dev.eclipse.org/mailman/listinfo/ca-dev</unsubscribe> + <archive>https://dev.eclipse.org/mhonarc/lists/ca-dev</archive> + </mailingList> + </mailingLists> + + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>build-helper-maven-plugin</artifactId> + <version>3.0.0</version> + </plugin> + <plugin> + <artifactId>maven-compiler-plugin</artifactId> + <version>3.8.0</version> + </plugin> + <plugin> + <groupId>org.glassfish.build</groupId> + <artifactId>spec-version-maven-plugin</artifactId> + <version>1.5</version> + </plugin> + <plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-bundle-plugin</artifactId> + <version>1.4.3</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jar-plugin</artifactId> + <version>3.1.0</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-remote-resources-plugin</artifactId> + <version>1.5</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-source-plugin</artifactId> + <version>3.0.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>3.0.1</version> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>findbugs-maven-plugin</artifactId> + <version>${findbugs.version}</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-release-plugin</artifactId> + <version>2.5.3</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.7.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-gpg-plugin</artifactId> + <version>1.6</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-enforcer-plugin</artifactId> + <version>3.0.0-M2</version> + </plugin> + <plugin> + <!-- Enables step-by-step staging deployment --> + <groupId>org.sonatype.plugins</groupId> + <artifactId>nexus-staging-maven-plugin</artifactId> + <version>1.6.7</version> + </plugin> + </plugins> + </pluginManagement> + + <plugins> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>build-helper-maven-plugin</artifactId> + <executions> + <execution> + <id>add-resource</id> + <phase>generate-resources</phase> + <goals> + <goal>add-resource</goal> + </goals> + <configuration> + <resources> + <resource> + <directory>${basedir}</directory> + <targetPath>META-INF</targetPath> + <includes> + <include>LICENSE.md</include> + <include>NOTICE.md</include> + </includes> + </resource> + </resources> + </configuration> + </execution> + </executions> + </plugin> + <plugin> + <artifactId>maven-compiler-plugin</artifactId> + <configuration> + <source>1.8</source> + <target>1.8</target> + <compilerArgument>-Xlint:unchecked</compilerArgument> + </configuration> + </plugin> + <plugin> + <groupId>org.glassfish.build</groupId> + <artifactId>spec-version-maven-plugin</artifactId> + <configuration> + <specMode>jakarta</specMode> + <spec> + <nonFinal>${non.final}</nonFinal> + <jarType>api</jarType> + <specBuild>${spec.build}</specBuild> + <specVersion>${spec.version}</specVersion> + <newSpecVersion>${new.spec.version}</newSpecVersion> + <specImplVersion>${project.version}</specImplVersion> + <apiPackage>${extension.name}</apiPackage> + </spec> + </configuration> + <executions> + <execution> + <goals> + <goal>set-spec-properties</goal> + <!-- TODO: + glassfish-spec-version-maven-plugin needs to be updated + in order to check 'jakarta.' prefixed values in manifest entries + --> + <!--<goal>check-module</goal>--> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-bundle-plugin</artifactId> + <configuration> + <supportedProjectTypes> + <supportedProjectType>jar</supportedProjectType> + </supportedProjectTypes> + <instructions> + <Bundle-Version>${spec.bundle.version}</Bundle-Version> + <Bundle-SymbolicName>${spec.bundle.symbolic-name}</Bundle-SymbolicName> + <Extension-Name>${spec.extension.name}</Extension-Name> + <Implementation-Version>${spec.implementation.version}</Implementation-Version> + <Specification-Version>${spec.specification.version}</Specification-Version> + <Bundle-Description> + Java(TM) Common Annotations ${spec.version} API Design Specification + </Bundle-Description> + <Specification-Vendor>${vendor.name}</Specification-Vendor> + <Implementation-Vendor>${project.organization.name}</Implementation-Vendor> + <Implementation-Vendor-Id>${implementation.vendor.id}</Implementation-Vendor-Id> + </instructions> + </configuration> + <executions> + <execution> + <id>bundle-manifest</id> + <phase>process-classes</phase> + <goals> + <goal>manifest</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jar-plugin</artifactId> + <configuration> + <archive> + <manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile> + <manifestEntries> + <!-- for JDK 9 --> + <Automatic-Module-Name> + java.annotation + </Automatic-Module-Name> + </manifestEntries> + </archive> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <executions> + <execution> + <id>attach-javadocs</id> + <goals> + <goal>jar</goal> + </goals> + </execution> + <execution> + <phase>javadoc</phase> + <goals> + <goal>javadoc</goal> + </goals> + <configuration> + <groups> + <group> + <title>Common Annotations API Documentation</title> + <packages>javax.annotation</packages> + </group> + </groups> + <bottom> +<![CDATA[Copyright © 1999-2018, + <a href="http://www.oracle.com">Oracle</a> + and/or its affiliates. All Rights Reserved. + Use is subject to + <a href="{@docRoot}/doc-files/speclicense.html" target="_top">license terms</a>. +]]> + </bottom> + </configuration> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>findbugs-maven-plugin</artifactId> + <configuration> + <threshold>${findbugs.threshold}</threshold> + <excludeFilterFile>${findbugs.exclude}</excludeFilterFile> + <findbugsXmlOutput>true</findbugsXmlOutput> + <findbugsXmlWithMessages>true</findbugsXmlWithMessages> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-release-plugin</artifactId> + <configuration> + <mavenExecutorId>forked-path</mavenExecutorId> + <useReleaseProfile>false</useReleaseProfile> + <arguments>${release.arguments}</arguments> + <tagNameFormat>@{project.version}</tagNameFormat> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <configuration> + <reporting> + <plugins> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>findbugs-maven-plugin</artifactId> + <version>${findbugs.version}</version> + <configuration> + <threshold>${findbugs.threshold}</threshold> + <excludeFilterFile>${findbugs.exclude}</excludeFilterFile> + </configuration> + </plugin> + </plugins> + </reporting> + </configuration> + </plugin> + <plugin> + <groupId>org.sonatype.plugins</groupId> + <artifactId>nexus-staging-maven-plugin</artifactId> + <extensions>true</extensions> + <executions> + <execution> + <id>default-deploy</id> + <phase>deploy</phase> + <goals> + <goal>deploy</goal> + </goals> + </execution> + </executions> + <configuration> + <serverId>ossrh</serverId> + <nexusUrl>https://oss.sonatype.org/</nexusUrl> + <autoReleaseAfterClose>false</autoReleaseAfterClose> + </configuration> + </plugin> + </plugins> + + </build> + +</project>
diff --git a/src/main/java/javax/annotation/Generated.java b/api/src/main/java/javax/annotation/Generated.java similarity index 100% rename from src/main/java/javax/annotation/Generated.java rename to api/src/main/java/javax/annotation/Generated.java
diff --git a/src/main/java/javax/annotation/ManagedBean.java b/api/src/main/java/javax/annotation/ManagedBean.java similarity index 100% rename from src/main/java/javax/annotation/ManagedBean.java rename to api/src/main/java/javax/annotation/ManagedBean.java
diff --git a/src/main/java/javax/annotation/PostConstruct.java b/api/src/main/java/javax/annotation/PostConstruct.java similarity index 100% rename from src/main/java/javax/annotation/PostConstruct.java rename to api/src/main/java/javax/annotation/PostConstruct.java
diff --git a/src/main/java/javax/annotation/PreDestroy.java b/api/src/main/java/javax/annotation/PreDestroy.java similarity index 100% rename from src/main/java/javax/annotation/PreDestroy.java rename to api/src/main/java/javax/annotation/PreDestroy.java
diff --git a/src/main/java/javax/annotation/Priority.java b/api/src/main/java/javax/annotation/Priority.java similarity index 100% rename from src/main/java/javax/annotation/Priority.java rename to api/src/main/java/javax/annotation/Priority.java
diff --git a/src/main/java/javax/annotation/Resource.java b/api/src/main/java/javax/annotation/Resource.java similarity index 100% rename from src/main/java/javax/annotation/Resource.java rename to api/src/main/java/javax/annotation/Resource.java
diff --git a/src/main/java/javax/annotation/Resources.java b/api/src/main/java/javax/annotation/Resources.java similarity index 100% rename from src/main/java/javax/annotation/Resources.java rename to api/src/main/java/javax/annotation/Resources.java
diff --git a/src/main/java/javax/annotation/package-info.java b/api/src/main/java/javax/annotation/package-info.java similarity index 100% rename from src/main/java/javax/annotation/package-info.java rename to api/src/main/java/javax/annotation/package-info.java
diff --git a/src/main/java/javax/annotation/security/DeclareRoles.java b/api/src/main/java/javax/annotation/security/DeclareRoles.java similarity index 100% rename from src/main/java/javax/annotation/security/DeclareRoles.java rename to api/src/main/java/javax/annotation/security/DeclareRoles.java
diff --git a/src/main/java/javax/annotation/security/DenyAll.java b/api/src/main/java/javax/annotation/security/DenyAll.java similarity index 100% rename from src/main/java/javax/annotation/security/DenyAll.java rename to api/src/main/java/javax/annotation/security/DenyAll.java
diff --git a/src/main/java/javax/annotation/security/PermitAll.java b/api/src/main/java/javax/annotation/security/PermitAll.java similarity index 100% rename from src/main/java/javax/annotation/security/PermitAll.java rename to api/src/main/java/javax/annotation/security/PermitAll.java
diff --git a/src/main/java/javax/annotation/security/RolesAllowed.java b/api/src/main/java/javax/annotation/security/RolesAllowed.java similarity index 100% rename from src/main/java/javax/annotation/security/RolesAllowed.java rename to api/src/main/java/javax/annotation/security/RolesAllowed.java
diff --git a/src/main/java/javax/annotation/security/RunAs.java b/api/src/main/java/javax/annotation/security/RunAs.java similarity index 100% rename from src/main/java/javax/annotation/security/RunAs.java rename to api/src/main/java/javax/annotation/security/RunAs.java
diff --git a/src/main/java/javax/annotation/security/package-info.java b/api/src/main/java/javax/annotation/security/package-info.java similarity index 100% rename from src/main/java/javax/annotation/security/package-info.java rename to api/src/main/java/javax/annotation/security/package-info.java
diff --git a/src/main/java/javax/annotation/sql/DataSourceDefinition.java b/api/src/main/java/javax/annotation/sql/DataSourceDefinition.java similarity index 100% rename from src/main/java/javax/annotation/sql/DataSourceDefinition.java rename to api/src/main/java/javax/annotation/sql/DataSourceDefinition.java
diff --git a/src/main/java/javax/annotation/sql/DataSourceDefinitions.java b/api/src/main/java/javax/annotation/sql/DataSourceDefinitions.java similarity index 100% rename from src/main/java/javax/annotation/sql/DataSourceDefinitions.java rename to api/src/main/java/javax/annotation/sql/DataSourceDefinitions.java
diff --git a/pom.xml b/pom.xml index f0e3681..7058bd5 100644 --- a/pom.xml +++ b/pom.xml
@@ -17,7 +17,7 @@ --> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> @@ -26,9 +26,20 @@ <version>1.0.5</version> </parent> - <groupId>jakarta.annotation</groupId> - <artifactId>jakarta.annotation-api</artifactId> + <groupId>org.eclipse.ee4j.ca</groupId> + <artifactId>ca-parent</artifactId> + <packaging>pom</packaging> <version>1.3.5-SNAPSHOT</version> + <name>${extension.name} API</name> + <description>Common Annotations for the JavaTM Platform API</description> + <url>https://projects.eclipse.org/projects/ee4j.ca</url> + + <scm> + <connection>scm:git:https://github.com/eclipse-ee4j/common-annotations-api.git</connection> + <developerConnection>scm:git:git@github.com:eclipse-ee4j/common-annotations-api.git</developerConnection> + <url>https://github.com/eclipse-ee4j/common-annotations-api</url> + <tag>HEAD</tag> + </scm> <properties> <non.final>false</non.final> @@ -41,17 +52,10 @@ <findbugs.threshold>Low</findbugs.threshold> </properties> - <name>${extension.name} API</name> - <description>Common Annotations for the JavaTM Platform API</description> - - <url>https://projects.eclipse.org/projects/ee4j.ca</url> - - <developers> - <developer> - <name>Linda De Michiel</name> - <organization>Oracle Corp.</organization> - </developer> - </developers> + <modules> + <module>api</module> + <module>spec</module> + </modules> <licenses> <license> @@ -66,306 +70,4 @@ </license> </licenses> - <scm> - <connection>scm:git:https://github.com/eclipse-ee4j/common-annotations-api.git</connection> - <developerConnection>scm:git:git@github.com:eclipse-ee4j/common-annotations-api.git</developerConnection> - <url>https://github.com/eclipse-ee4j/common-annotations-api</url> - <tag>HEAD</tag> - </scm> - - <issueManagement> - <system>github</system> - <url>https://github.com/eclipse-ee4j/common-annotations-api/issues</url> - </issueManagement> - - <mailingLists> - <mailingList> - <name>Common Annotations mailing list</name> - <post>ca-dev@eclipse.org</post> - <subscribe>https://dev.eclipse.org/mailman/listinfo/ca-dev</subscribe> - <unsubscribe>https://dev.eclipse.org/mailman/listinfo/ca-dev</unsubscribe> - <archive>https://dev.eclipse.org/mhonarc/lists/ca-dev</archive> - </mailingList> - </mailingLists> - - <build> - <pluginManagement> - <plugins> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>build-helper-maven-plugin</artifactId> - <version>3.0.0</version> - </plugin> - <plugin> - <artifactId>maven-compiler-plugin</artifactId> - <version>3.8.0</version> - </plugin> - <plugin> - <groupId>org.glassfish.build</groupId> - <artifactId>spec-version-maven-plugin</artifactId> - <version>1.5</version> - </plugin> - <plugin> - <groupId>org.apache.felix</groupId> - <artifactId>maven-bundle-plugin</artifactId> - <version>1.4.3</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-jar-plugin</artifactId> - <version>3.1.0</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-remote-resources-plugin</artifactId> - <version>1.5</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-source-plugin</artifactId> - <version>3.0.1</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <version>3.0.1</version> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>findbugs-maven-plugin</artifactId> - <version>${findbugs.version}</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-release-plugin</artifactId> - <version>2.5.3</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-site-plugin</artifactId> - <version>3.7.1</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-gpg-plugin</artifactId> - <version>1.6</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-enforcer-plugin</artifactId> - <version>3.0.0-M2</version> - </plugin> - <plugin> - <!-- Enables step-by-step staging deployment --> - <groupId>org.sonatype.plugins</groupId> - <artifactId>nexus-staging-maven-plugin</artifactId> - <version>1.6.7</version> - </plugin> - </plugins> - </pluginManagement> - - <plugins> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>build-helper-maven-plugin</artifactId> - <executions> - <execution> - <id>add-resource</id> - <phase>generate-resources</phase> - <goals> - <goal>add-resource</goal> - </goals> - <configuration> - <resources> - <resource> - <directory>${basedir}</directory> - <targetPath>META-INF</targetPath> - <includes> - <include>LICENSE.md</include> - <include>NOTICE.md</include> - </includes> - </resource> - </resources> - </configuration> - </execution> - </executions> - </plugin> - <plugin> - <artifactId>maven-compiler-plugin</artifactId> - <configuration> - <source>1.8</source> - <target>1.8</target> - <compilerArgument>-Xlint:unchecked</compilerArgument> - </configuration> - </plugin> - <plugin> - <groupId>org.glassfish.build</groupId> - <artifactId>spec-version-maven-plugin</artifactId> - <configuration> - <specMode>jakarta</specMode> - <spec> - <nonFinal>${non.final}</nonFinal> - <jarType>api</jarType> - <specBuild>${spec.build}</specBuild> - <specVersion>${spec.version}</specVersion> - <newSpecVersion>${new.spec.version}</newSpecVersion> - <specImplVersion>${project.version}</specImplVersion> - <apiPackage>${extension.name}</apiPackage> - </spec> - </configuration> - <executions> - <execution> - <goals> - <goal>set-spec-properties</goal> - <!-- TODO: - glassfish-spec-version-maven-plugin needs to be updated - in order to check 'jakarta.' prefixed values in manifest entries - --> - <!--<goal>check-module</goal>--> - </goals> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.apache.felix</groupId> - <artifactId>maven-bundle-plugin</artifactId> - <configuration> - <supportedProjectTypes> - <supportedProjectType>jar</supportedProjectType> - </supportedProjectTypes> - <instructions> - <Bundle-Version>${spec.bundle.version}</Bundle-Version> - <Bundle-SymbolicName>${spec.bundle.symbolic-name}</Bundle-SymbolicName> - <Extension-Name>${spec.extension.name}</Extension-Name> - <Implementation-Version>${spec.implementation.version}</Implementation-Version> - <Specification-Version>${spec.specification.version}</Specification-Version> - <Bundle-Description> - Java(TM) Common Annotations ${spec.version} API Design Specification - </Bundle-Description> - <Specification-Vendor>${vendor.name}</Specification-Vendor> - <Implementation-Vendor>${project.organization.name}</Implementation-Vendor> - <Implementation-Vendor-Id>${implementation.vendor.id}</Implementation-Vendor-Id> - </instructions> - </configuration> - <executions> - <execution> - <id>bundle-manifest</id> - <phase>process-classes</phase> - <goals> - <goal>manifest</goal> - </goals> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-jar-plugin</artifactId> - <configuration> - <archive> - <manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile> - <manifestEntries> - <!-- for JDK 9 --> - <Automatic-Module-Name> - java.annotation - </Automatic-Module-Name> - </manifestEntries> - </archive> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <executions> - <execution> - <id>attach-javadocs</id> - <goals> - <goal>jar</goal> - </goals> - </execution> - <execution> - <phase>javadoc</phase> - <goals> - <goal>javadoc</goal> - </goals> - <configuration> - <groups> - <group> - <title>Common Annotations API Documentation</title> - <packages>javax.annotation</packages> - </group> - </groups> - <bottom> -<![CDATA[Copyright © 1999-2018, - <a href="http://www.oracle.com">Oracle</a> - and/or its affiliates. All Rights Reserved. - Use is subject to - <a href="{@docRoot}/doc-files/speclicense.html" target="_top">license terms</a>. -]]> - </bottom> - </configuration> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>findbugs-maven-plugin</artifactId> - <configuration> - <threshold>${findbugs.threshold}</threshold> - <excludeFilterFile>${findbugs.exclude}</excludeFilterFile> - <findbugsXmlOutput>true</findbugsXmlOutput> - <findbugsXmlWithMessages>true</findbugsXmlWithMessages> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-release-plugin</artifactId> - <configuration> - <mavenExecutorId>forked-path</mavenExecutorId> - <useReleaseProfile>false</useReleaseProfile> - <arguments>${release.arguments}</arguments> - <tagNameFormat>@{project.version}</tagNameFormat> - </configuration> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-site-plugin</artifactId> - <configuration> - <reporting> - <plugins> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>findbugs-maven-plugin</artifactId> - <version>${findbugs.version}</version> - <configuration> - <threshold>${findbugs.threshold}</threshold> - <excludeFilterFile>${findbugs.exclude}</excludeFilterFile> - </configuration> - </plugin> - </plugins> - </reporting> - </configuration> - </plugin> - <plugin> - <groupId>org.sonatype.plugins</groupId> - <artifactId>nexus-staging-maven-plugin</artifactId> - <extensions>true</extensions> - <executions> - <execution> - <id>default-deploy</id> - <phase>deploy</phase> - <goals> - <goal>deploy</goal> - </goals> - </execution> - </executions> - <configuration> - <serverId>ossrh</serverId> - <nexusUrl>https://oss.sonatype.org/</nexusUrl> - <autoReleaseAfterClose>false</autoReleaseAfterClose> - </configuration> - </plugin> - </plugins> - - </build> - </project>
diff --git a/spec/README.md b/spec/README.md new file mode 100644 index 0000000..8cdb7db --- /dev/null +++ b/spec/README.md
@@ -0,0 +1,22 @@ +Jakarta Annotations Specification +============================ + +This project generates the Jakarta Annotations Specification. + +Building +-------- + +Prerequisites: + +* JDK8+ +* Maven 3.0.3+ + +Run the full build: + +`mvn install` + +Locate the html files: +- `target/generated-docs/annotations-spec-<version>.html` + +Locate the PDF files: +- `target/generated-docs/annotations-spec-<version>.pdf`
diff --git a/spec/assembly.xml b/spec/assembly.xml new file mode 100644 index 0000000..3ab0450 --- /dev/null +++ b/spec/assembly.xml
@@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- + + Copyright (c) 2019 Contributors to the Eclipse Foundation. + + This program and the accompanying materials are made available under the + terms of the Eclipse Public License v. 2.0, which is available at + http://www.eclipse.org/legal/epl-2.0. + + This Source Code may also be made available under the following Secondary + Licenses when the conditions for such availability set forth in the + Eclipse Public License v. 2.0 are satisfied: GNU General Public License, + version 2 with the GNU Classpath Exception, which is available at + https://www.gnu.org/software/classpath/license.html. + + SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 + +--> + +<assembly> + <id>spec</id> + <formats> + <format>zip</format> + </formats> + <baseDirectory>annotations-spec</baseDirectory> + <fileSets> + <fileSet> + <directory>target/generated-docs</directory> + <outputDirectory></outputDirectory> + </fileSet> + </fileSets> +</assembly>
diff --git a/spec/pom.xml b/spec/pom.xml new file mode 100644 index 0000000..e39cea1 --- /dev/null +++ b/spec/pom.xml
@@ -0,0 +1,194 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Copyright (c) 2019 Contributors to the Eclipse Foundation. + + This program and the accompanying materials are made available under the + terms of the Eclipse Public License v. 2.0, which is available at + http://www.eclipse.org/legal/epl-2.0. + + This Source Code may also be made available under the following Secondary + Licenses when the conditions for such availability set forth in the + Eclipse Public License v. 2.0 are satisfied: GNU General Public License, + version 2 with the GNU Classpath Exception, which is available at + https://www.gnu.org/software/classpath/license.html. + + SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <parent> + <groupId>org.eclipse.ee4j.ca</groupId> + <artifactId>ca-parent</artifactId> + <version>1.3.5-SNAPSHOT</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <artifactId>annotations-spec</artifactId> + <packaging>pom</packaging> + <name>Jakarta Annotations Specification</name> + + <properties> + <site.output.dir>${project.build.directory}/staging</site.output.dir> + <maven.site.skip>true</maven.site.skip> + <asciidoctor.maven.plugin.version>1.5.7.1</asciidoctor.maven.plugin.version> + <asciidoctorj.version>1.6.2</asciidoctorj.version> + <asciidoctorj.pdf.version>1.5.0-alpha.16</asciidoctorj.pdf.version> + <jruby.version>9.2.6.0</jruby.version> + <!-- status: DRAFT, BETA, etc., or blank for final --> + <status>DRAFT</status> + <maven.build.timestamp.format>MMMM dd, yyyy</maven.build.timestamp.format> + <revisiondate>${maven.build.timestamp}</revisiondate> + </properties> + + <build> + <defaultGoal>package</defaultGoal> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-enforcer-plugin</artifactId> + <version>1.4.1</version> + <executions> + <execution> + <id>enforce-versions</id> + <goals> + <goal>enforce</goal> + </goals> + <configuration> + <rules> + <requireJavaVersion> + <version>[1.8.0,1.9.0)</version> + <message>You need JDK8 or lower</message> + </requireJavaVersion> + </rules> + </configuration> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctor-maven-plugin</artifactId> + <version>${asciidoctor.maven.plugin.version}</version> + <dependencies> + <dependency> + <groupId>org.jruby</groupId> + <artifactId>jruby-complete</artifactId> + <version>${jruby.version}</version> + </dependency> + <dependency> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctorj</artifactId> + <version>${asciidoctorj.version}</version> + </dependency> + <dependency> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctorj-pdf</artifactId> + <version>${asciidoctorj.pdf.version}</version> + </dependency> + </dependencies> + <executions> + <execution> + <id>asciidoc-to-html</id> + <phase>generate-resources</phase> + <goals> + <goal>process-asciidoc</goal> + </goals> + <configuration> + <backend>html5</backend> + <outputFile>${project.build.directory}/generated-docs/annotations-spec-${project.version}.html</outputFile> + <attributes> + <doctype>book</doctype> + <status>${status}</status> + <data-uri /> + <icons>font</icons> + <toc>left</toc> + <icons>font</icons> + <sectanchors>true</sectanchors> + <idprefix /> + <idseparator>-</idseparator> + <docinfo1>true</docinfo1> + </attributes> + </configuration> + </execution> + <execution> + <id>asciidoc-to-pdf</id> + <phase>generate-resources</phase> + <goals> + <goal>process-asciidoc</goal> + </goals> + <configuration> + <backend>pdf</backend> + <outputFile>${project.build.directory}/generated-docs/annotations-spec-${project.version}.pdf</outputFile> + <attributes> + <pdf-stylesdir>${project.basedir}/src/main/theme</pdf-stylesdir> + <pdf-style>jakartaee</pdf-style> + <doctype>book</doctype> + <status>${status}</status> + <data-uri /> + <icons>font</icons> + <pagenums /> + <toc /> + <icons>font</icons> + <sectanchors>true</sectanchors> + <idprefix /> + <idseparator>-</idseparator> + <docinfo1>true</docinfo1> + <embedAssets>true</embedAssets> + </attributes> + </configuration> + </execution> + </executions> + <configuration> + <sourceDocumentName>annotations-spec.adoc</sourceDocumentName> + <sourceHighlighter>coderay</sourceHighlighter> + <attributes> + <revnumber>${project.version}</revnumber> + <revremark>${status}</revremark> + <revdate>${revisiondate}</revdate> + </attributes> + </configuration> + + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-release-plugin</artifactId> + <version>2.5.2</version> + <configuration> + <mavenExecutorId>forked-path</mavenExecutorId> + <useReleaseProfile>false</useReleaseProfile> + <arguments>${release.arguments}</arguments> + </configuration> + <dependencies> + <dependency> + <groupId>org.apache.maven.scm</groupId> + <artifactId>maven-scm-provider-gitexe</artifactId> + <version>1.9.4</version> + </dependency> + </dependencies> + </plugin> + + <!-- + This is the rule that builds the zip file for download. + --> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-assembly-plugin</artifactId> + <version>3.1.1</version> + <inherited>false</inherited> + <executions> + <execution> + <phase>package</phase> + <goals> + <goal>single</goal> + </goals> + <configuration> + <appendAssemblyId>false</appendAssemblyId> + <descriptors> + <descriptor>assembly.xml</descriptor> + </descriptors> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> +</project>
diff --git a/spec/src/main/asciidoc/annotations-spec.adoc b/spec/src/main/asciidoc/annotations-spec.adoc new file mode 100644 index 0000000..fa52af9 --- /dev/null +++ b/spec/src/main/asciidoc/annotations-spec.adoc
@@ -0,0 +1,28 @@ +// +// Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation +// + += Jakarta Annotations 1.3 +:authors: Jakarta Annotations Team, https://projects.eclipse.org/projects/ee4j.ca +:email: https://dev.eclipse.org/mailman/listinfo/ca-dev +:version-label!: +:doctype: book +:license: Eclipse Foundation Specification License v1.0 +:source-highlighter: coderay +:toc: left +:toclevels: 4 +:sectnumlevels: 4 +:sectanchors: +ifdef::backend-pdf[] +:pagenums: +:numbered: +:title-logo-image: image:jakarta_ee_logo_schooner_color_stacked_default.png[pdfwidth=4.25in,align=right] +endif::[] + +// == License +:sectnums!: +include::license-efsl.adoc[] + +// == Scope +:sectnums: +include::scope.adoc[]
diff --git a/spec/src/main/asciidoc/images/jakarta_ee_logo_schooner_color_stacked_default.png b/spec/src/main/asciidoc/images/jakarta_ee_logo_schooner_color_stacked_default.png new file mode 100644 index 0000000..97b46ce --- /dev/null +++ b/spec/src/main/asciidoc/images/jakarta_ee_logo_schooner_color_stacked_default.png Binary files differ
diff --git a/spec/src/main/asciidoc/license-efsl.adoc b/spec/src/main/asciidoc/license-efsl.adoc new file mode 100644 index 0000000..855fc87 --- /dev/null +++ b/spec/src/main/asciidoc/license-efsl.adoc
@@ -0,0 +1,72 @@ +[subs="normal"] +.... +Specification: {doctitle} + +Version: {revnumber} + +Status: {revremark} + +Release: {revdate} +.... + +=== Eclipse Foundation Specification License + +By using and/or copying this document, or the Eclipse Foundation +document from which this statement is linked, you (the licensee) agree +that you have read, understood, and will comply with the following +terms and conditions: + +Permission to copy, and distribute the contents of this document, or +the Eclipse Foundation document from which this statement is linked, in +any medium for any purpose and without fee or royalty is hereby +granted, provided that you include the following on ALL copies of the +document, or portions thereof, that you use: + +* link or URL to the original Eclipse Foundation document. +* All existing copyright notices, or if one does not exist, a notice + (hypertext is preferred, but a textual representation is permitted) + of the form: "Copyright (c) [$date-of-document] + Eclipse Foundation, Inc. <<url to this license>>" + +Inclusion of the full text of this NOTICE must be provided. We +request that authorship attribution be provided in any software, +documents, or other items or products that you create pursuant to the +implementation of the contents of this document, or any portion +thereof. + +No right to create modifications or derivatives of Eclipse Foundation +documents is granted pursuant to this license, except anyone may +prepare and distribute derivative works and portions of this document +in software that implements the specification, in supporting materials +accompanying such software, and in documentation of such software, +PROVIDED that all such works include the notice below. HOWEVER, the +publication of derivative works of this document for use as a technical +specification is expressly prohibited. + +The notice is: + +"Copyright (c) 2018 Eclipse Foundation. This software or +document includes material copied from or derived from [title and URI +of the Eclipse Foundation specification document]." + +==== Disclaimers + +THIS DOCUMENT IS PROVIDED "AS IS," AND THE COPYRIGHT +HOLDERS AND THE ECLIPSE FOUNDATION MAKE NO REPRESENTATIONS OR +WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, +NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THE DOCUMENT ARE +SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF SUCH CONTENTS +WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR +OTHER RIGHTS. + +THE COPYRIGHT HOLDERS AND THE ECLIPSE FOUNDATION WILL NOT BE LIABLE +FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT +OF ANY USE OF THE DOCUMENT OR THE PERFORMANCE OR IMPLEMENTATION OF THE +CONTENTS THEREOF. + +The name and trademarks of the copyright holders or the Eclipse +Foundation may NOT be used in advertising or publicity pertaining to +this document or its contents without specific, written prior +permission. Title to copyright in this document will at all times +remain with copyright holders.
diff --git a/spec/src/main/asciidoc/scope.adoc b/spec/src/main/asciidoc/scope.adoc new file mode 100644 index 0000000..6675b31 --- /dev/null +++ b/spec/src/main/asciidoc/scope.adoc
@@ -0,0 +1,3 @@ +== Specification Scope + +Jakarta Annotations defines a collection of annotations representing common semantic concepts that enable a declarative style of programming that applies across a variety of Java technologies.
diff --git a/spec/src/main/theme/jakartaee-theme.yml b/spec/src/main/theme/jakartaee-theme.yml new file mode 100644 index 0000000..6092a2f --- /dev/null +++ b/spec/src/main/theme/jakartaee-theme.yml
@@ -0,0 +1,299 @@ +# +# Following is the asciidoctor-pdf default theme [1], with small +# customizations, mostly for header and footer, marked "EE". +# +# [1] https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/default-theme.yml +# +font: + catalog: + # Noto Serif supports Latin, Latin-1 Supplement, Latin Extended-A, Greek, Cyrillic, Vietnamese & an assortment of symbols + Noto Serif: + normal: notoserif-regular-subset.ttf + bold: notoserif-bold-subset.ttf + italic: notoserif-italic-subset.ttf + bold_italic: notoserif-bold_italic-subset.ttf + # M+ 1mn supports ASCII and the circled numbers used for conums + M+ 1mn: + normal: mplus1mn-regular-ascii-conums.ttf + bold: mplus1mn-bold-ascii.ttf + italic: mplus1mn-italic-ascii.ttf + bold_italic: mplus1mn-bold_italic-ascii.ttf + # M+ 1p supports Latin, Latin-1 Supplement, Latin Extended, Greek, Cyrillic, Vietnamese, Japanese & an assortment of symbols + # It also provides arrows for ->, <-, => and <= replacements in case these glyphs are missing from font + M+ 1p Fallback: + normal: mplus1p-regular-fallback.ttf + bold: mplus1p-regular-fallback.ttf + italic: mplus1p-regular-fallback.ttf + bold_italic: mplus1p-regular-fallback.ttf + fallbacks: + - M+ 1p Fallback +page: + background_color: ffffff + layout: portrait + margin: [0.5in, 0.67in, 0.67in, 0.67in] + # margin_inner and margin_outer keys are used for recto/verso print margins when media=prepress + margin_inner: 0.75in + margin_outer: 0.59in + #size: A4 # EE + size: Letter # EE +base: + align: justify + # color as hex string (leading # is optional) + font_color: 333333 + # color as RGB array + #font_color: [51, 51, 51] + # color as CMYK array (approximated) + #font_color: [0, 0, 0, 0.92] + #font_color: [0, 0, 0, 92%] + font_family: Noto Serif + # choose one of these font_size/line_height_length combinations + #font_size: 14 + #line_height_length: 20 + #font_size: 11.25 + #line_height_length: 18 + #font_size: 11.2 + #line_height_length: 16 + font_size: 10.5 + #line_height_length: 15 + # correct line height for Noto Serif metrics + line_height_length: 12 + #font_size: 11.25 + #line_height_length: 18 + line_height: $base_line_height_length / $base_font_size + font_size_large: round($base_font_size * 1.25) + font_size_small: round($base_font_size * 0.85) + font_size_min: $base_font_size * 0.75 + font_style: normal + border_color: eeeeee + border_radius: 4 + border_width: 0.5 +# FIXME vertical_rhythm is weird; we should think in terms of ems +#vertical_rhythm: $base_line_height_length * 2 / 3 +# correct line height for Noto Serif metrics (comes with built-in line height) +vertical_rhythm: $base_line_height_length +horizontal_rhythm: $base_line_height_length +# QUESTION should vertical_spacing be block_spacing instead? +vertical_spacing: $vertical_rhythm +link: + font_color: 428bca +# literal is currently used for inline monospaced in prose and table cells +literal: + font_color: b12146 + font_family: M+ 1mn +menu_caret_content: " <font size=\"1.15em\"><color rgb=\"b12146\">\u203a</color></font> " +heading: + align: left + #font_color: 181818 + font_color: $base_font_color + font_family: $base_font_family + font_style: bold + # h1 is used for part titles (book doctype) or the doctitle (article doctype) + #h1_font_size: floor($base_font_size * 2.6) # EE + h1_font_size: floor($base_font_size * 2.5) # EE, squeeze title onto one line + # h2 is used for chapter titles (book doctype only) + h2_font_size: floor($base_font_size * 2.15) + h3_font_size: round($base_font_size * 1.7) + h4_font_size: $base_font_size_large + h5_font_size: $base_font_size + h6_font_size: $base_font_size_small + #line_height: 1.4 + # correct line height for Noto Serif metrics (comes with built-in line height) + line_height: 1 + margin_top: $vertical_rhythm * 0.4 + margin_bottom: $vertical_rhythm * 0.9 +title_page: + align: right + logo: + top: 10% + title: + top: 55% + font_size: $heading_h1_font_size + font_color: 999999 + line_height: 0.9 + subtitle: + font_size: $heading_h3_font_size + font_style: bold_italic + line_height: 1 + authors: + margin_top: $base_font_size * 1.25 + font_size: $base_font_size_large + font_color: 181818 + revision: + margin_top: $base_font_size * 1.25 +block: + margin_top: 0 + margin_bottom: $vertical_rhythm +caption: + align: left + font_size: $base_font_size * 0.95 + font_style: italic + # FIXME perhaps set line_height instead of / in addition to margins? + margin_inside: $vertical_rhythm / 3 + #margin_inside: $vertical_rhythm / 4 + margin_outside: 0 +lead: + font_size: $base_font_size_large + line_height: 1.4 +abstract: + font_color: 5c6266 + font_size: $lead_font_size + line_height: $lead_line_height + font_style: italic + first_line_font_style: bold + title: + align: center + font_color: $heading_font_color + font_family: $heading_font_family + font_size: $heading_h4_font_size + font_style: $heading_font_style +admonition: + column_rule_color: $base_border_color + column_rule_width: $base_border_width + padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm] + #icon: + # tip: + # name: fa-lightbulb-o + # stroke_color: 111111 + # size: 24 + label: + text_transform: uppercase + font_style: bold +blockquote: + font_color: $base_font_color + font_size: $base_font_size_large + border_color: $base_border_color + border_width: 5 + # FIXME disable negative padding bottom once margin collapsing is implemented + padding: [0, $horizontal_rhythm, $block_margin_bottom * -0.75, $horizontal_rhythm + $blockquote_border_width / 2] + cite_font_size: $base_font_size_small + cite_font_color: 999999 +# code is used for source blocks (perhaps change to source or listing?) +code: + font_color: $base_font_color + font_family: $literal_font_family + font_size: ceil($base_font_size) + padding: $code_font_size + line_height: 1.25 + # line_gap is an experimental property to control how a background color is applied to an inline block element + line_gap: 3.8 + background_color: f5f5f5 + border_color: cccccc + border_radius: $base_border_radius + border_width: 0.75 +conum: + font_family: M+ 1mn + font_color: $literal_font_color + font_size: $base_font_size + line_height: 4 / 3 +example: + border_color: $base_border_color + border_radius: $base_border_radius + border_width: 0.75 + background_color: ffffff + # FIXME reenable padding bottom once margin collapsing is implemented + padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm] +image: + align: left +prose: + margin_top: $block_margin_top + margin_bottom: $block_margin_bottom +sidebar: + background_color: eeeeee + border_color: e1e1e1 + border_radius: $base_border_radius + border_width: $base_border_width + # FIXME reenable padding bottom once margin collapsing is implemented + padding: [$vertical_rhythm, $vertical_rhythm * 1.25, 0, $vertical_rhythm * 1.25] + title: + align: center + font_color: $heading_font_color + font_family: $heading_font_family + font_size: $heading_h4_font_size + font_style: $heading_font_style +thematic_break: + border_color: $base_border_color + border_style: solid + border_width: $base_border_width + margin_top: $vertical_rhythm * 0.5 + margin_bottom: $vertical_rhythm * 1.5 +description_list: + term_font_style: bold + term_spacing: $vertical_rhythm / 4 + description_indent: $horizontal_rhythm * 1.25 +outline_list: + indent: $horizontal_rhythm * 1.5 + #marker_font_color: 404040 + # NOTE outline_list_item_spacing applies to list items that do not have complex content + item_spacing: $vertical_rhythm / 2 +table: + background_color: $page_background_color + #head_background_color: <hex value> + #head_font_color: $base_font_color + head_font_style: bold + #body_background_color: <hex value> + body_stripe_background_color: f9f9f9 + foot_background_color: f0f0f0 + border_color: dddddd + border_width: $base_border_width + cell_padding: 3 +toc: + indent: $horizontal_rhythm + line_height: 1.4 + dot_leader: + #content: ". " + font_color: a9a9a9 + #levels: 2 3 +# NOTE in addition to footer, header is also supported +footer: + font_size: $base_font_size_small + # NOTE if background_color is set, background and border will span width of page + #border_color: dddddd # EE + #border_width: 0.25 # EE + height: $base_line_height_length * 2.5 + line_height: 1 + padding: [$base_line_height_length / 2, 1, 0, 1] + vertical_align: top + #image_vertical_align: <alignment> or <number> + # additional attributes for content: + # * {page-count} + # * {page-number} + # * {document-title} + # * {document-subtitle} + # * {chapter-title} + # * {section-title} + # * {section-or-chapter-title} + recto: + #columns: "<50% =0% >50%" + right: + #content: '{page-number}' # EE + #content: '{section-or-chapter-title} | {page-number}' + #content: '{document-title} | {page-number}' + content: '{document-title}{nbsp}{nbsp}{nbsp} *{page-number}*' # EE + #center: + # content: '{page-number}' + left: # EE + content: '{status}' # EE + verso: + #columns: $footer_recto_columns + left: + #content: $footer_recto_right_content # EE + #content: '{page-number} | {chapter-title}' + content: '*{page-number}* {nbsp}{nbsp}{nbsp}{document-title}' # EE + #center: + # content: '{page-number}' + right: # EE + content: '{status}' # EE +header: # EE + font_size: $base_font_size_small # EE + border_color: dddddd # EE + border_width: 0.25 # EE + height: $base_line_height_length * 2.5 # EE + line_height: 1 # EE + padding: [$base_line_height_length / 2, 1, 0, 1] # EE + vertical_align: top # EE + recto: # EE + right: # EE + content: '{section-or-chapter-title}' # EE + verso: # EE + left: # EE + content: '{section-or-chapter-title}' # EE
