ucp-translator-html 0.1.18

HTML to UCM document translator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# HTML Translator

**ucp-translator-html** provides conversion from HTML to UCM documents.

## Overview

The HTML translator enables:

- **Parsing** - Convert HTML to UCM documents
- **Semantic mapping** - Map HTML elements to semantic roles
- **Heading strategies** - Configure how headings are processed

## Installation

```toml
[dependencies]
ucp-translator-html = "0.1"
```

## Quick Start

```rust
use ucp_translator_html::parse_html;

let html = r#"
<!DOCTYPE html>
<html>
<head><title>My Document</title></head>
<body>
  <h1>Introduction</h1>
  <p>Welcome to the guide.</p>
  <h2>Getting Started</h2>
  <p>Here's some content.</p>
</body>
</html>
"#;

let doc = parse_html(html).unwrap();
println!("Parsed {} blocks", doc.block_count());
```

## Parsing HTML

### HtmlParser

```rust
use ucp_translator_html::{HtmlParser, HtmlParserConfig, HeadingStrategy};

// Default parser
let parser = HtmlParser::new();
let doc = parser.parse(html)?;

// With custom configuration
let config = HtmlParserConfig {
    heading_strategy: HeadingStrategy::FromHierarchy,
    ..Default::default()
};
let parser = HtmlParser::with_config(config);
let doc = parser.parse(html)?;
```

### Supported Elements

| HTML Element | UCM Content Type | Semantic Role |
|--------------|------------------|---------------|
| `<h1>` | Text | `heading1` |
| `<h2>` | Text | `heading2` |
| `<h3>` | Text | `heading3` |
| `<h4>` | Text | `heading4` |
| `<h5>` | Text | `heading5` |
| `<h6>` | Text | `heading6` |
| `<p>` | Text | `paragraph` |
| `<pre><code>` | Code | `code` |
| `<ul>/<ol>` | Text | `list` |
| `<blockquote>` | Text | `quote` |
| `<table>` | Table | `table` |

### Heading Strategies

| Strategy | Description |
|----------|-------------|
| `FromTags` | Use HTML heading tags directly (h1-h6) |
| `FromHierarchy` | Derive heading level from document structure |

## Public API

```rust
pub use error::{HtmlError, Result};
pub use parser::{HtmlParser, HtmlParserConfig, HeadingStrategy};
pub use parse_html;
```

## See Also

- [UCM Core Content Types](../../docs/ucm-core/content-types.md) - Content type reference
- [Markdown Translator](../markdown) - Markdown support
- [Documents](../../docs/ucm-core/documents.md) - Document structure