Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinKl committed Aug 20, 2024
1 parent 996b227 commit 31099aa
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
| Type | Modules |
|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Import formats | [conllu](importers/conllu.md), [exmaralda](importers/exmaralda.md), [graphml](importers/graphml.md), [meta](importers/meta.md), [none](importers/none.md), [opus](importers/opus.md), [path](importers/path.md), [ptb](importers/ptb.md), [relannis](importers/relannis.md), [saltxml](importers/saltxml.md), [textgrid](importers/textgrid.md), [toolbox](importers/toolbox.md), [treetagger](importers/treetagger.md), [xlsx](importers/xlsx.md), [xml](importers/xml.md) |
| Export formats | [graphml](exporters/graphml.md), [exmaralda](exporters/exmaralda.md), [sequence](exporters/sequence.md), [table](exporters/table.md), [textgrid](exporters/textgrid.md), [xlsx](exporters/xlsx.md) |
| Export formats | [conllu](exporters/conllu.md), [graphml](exporters/graphml.md), [exmaralda](exporters/exmaralda.md), [sequence](exporters/sequence.md), [table](exporters/table.md), [textgrid](exporters/textgrid.md), [xlsx](exporters/xlsx.md) |
| Graph operations | [check](graph_ops/check.md), [collapse](graph_ops/collapse.md), [filter](graph_ops/filter.md), [visualize](graph_ops/visualize.md), [enumerate](graph_ops/enumerate.md), [link](graph_ops/link.md), [map](graph_ops/map.md), [revise](graph_ops/revise.md), [chunk](graph_ops/chunk.md), [split](graph_ops/split.md), [none](graph_ops/none.md) |
151 changes: 151 additions & 0 deletions docs/exporters/conllu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
# conllu (exporter)

This module exports a graph in CoNLL-U format.

## Configuration

### doc

This key is used to determine nodes that whose part-of subgraph constitutes a document, i. e. the entire input for a file.
Default is `annis::doc`, or `{ ns = "annis", name = "doc" }`.

Example:
```toml
[export.config]
doc = "annis::doc"
```

### groupby

This optional annotation key is used to identify annotation spans, that constitute a sentence. Default is no export of sentence blocks.
Default is `annis::doc`, or `{ ns = "annis", name = "doc" }`.

Example:
```toml
[export.config]
groupby = "norm::sentence"
```

### ordering

The nodes connected by this annotation component are used as nodes defining a line in a CoNLL-U file. Usually you want to use an ordering.
Default is `{ ctype = "Ordering", layer = "annis", name = "" }`.

Example:
```toml
[export.config]
ordering = { ctype = "Ordering", layer = "annis", name = "norm" }
```

### form

This annotation key is used to write the form column.
Default is `{ ns = "annis", name = "tok" }`.

Example:
```toml
[export.config]
form = { ns = "norm", name = "norm" }
```

### lemma

This annotation key is used to write the lemma column.
Default is `{ ns = "", name = "tok" }`.

Example:
```toml
[export.config]
lemma = { ns = "norm", name = "lemma" }
```

### upos

This annotation key is used to write the upos column.
Default is `{ ns = "", name = "upos" }`.

Example:
```toml
[export.config]
upos = { ns = "norm", name = "pos" }
```

### xpos

This annotation key is used to write the xpos column.
Default is `{ ns = "", name = "xpos" }`.

Example:
```toml
[export.config]
upos = { ns = "norm", name = "pos_spec" }
```

### features

This list of annotation keys will be represented in the feature column.
Default is the empty list.

Example:
```toml
[export.config]
features = ["Animacy", "Tense", "VerbClass"]
```

### dependency_component

The nodes connected by this annotation component are used to export dependencies.
Default is none, so nothing will be exported.

Example:
```toml
[export.config]
dependency_component = { ctype = "Pointing", layer = "", name = "dependencies" }
```

### dependency_anno

This annotation key is used to write the dependency relation, which will be looked for on the dependency edges.
Default is none, so nothing will be exported.

Example:
```toml
[export.config]
dependency_anno = { ns = "", name = "deprel" }
```

### enhanced_components

The listed components will be used to export enhanced dependencies. More than
one component can be listed.
Default is the empty list, so nothing will be exported.

Example:
```toml
[export.config]
enhanced_components = [{ ctype = "Pointing", layer = "", name = "dependencies" }]
```

### enhanced_annos

This list of annotation keys defines the annotation keys, that correspond to the
edge labels in the component listed in `enhanced_components`. The i-th element of
one list belongs to the i-th element in the other list. Default is the empty list.

Example:
```toml
[export.config]
enhanced_annos = ["func"]
```

### misc

This list of annotation keys will be represented in the misc column.
Default is the empty list.

Example:
```toml
[export.config]
misc = ["NoSpaceAfter", "Referent"]
```

10 changes: 10 additions & 0 deletions docs/exporters/table.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ Example:
quote_char = "\""
```

### no_value

Provides the string sequence used for n/a. Default is the empty string.

Example:
```toml
[export.config]
no_value = "n/a"
```

### ingoing

By listing annotation components, the ingoing edges of that component and their annotations
Expand Down

0 comments on commit 31099aa

Please sign in to comment.