acdh-oeaw / vicav-app

A map-based web application for VICAV project.

VICAV Web Page

A map-based web application for the VICAV project.

Set up a local instance

Prerequisites

• Java LTS (Oracle, Azul, or others) (17 at the moment)
• Node LTS (18 at the moment)
• git (for Windows, shipped with other OSes)
• curl for downloading Saxon HE (10.3 at the moment, curl is included with git for windows)
• This git repository needs to be cloned inside a BaseX ZIP-file distribution (please use 9.7.3 at the moment, version 10.x will be supported soon)

Setup

• unzip BaseX*.zip (for example in your home folder) <basexhome> is the directory containing BaseX.jar and the bin, lib and webapp directory (basex after unpacking the BaseX*.zip file, but you should probably rename it)
• in <basexhome>/webapp git clone this repository, please do not change the name vicav-app
• start a bash in <basexhome>/webapp/vicav-app
• run git submodule update --init --recursive
• optionally set the CONTENT_REPOsitory and the CONTENT_BRANCH

  # default settings if unset
  export CONTENT_REPO=https://github.com/acdh-oeaw/vicav-content
  export CONTENT_BRANCH=master

• run ./deployment/initial.sh

This will clone vicav-content into <basexhome>.

Update data and web page code

In <basexhome> execute ./redeploy.sh

Then if

Tests

3 types of tests:

• XSPEC for unit testing the XSL transformations in ./xslt,
• XUnit for testing basex API endpoint outputs
• Cypress for end-to-end testing of the frontend features

Test data is located in ./fixtures. Before running tests locally, you have to setup your test environment with the fixtures.

Tests are automatically executed upon a git push on Gitlab. See https://gitlab.com/acdh-oeaw/vicav/vicav-app/-/pipelines.

To run tests locally you need to tell the scripts where to find BaseX using the CYPRESS_BASEX_ROOT environment variable. E.g.:

$env:CYPRESS_BASEX_ROOT="<basexhome>"
npm run test

XSpec

Installation: Download xspec from https://github.com/xspec/xspec Running a test file: 1a. Windows: <xspechome>/bin/xspec.sh FILENAME 1b. Linux, mac: run <xspechome>/bin/xspec.sh FILENAME

Run xUnit:

Running a test file: Run <basexhome>/bin/basex -t FILENAME

Run cypress

Installation:

• install nodejs and npm
• run npm install

Running tests: Either open the GUI with npm run cypress:open or run them on command line with npm run cypress:run.

vicav-app's Issues

Closing the last available panel results in footer not being visible.

Implement option to switch a single panel full-screen view.

Scroll pos. bug on the first open panel after creating a new one.

Adapt footer to the project color palette

Change scroll behaviours of map / content panels / main container on smaller devices

Corpus query and layout fixes

Integrate data from NoSketch Engine (proof-of-concept)

We want to create a RestXQ based variant of the API used in voice-api.

• implement to be consumed by the application frontend (based on the VOICE API, excluding its query parser)
• document query API
• implement an endpoint to get utterances
• document the get API
• implement communication between BaseX and NoSketch Engine

We need a fuzzy and an exact search in dictionaries

Students often do not know how to spell a word exactly. A fuzzy default search is needed.

Fix formatting and styling issues of some query results.

Make the search input area of dictionary panels fixed

Implement web form for researchers to contribute to the project data.

Implement keyword text search function to the overlay.

Dictionary autocomplete area should be absolute positioned relative to the input section

Implement cookie bar + update imprint link

Implement proof-of-concept GUI (query form, result rendering) (in cooperation with frontend developer)

Basic implementation finished
Additional features:

• acdh-oeaw/vicav-vue3#31
• acdh-oeaw/vicav-vue3#32
• acdh-oeaw/vicav-vue3#33

Add interactive openAPI documentation

Corpus Texts are not loading

https://vicav.acdh.oeaw.ac.at/#map=[biblMarkers,.*,geo]&5=[sampleQuery,killing_jackal,Morocco,open]

https://vicav.acdh.oeaw.ac.at/sample?coll=vicav_corpus&id=killing_jackal&xslt=sampletext_01.xslt&_=1674827526228

Improve textbook audio

Audio Working with caveats
Implement more functions to control the audio?

• Use custom controls instead of relying on (very different) audio controls of the different browsers?
• Automatically stop a recording if another is started? They play simultaneously right now

Pin position is inconsistent on different map zoom levels

Integrate SHAWI dictionary

• adapt VICAV deployment worfklow to include the SHAWI dictionary
• [x ] if needed, adapt XSLT rendering to cater for new markup structures

replace static profile list with dynamic one

Currently the list of profiles are hard-coded in a static TEI document. This should be replaced by a dynamically generated list served by the dedicated endpoint developed for TUNOCENT.

TODO:

• add grouping level by country (in case there's more than one country in all input profiles)
• factor out the introduction text

Enhancements for TUNOCENT

• #82

Sound files under Damascus-Wörterbuch have positioning issues on smaller devices.

Add data-attributes to panels to define their scope / prevent duplicates of certain panels.

API: Output info for data querying along with menu points

I order to link the menupoints to their corresponding data queries the menu items in the projectInfo endpoint should contain the info on the queries.
preferred format would be:

{
  "id": "navBiblGeoMarkers",
  "title": "All Bibl. Locations on Map",
  "type": "item"
  "query": {
       "endpoint": "bibl_markers_tei",
       "query": ".*",
       "scope": "geo",
   }
}

currently this information is matched to the menu points here:

vicav-app/js/vicav_funcs.js

Line 1925 in f41b85e

$(document).on('mousedown', "#navBiblGeoMarkers,#subNavBiblGeoMarkers",

Implement how-to-use the app section with instructions

Implement option to close all open panels.

Check static texts rendering

[] The project team is tasked with providing the intro texts and other static texts for the project.
[] Lev is going to implement rendering of static texts.

Check that the static texts render correctly.

Fix mobile layout responsiveness i.e. panels vertical flow after a certain breakpoint.

Profile content header images should be smaller.

initial setup misses menu / project configuration

Following the setup steps in README.md, the resulting installation does not have a menu, because the project router file seems to be missing.

the XHR call to http://localhost:8984/vicav/project -H 'Accept: application/xml, text/xml, /; q=0.01'

returns

Stopped at /home/dschopper/bin/basex/webapp/vicav-app/api-problem.xqm, 207/10:
[basex:restxq] Unexpected node: message="http://basex.org/restxq: Unexpected node: message=""err:FODC0002: Resource '/home/user/bin/basex/webapp/vicav-app/vicav_projects/projects.xml' does not exist."".".

Implement a wysiwyg editor (redactor, frola) contribute modal.

Dictionary autocomplete results should have respective dict. styles.

Add selector on client side to switch between {city_name_en} and {city_name_local}

Implement URL parameters to share and reopen the current view.

While typing into the dictionary search input, it's not possible to add a special character between letters

Enhancements for SHAWI

For the SHAW I project the platform needs to be extended to provide

• #54
  • acdh-oeaw/shawi-data#8
• #57
• #55
  • #59
  • acdh-oeaw/shawi-data#10
  • #60
    • acdh-oeaw/vicav-vue3#31
    • acdh-oeaw/vicav-vue3#32
    • acdh-oeaw/vicav-vue3#33

Set up customized VICAV instance for SHAWI

Data and project specific customizations are in a dedicated content repository. See vicav-content and tunocent-content as reference.
We try to add the necessary additional data to shawi-data.
Deploying the SHAWI data instance is part of this repository.

• shawi-data - rework current VICAV deployment process to run on the ACDH-CH Kubernetes Cluster
• refactor branding mechanism (in collaboration with frontend developer)
• adapt basic styling (CSS, project logo) (in collaboration with frontend developer)
• implement first set of static pages (about project, team page, etc.) as provided by the project team

Add menu items that manipulate the map view to the sub bar

Reposition special characters block to be directly under the dictionary title

Fix scroll position bug while opening a 4th panel with the last one scrolled-down.

<pc> elements are not rendered neither in KWIC nor in the text view