Liking cljdoc? Tell your friends :D

dk.simongray.podcast.feed.spec

The vocabulary of the library as data: every element that it understands.

Each entry of elements describes one XML element: what the model calls it, where it can appear, how often, and the types of its attributes and text. The keys of an entry are:

  • :tag, the XML name, namespaced by alias, e.g. :podcast/transcript or :title
  • :key, the key in the model, or a map from parent to key when the element has another name under another parent
  • :parent, where it can appear: :channel, :item, which covers podcast:liveItem too, or the tag of its parent element
  • :count, :one or :many, or a map from parent to either
  • :attrs, the specified attributes by XML name, each with an optional :type from dk.simongray.podcast.feed.coerce/types, :required, and :values for an :enum, or the media types that a :mime takes
  • :content, the type of the node text, :none when the element has none, or :presence for an empty element that's true when it's there
  • :values, the allowed values of the node text of an enumeration
  • :deprecated, true, or the tag that replaces it
  • :children-as, the context to look up the children of the element in, when it borrows those of another element, as liveItem does with item
  • :doc, one line from the specification
The vocabulary of the library as data: every element that it
understands.

Each entry of elements describes one XML element: what the model calls it,
where it can appear, how often, and the types of its attributes and
text. The keys of an entry are:

- :tag, the XML name, namespaced by alias, e.g. :podcast/transcript or
  :title
- :key, the key in the model, or a map from parent to key when the
  element has another name under another parent
- :parent, where it can appear: :channel, :item, which covers
  podcast:liveItem too, or the tag of its parent element
- :count, :one or :many, or a map from parent to either
- :attrs, the specified attributes by XML name, each with an optional
  :type from dk.simongray.podcast.feed.coerce/types, :required, and
  :values for an :enum, or the media types that a :mime takes
- :content, the type of the node text, :none when the element has none,
  or :presence for an empty element that's true when it's there
- :values, the allowed values of the node text of an enumeration
- :deprecated, true, or the tag that replaces it
- :children-as, the context to look up the children of the element in,
  when it borrows those of another element, as liveItem does with item
- :doc, one line from the specification
raw docstring

categoriesclj/s

The categories of Apple Podcasts that itunes:category names, each with its subcategories.

The categories of Apple Podcasts that itunes:category names, each with
its subcategories.
sourceraw docstring

children-contextclj/s

(children-context entry)

The parent context that the children of entry are looked up in: its tag, unless the entry borrows the children of another element, as liveItem does.

The parent context that the children of `entry` are looked up in: its
tag, unless the entry borrows the children of another element, as
liveItem does.
sourceraw docstring

container?clj/s

(container? registry entry)

Whether entry has child entries of its own in registry, so that elements inside it are expected.

Whether `entry` has child entries of its own in `registry`, so that
elements inside it are expected.
sourceraw docstring

content-typeclj/s

(content-type entry)

The value type of the node text of entry, or :text when none is given.

The value type of the node text of `entry`, or :text when none is
given.
sourceraw docstring

count-forclj/s

(count-for entry parent)

The cardinality of entry under parent: :one or :many.

The cardinality of `entry` under `parent`: :one or :many.
sourceraw docstring

defaultclj/s

The registry of elements, used unless the options give another.

The registry of elements, used unless the options give another.
sourceraw docstring

elementsclj/s

Every element that the library understands, in the order that a feed is written in.

Every element that the library understands, in the order that a feed is
written in.
sourceraw docstring

entries-forclj/s

(entries-for registry parent)

The entries of registry that can appear right under parent, in the order of emit.

The entries of `registry` that can appear right under `parent`, in the
order of emit.
sourceraw docstring

entry-by-keyclj/s

(entry-by-key registry parent k)

The entry of registry whose model key under parent is k, or nil.

The entry of `registry` whose model key under `parent` is `k`, or nil.
sourceraw docstring

entry-forclj/s

(entry-for registry tag parent)

The entry of registry for tag under parent, or nil when none applies.

The entry of `registry` for `tag` under `parent`, or nil when none
applies.
sourceraw docstring

key-forclj/s

(key-for entry parent)

The model key of entry under parent.

The model key of `entry` under `parent`.
sourceraw docstring

map-shaped?clj/s

(map-shaped? registry entry)

Whether the value of entry in registry is a map, since it has attributes or child entries, rather than its coerced text alone.

Whether the value of `entry` in `registry` is a map, since it has
attributes or child entries, rather than its coerced text alone.
sourceraw docstring

mediumsclj/s

The values of podcast:medium, without the list variants.

The values of podcast:medium, without the list variants.
sourceraw docstring

namespacesclj/s

The canonical namespace URI of each alias that the elements use.

The canonical namespace URI of each alias that the elements use.
sourceraw docstring

registryclj/s

(registry entries)

The tag entries indexed, for the :registry of the options that take one.

The index is a map of :entries, :by-tag, :by-parent and :containers, and a registry that's already indexed comes back as it is. Every entry needs a :tag, a :key, a set of :parent and a :count, or this throws. An app extends the vocabulary of the library by indexing elements with its own entries:

(registry (conj elements {:tag :acme/rating :key :acme/rating
                          :parent #{:channel} :count :one}))
The tag `entries` indexed, for the :registry of the options that take
one.

The index is a map of :entries, :by-tag, :by-parent and :containers, and
a registry that's already indexed comes back as it is. Every entry needs
a :tag, a :key, a set of :parent and a :count, or this throws. An app
extends the vocabulary of the library by indexing elements with its own
entries:

    (registry (conj elements {:tag :acme/rating :key :acme/rating
                              :parent #{:channel} :count :one}))
sourceraw docstring

renamed-categoriesclj/s

The categories of Apple Podcasts before August 2019 that it renamed or dropped, each as a path of a category and perhaps a subcategory, with the path that stands for it now.

A subcategory of a renamed category that has the same name under the new one, e.g. Video Games of Games & Hobbies, needs no entry.

The categories of Apple Podcasts before August 2019 that it renamed or
dropped, each as a path of a category and perhaps a subcategory, with
the path that stands for it now.

A subcategory of a renamed category that has the same name under the new
one, e.g. Video Games of Games & Hobbies, needs no entry.
sourceraw docstring

rolesclj/s

Every role of the Podcast Taxonomy Project.

Every role of the Podcast Taxonomy Project.
sourceraw docstring

taxonomyclj/s

The groups of the Podcast Taxonomy Project and the roles in each, in lower case, which podcast:person draws from.

The groups of the Podcast Taxonomy Project and the roles in each, in
lower case, which podcast:person draws from.
sourceraw docstring

transcript-typesclj/s

The MIME types that the transcript specification names, and the variants in use.

The MIME types that the transcript specification names, and the
variants in use.
sourceraw docstring

uri->aliasclj/s

The alias of each namespace URI that a feed can use. The podcast namespace specification requires its old GitHub URI to be treated as identical to the canonical one.

The alias of each namespace URI that a feed can use. The podcast
namespace specification requires its old GitHub URI to be treated as
identical to the canonical one.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close