Skip to content

Commit b45e2fc

Browse files
committed
Touch ups to API.html as discussed at standup.
1 parent 4108379 commit b45e2fc

2 files changed

Lines changed: 20 additions & 10 deletions

File tree

public/API.html

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -532,11 +532,11 @@ <h3 id="text-search">Text Search</h3>
532532
The Text Search endpoint performs a full-text search across Annotation text content. It searches for exact word matches and tokenizes the search text, finding documents that contain all the search terms anywhere in their text content.
533533
</p>
534534
<p>
535-
The search covers multiple text fields depending on the syntax of objects. In particular it covers the current Web Annotation syntax, IIIF Presentation API 2.1 syntax, and IIIF Presentation API 3.0 syntax. See below for specific details.
535+
The search covers multiple text fields depending on the syntax of objects. In particular it covers the current Web Annotation syntax, IIIF Presentation API 3.0 syntax, and IIIF Presentation API 2.1 syntax<span class="dep" title="When creating new data be IIIF Presentation API 3.0 compliant!">⚠️</span>. See below for specific details.
536536
</p>
537537
<ul>
538-
<li><strong>IIIF 3.0 fields:</strong> <code class="language-plaintext highlighter-rouge">body.value</code>, <code class="language-plaintext highlighter-rouge">bodyValue</code>, and nested structures in <code class="language-plaintext highlighter-rouge">items</code> and <code class="language-plaintext highlighter-rouge">annotations</code></li>
539-
<li><strong>IIIF 2.1 fields:</strong> <code class="language-plaintext highlighter-rouge">resource.chars</code>, <code class="language-plaintext highlighter-rouge">resource.cnt:chars</code>, and nested structures in AnnotationLists, Canvas <code class="language-plaintext highlighter-rouge">otherContent</code>, and Manifest <code class="language-plaintext highlighter-rouge">sequences</code></li>
538+
<li><strong>IIIF Presentation API 3.0 & Web Annotation fields:</strong> Annotation <code class="language-plaintext highlighter-rouge">body.value</code>, Annotation <code class="language-plaintext highlighter-rouge">bodyValue</code>, and nested structures in AnnotationPage <code class="language-plaintext highlighter-rouge">items</code>, Canvas <code class="language-plaintext highlighter-rouge">annotations</code>, and Manifest <code class="language-plaintext highlighter-rouge">items</code>.</li>
539+
<li><strong>IIIF Presentation API 2.1 fields<span class="dep" title="When creating new data be IIIF Presentation API 3.0 compliant!">⚠️</span>:</strong> oa:Annotation <code class="language-plaintext highlighter-rouge">resource.chars</code>, oa:Annotation <code class="language-plaintext highlighter-rouge">resource.cnt:chars</code>, and nested structures in sc:AnnotationList <code class="language-plaintext highlighter-rouge">resources</code>, sc:Canvas <code class="language-plaintext highlighter-rouge">otherContent</code>, and sc:Manifest <code class="language-plaintext highlighter-rouge">sequences</code>.</li>
540540
</ul>
541541
<p>
542542
To allow for more records in the response one can add the URL parameter <code>limit</code> to the search requests. If you expect the search request will have a very large response with many objects, your application should use a paged search by also using the <code>skip</code> URL parameter. You will see an example of this below.
@@ -546,11 +546,11 @@ <h3 id="text-search">Text Search</h3>
546546
Search behavior:
547547
</p>
548548
<ul>
549-
<li>Results will only include Web Annotation, IIIF Presentation API 3.0, and IIIF Presentation API 2.1 resource types that have the text embedded within their structure.</li>
549+
<li>Results will only include Web Annotation, IIIF Presentation API 3.0, and IIIF Presentation API 2.1<span class="dep" title="When creating new data be IIIF Presentation API 3.0 compliant!">⚠️</span> resource types that have the text embedded within their structure.</li>
550550
<li>Searches are case-insensitive</li>
551+
<li>Partial word matches and wildcards are NOT supported in this search</li>
551552
<li>Standard linguistic analysis is applied (stemming, stop words, etc.)</li>
552553
<li>Multi-word searches find documents containing <strong>all</strong> the words (AND logic)</li>
553-
<li>Partial word matches are NOT supported in this search (coming soon)</li>
554554
<li>Results are sorted by relevance score (highest first)</li>
555555
<li>A <code class="language-plaintext highlighter-rouge">__rerum.score</code> property is added to each result indicating match quality</li>
556556
</ul>
@@ -650,11 +650,11 @@ <h3 id="phrase-search">Phrase Search</h3>
650650
The Phrase Search endpoint performs a proximity-based search for multi-word phrases, finding documents where search terms appear near each other in sequence. This is more precise than standard text search for multi-word queries while still being flexible enough to allow for minor variations.
651651
</p>
652652
<p>
653-
The search covers multiple text fields depending on the syntax of objects. In particular it covers the current Web Annotation syntax, IIIF Presentation API 2.1 syntax, and IIIF Presentation API 3.0 syntax. See below for specific details.
653+
The search covers multiple text fields depending on the syntax of objects. In particular it covers the current Web Annotation syntax, IIIF Presentation API 3.0 syntax, and IIIF Presentation API 2.1 syntax<span class="dep" title="When creating new data be IIIF Presentation API 3.0 compliant!">⚠️</span>. See below for specific details.
654654
</p>
655655
<ul>
656-
<li><strong>IIIF 3.0 fields:</strong> <code class="language-plaintext highlighter-rouge">body.value</code>, <code class="language-plaintext highlighter-rouge">bodyValue</code>, and nested structures in <code class="language-plaintext highlighter-rouge">items</code> and <code class="language-plaintext highlighter-rouge">annotations</code></li>
657-
<li><strong>IIIF 2.1 fields:</strong> <code class="language-plaintext highlighter-rouge">resource.chars</code>, <code class="language-plaintext highlighter-rouge">resource.cnt:chars</code>, and nested structures in AnnotationLists, Canvas <code class="language-plaintext highlighter-rouge">otherContent</code>, and Manifest <code class="language-plaintext highlighter-rouge">sequences</code></li>
656+
<li><strong>IIIF Presentation API 3.0 & Web Annotation fields:</strong> Annotation <code class="language-plaintext highlighter-rouge">body.value</code>, Annotation <code class="language-plaintext highlighter-rouge">bodyValue</code>, and nested structures in AnnotationPage <code class="language-plaintext highlighter-rouge">items</code>, Canvas <code class="language-plaintext highlighter-rouge">annotations</code>, and Manifest <code class="language-plaintext highlighter-rouge">items</code>.</li>
657+
<li><strong>IIIF Presentation API 2.1 fields<span class="dep" title="When creating new data be IIIF Presentation API 3.0 compliant!">⚠️</span>:</strong> oa:Annotation <code class="language-plaintext highlighter-rouge">resource.chars</code>, oa:Annotation <code class="language-plaintext highlighter-rouge">resource.cnt:chars</code>, and nested structures in sc:AnnotationList <code class="language-plaintext highlighter-rouge">resources</code>, sc:Canvas <code class="language-plaintext highlighter-rouge">otherContent</code>, and sc:Manifest <code class="language-plaintext highlighter-rouge">sequences</code>.</li>
658658
</ul>
659659
<p>
660660
To allow for more records in the response one can add the URL parameter <code>limit</code> to the search requests. If you expect the search request will have a very large response with many objects, your application should use a paged search by also using the <code>skip</code> URL parameter. You will see an example of this below.
@@ -664,8 +664,9 @@ <h3 id="phrase-search">Phrase Search</h3>
664664
Search behavior:
665665
</p>
666666
<ul>
667-
<li>Results will only include Web Annotation, IIIF Presentation API 3.0, and IIIF Presentation API 2.1 resource types that have the text embedded within their structure.</li>
667+
<li>Results will only include Web Annotation, IIIF Presentation API 3.0, and IIIF Presentation API 2.1<span class="dep" title="When creating new data be IIIF Presentation API 3.0 compliant!">⚠️</span> resource types that have the text embedded within their structure.</li>
668668
<li>Searches are case-insensitive</li>
669+
<li>Partial word matches and wildcards are NOT supported in this search</li>
669670
<li>Uses a "slop" value (default: 2) that allows intervening words between search terms (up to the default or provided value). You may supply your own <code class="language-plaintext highlighter-rouge">slop</code> option.</li>
670671
<li>Words don't need to be directly adjacent, providing flexibility while maintaining phrase coherence</li>
671672
<li>More precise than standard text search for multi-word queries</li>

public/stylesheets/api.css

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6521,7 +6521,16 @@ pre {
65216521

65226522
code span{
65236523
display: block;
6524-
position relaitve;
6524+
position: relative;
6525+
}
6526+
6527+
span.dep {
6528+
position: relative;
6529+
display: inline-block;
6530+
font-size: 10pt;
6531+
top: -10px;
6532+
cursor: help;
6533+
user-select: none;
65256534
}
65266535

65276536
span.ind1{

0 commit comments

Comments
 (0)