API Reference

This section provides the full Python API reference for the FLM library.

The API is organized into the following areas:

• FLM Code Parsing — core classes for defining FLM constructs, setting up environments, and compiling FLM text into fragments and documents.

• FLM Rendering — the render context and fragment renderer classes that produce output in specific formats (HTML, text, LaTeX, Markdown).

• FLM “Features” - Extensions — the pluggable feature system and all built-in feature modules.

• Compiled FLM Serialization — serialization and deserialization of compiled FLM fragments.

• Utilities — utility modules (counters, etc.).

• Code for Command-Line Usage Extensions and Workflows — the command-line tool internals (config merging, templates, workflows).

• FLM Recomposing — tools for recomposing parsed FLM nodes back into FLM or LaTeX source code.

See The FLM Python Library for a narrative introduction to using FLM as a Python library.

• FLM Code Parsing
  • FLM Definitions: flm.flmspecinfo
  • FLM Environment: flm.flmenvironment
  • FLM Document: flm.flmdocument
  • FLM Fragment: flm.flmfragment
• FLM Rendering
  • Render Context: flm.flmrendercontext
  • FLM Fragment Renderers flm.fragmentrenderer
• FLM “Features” - Extensions
  • Base feature class
  • Built-in Features
• Compiled FLM Serialization
  • Save/load FLM fragments with flm.flmdump
• Utilities
  • Counter Formatters
• Code for Command-Line Usage Extensions and Workflows
  • Module flm.main.configmerger
  • Module flm.main.template
  • Module flm.main.feature_graphics_collection
  • Module flm.main.workflow
• FLM Recomposing
  • Recompose FLM text: flm.flmrecomposer
• Self-documenting environments