Skip to content

Commit

Permalink
Merge pull request #39 from metafacture/documentationLinks
Browse files Browse the repository at this point in the history
Update links to the new documentation
  • Loading branch information
Phu2 authored Mar 7, 2025
2 parents ee51694 + 15eea4f commit ddb6ffd
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ <h1 class="title">Getting started</h1>
</header>
<h2 id="playground">Playground</h2>
<p>The easiest way to get started with Metafacture is the Playground. Take a look at an <a href="https://metafacture.org/playground/?example=encode-xml">example</a> and run it by pressing the <img src="img/process.png" alt="“Process”" /> button. Check out the other examples (first button, <img src="img/load-exmples.png" alt="“Load Examples”" />) for different input sources, transformations, and output formats.</p>
<p>For commands available in the Flux, see <a href="https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md">the Flux commands documentation</a>.</p>
<p>For functions and usage of the Fix, see <a href="https://github.com/metafacture/metafacture-documentation/blob/master/Fix-function-and-Cookbook.md">the Fix functions and cookbook</a>.</p>
<p>For commands available in the Flux, see <a href="https://metafacture.org/metafacture-documentation/docs/flux/flux-commands.html">the Flux commands documentation</a>.</p>
<p>For functions and usage of the Fix, see <a href="https://metafacture.org/metafacture-documentation/docs/fix/Fix-functions.html">the Fix functions</a> and <a href="https://metafacture.org/metafacture-documentation/docs/fix/Fix-User-Guide.html#cookbook">cookbook</a>.</p>
<p>For a tutorial, see <a href="https://metafacture.github.io/metafacture-tutorial/">metafacture-tutorial</a>.</p>
<h2 id="command-line">Command line</h2>
<p>To use Metafacture as a command-line tool, download the latest metafix-runner from our <a href="https://github.com/metafacture/metafacture-fix/releases">releases page</a>. Extract the downloaded archive and change into the newly created directory (e.g. <code>cd metafacture-runner-0.4.0</code>). Run a Flux workflow with:</p>
Expand All @@ -133,8 +133,8 @@ <h2 id="using-metafacture-as-a-java-library">Using Metafacture as a Java library
<p>To use Fix you would declare <code>metafix</code> instead of <code>metafacture-io</code> as in the example above. Note that <code>metafix</code> is not published to maven central but only to <a href="https://github.com/metafacture/metafacture-fix/releases">github releases</a>.</p>
<p>Occasionally, we publish snapshot builds on <a href="https://oss.sonatype.org/index.html#nexus-search;gav~org.metafacture~~~~~kw,versionexpand">Sonatype OSS Repository</a>. The version number is derived from the branch name. Snapshot builds from the master branch always have the version <code>master-SNAPSHOT</code>. We also provide sometimes pre releases as github packages.</p>
<h2 id="next-steps">Next steps</h2>
<p>Get familar with <a href="https://github.com/metafacture/metafacture-documentation/blob/master/Flux-User-Guide.md">FLUX</a> and <a href="https://github.com/metafacture/metafacture-documentation/blob/master/Fix-User-Guide.md">FIX</a>. And try out some Metafacture workflows.</p>
<p>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 <a href="https://github.com/metafacture/metafacture-documentation/blob/master/Framework-User-Guide.md">Framework</a>.</p>
<p>For a complete introduction to Metafacture in German, check out the latest iteration of <a href="https://slides.lobid.org/2022-12-metafacture-workshop/#/">our Metafacture Workshop</a>. For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see <a href="https://github.com/metafacture/metafacture-documentation">our documentation collection</a>.</p>
<p>Get familar with <a href="https://metafacture.org/metafacture-documentation/docs/flux/Flux-User-Guide.html">FLUX</a> and <a href="https://metafacture.org/metafacture-documentation/docs/fix/Fix-User-Guide.html">FIX</a>. And try out some Metafacture workflows.</p>
<p>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 <a href="https://metafacture.org/metafacture-documentation/docs/fix/Fix-User-Guide.html">Framework</a>.</p>
<p>For a complete introduction to Metafacture in German, check out the latest iteration of <a href="https://slides.lobid.org/2022-12-metafacture-workshop/#/">our Metafacture Workshop</a>. For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see <a href="https://metafacture.org/metafacture-documentation/">our documentation collection</a>.</p>
</body>
</html>
10 changes: 5 additions & 5 deletions getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down Expand Up @@ -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/).
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ <h1 class="title">Welcome</h1>
</header>
<p>Welcome to Metafacture.org!</p>
<p>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 <em>meta</em>data and manu<em>facture</em>.</p>
<p>Metafacture includes a <a href="https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md">large number of modules</a> 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 <strong>Flux</strong>. One of the core features of Metafacture is the <strong>Metamorph</strong> module. Metamorph is an xml-based language for specifying transformations of semi-structured data. It can be seamlessly integrated into Java code.</p>
<p>Metafacture includes a <a href="https://metafacture.org/metafacture-documentation/docs/flux/flux-commands.html">large number of modules</a> 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 <strong>Flux</strong>. One of the core features of Metafacture is the <strong>Metamorph</strong> module. Metamorph is an xml-based language for specifying transformations of semi-structured data. It can be seamlessly integrated into Java code.</p>
<p>At its heart Metafacture is a framework for implementing modules for metadata processing. This makes Metafacture easily extendable with additional modules. The <a href="https://github.com/metafacture/metafacture-core/wiki/Plugins-and-Tools">plugins and tools page</a> on the wiki shows supplementary packages and projects which extend Metafacture.</p>
<p>Originally, Metafacture was developed as part of the Culturegraph platform but it is developed independently now and used by others, too: <a href="https://github.com/metafacture/metafacture-core/wiki/Who-uses-Metafacture">see who uses Metafacture</a>.</p>
<p>Also <a href="https://github.com/metafacture/metafacture-fix">Metafacture Fix</a>, a non-xml Catmandu inspired language for specifying transformations, is being developed that is not stream-based but operates at record level.</p>
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit ddb6ffd

Please sign in to comment.