diff --git a/.vscode/settings.json b/.vscode/settings.json
index 308cd6b..e89852e 100755
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -6,5 +6,9 @@
"purescript.addSpagoSources": true,
"purescript.addNpmPath": true,
"purescript.buildCommand": "spago build --purs-args --json-errors",
- "nixEnvSelector.nixShellConfig": "${workspaceRoot}/shell.nix"
+ "nixEnvSelector.nixShellConfig": "${workspaceRoot}/shell.nix",
+ "spellchecker.ignoreWordsList": [
+ "spago",
+ "unminified"
+ ]
}
\ No newline at end of file
diff --git a/README.md b/README.md
index 91b3924..d41ec65 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,32 @@
# metajelo-ui
-[](https://travis-ci.com/labordynamicsinstitute/metajelo-ui)
+[](https://github.com/labordynamicsinstitute/metajelo-ui/actions)
-Web tools to display
+Web tools to edit and display
[metajelo](https://github.com/labordynamicsinstitute/metajelo) packages.
-# Retrieving and Integrating Metajelo-UI
+
+# Project dependencies
+
+The following dependencies were created specifically for metajelo, though `purescript-datacite`
+may have relevance beyond metajelo-related projects.
+
+- [purescript-datacite](https://github.com/CornellCAC/purescript-datacite) [](https://doi.org/10.5281/zenodo.4499120) — Provides types and parsers for DataCite JSON; full types are not provided as yet, but types relevant to metajelo are generally supported.
+- [metajelo](https://github.com/labordynamicsinstitute/metajelo) [](https://doi.org/10.5281/zenodo.2577294) — Schema definitions, presentations, and paper describing metajelo.
+- [purescript-metajelo](https://github.com/labordynamicsinstitute/purescript-metajelo) [](https://doi.org/10.5281/zenodo.4504661) — This project contains type defintions, parsers, and XML generators for metajelo.
+- [metajelo-ui-css-classes](https://github.com/labordynamicsinstitute/metajelo-ui-css-classes) [](https://doi.org/10.5281/zenodo.4507962)
+ — CSS classnames and an example SASS/CSS style used for both `metajelo-web` and `metajelo-ui` (this project).
+- [metajelo-web](https://github.com/labordynamicsinstitute/metajelo-web) [](https://doi.org/10.5281/zenodo.4507861) — A small application and
+library for rendering a styled HTML preview of a metajelo XML document. Like this project, also includes
+a live demo on GitHub pages.
+
+The exact versions employed are sepcified in the `packages.dhall` of each project, or implicitly by
+the package set (which is also specified in `packages.dhall`),
+and in some cases may refer to a git commit rather than a sepecific version. However, we try to
+maintain the use of versioned dependencies in releases where possible. All of this applies for
+other library dependencies that aren't directly a part of this project, as well.
+
+# Retrieving and Integrating metajelo-UI
## Get the latest build
@@ -19,9 +40,9 @@ wget -r -np -k https://labordynamicsinstitute.github.io/metajelo-ui/
## Get a versioned build
-(TODO)
+See the GitHub releases.
-## CSS for Metajelo UI
+## CSS for metajelo UI
By default, CSS files are retrieved from a [separate repository](https://github.com/labordynamicsinstitute/metajelo-ui-css-classes) using `scripts/getcss`; the file `css/style.css` contains some default styles used in our examples.
Feel free to include it, or modify it (renaming the file is also possible):
@@ -83,6 +104,16 @@ An example is [CSS Reload](https://addons.mozilla.org/en-US/firefox/addon/css-re
If you have the relevant build tools installed (`npm`, `spago`, `pulp`, etc.), you can
build using `npm run build && npm run prod`. For a more convenient approach, see
the section on Docker below, and for complete build commands used in CI, see
+`scripts/dist_build_commands.sh`. `npm run debug` will also create an unminified
+version that may be useful for debugging (additionally compilation errors may
+be far more verbose).
+
+Note that Continuous Integration (CI) is employed to build this package and deploy the
+resulting application to GitHub pages, which will host whatever the most recent successful
+build is from the `master` branch. Note that this may be an unversioned build.
+Previously, we used Travis-CI+Docker to achieve this, and now we use GitHub actions
+along with Nix packages to have pinned dependencies. The Travis Config
+and Dockerfile are still available, and all approaches still utilize
`scripts/dist_build_commands.sh`.
## Docker
@@ -92,14 +123,14 @@ the command in the container with the CWD mounted and then exit. Alternatively
if you want to issue multiple commands in the container quickly, you can
run `./psc.sh bash`.
-## Updating Dependendencies or the Metajelo Schema
+## Updating Dependencies or the metajelo Schema
Dependencies for JavaScript are minimal and are controlled by [npm](https://docs.npmjs.com/)
and specified in `package.json`. PureScript dependencies are controlled by
[spago](https://github.com/purescript/spago) and specified
in `spago.dhall`, but in some cases, packages not included in the standard package
set must also be described in `packages.dhall`. In particular, when updating
-the Metajelo schema to be used in metajelo-ui, it will be necessary to specify
+the metajelo schema to be used in metajelo-ui, it will be necessary to specify
a new version of `purescript-metajelo` (with the `purescript-` prefix dropped
in `packages.dhall`). This can simply be done by specifying a git commit hash
or by specifying a version in the relevant section of `packages.dhall`.
diff --git a/packages.dhall b/packages.dhall
index 185b07d..ca1d7aa 100644
--- a/packages.dhall
+++ b/packages.dhall
@@ -168,7 +168,7 @@ let additions =
{ dependencies =
[ "effect", "functors", "generics-rep", "naturals", "simple-json" ]
, repo = "https://github.com/CornellCAC/purescript-datacite.git"
- , version = "9cdd6e644fcc2b8fe1664d3a89de74f4c6722521"
+ , version = "v0.1.0"
}
, either-extra =
{ dependencies =
@@ -210,7 +210,7 @@ let additions =
, "xpath-like"
]
"https://github.com/labordynamicsinstitute/purescript-metajelo.git"
- "37e46c618c78f25a12eed10bfcee82adb5bf7019"
+ "v4.0.0"
, metajelo-web =
mkPackage
[ "prelude"
@@ -225,12 +225,12 @@ let additions =
, "url-validator"
]
"https://github.com/labordynamicsinstitute/metajelo-web.git"
- "e919b0419210e5a43a22e33c05511f608124e1bf"
+ "v2.0.0"
, metajelo-ui-css-classes =
mkPackage
[ "prelude", "concur-core", "concur-react" ]
"https://github.com/labordynamicsinstitute/metajelo-ui-css-classes.git"
- "v1.0.0"
+ "v1.0.1"
, naturals =
mkPackage
[ "enums", "maybe", "prelude" ]
diff --git a/static/index.html b/static/index.html
index 97b802f..6512527 100644
--- a/static/index.html
+++ b/static/index.html
@@ -3,7 +3,7 @@
- Tests for purescript-web-xpath
+ Metajelo User Interface