Skip to content

Commit

Permalink
Add spec/ submodule with boilerplate asciidoc
Browse files Browse the repository at this point in the history 
Signed-off-by: David Blevins <david.blevins@gmail.com>
  • Loading branch information
@dblevins
dblevins committed Jul 12, 2019
1 parent 7d205b7 commit 1b2ecb7
Show file tree
Hide file tree
Showing 9 changed files with 651 additions and 0 deletions.
1 change: 1 addition & 0 deletions pom.xml
View file
Expand Up @@ -43,6 +43,7 @@

<modules>
<module>api</module>
<module>spec</module>
</modules>

<licenses>
Expand Down
22 changes: 22 additions & 0 deletions spec/README.md
View file
@@ -0,0 +1,22 @@
Jakarta Messaging Specification
============================

This project generates the Jakarta Messaging Specification.

Building
--------

Prerequisites:

* JDK8+
* Maven 3.0.3+

Run the full build:

`mvn install`

Locate the html files:
- `target/generated-docs/messaging-spec-<version>.html`

Locate the PDF files:
- `target/generated-docs/messaging-spec-<version>.pdf`
32 changes: 32 additions & 0 deletions spec/assembly.xml
View file
@@ -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>messaging-spec</baseDirectory>
<fileSets>
<fileSet>
<directory>target/generated-docs</directory>
<outputDirectory></outputDirectory>
</fileSet>
</fileSets>
</assembly>
194 changes: 194 additions & 0 deletions spec/pom.xml
View file
@@ -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.jms</groupId>
<artifactId>jms-parent</artifactId>
<version>2.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>messaging-spec</artifactId>
<packaging>pom</packaging>
<name>Jakarta Messaging 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/messaging-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/messaging-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>messaging-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>
Binary file added spec/src/main/asciidoc/images/jakarta_ee_logo_schooner_color_stacked_default.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 72 additions & 0 deletions spec/src/main/asciidoc/license-efsl.adoc
View file
@@ -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 &quot;AS IS,&quot; 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.
28 changes: 28 additions & 0 deletions spec/src/main/asciidoc/messaging-spec.adoc
View file
@@ -0,0 +1,28 @@
//
// Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation
//

= Jakarta Messaging 2.0
:authors: Jakarta Messaging Team, https://projects.eclipse.org/projects/ee4j.jms
:email: https://dev.eclipse.org/mailman/listinfo/jms-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[]
3 changes: 3 additions & 0 deletions spec/src/main/asciidoc/scope.adoc
View file
@@ -0,0 +1,3 @@
== Specification Scope

Jakarta Messaging describes a means for Java applications to create, send, and receive messages via loosely coupled, reliable asynchronous communication services.

0 comments on commit 1b2ecb7

Please sign in to comment.