Documentation update

This commit is contained in:
Ross Stewart
2025-09-08 12:15:45 +00:00
parent 42bb28337b
commit 7517066c91
6 changed files with 173 additions and 43 deletions

View File

@@ -741,14 +741,6 @@ abbr, acronym {
cursor: help; cursor: help;
} }
.translated {
background-color: rgba(207, 255, 207, 0.2)
}
.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}
/* -- code displays --------------------------------------------------------- */ /* -- code displays --------------------------------------------------------- */
pre { pre {

View File

@@ -513,9 +513,11 @@ const Search = {
// perform the search on the required terms // perform the search on the required terms
searchTerms.forEach((word) => { searchTerms.forEach((word) => {
const files = []; const files = [];
// find documents, if any, containing the query word in their text/title term indices
// use Object.hasOwnProperty to avoid mismatching against prototype properties
const arr = [ const arr = [
{ files: terms[word], score: Scorer.term }, { files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term },
{ files: titleTerms[word], score: Scorer.title }, { files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title },
]; ];
// add support for partial matches // add support for partial matches
if (word.length > 2) { if (word.length > 2) {
@@ -547,8 +549,9 @@ const Search = {
// set score for the word in each file // set score for the word in each file
recordFiles.forEach((file) => { recordFiles.forEach((file) => {
if (!scoreMap.has(file)) scoreMap.set(file, {}); if (!scoreMap.has(file)) scoreMap.set(file, new Map());
scoreMap.get(file)[word] = record.score; const fileScores = scoreMap.get(file);
fileScores.set(word, record.score);
}); });
}); });
@@ -587,7 +590,7 @@ const Search = {
break; break;
// select one (max) score for the file. // select one (max) score for the file.
const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w)));
// add result to the result list // add result to the result list
results.push([ results.push([
docNames[file], docNames[file],

View File

@@ -352,14 +352,22 @@ document.write(`
<h2 id="G">G</h2> <h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_buffer">get_buffer() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_current_queue">get_current_queue() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_current_track">get_current_track() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_history">get_history() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_history_count">get_history_count() (asknavidrome.media_queue.MediaQueue method)</a> <li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_history_count">get_history_count() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_next_track">get_next_track() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_prevous_track">get_prevous_track() (asknavidrome.media_queue.MediaQueue method)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_next_track">get_next_track() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_previous_track">get_previous_track() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_queue_count">get_queue_count() (asknavidrome.media_queue.MediaQueue method)</a> <li><a href="index.html#asknavidrome.media_queue.MediaQueue.get_queue_count">get_queue_count() (asknavidrome.media_queue.MediaQueue method)</a>
</li> </li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.get_song_details">get_song_details() (asknavidrome.subsonic_api.SubsonicConnection method)</a> <li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.get_song_details">get_song_details() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
@@ -421,6 +429,8 @@ document.write(`
<h2 id="S">S</h2> <h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.scrobble">scrobble() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_album">search_album() (asknavidrome.subsonic_api.SubsonicConnection method)</a> <li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_album">search_album() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li> </li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_artist">search_artist() (asknavidrome.subsonic_api.SubsonicConnection method)</a> <li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_artist">search_artist() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
@@ -429,10 +439,12 @@ document.write(`
</li> </li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_song">search_song() (asknavidrome.subsonic_api.SubsonicConnection method)</a> <li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.search_song">search_song() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li> </li>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.shuffle">shuffle() (asknavidrome.media_queue.MediaQueue method)</a> <li><a href="index.html#asknavidrome.media_queue.MediaQueue.set_current_track_offset">set_current_track_offset() (asknavidrome.media_queue.MediaQueue method)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#asknavidrome.media_queue.MediaQueue.shuffle">shuffle() (asknavidrome.media_queue.MediaQueue method)</a>
</li>
<li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.star_entry">star_entry() (asknavidrome.subsonic_api.SubsonicConnection method)</a> <li><a href="index.html#asknavidrome.subsonic_api.SubsonicConnection.star_entry">star_entry() (asknavidrome.subsonic_api.SubsonicConnection method)</a>
</li> </li>
<li><a href="index.html#asknavidrome.controller.start_playback">start_playback() (in module asknavidrome.controller)</a> <li><a href="index.html#asknavidrome.controller.start_playback">start_playback() (in module asknavidrome.controller)</a>

File diff suppressed because one or more lines are too long

Binary file not shown.

File diff suppressed because one or more lines are too long