Skip to content

Commit

Permalink
Merge pull request #192 from cu-mkp/issue185y
Browse files Browse the repository at this point in the history
#185: how to use imgs width to 500
  • Loading branch information
njr2128 authored Dec 17, 2021
2 parents 024d9d5 + 1e256cf commit 2575e60
Showing 1 changed file with 16 additions and 18 deletions.
34 changes: 16 additions & 18 deletions docs/how-to-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ All versions can be accessed by navigating to [Read Fr. 640](/folios).

The manuscript is presented in a dual-pane display, allowing side-by-side viewing of any combination of two versions of the manuscript.

![how-to-use-dualpane](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-dualpane.png)

<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-dualpane.png" alt="how-to-use-dualpane" width="500">

To choose a version, click on the drop-down menu in the upper right corner of each pane.

![howtouse-dualdropdown](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-dualdropdown.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-dualdropdown.png" alt="howtouse-dualdropdown" width="500">


Quick access to the [Glossary](/folios/1r/f/1r/glossary) is a fourth option to be displayed in either pane (more about the Glossary below).
Expand All @@ -39,8 +38,7 @@ Within the pane, the facsimile image can be resized by clicking on the \+ and \-

To return to the thumbnail grid, click on the grid icon <i class="fas fa-th"></i> beneath the resizing icons on the left side of the viewing pane.

![howtouse-expand-bar](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-expand-bar.png)

<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-expand-bar.png" alt="howtouse-expand-bar" width="500">

### Transcriptions and Translations

Expand Down Expand Up @@ -104,15 +102,15 @@ For navigation help, click the <i class="fas fa-question-circle"></i> help icon.

The search returns results in the left pane from the two French transcriptions, the English translation, and the Research Essays.

[howtouse-search-results](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-search-results.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-search-results.png" alt="howtouse-search-results" width="500">

Click the <i class="fas fa-question-circle"></i> icon on the upper right of the search pane for quick tips on searching.

- Results can be sorted by relevance or by folio (i.e., listed sequentially).

- Results can be narrowed by where the results are found (e.g., the translation or the Research Essays).

[howtouse-search-filter](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-search-filter.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-search-filter.png" alt="howtouse-search-filter" width="500">

- Clicking on a result opens the manuscript page that contains the result in the opposite pane.

Expand All @@ -126,7 +124,7 @@ Click the <i class="fas fa-question-circle"></i> icon on the upper right of the

To return to the dual-pane view, click on "exit search" in the upper left corner.

[howtouse-search-exit-search](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-search-exit-search.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-search-exit-search.png" alt="howtouse-search-exit-search" width="500">

To return to the result listing, use the back arrow in your browser, or re-enter the search in the search bar, where the search term is retained.

Expand All @@ -141,23 +139,23 @@ The manuscript consists almost entirely of units of text under titles, which the

The entries can be sorted sequentially as they appear in the manuscript or alphabetically.

![howtouse-listentries](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-listentries.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-listentries.png" alt="howtouse-listentries" width="500">

Each entry has been assigned up to three of 26 broad categories, displayed on the entry card.

Relevant terms in each entry have been encoded with semantic tags.

To see the full list of tagged terms contained in any given entry, click on the upper right drop-down menu arrow.

![howtouse-listentries-select](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-listentries-select.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-listentries-select.png" alt="howtouse-listentries-select" width="500">

To choose the version (transcription, normalized transcription, and English translation) to be displayed, use the drop-down menu within each entry.

![howtouse-listentries-version](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-listentries-version.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-listentries-version.png" alt="howtouse-listentries-version" width="500">

The List of Entries can be filtered by both entry category and semantic tag in the left pane.

![howtouse-listentries-terms](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-listentries-terms.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-listentries-terms.png" alt="howtouse-listentries-terms" width="500">

To filter by semantic tag, click on the desired tags to view only entries that have those tagged terms. This can be further refined by clicking on multiple tag types. For a full list of the tags and their usage, see [Principles of Encoding](/content/resources/principles#principles-of-encoding).

Expand All @@ -172,7 +170,7 @@ A Glossary of distinctive terms in the manuscript can be accessed by selecting "

Use the alphabetical navigation bar to browse the contents.

![howtouse-glossary](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-glossary.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-glossary.png" alt="howtouse-glossary" width="500">

The Glossary has a dedicated filtering search which can be used to navigate by the head-word (the manuscript's original French variant) as well as alternate and modern spellings.

Expand All @@ -197,17 +195,17 @@ The Essays can be accessed directly in two places: 1) within the manuscript page

In the dual-pane display of the manuscript, click on the <i class="fas fa-flask"></i> essay icon to the right of the entry heading to access the essay.

![howtouse-folios-essay](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-folios-essay.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-folios-essay.png" alt="howtouse-folios-essay" width="500">

In the dedicated index, the listing of essays can be viewed as small thumbnails or as cards with the essays' abstracts. Click on "expand" to read longer abstracts.

Click on the small and large grids in the left menu bar to switch between the thumbnail and card views.

![howtouse-essay-grids](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-essay-grids.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-essay-grids.png" alt="howtouse-essay-grids" width="500">

On the cards in the large grid view, hover over the names for author information.

![howtouse-essay-author](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-essay-author.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-essay-author.png" alt="howtouse-essay-author" width="500">

The Research Essays are grouped into categories:

Expand All @@ -223,7 +221,7 @@ The Research Essays are grouped into categories:

To browse the essays by their categories, use the navigation bar on the left.

![howtouse-essays-themes](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-essays-themes.png)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-essays-themes.png" alt="howtouse-essays-themes" width="500">

In any essay, click on the folio numbers contained in the text to view that manuscript page (return by clicking the back arrow in your browser).

Expand Down Expand Up @@ -251,4 +249,4 @@ The respective field notes are also linked in each student Research Essay.

The XML files used as the source for the edition along with other metadata is available in the Github repository <https://github.com/cu-mkp/m-k-manuscript-data>. More information can be found in [About the Digital Development](https://edition640.makingandknowing.org/#/content/about).

![howtouse-fieldnotes](https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-fieldnotes.jpg)
<img src="https://raw.githubusercontent.com/cu-mkp/edition-webpages/master/images/howtouse-fieldnotes.jpg" alt="howtouse-fieldnotes" width="500">

0 comments on commit 2575e60

Please sign in to comment.