corrad-bp/doc/README.md
Afiq 72c61184ae Refactor Form Components and Enhance JavaScript Execution
- Removed unnecessary event propagation handling in ComponentPreview.vue for cleaner interaction.
- Adjusted FormBuilderConfiguration.vue to ensure proper min attribute placement for maxFiles input.
- Updated FormScriptEngine.vue to allow global CSS injection and added new notification helper functions for success, error, and info messages.
- Enhanced FormTemplatesModal.vue with a new CSS & JavaScript test form template, demonstrating real-time calculations and dynamic field updates.
- Improved documentation to include a comprehensive JavaScript API reference and updated user guides for better clarity on dynamic form functionalities.
- Added new fields to the JSON schema for custom scripts and CSS, enhancing form configuration capabilities.
- Updated formBuilder.js to include a method for updating preview form data, improving state management during form interactions.
2025-05-27 11:11:10 +08:00

64 lines
3.1 KiB
Markdown

# Corrad ProcessMaker Documentation
Welcome to the Corrad ProcessMaker documentation. This repository contains comprehensive guides and technical documentation for developers and users of the Corrad ProcessMaker platform.
## Documentation Structure
The documentation is organized into the following sections:
### Overview
- [Project Overview](./overview/PROJECT_OVERVIEW.md) - Introduction to the system and its capabilities
- [Architecture](./overview/ARCHITECTURE.md) - Technical architecture of the system
- [Development Guide](./overview/DEVELOPMENT_GUIDE.md) - Guide for new developers
### Process Builder
- [User Guide](./process-builder/USER_GUIDE.md) - How to use the Process Builder
- [Technical Guide](./process-builder/TECHNICAL_GUIDE.md) - Technical details of the Process Builder implementation
- [Roadmap](./process-builder/ROADMAP.md) - Planned improvements for the Process Builder
### Form Builder
- [User Guide](./form-builder/USER_GUIDE.md) - How to use the Form Builder
- [Technical Guide](./form-builder/TECHNICAL_GUIDE.md) - Technical details of the Form Builder implementation
- [JavaScript API Reference](./form-builder/JAVASCRIPT_API.md) - Complete JavaScript API for dynamic forms and calculations
- [Grid System Guide](./form-builder/grid-system.md) - Visual grid system and layout documentation
### Process Execution
- [User Guide](./process-execution/USER_GUIDE.md) - How to use the Process Execution interface
- [Technical Guide](./process-execution/TECHNICAL_GUIDE.md) - Technical details of the Process Execution implementation
## Getting Started
New to the project? We recommend reading the documentation in this order:
1. [Project Overview](./overview/PROJECT_OVERVIEW.md) - Understand what the system does
2. [Development Guide](./overview/DEVELOPMENT_GUIDE.md) - Learn how to set up your development environment
3. [Architecture](./overview/ARCHITECTURE.md) - Understand the technical architecture
4. User guides for components you'll be working with
5. Technical guides for deeper implementation details
## Contributing to Documentation
When contributing to this documentation:
1. Keep the structure organized and logical
2. Update cross-references when moving or renaming files
3. Ensure code examples are up-to-date
4. Include diagrams where helpful
5. Keep the language clear and concise
## Contact
If you have questions about this documentation or need help with the system, please contact the development team.
Last updated: December 2024
## Recent Updates
### December 2024 - Major Form Builder Enhancements
- **JavaScript Execution Engine**: Added FormScriptEngine component for real-time calculations
- **Dynamic Field Updates**: Implemented onFieldChange and onLoad event handlers
- **Real-time Calculations**: Forms now support live mathematical calculations and field dependencies
- **Enhanced Debugging**: Comprehensive logging and error handling for JavaScript execution
- **API Documentation**: Complete JavaScript API reference with practical examples
- **Performance Optimizations**: Improved change detection and memory management
- **Security Enhancements**: Sandboxed JavaScript execution with input validation