Blyx

Lapwing

Workflow framework · 0.1.0

Preflight fixed-line document pagination with indivisible paragraphs.

Paginate a report with indivisible paragraphs

The first two paragraphs fill a ten-line page. Three lines move to the second page and leave seven available there.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\lapwing.exe --help in PowerShell or ./bin/lapwing --help on Linux and macOS. Running the command with no arguments prints the worked example.

Build from source

With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-lapwing.git
cd blyx-lapwing
blyxc native-run project.blyx -- "4,6,3" 120 10 10 10

Why this framework exists

A report can fit in aggregate yet overflow when a paragraph must stay together. Pack the measured paragraphs into the usable page area. W3C, CSS fragmentation

Install Lapwing in your editor

Extension RahulChaube.blyx-lapwing · 0.1.0

The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.

Create an empty .blyx file, type blyx-lapwing-demo and accept the completion. Choose Blyx: Run File to run the example.

For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Lapwing.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Lapwing 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-lapwing=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/lapwing/main.blyx

To use this package in your application, copy share/blyx/lapwing/vendor/lapwing from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-lapwing.git vendor/lapwing

You can also download Lapwing as a ZIP. Extract its contents into vendor/lapwing.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::lapwing::lapwing;

fn main() {
    let blocks = [4, 6, 3];
    let paper = 120.0;
    let top = 10.0;
    let bottom = 10.0;
    let line = 10.0;
    let result = lapwing_paginate(blocks, paper, top, bottom, line);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

2
3
7
10

API and input requirements

Returns [pages, lines used on final page, unused line slots, printable lines per page]. Blocks are positive paragraph line counts. The host measures text and renders the resulting pages. Invalid arguments and nonfinite results return an empty vector.

APIUse
lapwing_paginate(blocks, paper, top, bottom, line)Returns [pages, lines used on final page, unused line slots, printable lines per page]. Blocks are positive paragraph line counts. The host measures text and renders the resulting pages.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.