Commit ea9fc5a7 authored by Roberto Minelli's avatar Roberto Minelli
Browse files

Updating README and lorem ispum in Empty.js

parent 6800ab22
Pipeline #884 failed with stage
# Mímir – A Visual Browser for the Federal Archives
Mímir is a visual platform to explore the [Swiss Federal Archives](https://www.bar.admin.ch/bar/en/home.html). It organizes the results according to the [archive plan](https://www.recherche.bar.admin.ch/recherche/#/en/search/archive-plan) and uses Voronoi treemaps to portray the result (i.e., an algorithm to represent hierarchies as nested polygons).
Mímir is a visual platform to explore the [Swiss Federal Archives](https://www.bar.admin.ch/bar/en/home.html). It aggregates the results according to the [archive plan](https://www.recherche.bar.admin.ch/recherche/#/en/search/archive-plan) and uses [Voronoi treemaps](https://pubsys.mmsp-kn.de/pubsys/publishedFiles/BaDe05b.pdf) to portray the result (i.e., an algorithm to represent hierarchies as nested polygons).
Users can query the Swiss Federal Archives with simple and advanced text queries. Mímir will show the results in a visualization and enable users to interact with it in various ways, for example by expanding and collapsing nodes or by requesting additional pieces of information about documents of interest.
In Mímir, users enter simple and advanced text queries (e.g., metadata, content, reference code, country) to find documents of interest. Mímir queries the archives using the [SFA Data Search API](https://www.recherche.bar.admin.ch/recherche/#/en/information/api), aggregates the results according to their archive plan context, and generates an interactive visualization. User can expand and collapse nodes or request additional pieces of information about documents of interest.
This project is a submission to the [SFA Data Challenge](https://www.bar.admin.ch/bar/en/home/research/searching/project-online-access.html).
......@@ -14,7 +14,7 @@ These instructions will get you a copy of the project up and running on your loc
### Prerequisites
To install Mímir and its dependencies, you need to have [NPM.js](https://www.npmjs.com) installed. NPM.js a package manager for the JavaScript programming language.
To install Mímir and its dependencies, you need to have [NPM.js](https://www.npmjs.com) installed. NPM.js a package manager for the JavaScript programming language.
To install it, please refer to the [official installation guide](https://www.npmjs.com/get-npm).
......
......@@ -9,14 +9,28 @@ export default function Empty(props) {
<Card.Header as={'h5'}>Welcome to Mìmir!</Card.Header>
<Card.Body>
<Card.Text>
Mìmir is a lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras eu tempus ex.
Etiam ut velit fermentum, aliquam mauris sed, ultrices nulla. Etiam rutrum urna nec erat
molestie, eget aliquet erat dignissim.
Mìmir is a visual platform to explore the{' '}
<a target='_blank' href='https://www.bar.admin.ch/bar/en/home.html'>
Swiss Federal Archives
</a>
. It aggregates the results according to the{' '}
<a
target='_blank'
href='https://www.recherche.bar.admin.ch/recherche/#/en/search/archive-plan'
>
archive plan
</a>{' '}
and presents them with{' '}
<a href='https://pubsys.mmsp-kn.de/pubsys/publishedFiles/BaDe05b.pdf' target='_blank'>
Voronoi treemaps
</a>
.
</Card.Text>
</Card.Body>
<ListGroup variant="flush">
<Card.Header as={'h6'}>Instructions</Card.Header>
<ListGroup variant='flush'>
<ListGroup.Item>
Use the <b>search bar</b> to enter your query
Enter your text query in the <b>search bar</b>
</ListGroup.Item>
<ListGroup.Item>
<b>Hover</b> on a node to get basic info
......@@ -28,13 +42,13 @@ export default function Empty(props) {
<b>Click</b> on a node to expand its direct children
</ListGroup.Item>
<ListGroup.Item>
<b>Option+Click</b> (Alt+Click) on a node to expand all its children recursively
<b>Alt/Option+Click</b> on a node to expand all its children
</ListGroup.Item>
<ListGroup.Item>
<b>Shift+Click</b> on a node to open the SFA
<b>Shift+Click</b> on a node to discover more on the SFA
</ListGroup.Item>
<ListGroup.Item>
<b>Right-click</b> to collapse its children
<b>Right-click</b> on a node to collapse its children
</ListGroup.Item>
</ListGroup>
</Card>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment