NOTES.md

Notes

(C) 2019 Damir Cavar, Umang Mehta, Aarushi Bisht, Jagpreet Chawla, Oren Baldinger, ...

Java JSON-NLP Maven module and validator.

Brought to you by the NLP-Lab.org.

Deployment on OSSRH

See pom.xml for details on how to include the Nexus plugin.

There are two deployment configuration. If the deployed module-name ends in "-SNAPSHOT", it will be deployed under the snapshot URL. Else it will be deployed under the staging URL.

The credentials have to be set up in .m2/settings.xml:

<servers>
    <server>
        <id>ossrh</id>
        <username>...</username>
        <password>...</password>
    </server>
</servers>

Add the Nexus plugin, the Javadoc, GPG-, and the JAR-Source plugins to pom.xml:

<build>
	<plugins>
		<plugin>
			<groupId>org.sonatype.plugins</groupId>
			<artifactId>nexus-staging-maven-plugin</artifactId>
			<version>1.6.7</version>
			<extensions>true</extensions>
			<configuration>
				<serverId>ossrh</serverId>
				<nexusUrl>https://oss.sonatype.org/</nexusUrl>
				<autoReleaseAfterClose>true</autoReleaseAfterClose>
			</configuration>
		</plugin>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-source-plugin</artifactId>
			<version>2.2.1</version>
			<executions>
				<execution>
					<id>attach-sources</id>
					<goals>
						<goal>jar-no-fork</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-javadoc-plugin</artifactId>
			<version>2.9.1</version>
			<executions>
				<execution>
					<id>attach-javadocs</id>
					<goals>
							<goal>jar</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>

Package Name

Our domain name of the NLP-Lab is:

nlp-lab.org

The package name is:

org.nlp_lab.clauseboundaryms

The Java guidelines recommend:

If the domain name contains a hyphen, or any other special character not allowed in an identifier (§3.8), convert it into an underscore.