Skip to content

Commit d72a238

Browse files
committed
Add example to string-decode (#54)
- update documentation "how to publish" flux-commands.md
1 parent 6d2ee7a commit d72a238

File tree

3 files changed

+22
-6
lines changed

3 files changed

+22
-6
lines changed

docs/Documentation-Maintainer-Guide.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,20 @@ parameter type of the method - here an "int"eger.
4040
## how to publish [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/28-use-jekyll-theme/docs/flux/flux-commands.md)
4141

4242
If you have updated some of these annotations, say "description", and these changes are
43-
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.
43+
merged into the master branch, generate a new flux-commands.md:
44+
go to the `metafacture-core`repo, build a distribution and start the flux script by doing:
45+
46+
```
47+
cd git/metafacture-core # go to the mf-core repo
48+
./gradlew metafacture-runner:signArchive # make a standalone distribution
49+
find . -name "metafacture-core*dist.tar.gz" # find the distribution
50+
tar xfz $pathToDst # unpack the distribution
51+
find . -name "flux.sh" # find the start script
52+
bash $pathToFlux.sh
53+
```
54+
55+
Modify the generated output (i.e. the header) and commit it to http://metafacture.github.io/metafacture-documentation/docs/flux/flux-commands.md.
56+
57+
Note that the example links to playground will only be generated if the git repo `metafacture-documentation` is checked out and the file `linksAndExamples.tsv` is accessible via `../linksAndExamples.tsv`.
4458

4559
The [publishing process will be automated with an github action](https://github.com/metafacture/metafacture-core/issues/368).

docs/flux/flux-commands.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ parent: Flux
55
nav_order: 2
66
---
77

8-
Available flux commands (with release 1.2.0)
8+
Available flux commands on master branch
99
=======================
1010

11+
1112
add-oreaggregation
1213
------------------
1314
- 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
133134
decode-json
134135
-----------
135136
- 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.
136-
- options: recordid (String), booleanmarker (String), recordcount (int), arraymarker (String), arrayname (String), recordpath (String), numbermarker (String), allowcomments (boolean)
137+
- options: recordid (String), recordcount (int), booleanmarker (String), arraymarker (String), arrayname (String), recordpath (String), allowcomments (boolean), numbermarker (String)
137138
- signature: String -> StreamReceiver
138139
- [example in Playground](https://metafacture.org/playground/?example=decode-json)
139140
- 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
166167
- description: Splits a String into several Strings, either by extracting parts that match a regexp or by splitting by a regexp.
167168
- options: mode [SPLIT, EXTRACT]
168169
- signature: String -> String
170+
- [example in Playground](https://metafacture.org/playground/?example=decode-string)
169171
- java class: [org.metafacture.strings.StringDecoder](https://github.com/metafacture/metafacture-core/blob/master/metafacture-strings/src/main/java/org/metafacture/strings/StringDecoder.java)
170172

171173
decode-xml
@@ -593,8 +595,8 @@ print
593595

594596
rdf-macros
595597
----------
596-
- description: Expands some macros for RDF/XML
597-
- options: autoaddedsubject (String)
598+
- description: Expands some macros for RDF/XML. When using Fix, configure `referenceMarker` to any char but the default `*`
599+
- options: autoaddedsubject (String), referencemarker (String), languagemarker (String)
598600
- signature: StreamReceiver -> StreamReceiver
599601
- java class: [org.metafacture.linkeddata.RdfMacroPipe](https://github.com/metafacture/metafacture-core/blob/master/metafacture-linkeddata/src/main/java/org/metafacture/linkeddata/RdfMacroPipe.java)
600602

linksAndExamples.tsv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ decode-json https://github.com/metafacture/metafacture-core/blob/master/metafact
1919
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
2020
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
2121
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
22-
decode-string https://github.com/metafacture/metafacture-core/blob/master/metafacture-strings/src/main/java/org/metafacture/strings/StringDecoder.java
22+
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
2323
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
2424
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
2525
decouple https://github.com/metafacture/metafacture-core/blob/master/metafacture-flowcontrol/src/main/java/org/metafacture/flowcontrol/ObjectPipeDecoupler.java

0 commit comments

Comments
 (0)