Skip to content
This repository was archived by the owner on Aug 23, 2023. It is now read-only.

Commit 74670e3

Browse files
wmhopkinswmhopkins
committed
restructure part 1: update top-level readme and pom.xml
1 parent cd26e5b commit 74670e3

File tree

2 files changed

+154
-38
lines changed

2 files changed

+154
-38
lines changed

‎README.adoc‎

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,10 @@
1-
= JSR 375 EE Security API: Specification, Java API, and JavaDoc Generation
1+
= JSR 375 EE Security API: Specification
22

3-
This project contains the AsciiDoc and Java API sources to generate the specification document, the Java API, and the JavaDoc. The project is organized into two modules: _api_ and _spec_. The api module contains the Java API sources, which may be used to generate the api jar and JavaDoc. The spec module contains the specification document sources, which may be used to generate the specification in both HTML and pdf format.
3+
The repository contains the AsciiDoc sources to generate the specification document in both HTML and pdf format.
44

5-
== Mirroring from java.net
5+
== Generating the Specification
66

7-
The specification must originate from java.net per Oracle policy. To enable use of the facilities of GitHub, the java.net repository is periodically mirrored into a GitHub repository. The corresponding GitHub repository is effectively "read only".
8-
9-
Source Repository on java.net::
10-
`git://java.net/javaee-security-spec~spec-api`
11-
12-
Mirrored Respository on GitHub::
13-
`[email protected]:javaee-security-spec/spec-api.git`
14-
15-
== Generating the Specification, API, and JavaDoc
16-
17-
Just enter `mvn` at the command line. Maven will generate the following artifacts.
7+
Just enter `mvn` at the command line in this directory. Maven will generate the following artifacts.
188

199
Specification as PDF::
2010
* The specification in PDF form.
@@ -24,22 +14,8 @@ Specification as HTML::
2414
* The specification in HTML form.
2515
* In the directory: `spec/target/publish/html`
2616

27-
API Jar::
28-
* The jar containing the api interfaces and classes.
29-
* In the directory: `/api/target`
30-
31-
API JavaDoc::
32-
* The JavaDoc for the api interfaces and classes.
33-
* In the directory: `api/target/site/apidocs`
34-
35-
== How to Contribute from GitHub
17+
== Specification Source
3618

37-
_NOTE: Only Expert Group members may contribute changes to this repository due to requiring a Java Specification Participation Agreement._
19+
The AsciiDoc specification source is located in this directory:
20+
`spec/src/main/doc`
3821

39-
[start=1]
40-
. Fork the repository
41-
. Create the change in your fork
42-
. Submit a Pull Request
43-
. The change is reviewed
44-
. If approved, spec lead merges the change into java.net
45-
. Change gets mirrored back to GitHub

‎pom.xml‎

Lines changed: 147 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<packaging>pom</packaging>
99

1010
<name>EE Security API Specification</name>
11-
<description>Parent module for EE Security API Specification</description>
11+
<description>Specification for Java EE Security API</description>
1212

1313
<url>https://java.net/projects/javaee-security-spec</url>
1414
<licenses>
@@ -37,14 +37,154 @@
3737
</mailingList>
3838
</mailingLists>
3939

40-
<modules>
41-
<module>spec</module>
42-
<!-- don't build api from this repository -->
43-
<!-- <module>api</module> -->
44-
</modules>
40+
<properties>
41+
<asciidoctor.version>1.5.2</asciidoctor.version>
42+
</properties>
4543

4644
<build>
47-
<defaultGoal>clean package javadoc:javadoc</defaultGoal>
45+
<defaultGoal>clean package</defaultGoal>
46+
<resources>
47+
<resource>
48+
<directory>src/main/doc</directory>
49+
<targetPath>${basedir}/target/filtered</targetPath>
50+
<filtering>true</filtering>
51+
</resource>
52+
</resources>
53+
<plugins>
54+
<plugin>
55+
<groupId>org.apache.maven.plugins</groupId>
56+
<artifactId>maven-resources-plugin</artifactId>
57+
<version>2.6</version>
58+
<executions>
59+
<execution>
60+
<id>filter</id>
61+
<phase>generate-resources</phase>
62+
<goals>
63+
<goal>resources</goal>
64+
</goals>
65+
</execution>
66+
</executions>
67+
<configuration>
68+
<encoding>UTF-8</encoding>
69+
</configuration>
70+
</plugin>
71+
<plugin>
72+
<groupId>org.asciidoctor</groupId>
73+
<artifactId>asciidoctor-maven-plugin</artifactId>
74+
<version>${asciidoctor.version}</version>
75+
<executions>
76+
<execution>
77+
<id>output-html</id>
78+
<phase>generate-resources</phase>
79+
<goals>
80+
<goal>process-asciidoc</goal>
81+
</goals>
82+
<configuration>
83+
<sourceHighlighter>highlightjs</sourceHighlighter>
84+
<backend>html5</backend>
85+
<outputDirectory>target/publish/html</outputDirectory>
86+
<sourceDocumentName>jsr375-spec.asciidoc</sourceDocumentName>
87+
<attributes>
88+
<toc2>left</toc2>
89+
<pygments>true</pygments>
90+
<toclevels>3</toclevels>
91+
</attributes>
92+
</configuration>
93+
</execution>
94+
<execution>
95+
<id>output-docbook</id>
96+
<phase>process-resources</phase>
97+
<goals>
98+
<goal>process-asciidoc</goal>
99+
</goals>
100+
<configuration>
101+
<backend>docbook45</backend>
102+
<doctype>book</doctype>
103+
104+
<templateEngine>slim</templateEngine>
105+
<headerFooter>true</headerFooter>
106+
<compact>false</compact>
107+
<outputDirectory>target/docbook/en-US</outputDirectory>
108+
<attributes>
109+
<numbered>true</numbered>
110+
<docinfo>true</docinfo>
111+
<experimental>true</experimental>
112+
<toc>true</toc>
113+
</attributes>
114+
</configuration>
115+
</execution>
116+
</executions>
117+
<configuration>
118+
<sourceDirectory>target/filtered</sourceDirectory>
119+
</configuration>
120+
</plugin>
121+
122+
<plugin>
123+
<groupId>org.jboss.maven.plugins</groupId>
124+
<artifactId>maven-jdocbook-plugin</artifactId>
125+
<version>2.3.8</version>
126+
<extensions>true</extensions>
127+
<dependencies>
128+
<dependency>
129+
<groupId>org.jboss.pressgang</groupId>
130+
<artifactId>pressgang-xslt</artifactId>
131+
<version>2.0.0</version>
132+
</dependency>
133+
<dependency>
134+
<groupId>org.jboss.pressgang</groupId>
135+
<artifactId>pressgang-jdocbook-style</artifactId>
136+
<type>jdocbook-style</type>
137+
<version>3.0.0</version>
138+
</dependency>
139+
</dependencies>
140+
<executions>
141+
<execution>
142+
<id>generate-pdf</id>
143+
<phase>process-resources</phase>
144+
<goals>
145+
<goal>generate</goal>
146+
</goals>
147+
</execution>
148+
</executions>
149+
<configuration>
150+
<sourceDirectory>target/docbook</sourceDirectory>
151+
<baseOutputDirectory>target/publish</baseOutputDirectory>
152+
<sourceDocumentName>jsr375-spec.xml</sourceDocumentName>
153+
<ignoreTranslations>true</ignoreTranslations>
154+
<!--<imageResource>
155+
<directory>${project.basedir}/target/docbook/en-US</directory>
156+
<includes>
157+
<include>images/*.png</include>
158+
</includes>
159+
</imageResource>-->
160+
<formats>
161+
<format>
162+
<formatName>pdf</formatName>
163+
<stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
164+
<finalName>jsr375-spec.pdf</finalName>
165+
</format>
166+
</formats>
167+
<options>
168+
<xincludeSupported>true</xincludeSupported>
169+
<xmlTransformerType>saxon</xmlTransformerType>
170+
<docbookVersion>1.72.0</docbookVersion>
171+
<localeSeparator>-</localeSeparator>
172+
<injectionDateFormat>dd/MM/yyy</injectionDateFormat>
173+
<transformerParameters>
174+
<property>
175+
<name>javax.xml.parsers.DocumentBuilderFactory</name>
176+
<value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
177+
</property>
178+
<property>
179+
<name>javax.xml.parsers.SAXParserFactory</name>
180+
<value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
181+
</property>
182+
</transformerParameters>
183+
</options>
184+
</configuration>
185+
</plugin>
186+
</plugins>
48187
</build>
49188

50189
</project>
190+

0 commit comments

Comments
 (0)