Skip to content

Compare: Home

New page
Showing with 180 additions and 119 deletions.
  1. +17 −21 Code-Quality-and-Style.md
  2. +7 −0 Flux-user-guide.md
  3. +6 −0 Framework-User-Guide.md
  4. +6 −3 Home.md
  5. +30 −0 How-to-debug.md
  6. +108 −91 Maintainer-Guidelines.md
  7. +1 −0 Who-uses-Metafacture.md
  8. +5 −4 _Sidebar.md
9 changes: 6 additions & 3 deletions Home.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
![logo](https://github.com/culturegraph/metafacture-core/wiki/img/metafacture_small.png)

> ⚠️ **_NOTE:_**
> This documentation is deprecated. Only the parts for Morph are still current. For the new documentation see: https://github.com/metafacture/metafacture-documentation

Metafacture comprises three main parts: Framework, Morph and Flux. It can be extended with modules.
Metafacture comprises three main parts: Framework, Fix (or Morph) and Flux. It can be extended with modules.

# Framework
The framework includes the interfaces and abstract classes which form the foundation of the data processing pipelines. This part of Metafacture is only relevant for you if you plan to use Metafacture as a Java library or if you wish to add pipe elements to Flux.

For more information see the [[Framework User Guide]].

# Fix
Fix is the transformation module and recommended instead of using Morph: https://github.com/metafacture/metafacture-fix#metafacture-fix

# Morph
Morph is the original transformation module and it is recommended to use Fix instead of Morph.

Metafacture Morph or short Metamorph is a domain specific language for metadata transformation. The Metamorph object performing the transformation is used as part of a processing pipeline. If you are using Metafacture as a Java library, just create a `Metamorph` object and add it to your pipeline (see also the [[Framework User Guide]]). If you are using the Flux scripting language to build and run pipelines, use the `morph` command.

The transformation itself is declared in XML. For more information on how to declare transformations see [[Metamorph User Guide]].
Expand Down