Artefact

Description

Artefact is a framework to generate PDF documents in Pharo.

Details

Source

GitHub

Dialect

pharo (65% confidence)

License

MIT

Stars

18

Forks

9

Created

Oct. 2, 2018

Updated

Dec. 31, 2025

Topics

pdf pharo smalltalk

README excerpt

# Artefact
[![Pharo](https://img.shields.io/static/v1?style=for-the-badge&message=Pharo&color=3297d4&logo=Harbor&logoColor=FFFFFF&label=)](https://www.pharo.org) 
[![PDF](https://img.shields.io/static/v1?style=for-the-badge&message=PDF&color=044a64&logo=PDF&logoColor=FFFFFF&label=)]([https://www.sqlite.org](https://en.wikipedia.org/wiki/PDF))

**Artefact** is a framework to generate PDF documents in [Pharo](https://www.pharo.org).

Artefact is written and supported by Olivier Auverlot and Guillaume Larcheveque (aka The Pasta Team) with contributions from Pharo community

[![Unit Tests](https://github.com/pharo-contributions/Artefact/workflows/Build/badge.svg?branch=master)](https://github.com/pharo-contributions/Artefact/actions?query=workflow%3ABuild)
[![Coverage Status](https://codecov.io/github/pharo-contributions/Artefact/coverage.svg?branch=master)](https://codecov.io/gh/pharo-contributions/Artefact/branch/master)

[![Pharo 6](https://img.shields.io/badge/Pharo-6.0-%23aac9ff.svg)](https://pharo.org/download)
[![Pharo 7](https://img.shields.io/badge/Pharo-7.0-%23aac9ff.svg)](https://pharo.org/download)
[![Pharo 8](https://img.shields.io/badge/Pharo-8.0-%23aac9ff.svg)](https://pharo.org/download)
[![Pharo 9](https://img.shields.io/badge/Pharo-9.0-%23aac9ff.svg)](https://pharo.org/download)
[![Pharo 10](https://img.shields.io/badge/Pharo-10-%23aac9ff.svg)](https://pharo.org/download)
[![Pharo 11](https://img.shields.io/badge/Pharo-11-%23aac9ff.svg)](https://pharo.org/download)
[![Pharo 12](https://img.shields.io/badge/Pharo-12-%23aac9ff.svg)](https://pharo.org/download)

## Description

It is fully written in Smalltalk and doesn't require any native library. Artefact is light, platform independant and offer to users a high level of abstraction in order to easily creating PDF documents.

- Completely written in Smalltalk (and only Smalltalk),
- Complete freedom about the order of creation for pages, elements... (no need to follow the document order)
- Multi format and orientation for pages
- Page composition based on reusables PDF elements,
- Extensibility by offering a composition standard to create your own high level elements
- StyleSheet that can be reused in many documents and avoid wasting time and place with duplication
- Image support with JPEG and PNG formats
- Pre-defined high level elements like datagrid
- Support PDF compression to produce compact files

[![Demo](https://img.youtube.com/vi/Jc_Z_YnW2uM/0.jpg)](https://www.youtube.com/watch?v=Jc_Z_YnW2uM)

## Install Artefact 

To install Artefact on your [Pharo](https://www.pharo.org) image you can just execute the following script:

### Load and use:
```Smalltalk
Metacello new
	githubUser: 'pharo-contributions' project: 'Artefact' commitish: 'master' path: 'src';
	baseline: 'Artefact';
	load
```
Check the demo and examples in the *"Artefact-Examples"* package.

### Develop:

If you want to contribut to development load the latest development branch:

```Smalltalk
Metacello new
	githubUser: 'pharo-contributions' project: 'Artefact' commitish: 'development' path: 'src';
	baseline: 'Artefact';
	load
```

### Add Artefact to your project(s):

To add Artefact to your baseline just add this:

```Smalltalk
spec
	baseline: 'Artefact'
	with: [ spec repository: 'github://pharo-contributions/Artefact:master/src' ]
```

Note that you can replace the #master by another branch as #development or a tag as #v1.0.0, #v1.? or #v1.2.? .

## Getting started

To start using Artefact, you should look at the

- [Guide](./docs/Guide.md)
- [Tutorial](./docs/Tutorial.md)