You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@any23.apache.org by le...@apache.org on 2014/11/15 08:59:49 UTC
any23 git commit: Change plugins README.txt to markdown
Repository: any23
Updated Branches:
refs/heads/master 5db11ef91 -> 7ece1adf2
Change plugins README.txt to markdown
Project: http://git-wip-us.apache.org/repos/asf/any23/repo
Commit: http://git-wip-us.apache.org/repos/asf/any23/commit/7ece1adf
Tree: http://git-wip-us.apache.org/repos/asf/any23/tree/7ece1adf
Diff: http://git-wip-us.apache.org/repos/asf/any23/diff/7ece1adf
Branch: refs/heads/master
Commit: 7ece1adf28886474da3300cb5c4e629900347e8f
Parents: 5db11ef
Author: Lewis John McGibbney <le...@jpl.nasa.gov>
Authored: Fri Nov 14 23:59:34 2014 -0800
Committer: Lewis John McGibbney <le...@jpl.nasa.gov>
Committed: Fri Nov 14 23:59:34 2014 -0800
----------------------------------------------------------------------
plugins/README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 66 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/any23/blob/7ece1adf/plugins/README.md
----------------------------------------------------------------------
diff --git a/plugins/README.md b/plugins/README.md
new file mode 100644
index 0000000..26c4091
--- /dev/null
+++ b/plugins/README.md
@@ -0,0 +1,66 @@
+# Any23 Plugins
+
+This is the root dir of the Any23 Plugins module.
+
+A plugin is an extension of the Any23 core and can be plugged using
+the Plugin Manager capabilities.
+
+# Plugins
+
+## basic-crawler
+
+A CLI tool which extends the Rover CLI adding crawler specific
+capabilities.
+
+## html-scraper
+
+The HTML scraper is able to convert any HTML page to triples
+containing the text scraped from the page.
+
+## office-scraper
+
+The Office scraper is able to convert the main MS Office compatible
+formats and convert them to triples.
+
+## integration-test
+
+This module contains the integration tests for all the defined plugins.
+
+# Generate Plugin Packaging
+
+To generate the desired plugin package, navigate to the plugin directory and execute
+```
+mvn package
+```
+e.g. to generate the basic-crawler plugin package
+```
+$cd $ANY23-HOME/plugins/basic-crawler
+$ mvn package
+```
+From the basic-crawler directory this generates
+```
+.
+|-- pom.xml
+|-- src
+| |-- main
+| | |-- assembly
+| | `-- java
+| `-- test
+`-- target
+ |-- any23-basic-crawler-${version}.jar
+ |-- apache-any23-basic-crawler-${version}-bin.tar.gz <<<
+ |-- apache-any23-basic-crawler-${version}-bin.zip <<<
+ |-- archive-tmp
+ |-- classes
+ | |-- META-INF
+ | `-- org
+ |-- generated-sources
+ |-- maven-archiver
+ |-- maven-shared-archive-resources
+ |-- surefire
+ |-- surefire-reports
+ `-- test-classes
+...
+```
+Plugin specific README's can be found in either ./target/*.tar.gz || ./target/*.zip (annotated above with '<<<'), where much more detailed information sources can be located.
+