The shows and episodes of feeds as documents for full-text search with dk.simongray.drop-in-search.
The shows and episodes of feeds as documents for full-text search with dk.simongray.drop-in-search.
Other names that a query can give the fields of the documents, e.g. notes:clojure for a word in the description.
Other names that a query can give the fields of the documents, e.g. notes:clojure for a word in the description.
How much a match in each field weighs in a query, e.g. a word in a title counts three times a word in the notes.
How much a match in each field weighs in a query, e.g. a word in a title counts three times a word in the notes.
(feed-document feed)(feed-document feed {:keys [url] :as opts})The search document of the show feed itself, by its guid, with the
:url in opts where the feed was fetched, for a feed without a
podcast:guid.
Its fields are :title, :description, :author, :people and :categories.
The search document of the show `feed` itself, by its guid, with the :url in `opts` where the feed was fetched, for a feed without a podcast:guid. Its fields are :title, :description, :author, :people and :categories.
(feed-documents feed url)The search documents of the show feed, fetched from url, and of each
of its episodes, once each.
The search documents of the show `feed`, fetched from `url`, and of each of its episodes, once each.
(feed-guids index)The guids of the shows whose documents index holds, of the show itself
or of an episode.
The guids of the shows whose documents `index` holds, of the show itself or of an episode.
(index)(index docs)An index of the search documents docs for dk.simongray.drop-in-search,
with boosts and aliases as the defaults of its queries, and the fields
of without-positions indexed without positions, or an empty one to add
to.
An index of the search documents `docs` for dk.simongray.drop-in-search, with boosts and aliases as the defaults of its queries, and the fields of without-positions indexed without positions, or an empty one to add to.
(item-document feed item)(item-document feed item {:keys [url chapters transcript] :as opts})The search document of item in feed, with the opts below.
Its fields are :title, :show, :description, :people, :keywords,
:chapters and :transcript. A result has the title, show, publication
date and duration, and its id names the show and the item, as
feed.guid/episode-id gives it. The URL of the feed is in the document of
the show. The opts are:
The search document of `item` in `feed`, with the `opts` below. Its fields are :title, :show, :description, :people, :keywords, :chapters and :transcript. A result has the title, show, publication date and duration, and its id names the show and the item, as feed.guid/episode-id gives it. The URL of the feed is in the document of the show. The `opts` are: - :url, where the feed was fetched, which a feed without a podcast:guid needs, or it throws - :chapters, the parsed chapters file, instead of the embedded ones - :transcript, the parsed transcript
(located feeds)A function that gives a result of a query of an index of feeds, a map
of feed guid to feed, with its :feed, and for an episode its :item too.
It looks the episodes of a feed up once, so give it once for all the results of a query.
A function that gives a result of a query of an index of `feeds`, a map of feed guid to feed, with its :feed, and for an episode its :item too. It looks the episodes of a feed up once, so give it once for all the results of a query.
(snippet index result q)(snippet index {:keys [id feed item] :as result} q opts)A window of the text of the result of a query q of index around
the words that match, with the opts below, or nil when no field of the
result matches.
The result has its :feed, and for an episode its :item, as located
gives them. The window is a map of the :field that the text is from, the
first of snippet-fields that matches, and its :parts, each a map of
:text, with :match? on the words that match. The opts are those of
dk.simongray.drop-in-search/snippet, e.g. :width.
A window of the text of the `result` of a query `q` of `index` around the words that match, with the `opts` below, or nil when no field of the result matches. The result has its :feed, and for an episode its :item, as located gives them. The window is a map of the :field that the text is from, the first of snippet-fields that matches, and its :parts, each a map of :text, with :match? on the words that match. The `opts` are those of dk.simongray.drop-in-search/snippet, e.g. :width.
The fields whose text a snippet shows, in order, the first that matches: those that a list of results doesn't show already come first.
The fields whose text a snippet shows, in order, the first that matches: those that a list of results doesn't show already come first.
(with-feed index feed url)The index with the documents of the show feed, fetched from url,
and of its episodes, in place of those it held of the show before.
The `index` with the documents of the show `feed`, fetched from `url`, and of its episodes, in place of those it held of the show before.
(without-feed index feed-guid)The index without the documents of the show feed-guid and of its
episodes.
The `index` without the documents of the show `feed-guid` and of its episodes.
The fields that an index holds without the positions of their words: the description, the longest, so that a phrase finds its words anywhere in the notes, and the index takes far less memory.
The fields that an index holds without the positions of their words: the description, the longest, so that a phrase finds its words anywhere in the notes, and the index takes far less memory.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |