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

Migrate to Docusaurus 3.0 Completed With Checks #279

Merged
merged 14 commits into from
Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs/manual/cellediting.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ This can help match cells that have typos, or incorrect spaces (such as matching

For an in-depth understanding of N-gram fingerprinting, check this [document](https://github.com/OpenRefine/OpenRefine/wiki/Clustering-In-Depth#n-gram-fingerprint)

_**Phonetic Clustering {#phonetic-clustering}**_
**<a name="phonetic-clustering">Phonetic Clustering</a>**

The next four methods are phonetic algorithms: they identify letters that sound the same when pronounced out loud, and assess text values based on that (such as knowing that a word with an “S” might be a mistype of a word with a “Z”). They are great for spotting mistakes made by not knowing the spelling of a word or name after hearing it spoken aloud.

Expand Down
6 changes: 3 additions & 3 deletions docs/manual/exporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ This can be used to:
* create multiple columns of output from different [member fields](expressions#variables) of a single project column
* employ [expressions](expressions) to modify data for output: for example, `cells["ColumnName"].value.toUppercase()`.

Anything that appears inside doubled curly braces ({{ }}) is treated as a GREL expression; anything outside is generated as straight text. You can use Jython or Clojure by declaring it at the start:
```
Anything that appears inside doubled curly braces `({{ }})` is treated as a GREL expression; anything outside is generated as straight text. You can use Jython or Clojure by declaring it at the start:
```json
{{jython:return cells["ColumnName"].value}}
```

Expand All @@ -99,7 +99,7 @@ Note that some syntax is different in this tool than elsewhere in OpenRefine: a
:::

You can include [regular expressions](expressions#regular-expressions) as usual (inside forward slashes, with any GREL function that accepts them). For example, you could output a version of your cells with punctuation removed, using an expression such as
```
```json
{{jsonize(cells["ColumnName"].value.replaceChars("/[.!?$&,/]/",""))}}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/grel.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ GREL (General Refine Expression Language) is designed to resemble Javascript. Fo

Note that the operator for string concatenation is `+` (not “&” as is used in Excel).

Evaluating conditions uses symbols such as <, >, *, /, etc. To check whether two objects are equal, use two equal signs (`value=="true"`).
Evaluating conditions uses symbols such as `<`, `>`, `*`, `/`, etc. To check whether two objects are equal, use two equal signs (`value=="true"`).

See the [GREL functions page for a thorough reference](grelfunctions) on each function and its inputs and outputs. Read on below for more about the general nature of GREL expressions.

Expand Down
4 changes: 3 additions & 1 deletion docs/manual/grelfunctions.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,7 @@ Parses a string as JSON. get() can then be used with parseJson(): for example, `

For example, from the following JSON array in `value`, we want to get all instances of “keywords” having the same object string name of “text”, and combine them, using the forEach() function to iterate over the array.

```json
{
"status":"OK",
"url":"",
Expand All @@ -335,6 +336,7 @@ For example, from the following JSON array in `value`, we want to get all instan
}
]
}
```

The GREL expression `forEach(value.parseJson().keywords,v,v.text).join(":::")` will output “York en route:::Anthony Eden:::President Eisenhower”.

Expand Down Expand Up @@ -569,7 +571,7 @@ Some of these math functions don't recognize integers when supplied as the first
|`pow(n1, n2)`|Returns n1 raised to the power of n2. Note: value.pow(3)` will work, whereas `2.pow(3)` will not work.|`pow(2, 3)` returns 8 (2 cubed) and `pow(3, 2)` returns 9 (3 squared). The square root of any numeric value can be called with `value.pow(0.5)`.|
|`quotient(n1, n2)`|Returns the integer portion of a division (truncated, not rounded), when supplied with a numerator and denominator.|`quotient(9,2)` returns 4.|
|`radians(n)`|Converts an angle in degrees to radians.|`radians(10)` returns 0.17453292519943295.|
|`random(n lowerBound, n upperBound)`|Returns a random integer in the interval between the lower and upper bounds (inclusively). Will output a different random number in each cell in a column. If no arguments are provided, returns a number in the range 0.0 <= x < 1.0|
|`random(n lowerBound, n upperBound)`|Returns a random integer in the interval between the lower and upper bounds (inclusively). Will output a different random number in each cell in a column. If no arguments are provided, returns a number in the range `0.0 <= x < 1.0`|
|`round(n)`|Rounds a number to the nearest integer.|`3.7.round()` returns 4 and `-3.7.round()` returns -4.|
|`sin(n)`|Returns the trigonometric sine of an angle.|`sin(10)` returns -0.5440211108893698.|
|`sinh(n)`|Returns the hyperbolic sine of an angle.|`sinh(10)` returns 11013.232874703393.|
Expand Down
6 changes: 3 additions & 3 deletions docs/manual/wikibase/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Maxlag is a parameter that controls how aggressive a mass-editing tool should be

##### tag {#tag}

Specifies a tag which should be applied to all edits made via the tool. The <code>${version}</code> variable will be replaced by the "major.minor" OpenRefine version before making edits.
Specifies a tag which should be applied to all edits made via the tool. The `<code>${version}</code>` variable will be replaced by the "major.minor" OpenRefine version before making edits.

##### max_edits_per_minute {#max_edits_per_minute}

Expand Down Expand Up @@ -165,7 +165,7 @@ The Wikibase instance must have at least a reconciliation service endpoint linke

##### reconciliation_endpoint {#reconciliation_endpoint}

The default reconciliation service endpoint for entities of this type. The endpoint must contain the "${lang}" variable such as "https://wikidata.reconci.link/${lang}/api", since the reconciliation service is expected to work for different languages. For the `item` entity type, you can get such a reconciliation service with [openrefine-wikibase](https://gitlab.com/nfdi4culture/ta1-data-enrichment/openrefine-wikibase). For the `mediainfo` entity type, you can use the [commons-recon-service](https://gerrit.wikimedia.org/g/labs/tools/commons-recon-service) which can be configured to run for other Wikibase instances.
The default reconciliation service endpoint for entities of this type. The endpoint must contain the `${lang}` variable such as `https://wikidata.reconci.link/${lang}/api`, since the reconciliation service is expected to work for different languages. For the `item` entity type, you can get such a reconciliation service with [openrefine-wikibase](https://gitlab.com/nfdi4culture/ta1-data-enrichment/openrefine-wikibase). For the `mediainfo` entity type, you can use the [commons-recon-service](https://gerrit.wikimedia.org/g/labs/tools/commons-recon-service) which can be configured to run for other Wikibase instances.

This parameter is optional: you do not need to run a reconciliation for all entity types available in your Wikibase instance. However, it is a prerequisite for being able to do edits to those entity types via OpenRefine.

Expand All @@ -188,7 +188,7 @@ Not required. Should be configured if the Wikibase instance has [EditGroups](htt

##### url_schema {#url_schema}

The URL schema used in edits summary. This is used for EditGroups to extract the batch id from a batch of edits and for linking to the EditGroups page of the batch. The URL schema must contains the variable '${batch_id}', such as '([[:toollabs:editgroups/b/OR/${batch_id}|details]])' for Wikidata.
The URL schema used in edits summary. This is used for EditGroups to extract the batch id from a batch of edits and for linking to the EditGroups page of the batch. The URL schema must contains the variable `${batch_id}`, such as `([[:toollabs:editgroups/b/OR/${batch_id}|details]])` for Wikidata.

#### Check the format of the manifest {#check-the-format-of-the-manifest}

Expand Down
3 changes: 2 additions & 1 deletion docs/technical-reference/migrating-older-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You will need to write a `pom.xml` in the root folder of your extension to confi

For any library that your extension depends on, you should try to find a matching artifact in the Maven Central repository. If you can find such an artifact, delete the `.jar` file from your extension and add the dependency in your `pom.xml` file. If you cannot find such an artifact, it is still possible to incorporate your own `.jar` file using `maven-install-plugin` that you can configure in your `pom.xml` file as follows:


```
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
Expand All @@ -47,6 +47,7 @@ For any library that your extension depends on, you should try to find a matchin
<!-- if you need to add more than one jar, add more execution blocks here -->
</executions>
</plugin>
```

And add the dependency to the `<dependencies>` section as usual:

Expand Down
9 changes: 5 additions & 4 deletions docs/technical-reference/openrefine-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ If the format is omitted OpenRefine will try to guess the format based on the fi
The values which can be specified in the JSON object submitted to the 'options' parameter will vary depending on the format being imported. If not specified the options will either be guessed at by OpenRefine (e.g. separator being used in a separated values file) or a default value used. The import options for each file format are not currently documented, but can be seen in the OpenRefine GUI interface when importing a file of the relevant format.

If the project creation is successful, you will be redirected to a URL of the form:

```
http://127.0.0.1:3333/project?project=<project id>
```

From the project parameter you can extract the project id for use in future API calls. The content of the response is the HTML for the OpenRefine interface for viewing the project.

Expand Down Expand Up @@ -194,9 +195,9 @@ In the parameter
'format' : format... (e.g 'tsv', 'csv')

In the form data

'engine' : JSON string... (e.g. '{"facets":[],"mode":"row-based"}')

```json
"engine" : JSON string... (e.g. '{"facets":[],"mode":"row-based"}')
```
Returns exported row data in the specified format. The formats supported will depend on the version of OpenRefine you are using and any Extensions you have installed. The common formats include:

* csv
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 6 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@
"netlify:build:deployPreview": "yarn build"
},
"dependencies": {
"@docusaurus/core": "^2.3.1",
"@docusaurus/preset-classic": "^2.3.1",
"@docusaurus/core": "^3.1.0",
"@docusaurus/preset-classic": "^3.1.0",
"clsx": "^1.2.1",
"create-docusaurus": "^2.1.0",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-lite-youtube-embed": "^2.3.1"
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-lite-youtube-embed": "^2.3.1",
"ua-parser-js": "^1.0.37"
}
}
2 changes: 1 addition & 1 deletion static/img/2022survey/2022-survey-openanswers.md
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@
* Thanks for doing all this!
* thanks for everything!
* Thanks for this amazing tool!
* The OpenRefine tool revolutionizes my ability to expand people's understanding about what software can do for us. It helps me convey to those traditionally managing data in spreadsheets, to understand what they've been missing. And, it helps them going forward to dream much bigger when looking at new software development or asking for new functions in existing software. (I'm not sure developers always love that part <cheeky grin>). But the ease with which Refine does things like clustering --- always elicits awe and catalyzes rich conversations about what's possible that they never knew before.
* The OpenRefine tool revolutionizes my ability to expand people's understanding about what software can do for us. It helps me convey to those traditionally managing data in spreadsheets, to understand what they've been missing. And, it helps them going forward to dream much bigger when looking at new software development or asking for new functions in existing software. (I'm not sure developers always love that part \<cheeky grin>). But the ease with which Refine does things like clustering --- always elicits awe and catalyzes rich conversations about what's possible that they never knew before.
* "This is just a technical detail: Removing/reordering columns has a horrible GUI. It should be changed to select all/no columns with checkboxes as it is in the custom tab exporter.
* But for the rest, thanks for your great work!"
* This tool is invaluable to the free culture movement! Thank you humans for all that you do to support this tool and the broader cultural heritage community.
Expand Down
6 changes: 3 additions & 3 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3968,9 +3968,9 @@ flux@^4.0.1:
fbjs "^3.0.1"

follow-redirects@^1.0.0, follow-redirects@^1.14.7:
version "1.15.1"
resolved "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.1.tgz"
integrity sha512-yLAMQs+k0b2m7cVxpS1VKJVvoz7SS9Td1zss3XRwXj+ZDH00RJgnuLx7E44wx02kQLrdM3aOOy+FpzS7+8OizA==
version "1.15.4"
resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.4.tgz#cdc7d308bf6493126b17ea2191ea0ccf3e535adf"
integrity sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==

fork-ts-checker-webpack-plugin@^6.5.0:
version "6.5.2"
Expand Down