From b68cd816c63f7e460752f70d91925afca8c1bbca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20B=C3=BClte?= Date: Thu, 6 Mar 2025 15:27:29 +0100 Subject: [PATCH 1/2] Update links to the new documentation --- getting-started.md | 10 +++++----- index.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/getting-started.md b/getting-started.md index 01c6f74..7670846 100644 --- a/getting-started.md +++ b/getting-started.md @@ -8,9 +8,9 @@ header-includes: The easiest way to get started with Metafacture is the Playground. Take a look at an [example](https://metafacture.org/playground/?example=encode-xml) and run it by pressing the !["Process"](img/process.png) button. Check out the other examples (first button, !["Load Examples"](img/load-exmples.png)) for different input sources, transformations, and output formats. -For commands available in the Flux, see [the Flux commands documentation](https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md). +For commands available in the Flux, see [the Flux commands documentation](https://metafacture.org/metafacture-documentation/docs/flux/flux-commands.html). -For functions and usage of the Fix, see [the Fix functions and cookbook](https://github.com/metafacture/metafacture-documentation/blob/master/Fix-function-and-Cookbook.md). +For functions and usage of the Fix, see [the Fix functions](https://metafacture.org/metafacture-documentation/docs/fix/Fix-functions.html) and [cookbook](https://metafacture.org/metafacture-documentation/docs/fix/Fix-User-Guide.html#cookbook). For a tutorial, see [metafacture-tutorial](https://metafacture.github.io/metafacture-tutorial/). @@ -55,9 +55,9 @@ Occasionally, we publish snapshot builds on [Sonatype OSS Repository](https://os ## Next steps -Get familar with [FLUX](https://github.com/metafacture/metafacture-documentation/blob/master/Flux-User-Guide.md) and [FIX](https://github.com/metafacture/metafacture-documentation/blob/master/Fix-User-Guide.md). And try out some Metafacture workflows. +Get familar with [FLUX](https://metafacture.org/metafacture-documentation/docs/flux/Flux-User-Guide.html) and [FIX](https://metafacture.org/metafacture-documentation/docs/fix/Fix-User-Guide.html). And try out some Metafacture workflows. -If you plan to use Metafacture as a Java library or if you wish to add commands to Flux you should get familar with the [Framework](https://github.com/metafacture/metafacture-documentation/blob/master/Framework-User-Guide.md). +If you plan to use Metafacture as a Java library or if you wish to add commands to Flux you should get familar with the [Framework](https://metafacture.org/metafacture-documentation/docs/fix/Fix-User-Guide.html). For a complete introduction to Metafacture in German, check out the latest iteration of [our Metafacture Workshop](https://slides.lobid.org/2022-12-metafacture-workshop/#/). -For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see [our documentation collection](https://github.com/metafacture/metafacture-documentation). +For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see [our documentation collection](https://metafacture.org/metafacture-documentation/). diff --git a/index.md b/index.md index 909d029..93c7336 100644 --- a/index.md +++ b/index.md @@ -8,7 +8,7 @@ Welcome to Metafacture.org! Metafacture is a toolkit for processing semi-structured data with a focus on library metadata. It provides a versatile set of tools for reading, writing and transforming data. Metafacture can be used as a stand-alone application or as a Java library in other applications. The name Metafacture is a portmanteau of the words *meta*data and manu*facture*. -Metafacture includes a [large number of modules](https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md) for operating on semi-structured data. These modules can be combined to build pipelines to perform complex metadata processing tasks. The pipelines can be constructed either in Java code or with the domain-specific language **Flux**. One of the core features of Metafacture is the **Metamorph** module. Metamorph is an xml-based language for specifying transformations of semi-structured data. It can be seamlessly integrated into Java code. +Metafacture includes a [large number of modules](https://metafacture.org/metafacture-documentation/docs/flux/flux-commands.html) for operating on semi-structured data. These modules can be combined to build pipelines to perform complex metadata processing tasks. The pipelines can be constructed either in Java code or with the domain-specific language **Flux**. One of the core features of Metafacture is the **Metamorph** module. Metamorph is an xml-based language for specifying transformations of semi-structured data. It can be seamlessly integrated into Java code. At its heart Metafacture is a framework for implementing modules for metadata processing. This makes Metafacture easily extendable with additional modules. The [plugins and tools page](https://github.com/metafacture/metafacture-core/wiki/Plugins-and-Tools) on the wiki shows supplementary packages and projects which extend Metafacture. From 15eea4f49ca779f6cc086cda4e299706e06cec80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20B=C3=BClte?= Date: Thu, 6 Mar 2025 14:27:55 +0000 Subject: [PATCH 2/2] Add newly generated html files by GitHub Actions. --- getting-started.html | 10 +++++----- index.html | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/getting-started.html b/getting-started.html index c444ed8..304796f 100644 --- a/getting-started.html +++ b/getting-started.html @@ -109,8 +109,8 @@

Getting started

Playground

The easiest way to get started with Metafacture is the Playground. Take a look at an example and run it by pressing the “Process” button. Check out the other examples (first button, “Load Examples”) for different input sources, transformations, and output formats.

-

For commands available in the Flux, see the Flux commands documentation.

-

For functions and usage of the Fix, see the Fix functions and cookbook.

+

For commands available in the Flux, see the Flux commands documentation.

+

For functions and usage of the Fix, see the Fix functions and cookbook.

For a tutorial, see metafacture-tutorial.

Command line

To use Metafacture as a command-line tool, download the latest metafix-runner from our releases page. Extract the downloaded archive and change into the newly created directory (e.g. cd metafacture-runner-0.4.0). Run a Flux workflow with:

@@ -133,8 +133,8 @@

Using Metafacture as a Java library

To use Fix you would declare metafix instead of metafacture-io as in the example above. Note that metafix is not published to maven central but only to github releases.

Occasionally, we publish snapshot builds on Sonatype OSS Repository. The version number is derived from the branch name. Snapshot builds from the master branch always have the version master-SNAPSHOT. We also provide sometimes pre releases as github packages.

Next steps

-

Get familar with FLUX and FIX. And try out some Metafacture workflows.

-

If you plan to use Metafacture as a Java library or if you wish to add commands to Flux you should get familar with the Framework.

-

For a complete introduction to Metafacture in German, check out the latest iteration of our Metafacture Workshop. For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see our documentation collection.

+

Get familar with FLUX and FIX. And try out some Metafacture workflows.

+

If you plan to use Metafacture as a Java library or if you wish to add commands to Flux you should get familar with the Framework.

+

For a complete introduction to Metafacture in German, check out the latest iteration of our Metafacture Workshop. For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see our documentation collection.

diff --git a/index.html b/index.html index e8555a8..7822a6b 100644 --- a/index.html +++ b/index.html @@ -47,7 +47,7 @@

Welcome

Welcome to Metafacture.org!

Metafacture is a toolkit for processing semi-structured data with a focus on library metadata. It provides a versatile set of tools for reading, writing and transforming data. Metafacture can be used as a stand-alone application or as a Java library in other applications. The name Metafacture is a portmanteau of the words metadata and manufacture.

-

Metafacture includes a large number of modules for operating on semi-structured data. These modules can be combined to build pipelines to perform complex metadata processing tasks. The pipelines can be constructed either in Java code or with the domain-specific language Flux. One of the core features of Metafacture is the Metamorph module. Metamorph is an xml-based language for specifying transformations of semi-structured data. It can be seamlessly integrated into Java code.

+

Metafacture includes a large number of modules for operating on semi-structured data. These modules can be combined to build pipelines to perform complex metadata processing tasks. The pipelines can be constructed either in Java code or with the domain-specific language Flux. One of the core features of Metafacture is the Metamorph module. Metamorph is an xml-based language for specifying transformations of semi-structured data. It can be seamlessly integrated into Java code.

At its heart Metafacture is a framework for implementing modules for metadata processing. This makes Metafacture easily extendable with additional modules. The plugins and tools page on the wiki shows supplementary packages and projects which extend Metafacture.

Originally, Metafacture was developed as part of the Culturegraph platform but it is developed independently now and used by others, too: see who uses Metafacture.

Also Metafacture Fix, a non-xml Catmandu inspired language for specifying transformations, is being developed that is not stream-based but operates at record level.