-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
171 lines (117 loc) · 4.42 KB
/
README.Rmd
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# stylex
<!-- badges: start -->
[](https://codecov.io/gh/niszet/stylex?branch=master)
[](https://travis-ci.com/niszet/stylex)
[](https://travis-ci.org/niszet/stylex)
<!-- badges: end -->
** NOTE ** This package is under an experimental phase. It is still under developping...
`stylex` is an R package to modify style setting in docx file. This is especially for Pandoc's docx input aka `reference.docx`. But any other docx file can be used.
`stylex` package acts as a wrapper functions of `xml2`. This helps you to modify the style object without knowledge of xml2 package behaviour.
## Installation
You can install `stylex` package from [GitHub](https://github.com/niszet/stylex) with:
``` r
remotes::install_github("niszet/stylex")
# or
devtools::install_github("niszet/stylex")
```
## Example 1
`stylex` package provides a way to modify docx file through a data.frame. By changing data.frame, many styles in target file can be modified simultaneously.
```{r example, eval=F}
library(stylex)
# set the complete file path
ref_file = "sample.docx"
# get docx_styles object (styles_node) from style.xml in the docx
style_xml <- read_styles(ref_file)
# transform docx_styles to data.frame format.
d <- style2df(style_xml)
# try to modify by specifing style_id and column name.
d[d$style_id=="1","r_pr_sz_val"] <- "400"
# update docx_style by updated data.frame.
xml <- update_styles_from_df(style_xml, d)
# write the modified docx file.
write_style(xml, ref_file, "modified.docx")
```
## Example 2
Internally, `stylex` package uses functions to each tags in docx file. Users can use these functions by calling with `:::` because these are internal functions.
```{r example2, eval=F}
library(stylex)
ref_file = "sample.docx"
style_xml <- read_styles(ref_file)
# node extract by tag name of "Date".
node <- get_node_by_name(style_xml, "Date")
# users can identify the node by style_id.
# This is more adequate because id is unique in the docx.
# node <- get_node_by_id(style_xml, "1")
# by name, you must write that exactly, i.e. white spaces.
# node <- get_node_by_name(style_xml, "heading 5")
# Set the value by function.
# When node object changes, original xml object is also changed.
stylex:::set_node_tagattr(node, val="42", tag="w:rPr/w:sz", attr="val")
stylex:::set_node_tagattr(node, val="accent2", tag="w:rPr/w:color", attr="themecolor")
stylex:::set_node_tagattr(node, val="2000", tag="w:rPr/w:spacing", attr="before")
stylex:::set_node_tagattr(node, val=TRUE, tag="w:rPr/w:b")
write_style(xml, ref_file, "modified.docx")
```
## Example 3
`stylex` package can create new style based on existing style. Now `create_new_style` is non-exported function.
```{r eval=F}
library(stylex)
file = "sample.docx"
styles_node <- read_styles(file)
node <- get_node_by_name(styles_node, "Author")
stylex::copy_style_from_node(node, "Author_based_new_style")
stylex::add_style_to_styles(styles_node, node)
```
# node structure
## Prepare
You can see the structure of xml node/node_set object by `xml2::xml_structure()` function as following
```{r eval=F}
> xml2::xml_structure(node)
[[1]]
<style [type, styleId]>
<name [val]>
<basedOn [val]>
<next [val]>
<uiPriority [val]>
<qFormat>
<pPr>
<keepNext>
<keepLines>
<spacing [before, after]>
<outlineLvl [val]>
<rPr>
<rFonts [asciiTheme, eastAsiaTheme, hAnsiTheme, cstheme]>
<b>
<bCs>
<color [val, themeColor]>
<sz [val]>
<szCs [val]>
```
This function will be imcorporated into `stylex` package.
# To see nodes of styles
```{r eval=F}
# Because the node is an object of xml2, prior to View it load xml2 package.
library(xml2)
View(node)
```
# Tag and its attributes
`stylex` can modify several tags and its attributes. You can get the full list of pair of tags and its attributes via `stylex:::TAGATTRLIST`.
```{r tagattrlist}
head(stylex:::TAGATTRLIST)
```
You can also get the above list as a data.frame via `stylex:::TAGATTRDF`.
```{r tagattrdf}
head(stylex:::TAGATTRDF)
```