Metadata-Version: 2.4
Name: fiduswriter-vivliostyle
Version: 5.0.0a1
Summary: Fidus Writer print engine extra: adds the AGPL licensed @vivliostyle/print pagination engine for printing and PDF export.
Author-email: Johannes Wilm <johannes@fiduswriter.org>
License-Expression: AGPL-3.0-or-later
Project-URL: repository, https://git.fiduswriter.org/fiduswriter/fiduswriter-vivliostyle-plugin
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 6.0
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# fiduswriter-vivliostyle

This is the Fidus Writer plugin package that adds
[@vivliostyle/print](https://www.npmjs.com/package/@vivliostyle/print) — via
the [vivliostyle-pdf](https://www.npmjs.com/package/vivliostyle-pdf) wrapper
package — as the pagination engine for printing and PDF export.

It is distributed as the `fiduswriter-vivliostyle` package on PyPI and is
installed as an extra of the main Fidus Writer package:

```bash
pip install fiduswriter[vivliostyle]
```

After installing, run `fiduswriter setup` again so that the JavaScript
dependencies are re-installed and the bundle is regenerated.

The default pagination engine is
[paged-with-floats](https://www.npmjs.com/package/paged-with-floats)
(LGPL-3.0), which needs no extra package. Installing this package switches the
engine to vivliostyle-pdf (which wraps the AGPL licensed
`@vivliostyle/print`) and adds it to the JavaScript bundle. The engine selection can be overridden from `configuration.py`:

```python
PRINT_ENGINE = "paged-with-floats"  # keep the default engine even though
                                    # fiduswriter-vivliostyle is installed
```

Uninstalling `fiduswriter-vivliostyle` and re-running `fiduswriter setup`
reverts to the default engine and removes the AGPL code from the bundle.

Note on licensing: `@vivliostyle/print` is AGPL-3.0. Use the default
paged-with-floats engine if you cannot include AGPL code in your deployment
(for example for a plugin distributed through wordpress.org).
