Welcome to ZooDb’s documentation!

ZooDb is a simple library I wrote to build technical “zoos”: A collection of ideas or concepts, mapped out and organized to bring out their structure and relations.

This library forms the core of the Error Correction Zoo. I might use it to build other zoos in the future. Feel free to use it to build your own zoo, too!

Github repository: phfaist/zoodb.

Contents:

• Overview of ZooDb
  • Features
  • An example
  • Why Javascript?
  • Next steps
• The Zoo’s Data Files
  • Collections of YAML files
  • Collections of JSON files
  • Collections of FLM files
• Object schemas
  • Data types and values validation
  • Primary key field
  • Autopopulated fields
  • FLM content strings
  • Relationships to other objects
  • Additional annotations intended for editors
• Flexible Latex-Like Markup (FLM)
  • How to enable FLM?
  • FLM Example
  • FLM Available Features
• Integration into the Eleventy website builder
  • Loading the zoo as global data
  • Writing page templates
  • Rendering full object pages
  • Relevant API reference
• Setting up a “Standard” ZooDb
• API Reference
  • The main ZooDb object
  • Loading schemas with SchemaLoader
  • FLM content compiling and rendering
  • Loading data from source files
  • Database processors
  • Managing bibliographic citations
  • Collecting external resources
  • General Utilities
  • Zoo Standard Setup Tools

Indices and tables

• Index

• Search Page