rtf-parser-tt 0.5.0

RTF parser with special character support (emdash, smart quotes, etc). Fork of rtf-parser.
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

# rtf-parser-tt


[![Crates.io](https://img.shields.io/crates/v/rtf-parser-tt.svg)](https://crates.io/crates/rtf-parser-tt)
[![Documentation](https://docs.rs/rtf-parser-tt/badge.svg)](https://docs.rs/rtf-parser-tt)
[![License](https://img.shields.io/crates/l/rtf-parser-tt.svg)](LICENSE.md)

RTF parser with special character support. Fork of [rtf-parser](https://crates.io/crates/rtf-parser) by [@d0rianb](https://github.com/d0rianb).

## Why This Fork?


The upstream `rtf-parser` crate silently drops special character control words like `\emdash`, `\endash`, and smart quotes. This causes **data loss** when parsing RTF from applications like Scrivener, Microsoft Word, and others.

This fork adds support for these characters.

## Support


If you find this crate useful, consider supporting development:

- [GitHub Sponsors](https://github.com/sponsors/twelvetake)
- [Ko-fi](https://ko-fi.com/twelvetake)

## Installation


```toml
[dependencies]
rtf-parser-tt = "0.5"
```

## What's Added


| Control Word | Unicode | Character |
|--------------|---------|-----------|
| `\emdash` | U+2014 | — |
| `\endash` | U+2013 | – |
| `\bullet` | U+2022 | • |
| `\lquote` | U+2018 | ' |
| `\rquote` | U+2019 | ' |
| `\ldblquote` | U+201C | " |
| `\rdblquote` | U+201D | " |
| `\tab` | U+0009 | (tab) |
| `\line` | U+000A | (newline) |

## Usage


```rust
use rtf_parser_tt::RtfDocument;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rtf = r#"{\rtf1\ansi Hello\emdash world}"#;
    let doc = RtfDocument::try_from(rtf)?;
    let text = doc.to_text();
    assert!(text.contains("—")); // Em-dash preserved!
    Ok(())
}
```

## API


The API is identical to `rtf-parser`. See the [original documentation](https://docs.rs/rtf-parser) for full details.

Key types:
- `RtfDocument` - Parsed RTF document
- `Lexer` - Tokenizes RTF input
- `Parser` - Converts tokens to document
- `StyleBlock` - Text with formatting info
- `Painter` - Text style (bold, italic, etc.)
- `Paragraph` - Layout info (alignment, spacing)

## Upstream Status


A PR has been submitted to the upstream `rtf-parser` repository. Once merged, this fork may be deprecated in favor of the upstream version.

## License


MIT License - same as upstream.

## Credits


- Original crate: [rtf-parser](https://github.com/d0rianb/rtf-parser) by [@d0rianb](https://github.com/d0rianb)
- Fork maintained by [TwelveTake Studios](https://twelvetake.com)