Gitiles
Code Review Sign In
korap.ids-mannheim.de / KorAP / Kalamar / fcadda63cb91a5dbff1b1268417d0aff944ac21f / . / dev / demo / tutorial.html
blob: 70e76aead8b8a71746bcd7d039115ae2178a9d46 [file] [log] [blame]
Nils Diewald0e6992a2015-04-14 20:13:52 +0000[diff] [blame]1<!DOCTYPE html>
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]2<html>
3 <head>
4 <title>Tutorial demo</title>
Nils Diewaldce328112015-04-08 22:48:18 +0000[diff] [blame]5 <link type="text/css" rel="stylesheet" href="../css/kalamar.css" />
Nils Diewaldfccfbcb2015-04-29 20:48:19 +0000[diff] [blame]6 <script data-main="alldemo.js" src="../js/lib/require.js" async="async"></script>
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]7 </head>
8 <body class="embedded">
Nils Diewald7c8ced22015-04-15 19:21:00 +0000[diff] [blame]9 <aside tabindex="0" class="active">
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]10 <div>
11<!-- Not embedded:
12 <h2>Tutorial</h2>
13-->
14 <nav>
15 <ul>
Marc Kupietzfcadda62021-09-08 09:06:25 +0200[diff] [blame^]16 <li><a href="/doc/development" class="active">KorAP</a>
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]17 <ul>
Nils Diewald0e6992a2015-04-14 20:13:52 +0000[diff] [blame]18 <!-- Versionsnummer -->
19 <li><a href="/doc/kalamar">Kalamar</a></li>
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]20 <li><a href="/doc/kustvakt">Kustvakt</a></li>
Nils Diewald0e6992a2015-04-14 20:13:52 +0000[diff] [blame]21 <li><a href="/doc/koral">Koral</a></li>
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]22 <li><a href="/doc/krill">Krill</a></li>
Nils Diewald0e6992a2015-04-14 20:13:52 +0000[diff] [blame]23 <li><a href="/doc/karang">Karang</a></li>
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]24 </ul>
25 </li>
26 <li><a href="/doc/ql">Query Languages</a>
27 <ul>
28 <li><a href="/doc/ql/cosmas-2">Cosmas II</a></li>
29 <li><a href="/doc/ql/poliqarp-plus">Poliqarp+</a></li>
30 <li><a href="/doc/ql/annis">Annis QL</a></li>
31 <li><a href="/doc/ql/cql">CQL</a></li>
32 <li><a href="/doc/ql/regexp">RegExp</a></li>
33 </ul>
34 </li>
35 <li><a href="/doc/data">Data</a>
36 <ul>
37 <li><a href="/doc/data/corpus">Corpora</a>
38 <ul>
39 <li><a href="/doc/data/corpus/dereko">DeReKo</a></li>
40 </ul>
41 </li>
42 <li><a href="/doc/data/annotation">Annotations</a>
43 <ul>
44 <li><a href="/doc/data/annotation/connexor">Connexor</a></li>
45 <li><a href="/doc/data/annotation/mate">Mate</a></li>
46 <li><a href="/doc/data/annotation/treetagger">TreeTagger</a></li>
47 </ul>
48 </li>
49 </ul>
50 </li>
51 <li><a href="/doc/api">API</a>
52<!--
53 <ul>
54 <li><a href="/doc/api/koralquery">KoralQuery</a></li>
55 <li><a href="/doc/api/search">Search API</a></li>
56 <li><a href="/doc/api/match">Match Information API</a></li>
57 <li><a href="/doc/api/user">User API</a></li>
58 </ul>
59-->
60 </li>
Nils Diewald7c8ced22015-04-15 19:21:00 +0000[diff] [blame]61 <li><a href="/doc/faq">FAQ (mit Mail)</a>
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]62 </ul>
63 </nav>
64 </div>
Nils Diewald7c8ced22015-04-15 19:21:00 +0000[diff] [blame]65 </aside>
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]66 <main class="tutorial">
Nils Diewald0e6992a2015-04-14 20:13:52 +0000[diff] [blame]67 <h2>KorAP</h2>
68
69 <object data="../img/korap-overview.svg#korap"
70 type="image/svg+xml"
71 alt="KorAP-Overview"
72 id="overview"></object>
73
Nils Diewalda944fab2015-04-08 21:02:04 +0000[diff] [blame]74 <section id="tut-intro">
75 <h3>Frontend Features</h3>
76 <p>This frontend ...</p>
77 </section>
78
79 <section id="tut-examples">
80 <h3>Example Queries</h3>
81 <p><strong>Poliqarp</strong>: Find all occurrences of the lemma &quot;baum&quot; as annotated by the <a href="#">default foundry</a>.</p>
82 <pre class="query tutorial" data-query="[base=Baum]" data-query-language="poliqarp"><code>[base=Baum]</code></pre>
83 </section>
84
85 <section id="tut-caveats">
86 <h3>Caveats</h3>
87 <p>Memcheck is not perfect; it occasionally produces false positives, and there are mechanisms for suppressing these (see Suppressing errors in the Valgrind User Manual). However, it is typically right 99% of the time, so you should be wary of ignoring its error messages. After all, you wouldn’t ignore warning messages produced by a compiler, right?</p>
88 <p>The suppression mechanism is also useful if Memcheck is reporting errors in library code that you cannot change. The default suppression set hides a lot of these, but you may come across more. Memcheck cannot detect every memory error your program has. For example, it can’t detect out-of-range reads or writes to arrays that are allocated statically or on the stack. But it should detect many errors that could crash your program (eg. cause a segmentation fault).</p>
89 <p>Try to make your program so clean that Memcheck reports no errors. Once you achieve this state, it is much easier to see when changes to the program cause Memcheck to report new errors. Experience from several years of Memcheck use shows that it is possible to make even huge programs run Memcheck-clean. For example, large parts of KDE, OpenOffice.org and Firefox are Memcheck-clean, or very close to it.</p>
90 </section>
91 <section id="tut-more-information">
92 <h3>More information</h3>
93 <p>Please consult the Valgrind FAQ and the Valgrind User Manual, which have much more information. Note that the other tools in the Valgrind distribution can be invoked with the <code>--tool</code> option.</p>
94 </section>
95 <section id="tut-overview">
96 <h3>An Overview of Valgrind</h3>
97 <p>Valgrind is an instrumentation framework for building dynamic analysis tools. It comes with a set of tools each of which performs some kind of debugging, profiling, or similar task that helps you improve your programs. Valgrind’s architecture is modular, so new tools can be created easily and without disturbing the existing structure.</p>
98 <p>A number of useful tools are supplied as standard.</p>
99 <ol>
100 <li><strong>Memcheck</strong> is a memory error detector. It helps you make your programs, particularly those written in C and C++, more correct.</li>
101 <li><strong>Cachegrind</strong> is a cache and branch-prediction profiler. It helps you make your programs run faster.</li>
102 <li><strong>Callgrind</strong> is a call-graph generating cache profiler. It has some overlap with Cachegrind, but also gathers some information that Cachegrind does not.</li>
103 <li><strong>Helgrind</strong> is a thread error detector. It helps you make your multi-threaded programs more correct.</li>
104 <li><strong>DRD</strong> is also a thread error detector. It is similar to Helgrind but uses different analysis techniques and so may find different problems.</li>
105 <li><strong>Massif</strong> is a heap profiler. It helps you make your programs use less memory.</li>
106 <li><strong>DHAT</strong> is a different kind of heap profiler. It helps you understand issues of block lifetimes, block utilisation, and layout inefficiencies.</li>
107 <li><strong>SGcheck</strong> is an experimental tool that can detect overruns of stack and global arrays. Its functionality is complementary to that of Memcheck: SGcheck finds problems that Memcheck can’t, and vice versa.</li>
108 <li><strong>BBV</strong> is an experimental SimPoint basic block vector generator. It is useful to people doing computer architecture research and development.</li>
109 </ol>
110 <p>There are also a couple of minor tools that aren’t useful to most users: Lackey is an example tool that illustrates some instrumentation basics; and Nulgrind is the minimal Valgrind tool that does no analysis or instrumentation, and is only useful for testing purposes. Valgrind is closely tied to details of the CPU and operating system, and to a lesser extent, the compiler and basic C libraries. Nonetheless, it supports a number of widely-used platforms, listed in full at <a href="http://www.valgrind.org/">valgrind.org</a>.</p>
111 <p>Valgrind is built via the standard Unix ./configure, make, make install process; full details are given in the README file in the distribution.</p>
112 </section>
113 </main>
114 </body>
115</html>