From 6e9c7edd1d4b785f8b8f1f3522af382719809d5c Mon Sep 17 00:00:00 2001 From: Matt Mascarenhas Date: Fri, 23 Sep 2022 17:39:07 +0100 Subject: [PATCH] Update README.md --- README.md | 183 +++++++++++++----------------------------------------- 1 file changed, 42 insertions(+), 141 deletions(-) diff --git a/README.md b/README.md index d3848c9..2b59c00 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,26 @@ deployment ### Install the dependencies -1. flex (for hmmlib) -2. curl (for cinera) +1. curl -### Download, and prepare the parser +### Download, and copy the parser into place 1. `git clone git@gitssh.handmade.network:Annotation-Pushers/Annotation-System.git` -2. `cd Annotation-System/hmmlib` -3. `make` -4. `cp hmml.a hmmlib.h ../cinera/` -5. `cd ../cinera/` +2. `cd Annotation-System/cinera` +3. `cp ../hmmlib2/hmmlib.h .` -Note: For each parser update, remember to make and copy it into place. +Note: For each parser update, remember to copy it into place. ### Build 1. `$SHELL cinera.c` +### Configure + + cinera -h + +This documents the configuration file format and default settings. + ### Configure the server If you enforce a strict Content Security Policy and X-Frame-Options in your @@ -38,56 +41,24 @@ and [Hardening your HTTP response headers](https://scotthelme.co.uk/hardening-yo ### Run -#### Single Edition operation - - cinera test.hmml - -This simply generates an HTML file (and updates `cinera_topics.css` if needed) -from `test.hmml` and outputs to `out.html` (configurable with -o). - -#### Project Edition operation - - cinera -p ProjectID - -Setting the ProjectID with the `-p` flag triggers Project Edition. In this -edition _Cinera_ monitors the Project Input Directory for new, edited and -deleted .hmml files, and generates one table of contents / search page and a -player page each for valid sets of annotations (or removes them, if needed). - -By default all directories - input and output - are set to the current working -directory. Typical operation will involve setting these flags: - - -d Project Input Directory, the directory where the .hmml files reside - -r Asset Root Directory, path shallower than or equal to the CSS, Images and - JS directories - -R Asset Root URL, corresponding to the Root Directory - -c CSS Directory, relative to Root - -i Images Directory, relative to Root - -j JS Directory, relative to Root - -b Output Base Directory, location of the table of contents / search page - -B Output Base URL, corresponding to the Output Base Directory - -t Template Directory - -x Search Template Location, relative to Template Directory - -y Player Template Location, relative to Template Directory + cinera -c /path/to/config.conf #### Templates -*Search Template* +*(Global) Search Template* - `` _to put inside your own ``_ - `` _the table of contents and search functionality_ *Player Template* - `` _to put inside your own ``_ -- `` - `` -- `` _must come after `` and ``_ *Optional tags available for use in your Player Template* - `` - `` - `` -*Other tags available for use in either template* +*Other tags available for use in any template* - Asset tags: - `` General purpose tag that outputs the URL of the specified asset @@ -113,8 +84,29 @@ All these asset tags additionally perform revving, appending a query string (-Q) and the file's checksum to the URL. Changes to a file trigger a rehash and edit of all HTML pages citing this asset. +- Navigation / Menu tags: + - `` + This menu will contain only the current project, its siblings and + subprojects of both the aforementioned + - `` + This menu will contain every project in the configuration +These navigation tags additionally take one parameter, e.g. +``: + - `dropdown` + A dropdown menu, that opens on hover + - `horizontal` + More-or-less the same as `dropdown`, but always open + - `plain` + A straightforward `