Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Mirror of Apache Any23
HTML Java TeX Other

ANY23-247 FIX Attribute name itemscope associated with an element typ…

…e 'html' must be followed by the ' = ' character. and Add Rover default output to the Any23 README
latest commit a03bafa9c1
@lewismc lewismc authored

README.md

          :::     ::::    ::: :::   :::  ::::::::   ::::::::
       :+: :+:   :+:+:   :+: :+:   :+: :+:    :+: :+:    :+:
     +:+   +:+  :+:+:+  +:+  +:+ +:+        +:+         +:+
   +#++:++#++: +#+ +:+ +#+   +#++:       +#+        +#++:
  +#+     +#+ +#+  +#+#+#    +#+      +#+             +#+
 #+#     #+# #+#   #+#+#    #+#     #+#       #+#    #+#
###     ### ###    ####    ###    ##########  ########

Apache Anything To Triples (Any23) is a library and web service that extracts structured data in RDF format from a variety of Web documents. Any23 documentation can be found on the website

Distribution Content

  • api: Any23 library external API.
  • core: The library core codebase.
  • csvutils: A CSV specific package
  • encoding: Encoding detection library.
  • mime: MIME Type detection library.
  • nquads: NQuads parsing and serialization library.
  • plugins: Library plugins codebase (read plugins/README.txt for further details).
  • service: The library HTTP service codebase.
  • src: Packaging for Any23 artifacts.
  • test-resources: Material relating to Any23 JUnit test cases.
  • RELEASE-NOTES.txt: File reporting main release notes for every version.
  • LICENSE.txt: Applicable project license.
  • README.md: This file.

Online Documentation

For details on the command line tool and web interface, see here

For a guide to using Any23 as a library in your Java applications, see here

Javadocs is available here

Community

You can reach our and connect with our community on our mailing lists

Build Any23 from Source Code

The canonical Any23 source code lives at the Apache Software Foundation Git repository.

Be sure to have the Apache Maven v.3.x+ installed and included in $PATH.

Clone the source:

git clone https://git-wip-us.apache.org/repos/asf/any23.git

Navigate and build:

cd any23
mvn clean install

From now on the above directory any23 is refered to as $ANY23_HOME This will install the Any23 artifacts and its dependencies in your local Maven3 repository. You can then extract the compiled code and use the command line interface Please note you will need to change the version to the tar or zip you are extracting.

tar -zxvf $ANY23_HOME/core/target/apache-any23-core-${version-SNAPSHOT}.tar.gz

Run the Any23 Commandline Tools

Any23 comes with some command line tools. Within the directory you just extracted, you can invoke: Linux

$ANY23_HOME/core/target/apache-any23-core-${version-SNAPSHOT}/bin/any23       # Provides the main Any23 use case: metadata extraction on a file or URL source.

Windows

$ANY23_HOME/core/target/apache-any23-core-${version-SNAPSHOT}/bin/any23.bat      # Provides the main Any23 use case: metadata extraction on a file or URL source.

The complete documentation about these tools can be found here

The bin scripts are generated dynamically during the package phase. To ensure the package generation, from the top level directory run:

mvn package

You can void extracting the archive files by going to the core generated bin folder

cd  $ANY23_HOME/core/target/appassembler/bin/

and finally invoke the script for your OS (UNIX or Windows):

  bin$ ./any23

usage instructions will be printed out.

Run the Any23 Web Service

Any23 can be run as a service. To run the Any23 service go to the service dir and then invoke the embedded Jetty server

cd $ANY23_HOME/service
mvn jetty:run

You can check the service is running by accessing http://localhost:8080/ with your browser.

The complete documentation about this service can be found here

Build the Any23 Web Service WAR

The Any23 Service WAR by default will be generated as self-contained, all the dependencies will be included as JAR within the WEB-INF/lib archive dir.

To generate the self contained WAR invoke from the service dir:

service$ mvn [-o] [-Dmaven.test.skip=true] clean package

Where -o will build the process offline, and -Dmaven.test.skip=true will force the test skipping.

The WAR will be generated in

$ANY23_HOME/service/target/any23-service-x.y.z-SNAPSHOT.war

To produce a instead a WAR WITHOUT the included JAR dependencies it is possible to use the war-without-deps profile:

any23-service$ mvn [-o] [-Dmaven.test.skip=true] clean package

The option [-o] will speed up the module build if you have already collected all the required dependencies.

The option [-Dmaven.test.skip=true] will disable tests.

Again the various versions of the WAR will be generated into

$ANY23_HOME/service/target/apache-any23-service-x.y.z-*

Any23 Web Service Tracker Disclaimer

The Any23 Web Service form (service/src/main/resources/form.html) contains a Google Analytics Tracker which is by default configured to report to the Any23 Community. It is possible to change the user ID modifying the form.tracker.id property in parent POM.

Generate the Documentation

To generate the project site locally execute the following command from $ANY23_HOME:

cd $ANY23_HOME
MAVEN_OPTS='-Xmx1024m' mvn [-o] clean site:site

You can speed up the site generation process specifying the offline option [-o], but it works only if all the involved plugin dependencies has been already downloaded in the local M2 repository.

If you're interested in generating the Javadoc enriched with navigable UML graphs, you can activate the umlgraphdoc profile. This profile relies on graphviz that must be installed in your system.

cd $ANY23_HOME
MAVEN_OPTS='-Xmx1024m' mvn -P umlgraphdoc clean site:site

Munging of Any23 code to ASF

When it was decided that the Any23 code be brought into the Apache Incubator, the existing code was migrated over to the ASF infrastructure and documented/managed via a number of Jira tickets e.g, INFRA-3978 INFRA-4146 and ANY23-29.

Something went wrong with that request. Please try again.