Skip to content

Commit 1914eea

Browse files
author
Jesse Eichar
committed
added readmes to all modules
1 parent 7e7b289 commit 1914eea

File tree

12 files changed

+27
-0
lines changed

12 files changed

+27
-0
lines changed

cachingxslt/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
The cachingxslt module contains an XSLT parser that will cache the compiled XSLT Style sheet to improve the performance of performing
2+
XSLT transformations.

common/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
The common module contains very basic utilities that are useful for all projects. For example utilities for assisting with parsing
2+
and encoding XML or making HTTP requests.

core/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
The core module contains the core Geonetwork classes. For example SearchManager for searching the metadata index, DataManager for saving
2+
and loading Metadata.
3+
4+
Services, Harvesters, etc... that are are plugins will usually depend on core and will make use of these core classes to implement their
5+
services.
6+
7+
Geonetwork is wired together via Spring-Dependency-Injection. The critical classes (DataManager, SchemaManager, SearchManager, etc...) are
8+
all singleton beans in the application context and can be either injected into other beans or obtained via the ServiceContext.getBean
9+
method (or ServiceContext.getApplicationContext()).

csw-server/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The csw-server module implements the services and support classes for implementing a CSW Server.

harvesters/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
The harvesters module contains harvester plugins for creating new harvesters which obtain metadata from other sources and add them to
2+
Geonetwork.

healthmonitor/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
The heathmonitor module contains various system health checks, like check that verify the index is not corrupted, the database can be accessed
2+
etc...

jeeves/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
The jeeves module used to be the Jeeves Web application framework but is in the process of being deprecated and removed. Right now it
2+
contains many of the classes and interfaces relevant to the web-application.

oaipmh/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The oaipmh module contains classes for providing a oaipmh end point and for writing oaipmh clients.

sde/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
The sde module provides the stub methods of the ArcSDE library. This module is required because the ArcSDE libraries cannot be included in
2+
an opensource project. They require licencing and therefore the jar created by this module should be replaced on the production server
3+
with the correct one if ArcSDE harvesting is to be performed.

services/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The services module contains the core services.

web-client/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The web-client module contains the javascript and html file for the geonetwork web clients.

web/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The web module contains the static resources and configuration file for building the final web application WAR.

0 commit comments

Comments
 (0)