From 1d721c43da648d9ab4ba550465177f25cee9f666 Mon Sep 17 00:00:00 2001 From: Arnei Date: Wed, 5 Jul 2023 09:10:02 +0200 Subject: [PATCH] Combine "Configuration" sections in ReadMe The ReadMe has two sections called "Configuration". This combines them. --- README.md | 78 +++++++++++++++++++++++++++---------------------------- 1 file changed, 38 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index d329c492b..318473ad2 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,43 @@ To make the editor work in a sub-path, use: Configuration ------------- -The editor can be configured through the `editor-settings.toml` settings file. It can either be provided in the public folder when running locally or can be found under `etc/opencast/ui-config/mh_default_org/editor` when deployed in Opencast. More information can be found in the example configuration file. + +### Configuration Methods + +Most configuration options can be set either as an option in the configuration file or as a URL parameter. + +The configuration file is called `editor-settings.toml`. It can either be provided in the public folder when running locally or can be found under `etc/opencast/ui-config/mh_default_org/editor` when deployed in Opencast. More information can be found in the example configuration file. + +If a configuration option belongs to a section, URL parameters are a combination of section and option separated by a single dot. + +For example, the following option in the configuration file: + +```toml +[trackSelection] +show = true +``` + +…can be specified as URL parameter in the form `trackSelection.show=true`. + +If an option can be specified both ways, the URL parameter will always take precedence. + + +### Settings + +Options which are usually specified in the configuration file are documented in there as well. Metadata configuration options are only documented in the configuration file. + +| Option | URL | File | Description +| --------------------|-----|------|------------ +| id | ✓ | ✓ | Id of the event that the editor should open by default. +| mediaPackageId | ✓ | ✓ | Deprecated. Use `id` instead. +| opencast.url | ✗ | ✓ | URL of the opencast server to connect to. +| opencast.name | ✗ | ✓ | Opencast user to use. For demo purposes only. +| opencast.password | ✗ | ✓ | Password to use for authentication. For demo purposes only. +| metadata.show | ✓ | ✓ | Show metadata tab. +| trackSelection.show | ✓ | ✓ | Show track selection tab. +| thumbnail.show | ✓ | ✓ | Show thumbnail tab. Demo only. +| debug | ✓ | ✗ | Enable internationalization debugging. +| lng | ✓ | ✗ | Select a specific language. Use language codes like `de` or `en-US`. How to cut a release for Opencast @@ -66,6 +102,7 @@ How to cut a release for Opencast if necessary - Verify that the new release runs in Opencast, then create the pull request. + Opencast API used by the Editor ------------- @@ -80,42 +117,3 @@ If you want to use current editor frontend with an earlier Opencast version, you Translating the Editor ------------- You can help translating the editor to your language on [crowdin.com/project/opencast-editor](https://crowdin.com/project/opencast-editor). Simply request to join the project on Crowdin and start translating. If you are interested in translating a language which is not a target language right now, please create [a GitHub issue](https://github.com/opencast/opencast-editor/issues) and we will add the language. - - -Configuration -------------- - -### Configuration Methods - -Most configuration options can be set either as a URL parameter or as an option in the configuration file. - -If the option belongs to a section, URL parameters are a combination of section and option separated by a single dot. - -For example, the following option in the configuration file: - -```toml -[trackSelection] -show = true -``` - -…can be specified as URL parameter in the form `trackSelection.show=true`. - -If an option can be specified both ways, the URL parameter will always take precedence. - - -### Settings - -Options which are usually specified in the configuration file are documented in there as well. Metadata configuration options are only documented in the configuration file. - -| Option | URL | File | Description -| --------------------|-----|------|------------ -| id | ✓ | ✓ | Id of the event that the editor should open by default. -| mediaPackageId | ✓ | ✓ | Deprecated. Use `id` instead. -| opencast.url | ✗ | ✓ | URL of the opencast server to connect to. -| opencast.name | ✗ | ✓ | Opencast user to use. For demo purposes only. -| opencast.password | ✗ | ✓ | Password to use for authentication. For demo purposes only. -| metadata.show | ✓ | ✓ | Show metadata tab. -| trackSelection.show | ✓ | ✓ | Show track selection tab. -| thumbnail.show | ✓ | ✓ | Show thumbnail tab. Demo only. -| debug | ✓ | ✗ | Enable internationalization debugging. -| lng | ✓ | ✗ | Select a specific language. Use language codes like `de` or `en-US`.