API Reference

The API documentation is still incomplete (sorry!), so you might wish to further inspect the source code directly.

Note

Because of its use of code generated by Transcypt, this library adds custom properties to some built-in JS objects such as Array.

Contents:

• The main ZooDb object
  • ZooDb
    • ZooDb.object_types
    • ZooDb.objects
    • ZooDb.schemas
    • ZooDb.data_dump()
    • ZooDb.install_zoo_loader_handler()
    • ZooDb.load()
    • ZooDb.load_data()
    • ZooDb.schema()
    • ZooDb.validate()
• Loading schemas with SchemaLoader
  • SchemaLoader
    • SchemaLoader.SchemaLoader
• FLM content compiling and rendering
  • The python-transpiled interface
  • FLM environment
    • ZooFLMEnvironment
    • FeatureZooGraphicsCollection
    • ZooFLMResourceInfo
    • is_flm_fragment()
    • zooflm_default_options()
    • RefResolver
    • CitationsProvider
  • Rendering content
    • ZooHtmlFragmentRenderer
    • html_fragmentrenderer_get_style_information()
    • ZooTextFragmentRenderer
    • render_html_standalone()
    • render_text_standalone()
  • Scanning fragments
    • ZooFLMScanner
    • visitor_scan_object()
    • visitor_scan_zoo()
  • Compiling citations
    • CitationCompiler
    • install_csl_flm_output_format()
• Loading data from source files
  • The Loader Handler Class
    • ZooDbDataLoaderHandler
  • Importing YAML Files
    • YamlDbDataLoader
  • Importing FLM Files
    • FlmFilesDbDataLoader
• Database processors
  • Database relations
    • ZooRelation
    • RelationsPopulator
  • High-level FLM content processing
    • ZooFLMProcessor
  • Low-level FLM content object field compilation
    • FLMSimpleContentCompiler
  • Git “last modified” information
    • GetGitLastModifiedDbProcessor
  • Index searchable content
    • SearchableTextFieldset
    • SearchableTextProcessor
    • FLMSearchableDocTextValuesAssembler
  • Base class
    • ZooDbProcessorBase
• Managing bibliographic citations
  • Citation manager
    • CitationDatabaseManager
  • Citation Sources
    • CitationSourceArxiv
    • CitationSourceDoi
    • CitationSourceManual
    • CitationSourceBibliographyFile
  • Citation Source Base Class
    • CitationSourceBase
• Collecting external resources
  • ResourceCollector
    • ResourceCollector.ResourceCollector
  • Resource Retrievers
    • FilesystemResourceRetriever
  • Resource Processors
    • FLMGraphicsResourceProcessor
• General Utilities
  • Object fields and schema inspection
  • Splitting a ‘prefix:label’ string
    • split_prefix_label()
  • HTML Javascript template literals
    • sqzhtml()
• Zoo Standard Setup Tools
  • makeStandardZooDb()
  • Feature helpers
    • use_relations_populator()
    • use_flm_environment()
    • default_target_href_resolver()
    • use_flm_processor()
    • use_gitlastmodified_processor()
    • use_searchable_text_processor()
  • Data loader
    • makeStandardYamlDbDataLoader()