diff --git a/docs/fix/fix.md b/docs/fix/fix.md index 087f940..63e277d 100644 --- a/docs/fix/fix.md +++ b/docs/fix/fix.md @@ -16,4 +16,4 @@ The transformation itself is declared in a fix-object which can be a file. For m See [here a list for all available FIX functions and a cookbook for using fix](//docs/fix/Fix-functions-and-Cookbook.html). {: .note } -> PS: There is also the transformation modul MORPH. Have a look at[ the old documentation](https://github.com/metafacture/metafacture-core/wiki/Metamorph-User-Guide) and the german cookbook by [Swissbib](https://swissbib.gitlab.io/metamorph-doku/). \ No newline at end of file +PS: There is also the transformation modul MORPH. Have a look at[ the old documentation](https://github.com/metafacture/metafacture-core/wiki/Metamorph-User-Guide) and the german cookbook by [Swissbib](https://swissbib.gitlab.io/metamorph-doku/). \ No newline at end of file diff --git a/docs/flux/Flux-User-Guide.md b/docs/flux/Flux-User-Guide.md index 1049fe6..2b1779d 100644 --- a/docs/flux/Flux-User-Guide.md +++ b/docs/flux/Flux-User-Guide.md @@ -122,7 +122,7 @@ _________________________ ## For developers: {: .note } -> Coding in JAVA. +Coding in JAVA. ### Adding new Commands Add your class and a descriptive flux shortcut to `flux-commands.properties`. This file acts as a lookup table for flux commands. Use the proper file, i.e. the one residing in the same module where your newly created class resides. If you have e.g. created a class in the module `metafacture-biblio`, you add the flux-command to https://github.com/metafacture/metafacture-core/blob/master/metafacture-biblio/src/main/resources/flux-commands.properties. diff --git a/docs/java-integration/Framework-User-Guide.md b/docs/java-integration/Framework-User-Guide.md index b38e079..462b862 100644 --- a/docs/java-integration/Framework-User-Guide.md +++ b/docs/java-integration/Framework-User-Guide.md @@ -8,7 +8,7 @@ nav_order: 1 # Framework User Guide {: .note } -> Relevant for Java developers. For using metafacture without Java Code see the [FLUX user guide](/docs/flux/Flux-User-Guide.html). +Relevant for Java developers. For using metafacture without Java Code see the [FLUX user guide](/docs/flux/Flux-User-Guide.html). This page explains how to create a Metafacture objects and how to assemble them to form a processing pipeline. We use as an example a simple pipeline containing a Metafix instance. diff --git a/docs/java-integration/java-integration.md b/docs/java-integration/java-integration.md index 1d64011..f41c51f 100644 --- a/docs/java-integration/java-integration.md +++ b/docs/java-integration/java-integration.md @@ -8,7 +8,7 @@ has_children: true ## Framework for Java integration/development {: .note } -> Relevant for developers +Relevant for developers 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. diff --git a/index.md b/index.md index aed69b8..ceb2204 100644 --- a/index.md +++ b/index.md @@ -17,7 +17,7 @@ This is the central place for the documentation about Metafacture. Metafacture comprises three main parts: **Framework**, **Flux** and one of the **Transformation-Modules Fix and Morph**. It can be extended with modules. {: .note } -> With regard to the Transformation-Modules this documentation focusses on Fix instead of MORPH. If you want to find out more about MORPH. Have a look at [the old documentation](https://github.com/metafacture/metafacture-core/wiki/Metamorph-User-Guide) and the german cookbook by [Swissbib](https://swissbib.gitlab.io/metamorph-doku/). +With regard to the Transformation-Modules this documentation focusses on Fix instead of MORPH. If you want to find out more about MORPH. Have a look at [the old documentation](https://github.com/metafacture/metafacture-core/wiki/Metamorph-User-Guide) and the german cookbook by [Swissbib](https://swissbib.gitlab.io/metamorph-doku/). Our goal with this repo is to collaboratively create comprehensive documentation on Metafacture in the [issue tracker](https://github.com/culturegraph/metafacture-documentation/issues?q=). Feel free to open issues not only for bugs or enhancements, but also questions about Metafacture usage, or to share your experiences. We hope that over time, in that way we can create useful tutorials, how-tos, and collect good practices for using Metafacture. @@ -29,7 +29,7 @@ Deciding which parts are relevant to you depends on the way you are using Metafa ## Using Metafacture via playground or CLI {: .note } -> No Java-Code is necessary!!! +No Java-Code is necessary!!! While working with the playground or the command line you only need [Flux](/docs/flux/flux.html) and the transformation module [Fix](/docs/fix/fix.html). Have a look here for [Getting started](/docs/Getting-Started.html).