https://github.com/crowdagger/crowbook-text-processing

Some text processing functions written for Crowbook and moved in a separate library
https://github.com/crowdagger/crowbook-text-processing

Last synced: 15 days ago
JSON representation

Some text processing functions written for Crowbook and moved in a separate library

• Host: GitHub
• URL: https://github.com/crowdagger/crowbook-text-processing
• Owner: crowdagger
• License: mpl-2.0
• Created: 2016-10-06T17:50:34.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2023-08-03T00:01:01.000Z (over 1 year ago)
• Last Synced: 2024-10-12T13:45:53.497Z (about 1 month ago)
• Language: Rust
• Size: 146 KB
• Stars: 12
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[See the full library documentation on Docs.rs.](https://docs.rs/crowbook-text-processing)

Provides some utilities functions for escaping text (to HTML or

LaTeX) and formatting it according to typographic rules (smart

quotes, ellipsis, french rules for non-breaking spaces).

These functions were originally written for

[Crowbook](https://github.com/lise-henry/crowbook), but have

been published on a separate crate and under a less restrictive

license (MPL instead of LGPL) so they can be used in other projects.

## Usage

Just add this line in the `dependencies` section of your `Cargo.toml`

file:

```toml

[dependencies]

crowbook-text-processing = "0.2"

```

## Example

```rust

use crowbook_text_processing::{FrenchFormatter, clean, escape};

let s = " Some  string with  too much   whitespaces & around 1% \

         characters that might cause trouble to HTML or LaTeX.";

// Remove unnecessary whitespaces (but doesn't trim as it can have meaning)

let new_s = clean::whitespaces(s);

// Escape forHTML

println!("for HTML: {}", escape::html(new_s.clone()));

// Escape for LaTeX

println!("for LaTeX: {}", escape::tex(new_s));

// Replace quotes with typographic quotation marks

let s = r#"Some "quoted string" and 'another one'."#;

let new_s = clean::quotes(s);

assert_eq!(&new_s, "Some “quoted string” and ‘another one’.");

// Replace three consecutive dots with ellipsis character

let s = clean::ellipsis("Foo...");

assert_eq!(&s, "Foo…");

// Format whitespaces according to french typographic rules, using

// the appropriate non-breaking spaces where needed

let s = " Une chaîne en français ! On voudrait un résultat \

         « typographiquement correct ».";

let french = FrenchFormatter::new();

println!("for text: {}", french.format(s));

println!("for LaTeX: {}", escape::tex(french.format_tex(s)));

```

## License

This is free software, published under the [Mozilla Public License,

version 2.0](https://www.mozilla.org/en-US/MPL/2.0/).

## ChangeLog

See the [ChangeLog file](ChangeLog.md).