Difference between revisions of "ESciDoc Important Links"

Revision as of 12:40, 17 July 2009

This page shall give a quick and easy overview of the eSciDoc system in a top down manner. Starting from abstract concepts and basic requirements to the service-oriented architecture and finally the pure Java source code. The eSciDoc Project is developed by the MPDL and FIZ Karlsruhe. FIZ Karlsruhe is responsible for the core functionality, while the MPDL concentrates on the useable solutions on top of the core functionality.

Overview[edit]

An overview of these solutions can be found on the eSciDoc Solutions summary page. From here you can easily reach the PubMan Portal Page, which provide you with information about the Publication Management system (PubMan). Here you will find interesting pages about PubMan scenarios, use cases and an online demo system.

The eSciDoc project page of FIZ Karlsruhe is located here.

Architecture[edit]

SOA Concept

To get deeper in touch with the eSciDoc system concerning infastructure, services and solutions, these pages gives a good impression:

Software Design

The Coreservice interfaces documentation can be found here. The PubMan software design is documented with the tool Enterprise Architect. An HTML export of the component and class diagrams can be downloaded here. These are the descriptions for the service interfaces

Data Model

The data exchange between FIZ coreservices and PubMan are XML-based via SOAP interfaces. The description of these XML data is done via XSD-schema definitions. The definitions can be found here.

Source code documentation[edit]

Maven is used to automatically create all types of documentation of the source code. Use these links to jump directly to the project site:

Latest publicly released PubMan version:
- Services project page
- PubMan project page
Latest development snapshot
- Services project page
- PubMan project page

From here you can navigate through all interesting reports. Some interesting reports are (Examples just for module pubman_presentation, others work similar):

Project information
- Continuous integration Release Snapshot
- Dependencies Release Snapshot
- Dependency convergence Release Snapshot
- Subversion repository Release Snapshot
Project reports
- JavaDoc Release Snapshot
- JDepends Release Snapshot
- PMD (Source code analysis) Release Snapshot
- CPD (duplicate code checker) Release Snapshot
- SourceXRef Release Snapshot
- NCSS Release Snapshot

Downloads[edit]

Download the latest coreservice module from the FIZ download page
Get the latest PubMan version from this PubMan snapshot download page or fetch the latest public released version from the PubMan release download page

@@ Line 35: / Line 35: @@
 == Source code documentation ==
-Maven is used to automatically create all types of documentation of the source code. Use these links to jump directly to the project site:
+[http://maven.apache.org/ Maven] is used to automatically create all types of documentation of the source code. Use these links to jump directly to the project site:
-* Latest public released PubMan version:
+* Latest publicly released PubMan version:
 ** [http://escidoc1.escidoc.mpg.de/projects/common_services/ Services project page]
 ** [http://escidoc1.escidoc.mpg.de/projects/pubman/ PubMan project page]
@@ Line 43: / Line 43: @@
 ** [http://escidoc1.escidoc.mpg.de/projects/snapshots/pubman/ PubMan project page]
-From here you can navigate through all interesting reports. Some interesting reports are (Examples just for module ''pubman_presentation'', other work similar):
+From here you can navigate through all interesting reports. Some interesting reports are (Examples just for module ''pubman_presentation'', others work similar):
 * Project information
 ** Continuous integration [http://escidoc1.escidoc.mpg.de/projects/pubman/pubman_presentation/integration.html Release] [http://escidoc1.escidoc.mpg.de/projects/snapshots/pubman/pubman_presentation/integration.html Snapshot]
@@ Line 49: / Line 49: @@
 ** Dependency convergence [http://escidoc1.escidoc.mpg.de/projects/pubman/pubman_presentation/dependency-convergence.html Release] [http://escidoc1.escidoc.mpg.de/projects/snapshots/pubman/pubman_presentation/dependency-convergence.html Snapshot]
 ** Subversion repository [http://escidoc1.escidoc.mpg.de/projects/pubman/pubman_presentation/source-repository.html Release] [http://escidoc1.escidoc.mpg.de/projects/snapshots/pubman/pubman_presentation/source-repository.html Snapshot]
-* Project Reports
+* Project reports
 ** JavaDoc [http://escidoc1.escidoc.mpg.de/projects/pubman/pubman_presentation/apidocs/index.html Release] [http://escidoc1.escidoc.mpg.de/projects/snapshots/pubman/pubman_presentation/apidocs/index.html Snapshot]
 ** JDepends [http://escidoc1.escidoc.mpg.de/projects/pubman/pubman_presentation/jdepend-record.html Release] [http://escidoc1.escidoc.mpg.de/projects/snapshots/pubman/pubman_presentation/jdepend-record.html Snapshot]