tutorial.html

<?xml version="1.0" encoding="UTF-8"?>
<div xmlns="http://www.w3.org/1999/xhtml" data-template="templates:surround" data-template-with="templates/page.html" data-template-at="content">
    
    <div data-template="app:logging"/>
    <div class="col-md-12">
        <h2>How to use and contribute to the Lexicon Linguae Aethiopicae</h2>
        <div class="col-md-12 tutorial" id="toc">
            <p>If you are looking for technical specification, this can be <a href="/Dillmann/about.html">found here</a>
            </p>
            <ul>

                <li>
                    <a class="page-scroll" href="#login">Getting started</a>
                </li>
                <li>
                    <a class="page-scroll" href="#search">Search</a>
                </li>
                <li>
                    <a class="page-scroll" href="#actions">Actions</a>
                </li>
                <li>
                    <a class="page-scroll" href="#browse">Browsing</a>
                </li>
            </ul>
        </div>
      
        <h3 id="search">Getting started with the search</h3>
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <p>This little form is where you primarily access the data in this digital edition
                    of the Lexicon linguae Aethiopicae. We will go through most of the options
                    available to you.</p>
                <p>The search is run once you click on the search icon <i class="fa fa-search" aria-hidden="true"/>.</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/37thesearch.png" width="100%"/>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6">
                <img src="resources/images/tutorial/2searchhelp.png" width="100%"/>
            </div>
            <div class="col-md-6  alert alert-success">
                <p>Click the info icon <i class="fa fa-info-circle" aria-hidden="true"/> by the
                    search input field. This will display a small window where you can find a lot of
                    useful information on how to do your search.</p>
                <h4>Search</h4>
                <p>This app is built with exist-db, and uses Lucene as the standard search engine.
                    This comes with several options available. A full list is <a href="https://lucene.apache.org/core/2_9_4/queryparsersyntax.html#Fuzzy Searches" target="_blank">here</a>
                </p>
                <p>Below very few examples.</p>
                <table class="table table-hover table-responsive">
                    <thead>
                        <tr>
                            <th/>
                            <th>sample</th>
                            <th>result</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr>
                            <td>*</td>
                            <td>*custodir*</td>
                            <td>Add wildcards to search for anything that comes before or after the string that you have entered.</td>
                        </tr>
                        <tr>
                            <td>?</td>
                            <td>custodir?</td>
                            <td>Will find any match for the position with the question mark.</td>
                        </tr>
                        <tr>
                            <td>~</td>
                            <td>ܐܰܘܓܺܝ~</td>
                            <td>Will make a fuzzy search.</td>
                        </tr>
                        <tr>
                            <td>""</td>
                            <td>"ምሕረትከ፡ ይትኖለወኒ፡"</td>
                            <td>Will find the exact string contained between quotes.</td>
                        </tr>
                        <tr>
                            <td>()</td>
                            <td>(verbo OR notionem) AND ܐܰܘܓܺܝ</td>
                            <td>Will find one of the two between brackets and the other string.</td>
                        </tr>
                    </tbody>
                </table>
            </div>
        </div>
        <div class="col-md-12 tutorial"/>
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <p>You can access the keyboard using the keyboard button beside the input. <i class="fa fa-keyboard-o" aria-hidden="true"/>
                </p>
                <h4>Input</h4>
                <p>If you want to transcribe some Fidal into Latin or update your transcription, you
                    can <a target="_blank" href="https://betamasaheft.github.io/transliteration/">have a go with our transcription tools</a>.</p>
                <p>If you are using the keyboard provided, please note that there are four layers,
                    the normal one and those activated by Shift, Alt, Alt+Shift.</p>
                <p>Normal and Shift contain mainly Fidal. Alt and Alt-Shift diacritics.</p>
                <p>To enter letters in Fidal and the diacritics with this keyboard, which is
                    independent of your local input selection, you can use two methods.</p>
                <h4>Keys Combinations</h4>
                <p>With this method you use keys combinations to trigger specific characters. <a target="_blank" href="/Dillmann/combos.html">Click here for a list of the
                        available combos.</a> This can be expanded<a target="_blank" href="https://github.com/Betamasaheft/Documentation/issues/new?labels=keyboard&amp;assignee=PietroLiuzzo&amp;body=Please%20add%20a%20combo%20in%20the%20input%20keyboard">, do not hesitate to ask (click here to post a new issue).</a>
                </p>
                <h4>Hold and choose</h4>
                <p>If you hold a key optional values will appear in a list. You can click on the
                    desired value or use arrows and enter to select it. The options are the same as
                    those activated by combinations.</p>
                <p>With this method you do not have to remember or lookup combos, but it does take
                    many more clicks...</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/3keyboard.png" width="100%"/>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6">
                <img src="resources/images/tutorial/4advancedsearch.png" width="100%"/>
            </div>
            <div class="col-md-6  alert alert-success">
                <h4>Advanced options</h4>
                <p>Click on the plus button <i class="fa fa-plus" aria-hidden="true"/> to get more
                    filters.</p>
                <p>You do not have to use all the parameters, set only those you are
                    interested in. You can also search for entries which don't contain a certain
                    information, using the corresponding switch . If this option is active you will
                    be selecting the ones you want to exclude instead of those you want to have.
                    Some examples:</p>
                <ul>
                    <li>Selecting <em>masculinus</em> will return you all the lemmas which do
                        contain that. Selecting <em>femininus</em> and checking not will return you
                        all the lemmas which do not have that (so also verbs, for examples, adverbs,
                        etc.). If you want all the terms which do not contain text in Greek switch
                        not and tick Greek. </li>
                    <li>If you want all the entries which contain text in Syriac or in Coptic tick
                        Syriac and Coptic, which does not mean that you will not get entries which
                        have the other values as well as the ones you picked.</li>
                </ul>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <h4>Modes</h4>
                <p>If you are searching a string, you might want to try one of the search modes.
                    Default method does not use any of those but uses the orthographic variants,
                    whereas if you do choose a mode, the variants will not be taken into
                    consideration and you will search only what you typed.</p>
                <h4>Search only in citations</h4>
                <p>Ticking this option will search only into <pre>ref</pre> elements in the TEI,
                    i.e. you are searching for citations of let's say Exodus. You tick this and
                    search "Ex." and you will get all places where this citation has been correctly
                    marked. There might be more because most of them have been tagged automatically
                    and there are known cases of mismatch or not matched.</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/5modes.png" width="100%"/>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6">
                <img src="resources/images/tutorial/6DillmannColumn.png" width="100%"/>
            </div>
            <div class="col-md-6  alert alert-success">
                <h4>Go to first entry in Dillmann Column #</h4>
                <p>Use this to select the number of the column in the Dillmann Lexicon you wish to
                    navigate to. It does not make a lot of sense to use this if you are searching a
                    string.</p>
                <p>The search will simply bring you to the lemma which contains the column break you
                    asked for.</p>
                <p>At the top of the lemma you will always have a link to the PDF on Ran HaCohen's
                    website if you still wish to check on the source.</p>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <h4>Home page search results</h4>
                <p>You might use this as a one page website. Results are shown directly below the
                    search. Then you can click the lemma name and see it in full in the left
                    pane.</p>
                <p>Results will be paginated by 20.</p>
                <p>If you are logged in you will also have for each of them the update button.</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/7homepagesearchresults.png" width="100%"/>
            </div>
        </div>
        <h3 id="actions">Available actions</h3>
        
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <p>If you search a string in Gǝʿǝz and then click on one of the results, the entry
                    will be displayed in full on the right pane.</p>
                <p> You will see strings of
                    Gǝʿǝz text where the exact string you searched occurs highlighted.</p>
                <p> You
                    can turn off this function with the switch at the top.</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/11highlightmatches.png" width="100%"/>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6">
                <img src="resources/images/tutorial/12revisions.png" width="100%"/>
            </div>
            <div class="col-md-6  alert alert-success">
                <p>Clicking on revisions will show you all modifications occurred to the data since
                    it was transformed in XML TEI.</p>
                <p>You can also download the current TEI-XML file or get a rendered PDF clicking on
                    the respective buttons.</p>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <p>If you click on the lemma you will be brought to a page displaying that lemma
                    only. This might be useful especially for long entries.</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/13lemmaView.png" width="100%"/>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6">
                <img src="resources/images/tutorial/24linkstolatin.png" width="100%"/>
            </div>
            <div class="col-md-6  alert alert-success">
                <p>Any Latin word, translations or explanation by August Dillmann, is linked to the
                    Perseus Latin Word Study Tool, where you can get an English translation of the
                    Latin.</p>
                <p>Any Greek word is linked to the Perseus Greek Word Study Tool, where you can get
                    an English translation of the Greek.</p>
                <p>Any Gǝʿǝz word is linked to a search in Beta Maṣāḥǝft.</p>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <p>This is how the page of the Perseus Latin Word Study Tool you will land to looks
                    like.</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/25latinword.png" width="100%"/>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6">
                <img src="resources/images/tutorial/18textfromcitation.png" width="100%"/>
            </div>
            <div class="col-md-6  alert alert-success">
                <p>Provided we have a record for a cited text in Beta Maṣāḥǝft; and provided we have
                    a text for it, which is quite rare, except for the text generously shared with
                    us from Ran HaCohen; and provided that the citation is correct and canonical,
                    you will see a small icon like this <i class="fa fa-file-text-o" aria-hidden="true"/> beside the citation. Double clicking on it will popup a
                    link to the full text on Beta Maṣāḥǝft, and if available the exact passage
                    cited.</p>
                <p>It is likely that if the passage in question uses the lemma and exactly that you
                    will also see it in the attestations. This function however is only dependent on
                    the citation, so if the structure of the text is correct it will give you the
                    cited text regardless of its content.</p>
                <p>This means, that the more texts we have, the better. If you would like to
                    contribute any text transcription or manuscript transcription you have, we would
                    very much welcome that kind of contribution to Beta Maṣāḥǝft. Please <a href="mailto:pietro.liuzzo@uni-hamburg.de">email Pietro</a>.</p>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <p>Every time you visualize a lemma we will run a search for the main lemma entry
                    (and only that) in the Beta Maṣāḥǝft corpus, including all records, i.e. also
                    manuscript transcriptions, additions, etc.</p>
                <p>You will see the Keyword in Context result and a link to the Beta Maṣāḥǝft
                    record. If you have rights to access Beta Maṣāḥǝft, then you can go to that page
                    and the text where the word occurs will be highlighted.</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/38attestations.png" width="100%"/>
            </div>
        </div>
        <h3 id="browse">Browsing the data</h3>
        <p>There are a series of other resources to help you navigate the data.</p>
        <div class="col-md-12 tutorial">
            <div class="col-md-6">
                <img src="resources/images/tutorial/14about.png" width="100%"/>
            </div>
            <div class="col-md-6  alert alert-success">
                <p>In the About section you will find </p>
                <ul>
                    <li>Information about the app, the partners, the functionalities.</li>
                    <li>a link to a digitized version of the Prolegomena by August Dillmann for the
                        1865 edition.</li>
                </ul>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <p>Clicking on browse will return you a list of all the lemmas letter by letter,
                    which you can expand. It will not have the full entry.</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/15browse.png" width="100%"/>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6">
                <img src="resources/images/tutorial/16reverse.png" width="100%"/>
            </div>
            <div class="col-md-6  alert alert-success">
                <p>If you are looking for a word in Greek or in translation you might find the reverse
                    index useful. By default the reverse index shows the translations, but you can
                    click on "non Latin terms" and then select the language you would like to
                    see.</p>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6  alert alert-success">
                <p>In this example I have clicked on "non Latin terms" and then selected Coptic.</p>
            </div>
            <div class="col-md-6">
                <img src="resources/images/tutorial/39reversecoptic.png" width="100%"/>
            </div>
        </div>
        <div class="col-md-12 tutorial">
            <div class="col-md-6">
                <img src="resources/images/tutorial/17abbreviations.png" width="100%"/>
            </div>
            <div class="col-md-6  alert alert-success">
                <p>The abbreviations menu will take you to a list of abbreviations used in Dillmann.
                    You can click the abbreviation to run a search for text containing that (if they
                    have been correctly marked up).</p>
            </div>
        </div>
      
        
    </div>
</div>