Module: Coradoc::Reference

Defined in:

lib/coradoc/reference.rb,
lib/coradoc/reference/edge.rb,
lib/coradoc/reference/result.rb,
lib/coradoc/reference/address.rb,
lib/coradoc/reference/catalog.rb,
lib/coradoc/reference/resolver.rb,
lib/coradoc/reference/edge/kind.rb,
lib/coradoc/reference/resolution.rb,
lib/coradoc/reference/address/doi.rb,
lib/coradoc/reference/address/url.rb,
lib/coradoc/reference/edge_search.rb,
lib/coradoc/reference/result/base.rb,
lib/coradoc/reference/address/isbn.rb,
lib/coradoc/reference/address/path.rb,
lib/coradoc/reference/edge/options.rb,
lib/coradoc/reference/materializer.rb,
lib/coradoc/reference/presentation.rb,
lib/coradoc/reference/catalog/local.rb,
lib/coradoc/reference/resolver/base.rb,
lib/coradoc/reference/address/anchor.rb,
lib/coradoc/reference/resolver/chain.rb,
lib/coradoc/reference/result/missing.rb,
lib/coradoc/reference/result/resolved.rb,
lib/coradoc/reference/resolver/caching.rb,
lib/coradoc/reference/resolver/catalog.rb,
lib/coradoc/reference/result/ambiguous.rb,
lib/coradoc/reference/catalog/composite.rb,
lib/coradoc/reference/edge/link_options.rb,
lib/coradoc/reference/materializer/base.rb,
lib/coradoc/reference/presentation/base.rb,
lib/coradoc/reference/presentation/page.rb,
lib/coradoc/reference/address/scoped_path.rb,
lib/coradoc/reference/catalog/memory_index.rb,
lib/coradoc/reference/edge/include_options.rb,
lib/coradoc/reference/edge/citation_options.rb,
lib/coradoc/reference/materializer/registry.rb,
lib/coradoc/reference/edge/image_ref_options.rb,
lib/coradoc/reference/edge/navigation_options.rb,
lib/coradoc/reference/materializer/passthrough.rb,
lib/coradoc/reference/presentation/split_pages.rb,
lib/coradoc/reference/edge/footnote_ref_options.rb,
lib/coradoc/reference/presentation/single_document.rb,
lib/coradoc/reference/presentation/custom_hierarchy.rb

Overview

Unified content-graph reference resolution.

Every referenceable thing in a document is a Content node; every reference is a directed Edge with a kind. The four primitives:

Content             — CoreModel::Base with an id (already on Base).
Document            — Content that contains Content (composite).
Reference::Edge     — directed {source Content, target Address, kind}.
Reference::Address  — scheme-aware locator (anchor, path, url, ...).

Same Content graph → N Presentations → M Materializers. The public entry point is Coradoc.resolve_references.

Defined Under Namespace

Modules: Catalog, EdgeSearch, Materializer, Presentation, Resolver, Result Classes: Address, AmbiguousReferenceError, Edge, Error, InvalidCatalogError, MissingReferenceError, Resolution, UnknownKindError