Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Reorganise the main menu and the data menu #807

Merged
merged 11 commits into from Sep 9, 2022
4 changes: 2 additions & 2 deletions docs/user-guide/data/search.md
Expand Up @@ -6,11 +6,11 @@ DSP-APP offers the possibility for the user to search in 3 different ways: **ful

## Full-text search

The full-text search performs queries including one or more terms or phrases and returns data that matches search conditions. By default, the search is performed in all projects stored in DSP. However, it is possible to filter by the project using the menu "Filter by project" on the left side of the search bar.
The full-text search performs queries including one or more terms or phrases and returns data that matches the search conditions. By default, the search is performed in all projects stored in DSP. However, it is possible to filter by project using the "Filter by project" menu on the left side of the search bar.

![Filter your full-text search by specific project](../../assets/images/search-fulltext-filterByProject.png)*<https://admin.dasch.swiss> - Search 1: Full-text search*

When clicking on the search bar, the search history panel is displayed. The **10** last searches are registered. It is also possible to clear the search history list (*Clear list* button at the bottom of the panel or the *x* at the end of each line).
When clicking on the search bar, the search history panel is displayed. The last **10** searches are registered. It is also possible to clear the search history list (*Clear list* button at the bottom of the panel or the *x* at the end of each line).

![Search history panel](../../assets/images/search-history.png)*Search history list is accessible for the full-text search from any webpage.*

Expand Down
24 changes: 12 additions & 12 deletions docs/user-guide/data/work-on-data.md
Expand Up @@ -14,7 +14,7 @@ If you don't have the permissions you were supposed to get, please contact the [

### Display a resource

DSP-APP offers different resource views for different media types (images, videos, audio, archives, text, and PDF files). You can access the resources from the list of search results. Depending on the media type, DSP-APP offers different tools to work on the resource.
DSP-APP offers different resource views for different media types (images, videos, audio, archives, text, and document files). You can access the resources from the list of search results. Depending on the media type, DSP-APP offers different tools to work on the resource.
Additionally, you can work on the resource directly, e.g, mark regions of interest on images and documents.

Each media viewer offers different tools and functionalities, either displayed in the bottom toolbar (e.g. zoom, open in fullscreen button, play button, etc. - captioned in orange thereafter) or in the menu - the three-dot button on the bottom-left side (e.g. copy the ARK URL to the clipboard, download/replace the file, open the file in a new tab - captioned in red thereafter).
Expand Down Expand Up @@ -76,15 +76,15 @@ By default, only important properties are shown in the resource viewer. To displ

![Show or hide properties.](../../assets/images/show-hide-properties.png)*Show or hide properties from the toolbar.*

To get more information about the property value, i.e. date of creation and author name, you mouse over the value and then on the info button.
To get more information about the property value, i.e. date of creation and author name, hover over the value and then over the info button.

![Get more information about the value](../../assets/images/value-info.png)*Get the creation date and the author name of the value.*

### Display a value comment

To display the existing value comment, you mouse over the property value and click on the comment button (3rd icon from the left).
To display the existing value comment, hover over the property value and click on the comment button (3rd icon from the left).

![Mouse over the property value to see if there is a comment.](../../assets/images/comment-value.png)*Mouse over the property value to see if there is a comment and display it.*
![Hover over the property value to see if there is a comment.](../../assets/images/comment-value.png)*Hover over the property value to see if there is a comment and display it.*

---

Expand Down Expand Up @@ -117,13 +117,13 @@ A "plus" button is displayed to the right of the label or after the first value

![Save or undo the changes.](../../assets/images/add-new-text-value.png)*Save or undo the changes you made.*

If your property is linked to another resource, you can search for an existing value by typing the first letter of the resource label you are looking for. You can also create a new resource instance by clicking on the first option in the drop-down menu, `Create new: xxx`.
If your property is linked to another resource, you can search for an existing value by typing the first three letter of the resource label you are looking for. You can also create a new resource instance by clicking on the first option in the drop-down menu, `Create new: xxx`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

letter -> letters


![Add a new linked resource value.](../../assets/images/add-new-resource-value.png)

### Add an image region

To create a new region on an image, you click on the button Draw a region in the toolbar, then select the region you want on the image.
To create a new region on an image, you click on the button `Draw a region` in the toolbar, then select the region you want on the image.

![Select a region.](../../assets/images/region_draw.png)*Select a region on the image with the drawing tool.*

Expand All @@ -143,13 +143,13 @@ The new region information is displayed after the image viewer. You can edit or

### Edit a resource

To edit the resource label, you reach the edit form by opening the resource menu on the right-side of the toolbar and clicking on `Edit label`.
To edit the resource label, open the resource menu on the right-side of the toolbar and click on `Edit label`.

![Add a new linked resource value.](../../assets/images/edit-resource-label.png)

### Edit a property value

You can edit a property value from the resource viewer. You mouse over the value and click on the edit button.
You can edit a property value from the resource viewer. Hover over the value and click on the edit button.

![Add a new linked resource value.](../../assets/images/edit-value.png)*Edit button when mousing over the value.*

Expand All @@ -171,13 +171,13 @@ To delete a resource, there are 2 possibilities:

1. **Delete** resource: the resource is not searchable or findable in DSP-APP anymore but the data still exists in the database.

2. **Erase** resource: the resource is **definitely** deleted from the database, it will be impossible to get it back.
2. **Erase** resource: the resource is **permanently** deleted from the database, it will be impossible to get it back.

![Delete or erase a resource.](../../assets/images/delete-erase-resource.png)*Delete or erase a resource.*

### Delete a property value

You can delete a property value. You mouse over the value and click on the delete button. You have to confirm your choice. It is possible to comment on the deletion of the value in the confirmation pop-up window to explain why it is being deleted.
You can delete a property value. Hover over the value and click on the delete button. You have to confirm your choice. It is possible to comment on the deletion of the value in the confirmation pop-up window to explain why it is being deleted.

![Delete a property value.](../../assets/images/delete-value.png)*Delete a property value.*

Expand All @@ -203,7 +203,7 @@ To link 2 resources (A is an image and B is a document in the example), you go t

![Copy the internal link](../../assets/images/link_copy_internal_link.png)*Copy the internal link of the resource A.*

Go to your resource B. You click on the **edit** button of the property value where you want to add the link (by mousing over the value content). This value must be of type **rich text**.
Go to your resource B. You click on the **edit** button of the property value where you want to add the link (by hovering over the value content). This value must be of type **rich text**.

![Edit the property value](../../assets/images/link_edit_value.png)*Edit the property value of type rich text to add the link.*

Expand Down Expand Up @@ -235,7 +235,7 @@ It is possible to add other resources later on by clicking on the `+` button in

## Share your data

Each resource of your dataset gets an ARK URL (Archival Resource Key), a persistent identifier that will allow citing permanently your resource in papers, conference presentations, books, etc.
Each resource of your dataset gets an ARK URL (Archival Resource Key), a persistent identifier that will allow you to permanently cite your resource in papers, conference presentations, books, etc.

You will find it in the **Share** menu of the resource toolbar, click on `Copy ARK to clipboard` to copy and paste it wherever you want.

Expand Down