% CARTELLA(1)
% Roberto Ceccarelli - Casasoft
% April 2023

NAME

Cartella - Folder builder using a 20x27 cm paper

SYNOPSIS

Cartella [options]*

DESCRIPTION

This program allows you to create an exploded view of a folder case,
without glued parts, for Carte de Visite.
It has dimensions 105x70mm with a thickness that can be changed by a parameter on the command line.

OPTIONS

-a, –aboveimage=VALUE :
set the image for the top cover

-z, –bottomimage=VALUE :
set the image for the bottom

-l, –leftimage=VALUE :
set the image for the left border

-r, –rightimage=VALUE :
set the image for the right border

-f, –frontimage=VALUE :
set the image for the front

-b, –backimage=VALUE :
set the image for the back

-t, –thickness=VALUE :
set the box thickness (default 5mm)

–bordertext=VALUE :
text to print on left border

–font=VALUE :
text font (default Arial)

–fontbold :
use bold font weight

–fontitalic :
use italic font style

–format=VALUE :
size of the box: ‘cdv’ or ‘cc’ (default ‘CDV’)

–orientation=VALUE :
orientation of the box: ‘portrait’ or ‘landscape’ (
default ‘PORTRAIT’)

–paper=VALUE :
Output paper size:
Large (default) 20x27cm
Medium 15x20cm
A4 210x297mm

–sample :
generate sample images

–fillcolor=VALUE :
set the color used to fill the images
(default #FFFFFF)

–bordercolor=VALUE :
set the color used to border the images
(default #000000)

–dpi=VALUE :
set output resolution (default 300)

–json=VALUE :
parameters in json format,
use –helpjson for sample template
Text can be stored in a file instead of a string
The file must be referenced as ‘@filename’

–script=VALUE :
c# script for custom processing,
use –helpscript for sample template
Text can be stored in a file instead of a string
The file must be referenced as ‘@filename’

-o, –output=VALUE :
set output dir/filename

–extension=VALUE :
file extension for output file (default ‘jpg’)

–tag=VALUE :
extra info for user scripts
Text can be stored in a file instead of a string
The file must be referenced as ‘@filename’

–nobanner :
suppress the banner

-h, –help :
show this message and exit

–helpjson :
show json parameters template

–helpscript :
show script template

–man :
show the man page source and exit

–colors :
list available colors by name

–license :
show program license (AGPL 3.0)

COLORS

Colors can be written in any of these formats:
#rgb
#rrggbb
#rrggbbaa
#rrrrggggbbbb
#rrrrggggbbbbaaaa
colorname (use Cartella –colors to see all available colors)

JSON

Parameters can also be passed with a json formatted string
using the following template:

{
  "topImage": "",
  "bottomImage": "",
  "leftImage": "",
  "rightImage": "",
  "frontImage": "",
  "backImage": "",
  "fontBold": false,
  "fontItalic": false,
  "font": "Arial",
  "borderText": "",
  "spessore": 5,
  "isHorizontal": false,
  "targetFormat": 0,
  "useTestImages": false,
  "Paper": null,
  "FillColor": "#FFFFFF",
  "BorderColor": "#000000",
  "Dpi": 300,
  "OutputName": "",
  "Extension": "jpg",
  "Script": null,
  "Tag": null,
  "FilesList": []
}

ENVIRONMENT VARIABLES

The program can read values from these variables:

CDV_OUTPATH :
Base path for output files

CDV_DPI :
Resolution for output files

CDV_FILL :
Color used to fill images

CDV_BORDER :
Border color

SCRIPTING

You can add custom c# code, compiled at runtime, with the –script parameter. You can call a property engine that exposes all the parameters passed to the main program.

The following using are declared:

using Casasoft.CCDV;
using Casasoft.CCDV.Engines;
using Casasoft.CCDV.JSON;
using ImageMagick;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;

These are the signatures of the scriptable methods:

// Script template for Cartella

/// <summary>
/// Custom class initialization
/// </summary>
public void Init() { }

/// <summary>
/// Image for final output
/// </summary>
/// <returns></returns>
public MagickImage OutputImage() => null;

/// <summary> 
/// Preprocesses the loaded image for Front
/// </summary>
/// <param name="image">The loaded image</param>
/// <returns>The Processed image</returns>
public MagickImage ProcessOnLoadFront(MagickImage image) => image;

/// <summary> 
/// Preprocesses the loaded image for Back
/// </summary>
/// <param name="image">The loaded image</param>
/// <returns>The Processed image</returns>
public MagickImage ProcessOnLoadBack(MagickImage image) => image;

/// <summary> 
/// Preprocesses the loaded image for Top
/// </summary>
/// <param name="image">The loaded image</param>
/// <returns>The Processed image</returns>
public MagickImage ProcessOnLoadTop(MagickImage image) => image;

/// <summary> 
/// Preprocesses the loaded image for Bottom
/// </summary>
/// <param name="image">The loaded image</param>
/// <returns>The Processed image</returns>
public MagickImage ProcessOnLoadBottom(MagickImage image) => image;

/// <summary> 
/// Preprocesses the loaded image for Left
/// </summary>
/// <param name="image">The loaded image</param>
/// <returns>The Processed image</returns>
public MagickImage ProcessOnLoadLeft(MagickImage image) => image;

/// <summary> 
/// Preprocesses the loaded image for Right
/// </summary>
/// <param name="image">The loaded image</param>
/// <returns>The Processed image</returns>
public MagickImage ProcessOnLoadRight(MagickImage image) => image;

COPYRIGHT

Casasoft Casasoft Cartella is free software:
you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

You should have received a copy of the GNU AGPL v.3
along with Casasoft Casasoft Cartella.
If not, see http://www.gnu.org/licenses/.

DISCLAIMER

Casasoft Casasoft Cartella is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.