User Guide

Purpose

This section explains detailed usage methods and advanced features of RDEToolKit. After completing basic installation and initial execution, this provides information for more effective utilization of RDEToolKit.

Key Topics

Basic Concepts

What is Structuring Processing - Core concepts and processing flow of RDEToolKit
Processing Modes - Characteristics and usage of four processing modes
Directory Structure - Standard file organization of RDE projects
Structuring Processing Development Guide (Overview) - Practical development process and learning flow

Configuration and Customization

Configuration File - Behavior control using rdeconfig.yaml and pyproject.toml
Magic Variables - Dynamic metadata replacement functionality
gen-config CLI - Generate rdeconfig.yaml using ready-made templates or interactive prompts

Template Files

Template File Guide - Roles and structure of invoice.schema.json, invoice.json, metadata-def.json, and metadata.json
init CLI - Automatically scaffold key templates and directory layout
Repository samples: templates/tasksupport/invoice.schema.json, templates/tasksupport/metadata-def.json

Practical Usage

CLI Tools - Detailed command-line operations
Structuring Processing Development Guide (Hands-on) - Build with real datasets step by step
Validation - Data quality verification methods

Advanced Features

Docker Usage - Environment setup and execution using Docker

Usage Flow

Concept Understanding: Grasp the big picture via What is Structuring Processing and the Structuring Processing Development Guide
Template Preparation: Use the init CLI and gen-config CLI to generate initial files
Environment Configuration: Refine rdeconfig.yaml and invoice/metadata definitions with the Configuration File docs and Template File Guide
Practical Application: Operate workflows with the CLI Tools and Validation guides, expanding into advanced features as needed

Support Resources

Documentation

API Reference - Technical specifications of all features
Developer Guide - Contribution methods
Structuring Processing Development Guide - Step-by-step practice from template creation to validation

Community

GitHub Issues - Bug reports and feature requests
GitHub Discussions - Questions and information exchange

Learning Approach

To effectively learn RDEToolKit, we recommend first understanding the basic concepts in What is Structuring Processing, then referring to topics according to your specific use cases.

Next Steps

For beginners: Start with What is Structuring Processing
To modify settings: Refer to Configuration File
For advanced features: Check Docker Usage