edit carrel home page template

[ericleasemorgan]

Edit carrel home page template

The home page of each study carrel is driven by a template file:

https://github.com/ericleasemorgan/reader/blob/master/etc/about.htm

The template is filled with tokens and each token is delimited by a pair of hash marks (##). For example, ##SUMOFWORDS## denotes the total number of words in a carrel.

Since we already know a lot about our data set, the generic template file can be edited to reflect our particular data set, and it can be re-written so it is more formal. For example, remove the bogus notes (things like "[0]"), or add from whence the carrel's data came. In short, copy edit about.htm.

To fix this issue, one does not need to write any software, just edit, test, and repeat. Here's a suggested process:

1. connect to the cluster - ssh 149.165.170.42
2. duplicate the template - cp /export/reader/etc/about.htm /export/reader/etc/x-about.htm
3. edit the template - [for this step, use whatever editor you desire]
4. using a given test carrel, recreate an about page - cd /export/reader/carrels/tiny-carrel; ../../bin/carrel2about.py > ./index.htm
5. wait for the process to finish, which is about 20 seconds
6. evaluate the results by perusing the carrel's home page - http://cord.distantreader.org/carrels/tiny-carrel/
7. if not satisfied, then go to Step add CDS branding to distantreader.org #3
8. done

In the end, let Eric know of your progress.

[ericleasemorgan]

Here's are two additional enhancements to this issue, as per Natalie:

On https://cord.distantreader.org/carrels/ update the link from
distantreader logo etc so the user "stays" in
cord.distantreader.org instead of getting punted out to
distantreader.org ?

And figure out another UI way for the user to get back to cord
"carrels" instead of getting punted over to distantreader.org
after clicking into a cord carrel page from
https://cord.distantreader.org/carrels/?

[ericleasemorgan]

I did much of this work weeks ago. Closing.