Skip to content

Latest commit

 

History

History
182 lines (128 loc) · 4.79 KB

Nemo.api.rst

File metadata and controls

182 lines (128 loc) · 4.79 KB
Raw

Nemo API

flask_nemo.Nemo

Flask related function

flask_nemo.Nemo.init_app

flask_nemo.Nemo.create_blueprint

flask_nemo.Nemo.register_assets

flask_nemo.Nemo.register_plugins

flask_nemo.Nemo.register_filters

Controller

Specific methods

flask_nemo.Nemo.get_inventory

flask_nemo.Nemo.get_collection

flask_nemo.Nemo.get_siblings

flask_nemo.Nemo.get_reffs

flask_nemo.Nemo.get_passage

Customization appliers

flask_nemo.Nemo.chunk

flask_nemo.Nemo.getprevnext

flask_nemo.Nemo.transform

flask_nemo.Nemo.transform_urn

Shared methods

flask_nemo.Nemo.render

flask_nemo.Nemo.view_maker

flask_nemo.Nemo.route

Routes

Statics

Filters

Filters follow a naming convention : they should always start with f_

flask_nemo.filters.f_active_link

flask_nemo.filters.f_collection_i18n

flask_nemo.filters.f_formatting_passage_reference

flask_nemo.filters.f_order_text_edition_translation

flask_nemo.filters.f_i18n_citation_type

flask_nemo.filters.f_is_str

flask_nemo.filters.f_annotation_filter

Helpers

flask_nemo.Nemo.map_urns

flask_nemo.Nemo.filter_urn

flask_nemo.Nemo.in_and_not_in

flask_nemo.Nemo.prevnext_callback_generator

Chunkers

flask_nemo.chunker.default_chunker

flask_nemo.chunker.line_chunker

flask_nemo.chunker.scheme_chunker

flask_nemo.chunker.level_grouper

flask_nemo.chunker.level_chunker

Plugin

flask_nemo.plugin.PluginPrototype.render

Default Plugins

flask_nemo.plugins.default.Breadcrumb

Common

flask_nemo.common.resource_qualifier

Query Interfaces and Annotations

Annotations

flask_nemo.query.annotation.AnnotationResource

flask_nemo.query.annotation.AnnotationResource.read

flask_nemo.query.annotation.AnnotationResource.expand

flask_nemo.query.annotation.Target

flask_nemo.query.annotation.Target.to_json

Query Interfaces

Prototype

flask_nemo.query.proto.QueryPrototype

flask_nemo.query.proto.QueryPrototype.getAnnotations

flask_nemo.query.proto.QueryPrototype.getResource

Simple Query

flask_nemo.query.interface.SimpleQuery

flask_nemo.query.interface.SimpleQuery.process

Resolver and Retrievers

flask_nemo.query.resolve.UnresolvableURIError

flask_nemo.query.resolve.Resolver

flask_nemo.query.resolve.Resolver.resolve

flask_nemo.query.resolve.RetrieverPrototype

flask_nemo.query.resolve.RetrieverPrototype.match

flask_nemo.query.resolve.RetrieverPrototype.read

flask_nemo.query.resolve.HTTPRetriever

flask_nemo.query.resolve.HTTPRetriever.match

flask_nemo.query.resolve.HTTPRetriever.read

flask_nemo.query.resolve.LocalRetriever

flask_nemo.query.resolve.LocalRetriever.match

flask_nemo.query.resolve.LocalRetriever.read

flask_nemo.query.resolve.CTSRetriever

flask_nemo.query.resolve.CTSRetriever.match

flask_nemo.query.resolve.CTSRetriever.read

Plugins

AnnotationApi

flask_nemo.plugins.annotations_api.AnnotationsApiPlugin

flask_nemo.plugins.annotations_api.AnnotationsApiPlugin.r_annotations

flask_nemo.plugins.annotations_api.AnnotationsApiPlugin.r_annotation

flask_nemo.plugins.annotations_api.AnnotationsApiPlugin.r_annotation_body