Skip to content

Commit

Permalink
Try to better align with plugin-readme guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
carstingaxion committed May 28, 2024
1 parent a607b2d commit 45a21b7
Showing 1 changed file with 56 additions and 55 deletions.
111 changes: 56 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# Label Printing

Requires at least: 6.2
Tested up to: 6.3.1
Requires PHP: 7.4
Stable tag: 0.2.0
License: GPL3+
Contributors: carstenbach
Stable tag: 0.2.1
Tested up to: 6.5.3
Requires at least: 6.3
Requires PHP: 8.1
License: GPL v3 or later
Tags: Label, print, print.css, block

Contributors: carstenbach

![](.wordpress-org/banner-1544x500.png)

Expand Down Expand Up @@ -116,7 +115,7 @@ The installation process for the ***Label Printing* block** plugin is straightfo

### Installation from within WordPress

1. Visit **Plugins** > Add New**.
1. Visit **Plugins** > **Add New**.
2. Search for **Label Printing**.
3. Install and activate the Label Printing plugin.

Expand All @@ -128,55 +127,60 @@ The installation process for the ***Label Printing* block** plugin is straightfo

### Install via composer

1. Install via command line
```sh
composer require figuren-theater/label-printing
```
1. Install via command line `composer require figuren-theater/label-printing`
2. Visit **Plugins**.
3. Activate the Label Printing plugin.

## Screenshots

1. Insert the Label Printing block
2. Choose your pre-defined Label
3. Switch visually between different label presets
4. Fill in your label content
5. Check everything in your browsers print dialog, exclude pages with header and footer and finally print your labels.

## Frequently Asked Questions

### What are default label sizes that will be created?

The default labels, if not changed via the `Figuren_Theater\Label_Printing\Patterns\bootstrap_labels` filter, are:

```php
$bootstrap_labels = [
[
'name' => 'A6 Landscape',
'width' => 148,
'height' => 105,
'a4_border_tb' => 0,
'a4_border_lr' => 0,
'orientation' => 'landscape',
],
[
'name' => 'A6 Landscape (with Top-Bottom-Borders)',
'width' => 148,
'height' => 90,
'a4_border_tb' => 15,
'a4_border_lr' => 0,
'orientation' => 'landscape',
],
[
'name' => 'A8 Portrait',
'width' => 52.5,
'height' => 74,
'a4_border_tb' => 0,
'a4_border_lr' => 0,
'orientation' => 'portrait',
],
[
'name' => 'A8 Landscape',
'width' => 74,
'height' => 52.5,
'a4_border_tb' => 0,
'a4_border_lr' => 0,
'orientation' => 'landscape',
],
];
```
`
\$bootstrap_labels = [
[
'name' => 'A6 Landscape',
'width' => 148,
'height' => 105,
'a4_border_tb' => 0,
'a4_border_lr' => 0,
'orientation' => 'landscape',
],
[
'name' => 'A6 Landscape (with Top-Bottom-Borders)',
'width' => 148,
'height' => 90,
'a4_border_tb' => 15,
'a4_border_lr' => 0,
'orientation' => 'landscape',
],
[
'name' => 'A8 Portrait',
'width' => 52.5,
'height' => 74,
'a4_border_tb' => 0,
'a4_border_lr' => 0,
'orientation' => 'portrait',
],
[
'name' => 'A8 Landscape',
'width' => 74,
'height' => 52.5,
'a4_border_tb' => 0,
'a4_border_lr' => 0,
'orientation' => 'landscape',
],
];
`

### Why should I use a `blank.php` template

Expand Down Expand Up @@ -222,13 +226,10 @@ Depending on your selected **pre-defined label** the `…/label-proxy` block wil
- de_DE
- de_DE_formal

## Screenshots
## Upgrade Notice

1. Insert the Label Printing block
2. Choose your pre-defined Label
3. Switch visually between different label presets
4. Fill in your label content
5. Check everything in your browsers print dialog, exclude pages with header and footer and finally print your labels.
(silence is golden)

<!-- changelog -->
## Changelog

<!-- changelog -->

0 comments on commit 45a21b7

Please sign in to comment.