You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,12 +41,36 @@ See [`CONTRIBUTING.md`][org-contrib].
41
41
42
42
## Development
43
43
44
+
All necessary files to bundle or run the Chooser are located within the `/src` directory.
45
+
44
46
*`/src/index.html`: relevant HTML markup.
45
47
*`/src/style.css`: localized styles, built on top of [Vocabulary][vocabulary].
46
48
*`/src/scripts.js`: relevant JavaScript logic.
47
49
50
+
The Chooser exists bundled within the [`vocabulary-theme`][vocabulary-theme] repository for production purposes. This repository is for isolated development purposes, similar to the setup followed by [`cc-legal-tools-app`][cc-legal-tools-app] + [`cc-legal-tools-data`][cc-legal-tools-data], and [`index-prototype`][index-prototype].
51
+
52
+
Once changes are implemented here, they need to be updated within the `/chooser` directory within `vocabulary-theme`.
53
+
54
+
Final production changes are deployed within vocabulary-theme Releases, updated within [`index-dev-env`][index-dev-env], and finally deployed to `index__stage` and then `index__prod` environments; going LIVE at `https://creativecommons.org/choose`.
55
+
48
56
49
57
## Setup
50
58
1. open the `src/index.html` file within a browser to view the Chooser.
The initial markup is rendered via the `index.html` file. Visual display is derived from the `style.css` rules.
71
+
72
+
On initlialization the `scripts.js` functions set the correct fieldsets to default display; based on user provided actions through the stepper fieldsets will display or hide, exposing the relevant pathways to getting a `tool` recommendation. Correct pathways are located within the `rawStatePathRoutes` array. When a correct pathway matches the current `state`, the appropriate `tool` is matched and recommended, if the current state is not a known pathway the `tool` is set to `unknown` until the required input is given.
73
+
74
+
The main `tool` recommendation content is pull via the appropriate `<template>` markup located within HTML. Additional information for the marking formats is also sourced from these `<template>` elements and the contents of the `Attribution Details` fields.
75
+
76
+
Marking formats are pulled from a combination of HTML markup and JS string interpolation found within the `scripts.js` file within the `renderMarkingFormats` function.
0 commit comments