Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify HTML comments #82

Merged
merged 1 commit into from
Sep 18, 2023
Merged

Simplify HTML comments #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,14 +185,14 @@ Please see the [`publish.yml`] workflow in the Comprehensive Rust 🦀 repositor
## Marking Sections to be Skipped for Translation

A block can be marked to be skipped for translation by prepending a special HTML
comment `<!--- mdbook-xgettext:skip -->` to it.
comment `<!-- mdbook-xgettext:skip -->` to it.

For example:

````markdown
The following code block should not be translated.

<!--- mdbook-xgettext:skip -->
<!-- mdbook-xgettext:skip -->

```
fn hello() {
Expand All @@ -204,7 +204,7 @@ Itemized list:

- A should be translated.

<!--- mdbook-xgettext:skip -->
<!-- mdbook-xgettext:skip -->

- B should be skipped.
- C should be translated.
Expand Down
24 changes: 12 additions & 12 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,9 +673,9 @@ mod tests {
#[test]
fn extract_events_comments() {
assert_eq!(
extract_events("<!--- mdbook-xgettext:skip -->\nHello", None),
extract_events("<!-- mdbook-xgettext:skip -->\nHello", None),
vec![
(1, Html("<!--- mdbook-xgettext:skip -->\n".into())),
(1, Html("<!-- mdbook-xgettext:skip -->\n".into())),
(2, Start(Paragraph)),
(2, Text("Hello".into())),
(2, End(Paragraph)),
Expand Down Expand Up @@ -1100,7 +1100,7 @@ The document[^1] text.
#[test]
fn extract_messages_skip_simple() {
assert_extract_messages(
r#"<!--- mdbook-xgettext:skip -->
r#"<!-- mdbook-xgettext:skip -->

This is a paragraph."#,
vec![],
Expand All @@ -1110,7 +1110,7 @@ This is a paragraph."#,
#[test]
fn extract_messages_skip_next_paragraph_ok() {
assert_extract_messages(
r#"<!--- mdbook-xgettext:skip -->
r#"<!-- mdbook-xgettext:skip -->
This is a paragraph.

This should be translated.
Expand All @@ -1122,7 +1122,7 @@ This should be translated.
#[test]
fn extract_messages_skip_next_codeblock() {
assert_extract_messages(
r#"<!--- mdbook-xgettext:skip -->
r#"<!-- mdbook-xgettext:skip -->
```
def f(x): return x * x
```
Expand All @@ -1135,11 +1135,11 @@ This should be translated.
#[test]
fn extract_messages_skip_back_to_back() {
assert_extract_messages(
r#"<!--- mdbook-xgettext:skip -->
r#"<!-- mdbook-xgettext:skip -->
```
def f(x): return x * x
```
<!--- mdbook-xgettext:skip -->
<!-- mdbook-xgettext:skip -->
This should not translated.

But *this* should!
Expand All @@ -1152,7 +1152,7 @@ But *this* should!
fn extract_messages_inline_skips() {
assert_extract_messages(
"
this should be translated <!--- mdbook-xgettext:skip --> but not this.
this should be translated <!-- mdbook-xgettext:skip --> but not this.
... nor this.

But *this* should!",
Expand All @@ -1165,7 +1165,7 @@ But *this* should!",
assert_extract_messages(
"
* A
<!--- mdbook-xgettext:skip -->
<!-- mdbook-xgettext:skip -->
* B
* C
",
Expand All @@ -1179,7 +1179,7 @@ But *this* should!",
"
* A

<!--- mdbook-xgettext:skip -->
<!-- mdbook-xgettext:skip -->
* B

* C
Expand All @@ -1201,7 +1201,7 @@ But *this* should!",
assert_extract_messages(
"
* A
* <!--- mdbook-xgettext:skip --> B
* <!-- mdbook-xgettext:skip --> B
* C
",
vec![(2, "A")],
Expand All @@ -1211,7 +1211,7 @@ But *this* should!",
#[test]
fn extract_messages_inline_skip_to_end_of_block() {
assert_extract_messages(
"foo <!--- mdbook-xgettext:skip --> **bold** bar
"foo <!-- mdbook-xgettext:skip --> **bold** bar
still skipped

not-skipped",
Expand Down