XML::OPDS::Navigation - Navigation elements for OPDS feeds
The all are read-write
If provided, every uri will have this string prepended, so you can just pass URIs like '/path/to/file' and have them consistently turned to 'http://myserver.org/path/to/file' if you set this to 'http://myserver.org'. See also XML::OPDS prefix method.
prefix
Required. The URI of the resource. If prefix is provided it is prepended on output.
Defaults to subsection. Permitted values: self, start, up, subsection, search.
subsection
self
start
up
search
Additionally:
new and popular will expand to http://opds-spec.org/sort/new and http://opds-spec.org/sort/popular as per spec paragraph 7.4.1.
new
popular
Acquisition Feeds using the "http://opds-spec.org/sort/new" relation SHOULD be ordered with the most recent items first. Acquisition Feeds using the " http://opds-spec.org/sort/popular" relation SHOULD be ordered with the most popular items first.
featured will expand to http://opds-spec.org/featured as per 7.4.2
featured
recommended will expand to http://opds-spec.org/recommended as per 7.4.3
recommended
shelf will expand to http://opds-spec.org/shelf and subscriptions to http://opds-spec.org/subscriptions.
shelf
subscriptions
crawlable will expand to http://opds-spec.org/crawlable.
crawlable
This list is a work in progress and probably incomplete.
Facets are not supported yet (patches welcome). Client support for facets is unclear. https://en.wikipedia.org/wiki/OPDS.
Boolean, default to false. Indicates that the href is a leaf feed with acquisition entries.
href
HTML allowed.
A DateTime object with the time of last update.
The are mostly internals and used by XML::OPDS
Depend if acquisition is true of false.
acquisition
The navigation as XML::Atom::Link object.
Return the id or the URI.
[INTERNAL] Resolve the rel shortcuts.
The navigation as XML::Atom::Entry object.
To install XML::OPDS, copy and paste the appropriate command in to your terminal.
cpanm
cpanm XML::OPDS
CPAN shell
perl -MCPAN -e shell install XML::OPDS
For more information on module installation, please visit the detailed CPAN module installation guide.