API Reference

Some parts of the API documentation may still be incomplete; you can always inspect the source code directly for full details.

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.load_schemas()
    • ZooDb.schema()
    • ZooDb.update_objects()
    • ZooDb.validate()
• Loading schemas with SchemaLoader
  • SchemaLoader
    • SchemaLoader.SchemaLoader
    • SchemaLoader.load_schema_by_name()
    • SchemaLoader.load_schemas()
• FLM content compiling and rendering
  • The python-transpiled interface
  • Overview of FLM-related definitions
  • FLM environment
    • ZooFLMEnvironment
    • FeatureZooGraphicsCollection
    • ZooFLMResourceInfo
    • is_flm_fragment()
    • zooflm_default_environment_options()
    • RefResolver
    • CitationsProvider
  • Rendering content
    • ZooHtmlFragmentRenderer
    • html_fragmentrenderer_get_style_information()
    • ZooTextFragmentRenderer
    • render_html_standalone()
    • render_text_standalone()
    • make_render_shorthands()
    • render_value()
    • value_not_empty()
    • make_and_render_document()
  • 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
  • Computed object properties
    • ComputedDataProcessor
  • 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
    • ResourceCollector.collect()
    • ResourceCollector.finish()
    • ResourceCollector.get_resource_data()
  • Resource Retrievers
    • FilesystemResourceRetriever
  • Resource Processors
    • FLMGraphicsResourceProcessor
• General Utilities
  • Object fields and schema inspection
    • get_field_schema()
    • iterfield()
    • getfield()
    • setfield()
    • concatlistfield()
    • iter_object_fields_recursive()
    • iter_schema_fields_recursive()
    • copy_object_structure()
  • Miscellaneous utilities
    • promisify()
    • promisifyMethods()
    • timeout()
    • escapeRegExp()
    • url_has_protocol()
    • path_or_url_to_url()
    • makeLexicographicCompareFn()
  • 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()