Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BenjaminLouis/wimpress
Shiny module to prepare PDF template with CSS for Paged Media
https://github.com/BenjaminLouis/wimpress
Last synced: about 2 months ago
JSON representation
Shiny module to prepare PDF template with CSS for Paged Media
- Host: GitHub
- URL: https://github.com/BenjaminLouis/wimpress
- Owner: BenjaminLouis
- License: other
- Created: 2018-10-18T18:36:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-21T13:41:30.000Z (over 5 years ago)
- Last Synced: 2024-08-13T07:15:17.160Z (5 months ago)
- Language: R
- Size: 71.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - BenjaminLouis/wimpress - Shiny module to prepare PDF template with CSS for Paged Media (R)
README
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://travis-ci.org/BenjaminLouis/wimpress)
[](https://ci.appveyor.com/project/BenjaminLouis/wimpress)
[](https://codecov.io/github/BenjaminLouis/wimpress?branch=master)
# wimpress
The goal of wimpress is to provide a shiny application to help customisation of `PDF` files with [CSS for Paged Media](https://www.w3.org/TR/css-page-3/).
## Workflow
This shiny app strongly relies on the very nice package from [Romain Lesur](https://github.com/RLesur), [weasydoc](https://github.com/RLesur/weasydoc), whose goal is to convert `R Markdown` to `PDF` using [CSS for Paged Media](https://www.w3.org/TR/css-page-3/) converters. As Romain wrote, _`CSS for Paged Media` [...] allows conversion from HTML to PDF using CSS rules._. If you want to learn more about it, Romain gives some usefull references so I strongly recommand to take a look a his package.
Inputs of this shiny app are CSS properties names and values that can be added and changed by users. These inputs became variables for several `sass` language files. [Sass](https://sass-lang.com/) language is a CSS preprocessor language that allows utilisation of variables, loop, conditional statements... with CSS. These files are converted into one CSS file with the help of the [sass](https://github.com/rstudio/sass) [RStudio](https://www.rstudio.com/) package and used in [weasydoc](https://github.com/RLesur/weasydoc) to render the result in a example `PDF` file.
## Installation
You can install the development version of wimpress with:
``` r
#install.packages("devtools")
devtools::install.github("BenjaminLouis/wimpress")
```
Please, be aware that both [weasydoc](https://github.com/RLesur/weasydoc) and [sass](https://github.com/rstudio/sass) are in development and you have to install them to use wimpress. Note that [weasydoc](https://github.com/RLesur/weasydoc) needs extra steps as you need to install [WeasyPrint](https://weasyprint.org/), a CSS for Pages Media converter. Please, refer to the repository of [weasydoc](https://github.com/RLesur/weasydoc) for more information.
## Usage
You can run the shiny app with :
```{r example}
wimpress::run_app()
```
[CSS for Paged Media](https://www.w3.org/TR/css-page-3/) allows to change properties for all PDF pages or only the first, last, left or right pages. Besides, you can change only margin properties of these pages. The margins are split into 16 boxes that can independently received CSS rules : the four corners and a subdivision in three boxes of the top, left, bottom and right margins. This allows for example the definition of header and footer. The example document used to see the results of CSS rules is an explanation of how [CSS for Paged Media](https://www.w3.org/TR/css-page-3/) works and how to use it in this app.
## Code of conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.