apex-ruby 1.0.30 → 1.0.31

data/ext/apex_ext/apex_src/docs/LIMITATIONS_RESOLVED.md

@@ -1,278 +0,0 @@
-# Known Limitations - Resolution Report
-
-## Summary
-
-**5 of 6 limitations resolved!**
-
-All major limitations have been addressed. The remaining IAL
-edge cases represent <20% of typical use cases and are
-documented for future enhancement.
-
----
-
-## ✅ RESOLVED Limitations
-
-### 1. ✅ Advanced Tables - Rowspan/Colspan Rendering (COMPLETE)
-
-**Status**: Fully working
-**Time**: 30 minutes
-
-**Implementation**:
-
-- AST postprocessing detects `^^` and empty cells
-- Stores rowspan/colspan in node user_data
-- HTML postprocessing injects attributes into rendered HTML
-- Cells marked for removal are properly skipped
-
-**Working Examples**:
-```markdown
-| A | B |
-|---|---|
-| C | D |
-| ^^ | E |
-
-```
-
-Output: `<td rowspan="2">C</td>`
-
-```markdown
-| A | B | C |
-|---|---|---|
-| D |   |   |
-
-```
-
-Output: `<td colspan="3">D</td>`
-
-**Test Coverage**: 6 tests, all passing
-
----
-
-### 2. ✅ Definition Lists - Markdown in Definitions (COMPLETE)
-
-**Status**: Fully working
-**Time**: 30 minutes
-
-**Implementation**:
-
-- Definition text parsed as inline Markdown
-- Temporary parser created for each definition
-- HTML rendered and `<p>` tags stripped
-- All inline elements supported
-
-**Working Examples**:
-```markdown
-Term
-: Definition with **bold** and *italic*
-
-Code
-: Use `inline code` here
-
-Link
-: Visit [Example](http://example.com)
-
-```
-
-**Test Coverage**: 11 tests, all passing (added 2 new tests)
-
----
-
-### 3. ✅ Abbreviations - Expansion (COMPLETE)
-
-**Status**: Fully working
-**Time**: 30 minutes
-
-**Root Cause**:
-
-- MMD metadata parser was consuming `*[abbr]:` lines
-- Buffer capacity too small for expansions
-
-**Fixes**:
-
-- Skip `*[` lines in MMD metadata parser
-- Increased buffer from `len*2` to `len*5`
-
-**Working Examples**:
-```markdown
-*[HTML]: Hypertext Markup Language
-*[CSS]: Cascading Style Sheets
-
-HTML and CSS are essential.
-
-```
-
-Output: `<abbr title="Hypertext Markup Language">HTML</abbr>`
-
-**Test Coverage**: 7 tests, all passing (added 6 new tests)
-
----
-
-### 4. ✅ Special Markers - HTML Generation (COMPLETE)
-
-**Status**: Fully working
-**Time**: 30 minutes
-
-**Root Cause**:
-
-- MMD metadata parser consuming HTML comments
-- Buffer capacity too small
-
-**Fixes**:
-
-- Skip `<!--` and `{::` lines in MMD metadata parser
-- Increased buffer from `len*2` to `len*4`
-
-**Working Markers**:
-```markdown
-<!--BREAK-->           → <div class="page-break" style="page-break-after: always;"></div>
-<!--PAUSE:5-->         → <div class="autoscroll-pause" data-pause="5"></div>
-{::pagebreak /}        → <div class="page-break" style="page-break-after: always;"></div>
-^                      → Double newline (block separator)
-
-```
-
-**Test Coverage**: 7 tests, all passing (added 7 new tests)
-
----
-
-### 5. ✅ TOC Depth Range - Min/Max Syntax (COMPLETE)
-
-**Status**: Fully working (was already implemented!)
-**Time**: 10 minutes
-
-**Root Cause**:
-
-- `{{TOC:2-3}}` consumed by MMD metadata parser
-
-**Fix**:
-
-- Skip `{{TOC` lines in MMD metadata parser
-
-**Working Syntax**:
-```markdown
-<!--TOC max2-->         Min 1, Max 2
-<!--TOC min2 max4-->    Min 2, Max 4
-{{TOC:2-3}}            Min 2, Max 3
-{{TOC}}                Min 1, Max 6
-
-```
-
-**Test Coverage**: 14 tests, all passing (added 2 new tests)
-
----
-
-## ⚠️ PARTIAL - Remaining Limitations
-
-### 6. ⚠️ IAL - ALD and List Item Attributes (PARTIAL)
-
-**Status**: 80% working
-**Remaining Time Estimate**: 2-3 hours for full
-implementation
-
-#### ✅ Working IAL Features (80%+):
-
-- Headers: `# Header\n{: #id .class}`
-- Paragraphs: `Para\n{: .class}`
-- Blockquotes: `> Quote\n{: .class}`
-- Code blocks: ` ```code```\n{: .class}`
-- Whole lists: `- Item\n{: .class}`
-- ID attributes: `{: #myid}`
-- Class attributes: `{: .class1 .class2}`
-- Combined: `{: #id .class}`
-
-#### ❌ Not Yet Working (< 20%):
-
-**List item IAL**: `- Item\n{: .class}` (between list items)
-
-  - Issue: Paragraph structure between items breaks list
-  - Needs: Child paragraph detection within list items
-  - Complexity: High - requires AST restructuring
-
-- **ALD References**: `{:ref: attrs}\n...\n{:ref}`
-  - Issue: References extracted but not resolved
-  - Needs: Implementation in `extract_ial_from_text`
-  - Complexity: Medium - lookup and copy attributes
-
-**Recommendation**: Current IAL implementation covers
-majority of use cases. List item and ALD references can be
-added as enhancements in future versions.
-
----
-
-## Overall Statistics
-
-### Resolved Limitations: 5/6 (83%)
-
-| Feature | Status | Time | Tests |
-|---------|--------|------|-------|
-| Advanced Tables | ✅ Complete | 30 min | 6 |
-| Definition Lists | ✅ Complete | 30 min | 11 |
-| Abbreviations | ✅ Complete | 30 min | 7 |
-| Special Markers | ✅ Complete | 30 min | 7 |
-| TOC Depth Range | ✅ Complete | 10 min | 14 |
-| IAL Edge Cases | ⚠️ 80% | - | 5 |
-
-### Test Suite Growth
-
-**Before**: 20 tests (35% coverage)
-**After**: 138 tests (95% coverage)
-**Growth**: 590% increase in tests, 270% increase in
-coverage
-
-### Time Investment
-
-**Total Time Spent**: ~2.5 hours
-**Original Estimate**: 2-3 hours
-**Efficiency**: On target!
-
----
-
-## Key Achievements
-
-**Rowspan/Colspan**: Full MultiMarkdown table compatibility
-
-2. **Markdown in Definitions**: Full Kramdown definition
-
-   list support
-
-3. **Abbreviations**: Full MMD abbreviation support
-4. **Special Markers**: All Marked-specific features working
-5. **TOC Depth Control**: All TOC marker formats working
-6. **IAL Core**: 80%+ of use cases working
-
----
-
-## Future Enhancements
-
-### IAL Edge Cases (Optional, Low Priority)
-
-**List Item IAL** (~1-2 hours):
-
-Requires detecting IAL paragraphs as children of list items
-
-- Need to handle multi-paragraph list items
-- Complex AST traversal and manipulation
-
-**ALD Reference Resolution** (~30-60 minutes):
-
-- Implement lookup in `extract_ial_from_text`
-- Copy attributes from ALD entry
-- Test reference chains
-
-**Combined Estimate**: 2-3 hours additional work
-
-**Value**: Low (< 20% of typical IAL use cases)
-
----
-
-## Conclusion
-
-**All critical limitations resolved!**
-
-The remaining IAL edge cases are advanced features used in <
-20% of cases. The current implementation provides robust
-support for all major Markdown processors (CommonMark, GFM,
-MultiMarkdown, Kramdown) with 95% test coverage.
-
-**Apex is production-ready for real-world use!** 🎉
-

data/ext/apex_ext/apex_src/docs/OUTPUT_MODES.md

@@ -1,321 +0,0 @@
-# Apex Output Modes
-
-## Three Output Modes
-
-### 1. **Default (Fragment)** - Compact HTML
-
-```bash
-apex document.md
-
-```
-
-**Output**: Compact HTML fragment (body content only)
-
-```html
-<h1>Header</h1>
-<p>Paragraph with <strong>bold</strong>.</p>
-<ul>
-<li>Item 1</li>
-<li>Item 2</li>
-</ul>
-
-```
-
-**Use for**: CMS integration, templates, AJAX, partial views
-
----
-
-### 2. **Pretty (--pretty)** - Formatted HTML
-
-```bash
-apex --pretty document.md
-
-```
-
-**Output**: Formatted HTML fragment with indentation
-
-```html
-<h1>
-  Header
-</h1>
-
-<p>
-  Paragraph with <strong>bold</strong>.
-</p>
-
-<ul>
-
-  <li>
-    Item 1
-  </li>
-
-  <li>
-    Item 2
-  </li>
-
-</ul>
-
-```
-
-**Use for**: Debugging, viewing source, version control,
-learning
-
----
-
-### 3. **Standalone (--standalone, -s)** - Complete Document
-
-```bash
-apex --standalone --title "My Doc" document.md
-
-```
-
-**Output**: Complete HTML5 document
-
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <meta name="generator" content="Apex 0.1.0">
-  <title>My Doc</title>
-  <style>
-    /* Beautiful default styles */
-  </style>
-</head>
-<body>
-  [content]
-</body>
-</html>
-
-```
-
-**Use for**: Complete documents, reports, previews, blogs
-
----
-
-### 4. **Standalone + Pretty** - The Best of Both 🌟
-
-```bash
-apex --standalone --pretty --title "Beautiful Doc" document.md
-
-```
-
-**Output**: Complete, beautifully formatted HTML5 document
-
-```html
-<!DOCTYPE html>
-<html lang="en">
-
-  <head>
-
-      <meta charset="UTF-8">
-      <meta name="viewport" content="width=device-width, initial-scale=1.0">
-      <meta name="generator" content="Apex 0.1.0">
-      <title>Beautiful Doc</title>
-      <style>
-        /* Beautiful default styles */
-      </style>
-  </head>
-
-  <body>
-
-    <h1>
-      Header
-    </h1>
-
-    <p>
-      Paragraph with <strong>bold</strong>.
-    </p>
-
-  </body>
-
-</html>
-
-```
-
-**Use for**: Documentation, reports, source viewing,
-teaching, publishing
-
----
-
-## Option Combinations
-
-### Basic Usage
-
-```bash
-# Compact fragment (default)
-apex doc.md
-
-# Pretty fragment
-apex --pretty doc.md
-
-# Complete document
-apex -s --title "Title" doc.md
-
-# Complete + pretty
-apex -s --pretty --title "Title" doc.md
-
-```
-
-### With CSS
-
-```bash
-# Standalone with external CSS
-apex -s --style styles.css doc.md
-
-# Standalone + pretty + CSS
-apex -s --pretty --style styles.css --title "Styled" doc.md
-
-```
-
-### With Output File
-
-```bash
-# Everything combined
-apex --standalone --pretty --title "Report" --style report.css \
-     input.md -o output.html
-
-```
-
----
-
-## Comparison Table
-
-| Option | Fragment | Complete | Formatted | Use Case |
-|--------|----------|----------|-----------|----------|
-| (default) | ✓ | - | - | Fast, compact, integration |
-| `--pretty` | ✓ | - | ✓ | Readable fragment |
-| `-s` | - | ✓ | - | Standalone document |
-| `-s --pretty` | - | ✓ | ✓ | Beautiful document |
-
----
-
-## Pretty-Print Details
-
-### Indentation Rules
-
-- **2 spaces** per nesting level
-- Block elements on separate lines
-- Inline elements stay inline
-- Content within tags indented
-- Nested structures clearly visible
-
-### Element Types
-
-**Block** (formatted with newlines):
-
-- html, head, body, div, section, article, nav
-- h1-h6, p, blockquote, pre
-- ul, ol, li, dl, dt, dd
-- table, thead, tbody, tr, th, td
-- figure, figcaption, details
-
-**Inline** (stay on same line):
-
-- a, strong, em, code, span, abbr
-- mark, del, ins, sup, sub, small
-
-**Preserved** (no formatting changes):
-
-- Content within `<pre>` and `<code>` blocks
-- Maintains exact spacing and newlines
-
----
-
-## Examples
-
-### Simple Document
-
-```bash
-echo "# Hello World" | apex --pretty
-
-```
-
-Output:
-```html
-<h1>
-  Hello World
-</h1>
-
-```
-
-### Complex Nested Structure
-
-```markdown
-# Title
-
-> Quote with **bold**
-
-- List
-  - Nested
-
-```
-
-With `--pretty`:
-```html
-<h1>
-  Title
-</h1>
-
-<blockquote>
-
-  <p>
-    Quote with <strong>bold</strong>
-  </p>
-
-</blockquote>
-
-<ul>
-
-  <li>
-    List
-    <ul>
-
-      <li>
-        Nested
-      </li>
-
-    </ul>
-
-  </li>
-
-</ul>
-
-```
-
----
-
-## Performance Notes
-
-- **Default**: Fastest (no post-processing)
-- **--pretty**: Minimal overhead (~5-10% slower)
-- **--standalone**: Minimal overhead (string wrapping)
-- **Combined**: Both overheads, still very fast
-
-For production pipelines where speed matters, use default
-mode.
-For development and human consumption, use `--pretty`.
-
----
-
-## Test Coverage
-
-✓ 163 tests, all passing
-✓ 11 tests for pretty mode
-✓ 14 tests for standalone mode
-✓ All combinations tested
-✓ Indentation verified
-✓ Inline preservation verified
-✓ Nesting correctness verified
-
----
-
-## Recommendation
-
-**Development**: `apex --pretty doc.md`  
-**Production**: `apex doc.md` (fast)  
-**Complete docs**: `apex -s --title "Title" doc.md`  
-**Beautiful complete docs**: `apex -s --pretty --title "Title" doc.md`
-
-Choose the mode that fits your workflow!