jefferya
commented
7 years ago Rough note on how to install CWRC-GitWriter
Note: fix GitHub repo names below as code moves from dev into prod
- install npm (version 1.x doesn't work; tested with 3+ or 5.4.2
- requires a release of islandora_cwrc_writer after 2017-10-13
cd libraries/
git clone https://github.com/ajmacdonald/CWRC-GitWriter.git
cd CWRC-GitWriter
npm install
npm run build
cd ../modules/
git clone https://github.com/cwrc/islandora_cwrc_writer.git
drush cc all
suggestions for enhancing documentation:
"Maybe the question is more about how Drupal incorporates javascript libraries into the pages it sends down to the browser?"
It would be great if there was a simple diagram showing how the CWRC-Writer (currently) runs in Islandora. Is there anything like that?
ref: 2017-07-18 e-mail conversation with James
There is a rough pic attached that shows the interaction - is this close to what you were thinking (rough as I spent about 5min drawing).
The islandora_cwrc_writer modules uses code within the "theme", "utilities", and "js" directories to embed CWRC-Writer into a Drupal page by referencing items within the CWRC-Writer directory and overriding aspects (delegator to save/load docs).
CWRC-Writer is treated as a static library (i.e., no changes made to the CWRC-Writer directory relative to what is pulled from GitHub)
In the more general case, the "theme" for a give module (not to be confused with the theme for the site) calls/activates JS libraries located at a particular url.```
"Maybe we could even annotate the diagram with links to the directories in github, to kind of tie it into the actual code base? And possibly also links to where there running code sits on the server?"
Thanks for the suggestions. The directory structure within Drupal is implied by the "/" and relative to Drupal and the CWRC GitHup repositories are implied in by "CWRC-Writer" and "islandora_cwrc_writer". given that this may/will change, I'm hesitant to put time toward this unless there is an immediate need, is there?
link to "https://github.com/cwrc/tech_documentation"