Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Ambiguous term definition priority #269

Merged
merged 49 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
75b1294
Fix run schedule
about-code Apr 7, 2023
442e0b9
Collect distribution of occurrences over glossaries
about-code Apr 8, 2023
a3a8fc5
Refactor and prepare
about-code Apr 8, 2023
e61b351
test: New baseline.
about-code Apr 8, 2023
86da174
feat: Select glossary for ambiguous term definitions based on the num…
about-code Apr 8, 2023
9e3d84c
Refactor: Plug-in factories add function scope that runs once instead…
about-code Apr 9, 2023
d0f0d47
test: New test case.
about-code Apr 9, 2023
9f46633
test: New test case.
about-code Apr 9, 2023
e56ce17
Revert "test: New test case."
about-code Apr 9, 2023
9854841
test: New baseline.
about-code Apr 9, 2023
467590a
test: New test case.
about-code Apr 10, 2023
5001552
test: New baseline.
about-code Apr 10, 2023
d2fb180
feat: New option 'linking.sortAlternatives'.
about-code Apr 15, 2023
c87038b
test: Update test case.
about-code Apr 15, 2023
529743d
test: New baseline.
about-code Apr 15, 2023
256d9a7
chore: refactor (performance)
about-code Apr 15, 2023
5436c97
Easier access to a term definitions origin file
about-code Apr 30, 2023
dce60dd
test: New baseline.
about-code Apr 30, 2023
39a4815
Term occurrence context tree. Count ambiguous terms, too.
about-code May 1, 2023
6fe1017
Move and reword tests
about-code May 1, 2023
fc7441e
test: New test case.
about-code May 1, 2023
807e7a0
test: New baseline.
about-code May 1, 2023
f4cdd3a
chore(docs): Multiple glossaries and ambiguity
about-code May 1, 2023
0f276e6
Rename enum value
about-code May 1, 2023
19a6705
Update docs
about-code May 1, 2023
438206c
Update docs
about-code May 1, 2023
fb90a84
Allow future parameters for term disambiguation algorithms
about-code May 1, 2023
4b03610
test: New baseline.
about-code May 1, 2023
90dff7e
Fix doc
about-code May 1, 2023
757c593
Split searching/linking; Add file node.
about-code Jul 22, 2023
52458e9
Refactor: Hierarchical histograms.
about-code Aug 15, 2023
e323206
test: Add new test cases. Refactor JS test execution.
about-code Aug 15, 2023
099b01c
test: Update test case to fit new config schema.
about-code Aug 15, 2023
f17d2dc
test: New baseline.
about-code Aug 15, 2023
9860bef
chore(docs): Update docs.
about-code Aug 15, 2023
a959df5
chore(docs): Update config docs.
about-code Aug 15, 2023
b309dd3
chore(docs): Improve config schema documentation.
about-code Aug 18, 2023
9fd0610
test: New test case.
about-code Aug 21, 2023
3fb1d1d
test: Move files.
about-code Aug 21, 2023
bab4ff7
test: New baseline.
about-code Aug 21, 2023
6f729f6
test: New test case.
about-code Aug 21, 2023
e337697
test: New baseline.
about-code Aug 21, 2023
e096a47
chore(docs): Update docs
about-code Aug 22, 2023
7d2c557
test: New test case.
about-code Aug 22, 2023
f03387a
test: New baseline.
about-code Aug 22, 2023
533cca4
Update docs
about-code Aug 22, 2023
869a9f9
test: New baseline. (Fix test case description)
about-code Aug 22, 2023
7552272
Update docs.
about-code Aug 22, 2023
f194442
Remove no longer required FileNode
about-code Aug 22, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/tests-latest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
branches:
- master
schedule:
- cron: '0 12,23 * * *'
- cron: '0 23 * * *'
jobs:
test:
runs-on: ${{ matrix.os }}
Expand Down
6 changes: 5 additions & 1 deletion conf/v5/doc/schema-defs-csvdialect.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# csvDialect Properties


| Property | Type | Required | Nullable | Defined by |
| :------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [delimiter](#delimiter) | `string` | Required | cannot be null | [Configuration Schema](schema-defs-csvdialect-properties-delimiter.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/csvDialect/properties/delimiter") |
| [quoteChar](#quotechar) | `string` | Optional | cannot be null | [Configuration Schema](schema-defs-csvdialect-properties-quotechar.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/csvDialect/properties/quoteChar") |
| [escapeChar](#escapechar) | `string` | Optional | cannot be null | [Configuration Schema](schema-defs-csvdialect-properties-escapechar.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/csvDialect/properties/escapeChar") |

## delimiter

Expand Down
21 changes: 0 additions & 21 deletions conf/v5/doc/schema-defs-csvtableschema-properties-fields-items.md

This file was deleted.

4 changes: 3 additions & 1 deletion conf/v5/doc/schema-defs-csvtableschema.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# csvTableSchema Properties


| Property | Type | Required | Nullable | Defined by |
| :---------------- | :------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [fields](#fields) | `array` | Required | cannot be null | [Configuration Schema](schema-defs-csvtableschema-properties-fields.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/csvTableSchema/properties/fields") |

## fields

Expand Down
4 changes: 3 additions & 1 deletion conf/v5/doc/schema-defs-csvtableschemafield.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# csvTableSchemaField Properties


| Property | Type | Required | Nullable | Defined by |
| :------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [name](#name) | `string` | Optional | cannot be null | [Configuration Schema](schema-defs-csvtableschemafield-properties-name.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/csvTableSchemaField/properties/name") |

## name

Expand Down
29 changes: 18 additions & 11 deletions conf/v5/doc/schema-defs-dev.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# dev Properties

| Property | Type | Required | Nullable | Defined by |
| :-------------------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [effectiveConfFile](#effectiveconffile) | `string` | Optional | cannot be null | [Configuration Schema](schema-defs-dev-properties-effectiveconffile.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/dev/properties/effectiveConfFile") |
| [printInputAst](#printinputast) | Multiple | Optional | cannot be null | [Configuration Schema](schema-defs-dev-properties-printinputast.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/dev/properties/printInputAst") |
| [printOutputAst](#printoutputast) | Multiple | Optional | cannot be null | [Configuration Schema](schema-defs-dev-properties-printoutputast.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/dev/properties/printOutputAst") |
| [reportsFile](#reportsfile) | `string` | Optional | cannot be null | [Configuration Schema](schema-defs-dev-properties-reportsfile.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/dev/properties/reportsFile") |
| [reproducablePaths](#reproducablepaths) | `boolean` | Optional | cannot be null | [Configuration Schema](schema-defs-dev-properties-reproducablepaths.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/dev/properties/reproducablePaths") |
| [termsFile](#termsfile) | `string` | Optional | cannot be null | [Configuration Schema](schema-defs-dev-properties-termsfile.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/dev/properties/termsFile") |

## effectiveConfFile

File where to write the configuration that is applied effectively after merging config file, cli opts and schema defaults.

`effectiveConfFile`

* is optional

* Type: `string`

## printInputAst

Expand All @@ -24,7 +41,7 @@ Print the AST of scanned markdown documents after linkification. May be a Regex

## reportsFile

File where to write console report output. Enables testing the report output generated by the 'writer' component.
File where to write console report output. Enables testing the report output generated by the 'writer' component.

`reportsFile`

Expand All @@ -51,13 +68,3 @@ File where to write term book to. Enables testing the term extraction results of
* is optional

* Type: `string`

## effectiveConfFile

File where to write the configuration that is applied effectively after merging config file, cli opts and schema defaults.

`effectiveConfFile`

* is optional

* Type: `string`
43 changes: 0 additions & 43 deletions conf/v5/doc/schema-defs-generatefiles-properties-indexfile.md

This file was deleted.

This file was deleted.

43 changes: 0 additions & 43 deletions conf/v5/doc/schema-defs-generatefiles-properties-listof-items.md

This file was deleted.

43 changes: 0 additions & 43 deletions conf/v5/doc/schema-defs-generatefiles-properties-listoffigures.md

This file was deleted.

43 changes: 0 additions & 43 deletions conf/v5/doc/schema-defs-generatefiles-properties-listoftables.md

This file was deleted.

8 changes: 7 additions & 1 deletion conf/v5/doc/schema-defs-generatefiles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# generateFiles Properties


| Property | Type | Required | Nullable | Defined by |
| :------------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [indexFile](#indexfile) | `object` | Optional | cannot be null | [Configuration Schema](schema-defs-indexfile.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/generateFiles/properties/indexFile") |
| [indexFiles](#indexfiles) | `array` | Optional | cannot be null | [Configuration Schema](schema-defs-generatefiles-properties-indexfiles.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/generateFiles/properties/indexFiles") |
| [listOf](#listof) | `array` | Optional | cannot be null | [Configuration Schema](schema-defs-generatefiles-properties-listof.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/generateFiles/properties/listOf") |
| [listOfFigures](#listoffigures) | `object` | Optional | cannot be null | [Configuration Schema](schema-defs-listofitemsfile.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/generateFiles/properties/listOfFigures") |
| [listOfTables](#listoftables) | `object` | Optional | cannot be null | [Configuration Schema](schema-defs-listofitemsfile.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/generateFiles/properties/listOfTables") |

## indexFile

Expand Down
21 changes: 12 additions & 9 deletions conf/v5/doc/schema-defs-glossaryfile-properties-export-oneof-0.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
# 0 Properties

| Property | Type | Required | Nullable | Defined by |
| :------------------ | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [context](#context) | `string` | Optional | cannot be null | [Configuration Schema](schema-defs-glossaryfileexport-properties-context.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/glossaryFileExport/properties/context") |
| [file](#file) | `string` | Required | cannot be null | [Configuration Schema](schema-defs-glossaryfileexport-properties-file.md "https://raw.githubusercontent.com/about-code/glossarify-md/v7.0.0/conf/v5/schema.json#/$defs/glossaryFileExport/properties/file") |

## context

## file

A JSON file name to write exported terms to. Recommended file extension is '.json' or '.jsonld'
File path or URL to a custom JSON-LD context document. JSON-LD contexts map terms from glossarify-md's export format onto terms of the well-known W3C SKOS vocabulary. If you want to import terms to another application supporting JSON-LD but not SKOS, then you can provide a custom JSON-LD context document with mappings of glossarify-md's terminology onto the one understood by the target application.

`file`
`context`

* is required
* is optional

* Type: `string`

## context
## file

File path or URL to a custom JSON-LD context document. JSON-LD contexts map terms from glossarify-md's export format onto terms of the well-known W3C SKOS vocabulary. If you want to import terms to another application supporting JSON-LD but not SKOS, then you can provide a custom JSON-LD context document with mappings of glossarify-md's terminology onto the one understood by the target application.
A JSON file name to write exported terms to. Recommended file extension is '.json' or '.jsonld'

`context`
`file`

* is optional
* is required

* Type: `string`
Loading
Loading