Skip to content

Commit

Permalink
update screenshots and content
Browse files Browse the repository at this point in the history
  • Loading branch information
marcolarosa committed Apr 29, 2024
1 parent 5fcd3ce commit 5f306d6
Show file tree
Hide file tree
Showing 33 changed files with 35 additions and 40 deletions.
17 changes: 5 additions & 12 deletions src/docs/guide/tutorials/transcribing-content-assistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,18 @@ current, or complete information.
# Using the assistant

As you are transcribing your content, you are also marking up entities that are found in that
content. That markup, as seen in the previous tutorial is stored as data attributes in the
transcription and also the metadata.
content. That markup, as seen in the previous tutorial is stored in the metadata and as data
attributes in the transcription.

The next step is developing and enriching your description of the content by using the assistant to
interrogate the text; potentially from differing perspectives.

In the following images, the assistant is first used to summarise the text and describe the main
topics. Then, acting as an anthropologist (ie prompting it to assume a particular role), the
assistant is again asked what the main topics are. After that, the assistant is asked to assume the
role of a social scientist to explain the narrative with respect to any cultural symbolism. Finally
(the second image), the assistant is asked to explain whether the narrator is a part of the event.
role of a social scientist to explain the narrative with respect to any cultural symbolism.

<ImageComponent src="/images/tutorial-transcribing-content-assistant/assistant1.png"></ImageComponent>
<ImageComponent src="/images/tutorial-transcribing-content-assistant/assistant2.png"></ImageComponent>

In each case, the assistant provides a detailed answer with evidence from the text to support its
commentary.
Expand All @@ -49,16 +47,11 @@ wish to define yourself) and associated to the file.
When we navigate back to the describe tab we see the descriptions and defined terms that we added
previously.

<ImageComponent src="/images/tutorial-transcribing-content-assistant/assistant3.png"></ImageComponent>
<ImageComponent src="/images/tutorial-transcribing-content-assistant/assistant2.png"></ImageComponent>

Moving onto another image we can again engage the assistant to describe the text and when we go to
add defined terms, not only can we create new ones but we can also look up existing terms that have
been defined in the metadata. Notice the dropdown in the image shows the defined terms we created
for the first page?

<ImageComponent src="/images/tutorial-transcribing-content-assistant/assistant4.png"></ImageComponent>

As before, when we navigate to the describe tab, we see the description entries and defined terms
associated to the file.

<ImageComponent src="/images/tutorial-transcribing-content-assistant/assistant5.png"></ImageComponent>
<ImageComponent src="/images/tutorial-transcribing-content-assistant/assistant3.png"></ImageComponent>
33 changes: 18 additions & 15 deletions src/docs/guide/tutorials/transcribing-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ content in the RO-Crate as entities attached to the specific file.
## The transcription Tab

When you navigate to the transcription tab you will see a 3 pane layout. In the first pane is the
file browser showing only images in your folder. For now, Describo can only work with image formats;
specifically files with the extension 'tif', 'tiff', 'jpg', 'jpeg', 'webp' or 'png'.
file browser showing only images in your folder. As this section works with image files, only those
files will be shown in the file browser. Supported file types are files with the extension 'jpg',
'jpeg', 'webp' or 'png'.

<ImageComponent src="/images/tutorial-transcribing-content/transcribe1.png"></ImageComponent>

Expand Down Expand Up @@ -58,8 +59,8 @@ fractions of a cent, having a go won't cost much.

:::

In the following two images, the control `Extract text using OCR` is pressed and after a few
moments, the text is written into the transcription editor.
In the following two images, the control `Extract text` is pressed and after a few moments, the text
is written into the transcription editor.

<ImageComponent src="/images/tutorial-transcribing-content/transcribe3.png"></ImageComponent>
<ImageComponent src="/images/tutorial-transcribing-content/transcribe4.png"></ImageComponent>
Expand All @@ -70,15 +71,16 @@ confirmed by you.

Highlighting an entity in the text and then pressing `Markup Entity` in the controls allows you to
mark up that entity in the RO-Crate. In the following example we are saying that that entity in the
text is a Person with name `Goolgoolia`.
text is a Person with name `Wadhoorja`.

<ImageComponent src="/images/tutorial-transcribing-content/transcribe5.png"></ImageComponent>

After pressing `Create and Link Entity` the background has changed to indicate that the entity has
been confirmed by you. Entities can be unmarked by highlighting them and selectin `Unmark Entity`.
been confirmed by you. Entities can be unmarked by highlighting them and selecting `Unmark Entity`.

You can also select text and associate it to an entity that has already been defined in the
metadata.
You can also select any other text and mark it up as an entity; either one already defined or a new
one altogether. And when you have marked up the entities you are interested in, you can clear all
the unconfirmed entities by pressing `(x) unconfirmed`.

::: tip

Expand All @@ -97,18 +99,19 @@ If you want to link an entity in the text to an entity that has already been def
## Content markup

In this way, you can go through and markup all of the entities in the text. In the following example
four entities have been marked up as People: Wadhoorja, Dhoodhoo yini, Ngallilea, Pompey.
two entities have been marked up as People: Mallalea and Wadhoorja.

And when we go back to the `Describe` tab we see that the entities are listed in the `mentions`
property against the file. On this tab we can also see some extra files in the file manager on the
left. The original image is `Bates35-005.jpg` and alongside it is `Bates35-005.textract-OCR.json`
and `Bates35-005.transcription.html`. The file named textract OCR contains the textract data and the
html file is the marked up transcription.
property against the file. On this tab we can also see some extra files have been created and
associated:

<ImageComponent src="/images/tutorial-transcribing-content/transcribe10.png"></ImageComponent>
- `Has Ocr Data file` is a reference to the OCR raw data
- `Has Transcription` is a reference to the transcription marked up as a HTML file.

<ImageComponent src="/images/tutorial-transcribing-content/transcribe6.png"></ImageComponent>

If we look at the content of the html file we see that the entity data is marked up as HTML data
attributes. In the following example, the first entity has the class `unconfirmed` whilst the second
does not meaning that the second has been confirmed.

<ImageComponent src="/images/tutorial-transcribing-content/transcribe11.png"></ImageComponent>
<ImageComponent src="/images/tutorial-transcribing-content/transcribe7.png"></ImageComponent>
10 changes: 6 additions & 4 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,13 +165,15 @@ layout: home
interrogate your data using natural language. It's your very own research
assistant.
</p>
<p>
<!-- <p>
Watch the video to see the assistant in action.
</p>
</p> -->
</template>
<template #content>
<video controls class="p-2 border border-slate-400">
<source src="/images/tour/analysis.mp4" type="video/mp4"></video>
<!-- <video controls class="p-2 border border-slate-400">
<source src="/images/tour/analysis.mp4" type="video/mp4">
</video> -->
<ImageComponent src="/images/tutorial-transcribing-content-assistant/assistant1.png" />
</template>
</InfoPanelComponent>
</div>
Expand Down
Binary file modified src/public/images/tour/desktop10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop13.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop14.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop15.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/public/images/tour/desktop9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/public/images/tour/product-tour.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file modified src/public/images/tutorial-transcribing-content/transcribe1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 6 additions & 9 deletions src/tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ aside: false
const cards = [
{
text: `The dashboard. Select a folder of content to describe; load a previously used folder or manage data pack data.
Whether you are describing research data or creating a cultural collection, everything you do will be stored in this folder.
Nothing is locked up inside Describo.`,
Whether you are describing research data, creating a cultural collection or just discovering what your content
is about, everything you do will be stored in this folder. <br/><strong>Nothing is locked up inside Describo.</strong>`,
image: "/images/tour/desktop1.png",
},
{
text: "Get started by pressing the help button to activate context sensitive help. The documentation link in the navigation bar links to context specific documentation.",
image: "/images/tour/desktop2.png",
},
{
text: `When the RO Crate file is loaded the root dataset is shown in the middle pane along with a file browser on the left.
text: `When a folder is selected, the root dataset is shown in the middle pane along with a file browser on the left.
In the navigation bar we can see which folder is loaded as well as controls to load a profile and access application settings.
`,
image: "/images/tour/desktop3.png",
Expand All @@ -35,8 +35,7 @@ const cards = [
image: "/images/tour/desktop5.png",
},
{
text: `Entities can be created directly. 'Spatial Coverage' is expecting an entity of type Place and Describo provides controls
to create a new entity of that type. In this example, we are creating an entity of type Place with the name 'Some Location'.`,
text: `Entities can be created directly. 'Spatial Coverage' is expecting an entity of type Place and Describo provides controls to create a new entity of that type.`,
image: "/images/tour/desktop6.png",
},
{
Expand All @@ -52,7 +51,7 @@ const cards = [
},
{
text: `When using the transcription tools the data is written into the RO-Crate. And the markup is created as data attributes in the HTML.`,
image: [ "/images/tour/desktop9.png", "/images/tour/transcribe11.png" ]
image: [ "/images/tour/desktop9.png", "/images/tour/transcribe1.png" ]
},
{
text: `Describo interfaces with a conversational AI assistant to help you interrogate and understand your content. In this image
Expand All @@ -75,9 +74,7 @@ const cards = [
image: "/images/tour/desktop10.png",
},
{
text: `When a profile is loaded, the view will adapt based on the content of that profile. In this example, the profile defines
a tabbed layout for Dataset entities in addition to showing specific properties. This allows the profile author to define
exactly how the UI should look for their users and guide them on what is required.`,
text: `When a profile is loaded, the view will adapt based on the instructions in that profile. In this example, the profile defines a tabbed layout for Dataset entities in addition to showing specific properties. This allows the profile author to define exactly how the UI should look for their users and guide them on what is required.`,
image: "/images/tour/desktop11.png",
},
{
Expand Down

0 comments on commit 5f306d6

Please sign in to comment.