diff --git a/docs/manual/cellediting.md b/docs/manual/cellediting.md index e13c2bdb..47c31b73 100644 --- a/docs/manual/cellediting.md +++ b/docs/manual/cellediting.md @@ -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}**_ +**Phonetic Clustering** 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. diff --git a/docs/manual/exporting.md b/docs/manual/exporting.md index 79d99ba3..d827b556 100644 --- a/docs/manual/exporting.md +++ b/docs/manual/exporting.md @@ -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}} ``` @@ -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("/[.!?$&,/]/",""))}} ``` diff --git a/docs/manual/grel.md b/docs/manual/grel.md index 7ec90b46..a231bc90 100644 --- a/docs/manual/grel.md +++ b/docs/manual/grel.md @@ -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. diff --git a/docs/manual/grelfunctions.md b/docs/manual/grelfunctions.md index 39f5c966..e2e4c02c 100644 --- a/docs/manual/grelfunctions.md +++ b/docs/manual/grelfunctions.md @@ -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":"", @@ -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”. @@ -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.| diff --git a/docs/manual/wikibase/configuration.md b/docs/manual/wikibase/configuration.md index a53b4bcd..774b4ee0 100644 --- a/docs/manual/wikibase/configuration.md +++ b/docs/manual/wikibase/configuration.md @@ -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 ${version} 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 `${version}` variable will be replaced by the "major.minor" OpenRefine version before making edits. ##### max_edits_per_minute {#max_edits_per_minute} @@ -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. @@ -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} diff --git a/docs/technical-reference/migrating-older-extensions.md b/docs/technical-reference/migrating-older-extensions.md index fc5ce3c4..2bcd0663 100644 --- a/docs/technical-reference/migrating-older-extensions.md +++ b/docs/technical-reference/migrating-older-extensions.md @@ -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: - +``` org.apache.maven.plugins maven-install-plugin @@ -47,6 +47,7 @@ For any library that your extension depends on, you should try to find a matchin +``` And add the dependency to the `` section as usual: diff --git a/docs/technical-reference/openrefine-api.md b/docs/technical-reference/openrefine-api.md index ba5c40e8..cad36dc0 100644 --- a/docs/technical-reference/openrefine-api.md +++ b/docs/technical-reference/openrefine-api.md @@ -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= +``` 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. @@ -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 diff --git a/package-lock.json b/package-lock.json index fac040ff..fcdc6202 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22317,4 +22317,4 @@ "integrity": "sha512-V50KMwwzqJV0NpZIZFwfOD5/lyny3WlSzRiXgA0G7VUnRlqttta1L6UQIHzd6EuBY/cHGfwTIck7w1yH6Q5zUw==" } } -} +} \ No newline at end of file diff --git a/package.json b/package.json index 648934a7..5bdb3683 100644 --- a/package.json +++ b/package.json @@ -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" } } diff --git a/static/img/2022survey/2022-survey-openanswers.md b/static/img/2022survey/2022-survey-openanswers.md index a309951e..ab67cf8b 100644 --- a/static/img/2022survey/2022-survey-openanswers.md +++ b/static/img/2022survey/2022-survey-openanswers.md @@ -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 ). 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 \). 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. diff --git a/yarn.lock b/yarn.lock index bd37995f..bf93b667 100644 --- a/yarn.lock +++ b/yarn.lock @@ -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"