diff --git a/docs/Documentation-Maintainer-Guide.md b/docs/Documentation-Maintainer-Guide.md index 6759051..44a8194 100644 --- a/docs/Documentation-Maintainer-Guide.md +++ b/docs/Documentation-Maintainer-Guide.md @@ -6,7 +6,7 @@ nav_order: 8 # Maintainer Guide -## how to change [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/master/docs/flux/flux-commands.md) +## How to change [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/master/docs/flux/flux-commands.md) The entries in [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/master/docs/flux/flux-commands.md) describe the usage of commands used by flux. flux-commands.md is fully automatically generated. To make this happen one has to @@ -37,9 +37,23 @@ The option's name is produced by cutting away the "set" from the methods name, l "BatchSize" which is then lowercased. The parameter of this option is generated from the parameter type of the method - here an "int"eger. -## how to publish [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/28-use-jekyll-theme/docs/flux/flux-commands.md) +## How to publish [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/master/docs/flux/flux-commands.md) If you have updated some of these annotations, say "description", and these changes are -merged into the master branch, generate a new flux-commands.md like explained in https://github.com/metafacture/metafacture-fix/wiki/Maintainer-Guidelines#update-flux-commands. +merged into the master branch, generate a new flux-commands.md: +go to the metafacture-core repo, build a distribution and start the flux script by doing: + +``` + cd git/metafacture-core # go to the mf-core repo + ./gradlew metafacture-runner:signArchive # make a standalone distribution + find . -name "metafacture-core*dist.tar.gz" # find the distribution + tar xfz $pathToDst # unpack the distribution + find . -name "flux.sh" # find the start script + bash $pathToFlux.sh +``` + +Modify the generated output (i.e. the header), copy it to docs/flux/flux-commands.md and commit it. + +Note that the example links to playground will only be generated if the "metafacture-documentation" repo is checked out and the file "linksAndExamples.tsv" is accessible via "../linksAndExamples.tsv" from the "metafacture-core" repo. The [publishing process will be automated with an github action](https://github.com/metafacture/metafacture-core/issues/368). diff --git a/docs/flux/flux-commands.md b/docs/flux/flux-commands.md index a128f30..2215829 100644 --- a/docs/flux/flux-commands.md +++ b/docs/flux/flux-commands.md @@ -5,9 +5,10 @@ parent: Flux nav_order: 2 --- -Available flux commands (with release 1.2.0) +Available flux commands on master branch ======================= + add-oreaggregation ------------------ - description: adds ore:Aggregation to an Europeana Data Model stream. The aggregation id is set by emitting literal('aggregation_id', id) @@ -133,7 +134,7 @@ decode-html decode-json ----------- - description: Decodes JSON to metadata events. The 'recordPath' option can be used to set a JsonPath to extract a path as JSON - or to split the data into multiple JSON documents. -- options: recordid (String), booleanmarker (String), recordcount (int), arraymarker (String), arrayname (String), recordpath (String), numbermarker (String), allowcomments (boolean) +- options: recordid (String), recordcount (int), booleanmarker (String), arraymarker (String), arrayname (String), recordpath (String), allowcomments (boolean), numbermarker (String) - signature: String -> StreamReceiver - [example in Playground](https://metafacture.org/playground/?example=decode-json) - java class: [org.metafacture.json.JsonDecoder](https://github.com/metafacture/metafacture-core/blob/master/metafacture-json/src/main/java/org/metafacture/json/JsonDecoder.java) @@ -166,6 +167,7 @@ decode-string - description: Splits a String into several Strings, either by extracting parts that match a regexp or by splitting by a regexp. - options: mode [SPLIT, EXTRACT] - signature: String -> String +- [example in Playground](https://metafacture.org/playground/?example=decode-string) - java class: [org.metafacture.strings.StringDecoder](https://github.com/metafacture/metafacture-core/blob/master/metafacture-strings/src/main/java/org/metafacture/strings/StringDecoder.java) decode-xml @@ -593,8 +595,8 @@ print rdf-macros ---------- -- description: Expands some macros for RDF/XML -- options: autoaddedsubject (String) +- description: Expands some macros for RDF/XML. When using Fix, configure `referenceMarker` to any char but the default `*` +- options: autoaddedsubject (String), referencemarker (String), languagemarker (String) - signature: StreamReceiver -> StreamReceiver - java class: [org.metafacture.linkeddata.RdfMacroPipe](https://github.com/metafacture/metafacture-core/blob/master/metafacture-linkeddata/src/main/java/org/metafacture/linkeddata/RdfMacroPipe.java) diff --git a/linksAndExamples.tsv b/linksAndExamples.tsv index 110286c..fb59de0 100644 --- a/linksAndExamples.tsv +++ b/linksAndExamples.tsv @@ -19,7 +19,7 @@ decode-json https://github.com/metafacture/metafacture-core/blob/master/metafact decode-mab https://github.com/metafacture/metafacture-core/blob/master/metafacture-biblio/src/main/java/org/metafacture/biblio/MabDecoder.java https://metafacture.org/playground/?example=decode-mab decode-marc21 https://github.com/metafacture/metafacture-core/blob/master/metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Decoder.java https://metafacture.org/playground/?example=decode-marc21 decode-pica https://github.com/metafacture/metafacture-core/blob/master/metafacture-biblio/src/main/java/org/metafacture/biblio/pica/PicaDecoder.java https://metafacture.org/playground/?example=decode-pica -decode-string https://github.com/metafacture/metafacture-core/blob/master/metafacture-strings/src/main/java/org/metafacture/strings/StringDecoder.java +decode-string https://github.com/metafacture/metafacture-core/blob/master/metafacture-strings/src/main/java/org/metafacture/strings/StringDecoder.java https://metafacture.org/playground/?example=decode-string decode-xml https://github.com/metafacture/metafacture-core/blob/master/metafacture-xml/src/main/java/org/metafacture/xml/XmlDecoder.java https://metafacture.org/playground/?example=decode-xml decode-yaml https://github.com/metafacture/metafacture-core/blob/master/metafacture-yaml/src/main/java/org/metafacture/yaml/YamlDecoder.java https://metafacture.org/playground/?example=decode-yaml decouple https://github.com/metafacture/metafacture-core/blob/master/metafacture-flowcontrol/src/main/java/org/metafacture/flowcontrol/ObjectPipeDecoupler.java