easy-docx-template 0.2.4

create docx template
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149


# 🚀Easy Docx Template


Create docx templates

## âš¡Install to your project

`cargo add easy-docx-template`

## Changelog 0.2.4v

* Added {{value}} placeholders for default arrays ["1", "2", "3"]
* Added Each internal blocks

```
{{#each exam.users}}
{{@index}}. {{name}} has {{#each pets}} {{type}} {{/each}}
{{/each}}
  |
 \ /
 1. Alice has dog
 2. Peter has cat
```
## Placeholder Helpers
`get array len: {{#exam.nums}} -> 3`

`set lowercase for text: {{lower exam.title}} -> "math exam"`

`set uppercase for text: {{upper exam.title}} -> "MATH EXAM"`

## Each block
```
{{#each exam.users}}

{{@index}}: {{first}} {{last}}

{{/each}}

 |
\ /

1: Ivan Ivanov
2: Petr Petrov
```
## Usage/Examples


Example 1:
```Rust
use easy_docx_template::DOCX;

fn main()  {
    // 1. Loading docx file
    let mut docx = DOCX::new("example/test.docx".to_string());
    docx.read();

    // 2. Adding placeholders
    docx.add_placeholder("{{exam.title}}", "Math exam");
    docx.add_placeholder("{{exam.variant}}", "1 variant");
    docx.add_placeholder("{{exam.subject}}", "Math");
    docx.add_placeholder("{{exam.level}}", "1-A form");
    docx.add_placeholder("{{exam.image_subtitle}}", "Hello world!");
    docx.add_placeholder("{{exam.nums}}",vec!["1", "2", "3"]);

    // 3. Init placeholders
    docx.init_placeholders();

    // 4. Save our docx file
    docx.save("output.docx");
    println!("✅ File saved: output.docx")
}
```

Example 2(Loading data from json):

```Rust
use easy_docx_template::DOCX;

fn main() {
    // 1. Loading docx file
    let mut docx = DOCX::new("example/test.docx".to_string());
    docx.read();

    // 2. Adding placeholders
    docx.add_placeholders_from_json::<String>(r#"{
            "exam": {
                    "level": "form 2-A",
                    "variant": "1 variant",
                    "title": "Math exam",
                    "subject": "math",
                    "image_subtitle": "Hello world!",
                    "nums": ["1", "2"]
                }
            }"#);

    // 3. Init placeholders
    docx.init_placeholders();

    // 4. Save our docx file
    docx.save("output.docx");
    println!("✅ File saved: output.docx")
}
```
#### 🚨Warning! Image placeholders are initialized when the final file is saved.


Example 3(Add image placeholder)

```Rust
use easy_docx_template::DOCX;

fn test_1() {
        // 1. Loading docx file
        let mut docx: DOCX = DOCX::new("example/test.docx".to_string());
        docx.read();

        // 2. Adding placeholders
        docx.add_placeholders_from_json::<String>(r#"{
            "exam": {
                    "level": "form 2-A",
                    "variant": "1 variant",
                    "title": "Math exam",
                    "subject": "math",
                    "image_subtitle": "Hello world!",
                    "nums": ["1", "2"],
                    "users": [
                        { "first": "Ivan", "last": "Ivanov" },
                        { "first": "Petr", "last": "Petrov" }
                    ],
                }
            }"#);

        // 4. Add image placeholder
        docx.add_image_placeholder("image1.jpeg", "example/replace_image1.png");

        // 5. Init placeholders
        docx.init_placeholders();

        // 6. Save our docx file
        docx.save("output.docx");
        println!("✅ File saved: output.docx")
    }
```

![example1](/imgs/example1.png)

# 🚧 Roadmap

- optimize
- Add list and table support

# 🔗Author

Created by Dmitry Dzhugov
`morfyalt@proton.me`