Djerba documentation

• Introduction
  • About Djerba
  • Further Reading
• Mini-Djerba
  • Introduction
  • Usage
    • Render initial PDF
    • Generate config file
    • Edit config file
    • Update to produce a new PDF
    • Additional options
  • Troubleshooting
  • The Mini-Djerba config file
    • MDC example
    • MDC Format Specification: Version 2.0
    • MDC Version History
  • The JSON input file
  • For Developers
    • Build instructions
    • Technical notes
• Getting started
  • Welcome to Djerba!
  • Requirements
  • Installation
    • Example installation in a virtual environment
  • Djerba scripts
  • Running the demo plugins
    • Command-line output
    • HTML and PDF output
    • JSON output
  • Running core tests
    • Workaround for validate_json.py
    • Database configuration
    • Expected test output
    • Running without a database
  • Writing your own plugins
• Plugin Developer’s Guide
  • Purpose of this document
  • Definitions
    • What is a plugin?
    • Other definitions
  • Identifiers
  • Getting started: Files and directories
  • Configure step: The INI file structure
    • Reserved parameters
    • Plugin-specific parameters
    • Substituting environment variables
    • Using the workspace
    • Example INI section
    • Implementation: How to write the code
  • Extract step: From INI to JSON
    • Overview
    • The JSON schema
    • Implementation: How to write the code
  • Render step: From JSON to HTML
    • The Prime Directive of Rendering
    • Do not use the workspace
  • Testing a plugin
    • A simple test class
    • Bootstrapping test development
    • Example of running a test
    • Further remarks on testing
  • Conclusion
• Methods of plugin objects
  • Plugin requirements
  • Key methods of plugins
    • configure
    • extract
    • render
    • specify_params
  • Other useful methods of plugins
    • get_starting_data
    • Other, other methods (descriptions TODO)
  • Djerba configuration with INI files
  • Methods of the config_wrapper class
    • __init__
    • get_config
    • get_core_string
    • get_core_int
    • get_core_float
    • get_core_boolean
    • get_my_attributes
    • get_my_boolean
    • get_my_float
    • get_my_int
    • get_my_string
    • get_boolean
    • get_float
    • get_int
    • get
    • get_string
    • get_my_priorities
    • my_param_is_null
    • my_param_is_not_null
    • param_is_null
    • param_is_not_null
    • has_my_param
    • has_option
    • has_param
    • set_my_param
    • set_param
    • set
    • set_my_priorities
    • apply_env_templates
    • apply_my_env_templates
    • get_dir_from_env
    • get_djerba_data_dir
    • get_djerba_private_dir
    • get_djerba_test_dir
• Contact Us

Tools

• Search Page