feat: add v1.2 feature examples (tables and modular docs)

alpha912 · alpha912 · commit 12889239947d · 2025-10-17T08:34:17.000Z
Breaking Changes: NONE New Examples (7 files): Tables: - tables/basic-table.osf - Simple product catalog - tables/styled-table.osf - All style variants with alignment - tables/sales-report.osf - Complete business report Modular Documents: - modular/main.osf - Main document with @include directives - modular/sections/intro.osf - Executive summary section - modular/sections/body.osf - Technical implementation - modular/sections/conclusion.osf - Results and recommendations Changes: - Update README.md with new example sections - Update omniscript-parser dependency from ^0.6.0 to ^1.2.0 - Add comprehensive @table examples (3 files, all styles) - Add complete modular document example (4 files) All examples parse successfully and demonstrate v1.2 features with realistic, production-quality content. Refs: P0-2, P2-8
diff --git a/README.md b/README.md
@@ -36,6 +36,19 @@ Data analysis and tracking sheets:
 - **[expense-report.osf](spreadsheets/expense-report.osf)** - Expense tracking with formulas
 - **[inventory-management.osf](spreadsheets/inventory-management.osf)** - Inventory system
 
+### 📋 Tables (v1.2+)
+Professional tables with styling and alignment:
+- **[basic-table.osf](tables/basic-table.osf)** - Simple product catalog with default styling
+- **[styled-table.osf](tables/styled-table.osf)** - Examples of all three style variants
+- **[sales-report.osf](tables/sales-report.osf)** - Complete sales report with multiple tables
+
+### 🔗 Modular Documents (v1.2+)
+Document composition using @include directive:
+- **[main.osf](modular/main.osf)** - Main document including multiple sections
+- **[sections/intro.osf](modular/sections/intro.osf)** - Executive summary section
+- **[sections/body.osf](modular/sections/body.osf)** - Technical implementation section
+- **[sections/conclusion.osf](modular/sections/conclusion.osf)** - Results and recommendations
+
 ### 🎯 Combined
 Multi-format documents demonstrating OSF's versatility:
 - **[business-report.osf](combined/business-report.osf)** - Doc + Slides + Sheets in one file
diff --git a/modular/main.osf b/modular/main.osf
@@ -0,0 +1,27 @@
+// File: omniscript-examples/modular/main.osf
+// What: Main document demonstrating @include directive
+// Why: Show how to compose documents from multiple files
+// Related: sections/intro.osf, sections/body.osf, sections/conclusion.osf
+
+@meta {
+  title: "Complete Project Report";
+  author: "Project Team";
+  date: "2025-10-17";
+  description: "Comprehensive project documentation using modular composition";
+}
+
+@include { path: "./sections/intro.osf"; }
+
+@include { path: "./sections/body.osf"; }
+
+@include { path: "./sections/conclusion.osf"; }
+
+@doc {
+  ---
+  
+  **Document composed from multiple files using @include directive**
+  
+  - intro.osf: Executive summary and project overview
+  - body.osf: Technical details and implementation
+  - conclusion.osf: Results and recommendations
+}
diff --git a/modular/sections/body.osf b/modular/sections/body.osf
@@ -0,0 +1,45 @@
+// File: omniscript-examples/modular/sections/body.osf
+// What: Body section with technical details
+// Why: Demonstrate technical content in modular docs
+// Related: main.osf, intro.osf, conclusion.osf
+
+@doc {
+  # Technical Implementation
+  
+  ## Architecture
+  
+  The new portal uses a microservices architecture with:
+  - React 18 frontend
+  - Node.js 22 backend services
+  - PostgreSQL 17 database
+  - Redis caching layer
+  - Docker containerization
+}
+
+@table {
+  caption: "Performance Metrics - Before vs After";
+  style: "bordered";
+  alignment: ["left", "right", "right", "center"];
+  
+  | Metric | Before | After | Improvement |
+  | --- | --- | --- | --- |
+  | Page Load Time | 3.2s | 1.1s | -65% ↓ |
+  | Time to Interactive | 4.8s | 1.6s | -67% ↓ |
+  | Mobile Performance | 45 | 92 | +104% ↑ |
+  | SEO Score | 72 | 96 | +33% ↑ |
+}
+
+@doc {
+  ## Security Enhancements
+  
+  - Multi-factor authentication (MFA)
+  - OAuth 2.0 with PKCE
+  - OWASP Top 10 compliance
+  - Automated security scanning in CI/CD
+  - Regular penetration testing
+  
+  ## Deployment Strategy
+  
+  Blue-green deployment with automated rollback capability ensured zero-downtime
+  updates across all regions.
+}
diff --git a/modular/sections/conclusion.osf b/modular/sections/conclusion.osf
@@ -0,0 +1,52 @@
+// File: omniscript-examples/modular/sections/conclusion.osf
+// What: Conclusion section with recommendations
+// Why: Complete the modular document example
+// Related: main.osf, intro.osf, body.osf
+
+@doc {
+  # Results and Impact
+  
+  ## Business Impact
+  
+  The new customer portal has significantly improved business metrics:
+  - **50% increase** in user engagement
+  - **40% reduction** in support tickets
+  - **$1.2M annual savings** in infrastructure costs
+  - **120% ROI** in first year
+}
+
+@table {
+  caption: "User Adoption by Region";
+  style: "striped";
+  alignment: ["left", "right", "right", "center"];
+  
+  | Region | Users (Before) | Users (After) | Growth |
+  | --- | --- | --- | --- |
+  | North America | 12,000 | 18,500 | +54% |
+  | Europe | 8,500 | 13,200 | +55% |
+  | Asia Pacific | 6,200 | 11,800 | +90% |
+  | Latin America | 3,100 | 4,800 | +55% |
+  | Middle East | 1,800 | 2,700 | +50% |
+}
+
+@doc {
+  ## Recommendations
+  
+  1. **Expand to Mobile App**: Consider native iOS/Android apps
+  2. **Add AI Assistant**: Implement chatbot for common queries
+  3. **Enhance Analytics**: Real-time dashboards for business users
+  4. **Global CDN**: Further reduce latency in distant regions
+  5. **API Marketplace**: Allow third-party integrations
+  
+  ## Lessons Learned
+  
+  - Early user testing prevented costly late-stage changes
+  - Automated testing caught 85% of bugs before production
+  - Modular architecture enabled parallel team development
+  - Regular stakeholder demos maintained alignment
+  
+  ---
+  
+  **Project Status**: ✓ Successfully Completed  
+  **Next Phase**: Q1 2026 - Mobile App Development
+}
diff --git a/modular/sections/intro.osf b/modular/sections/intro.osf
@@ -0,0 +1,26 @@
+// File: omniscript-examples/modular/sections/intro.osf
+// What: Introduction section for modular document
+// Why: Demonstrate section composition
+// Related: main.osf, body.osf, conclusion.osf
+
+@doc {
+  # Executive Summary
+  
+  This project successfully delivered a new customer portal with enhanced features
+  and improved performance. The system now serves **50,000+ active users** with
+  **99.9% uptime**.
+  
+  ## Project Overview
+  
+  - **Duration**: 8 months (January - August 2025)
+  - **Team Size**: 12 members
+  - **Budget**: $850,000
+  - **Status**: ✓ Completed on time and under budget
+  
+  ## Key Achievements
+  
+  1. Reduced page load time by 65%
+  2. Increased mobile usage by 120%
+  3. Improved customer satisfaction score from 7.2 to 8.9
+  4. Deployed to 5 regions with zero downtime
+}
diff --git a/node_modules/.package-lock.json b/node_modules/.package-lock.json
diff --git a/node_modules/omniscript-parser b/node_modules/omniscript-parser
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,6 +28,6 @@
   },
   "homepage": "https://omniscriptosf.github.io",
   "devDependencies": {
-    "omniscript-parser": "^0.6.0"
+    "omniscript-parser": "^1.2.0"
   }
 }
diff --git a/tables/basic-table.osf b/tables/basic-table.osf
@@ -0,0 +1,29 @@
+// File: omniscript-examples/tables/basic-table.osf
+// What: Basic table example with default styling
+// Why: Demonstrate simple table usage
+// Related: sales-report.osf, styled-table.osf
+
+@meta {
+  title: "Basic Table Example";
+  author: "Documentation Team";
+  date: "2025-10-17";
+}
+
+@doc {
+  # Simple Product Catalog
+  
+  Basic table showing product information with default styling.
+}
+
+@table {
+  | Product | Price | Stock |
+  | --- | --- | --- |
+  | Widget A | $19.99 | 150 |
+  | Widget B | $24.99 | 87 |
+  | Widget C | $29.99 | 203 |
+  | Widget D | $34.99 | 45 |
+}
+
+@doc {
+  Tables use Markdown pipe syntax for easy editing and Git-friendly diffs.
+}
diff --git a/tables/sales-report.osf b/tables/sales-report.osf
@@ -0,0 +1,84 @@
+// File: omniscript-examples/tables/sales-report.osf
+// What: Sales report example demonstrating @table blocks
+// Why: Show how to create professional sales reports with tables
+// Related: basic-table.osf, styled-table.osf
+
+@meta {
+  title: "Q4 2025 Sales Report";
+  author: "Sales Team";
+  date: "2025-10-17";
+  description: "Quarterly sales performance by region and product";
+}
+
+@doc {
+  # Executive Summary
+  
+  This report presents Q4 2025 sales performance across all regions and product lines.
+  Overall revenue increased by **18%** compared to Q3 2025.
+}
+
+@table {
+  caption: "Sales by Region - Q4 2025";
+  style: "bordered";
+  alignment: ["left", "right", "center", "right"];
+  
+  | Region | Revenue | Growth | Status |
+  | --- | --- | --- | --- |
+  | North America | $2,450,000 | +22% | ✓ Exceeds Target |
+  | Europe | $1,890,000 | +15% | ✓ Meets Target |
+  | Asia Pacific | $3,120,000 | +28% | ✓ Exceeds Target |
+  | Latin America | $890,000 | +8% | → Below Target |
+  | Middle East | $675,000 | +12% | → Below Target |
+}
+
+@doc {
+  ## Product Line Performance
+  
+  Our flagship products continue to drive growth, with cloud services showing exceptional results.
+}
+
+@table {
+  caption: "Revenue by Product Line";
+  style: "striped";
+  alignment: ["left", "right", "right", "center"];
+  
+  | Product | Q3 2025 | Q4 2025 | Change |
+  | --- | --- | --- | --- |
+  | Cloud Services | $3,200,000 | $4,100,000 | +28% ↑ |
+  | Enterprise Software | $2,800,000 | $3,150,000 | +13% ↑ |
+  | Professional Services | $1,450,000 | $1,575,000 | +9% ↑ |
+  | Hardware | $875,000 | $900,000 | +3% → |
+}
+
+@doc {
+  ## Top Performing Representatives
+  
+  Recognition for outstanding individual performance this quarter.
+}
+
+@table {
+  caption: "Top 5 Sales Representatives";
+  style: "minimal";
+  alignment: ["left", "center", "right", "right"];
+  
+  | Name | Region | Deals Closed | Total Revenue |
+  | --- | --- | --- | --- |
+  | Sarah Chen | Asia Pacific | 47 | $1,250,000 |
+  | Marcus Johnson | North America | 42 | $1,180,000 |
+  | Elena Rodriguez | Europe | 38 | $965,000 |
+  | Ahmed Hassan | Middle East | 35 | $820,000 |
+  | Maria Silva | Latin America | 31 | $710,000 |
+}
+
+@doc {
+  ## Recommendations
+  
+  1. **Expand in Asia Pacific**: Highest growth rate warrants additional investment
+  2. **Support Latin America**: Provide additional training and resources
+  3. **Cloud Services Focus**: Continue prioritizing cloud product development
+  4. **Recognition Program**: Celebrate top performers at annual conference
+  
+  ---
+  
+  *Report prepared by Sales Analytics Team - October 2025*
+}
diff --git a/tables/styled-table.osf b/tables/styled-table.osf

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@`
`28`	`28`	`},`
`29`	`29`	`"homepage": "https://omniscriptosf.github.io",`
`30`	`30`	`"devDependencies": {`
`31`		`- "omniscript-parser": "^0.6.0"`
	`31`	`+ "omniscript-parser": "^1.2.0"`
`32`	`32`	`}`
`33`	`33`	`}`