Scripts Included With Scribus

If you select from the menu Script > About Script, you are presented with a file dialog to find the script you would like to find information about. This can be challenging to locate where these scripts are on your system. Here we will show the information about the scripts included with Scribus.

Autoquote

This script transforms typewriter quotes to typographic quotes for a large variety of language conventions.

USAGE

You must have a document open, and a text frame selected.
There will be a valueDialog asking for your language for the quotes,
the default is 'en', but change the default to suit your needs.
Detected errors shut down the script with an appropriate message.

Autoquote2

This is a variation on Autoquote, offering some additional features, including the option to have dialogs in French, and to add spaces between quotes and the text it surrounds.

CHANGELOGS
Original script is quotes.py or autoquotes.py
9 oct 2013 :
The algorithm has been slightly changed for determining
whether a quote is opening or closing
+ it provides the choice for the type of space to add :
none or non-breaking or thin or non-breaking thin
+ spaces are only added when not already there...
+ a french version of the dialogs is included
25 oct 2013 :
choice to change the spaces for already existing correct doublequotes
if 'none' is chosen, then existing spaces inside double quotes are deleted
+ take into account already existing doublequotes for the correct choice open / close of next dquote
+ warning if some open/close inconsistency is detected
for example in « texte " suite »
5 apr 2017 :
+ added new language choice of de-g: German with inverted guillemets for double quotes

LIMITS
- it only acts on the currently selected frame
(todo : acting on more than one selected frame,
or on whole chain of linked text frame would be nice).
- Spaces are not added outside of the quotes.
(that could be a job for another more general typographic tool)

USAGE

You must have a document open, and a text frame selected.
Run script from scribus menu (Script > Run script...)
There will be a dialog asking for the language for the quotes,
Detected errors shut down the script with an appropriate message.
A dialog then asks what is your choice as for spaces.
Follow indications and answer 0, 1, 2 or 3
Another dialog asks whether you want the script to manage
existing correct doublequotes.

CalendarWizard

This is a simple 'Calendar creation wizard' for Scribus. It's a fully rewritten Calendar.py from Scribus examples. Enjoy.

DESCRIPTION & USAGE:

This script needs Tkinter. It will create a GUI with available options
for easy calendar page creation. You'll get new pages with calendar
tables into a new document you are asked for. Position of the
objects in page is calculated with the "golden-ratio" aspect from the
page margins.

Steps to create:

  1. Fill requested values in the Calendar dialog
  2. You will be prompted for new document
  3. You will be prompted for new paragraph style which will be used in calendar text frames. It could be changed later.

There are 2 types of calendar supported:

  1. Classic calendar with one month matrix per page. I suggest here PORTRAIT orientation.
  2. Horizontal event calendar with one week per page with huge place for human inputs. There should be LANDSCAPE imho.
  3. Horizontal event calendar with one week per page with huge place for human inputs. There should be LANDSCAPE imho.

But everything works with both orientations well of course too.

Caption

Creates a text frame (caption) in selected location relative to one or more selected frames.

USAGE

Select one or more object (can be any kind of frame, or even imported vector graphics),
run script. Dialog appears for choosing placement of all caption frames
B/T/R/L (Bottom/Top/Right/Left).
Bottom and Top caption frames are sized to width of parent object and height
of 24 points. Right and Left caption frames sized to 150 points width and
40 points height.

color2csv

ABOUT THIS SCRIPT:

Export Scribus Colors to CSV

color2csv.py allows a user to export the colors of a given scribus document in a csv file.
The file will be a text file with comma separated values in the following format:
"colorname", c,m,y,k
If there is a document opened in scribus, color2csv uses this document as color source.
If there is no document opened in scribus, color2csv displays a file open dialog to allow
the user to chose a scribus file to get the colors from.
Use csv2color to import the colors into a scribus document from a csv file.

ColorChart

ABOUT THIS SCRIPT:

ColorChart.py allows a user to create color charts with all
the colors of a given scribus document.
It generates a color field for each color and a description
of the color, containing the color name, the CMYK values and
the RGB values.
If there is a document opened in scribus, ColorChart uses this
document as color source and creates a new document with the
color chart.
If there is no document opened in scribus, ColorChart displays
a file open dialog to allow the user to chose a scribus file
to generate a colorchart of.
You will be asked to give a name for the color chart. This name
will be displayed in the pages headlines.

csv2color

ABOUT THIS SCRIPT:

Import Colors from a CSV file to Scribus
csv2color.py allows a user to import colors from a given csv file into a scribus document.
The file must be a text file with comma separated values in the following format:
"colorname", c,m,y,k
There must be a document opened in scribus where the colors can be defined in.
If the csv contains one or more color names that already exist in the document,
the colors will be imported with a `*` as prefix.
This script is especially helpful if you want to use CMYK color representations of
color systems like HKS, Pantone or RAL in Scribus. Lots of such CMYK translation tables
can be found on the Web.
One can easily copy such a table into a text file, save it in the obove described format
and import it into a scribus document.
Use color2csv to export the colors from a scribus document into a csv file.

DirectImageImport

This script imports an image and places it on current page.
Image frame is adapted to the picture and set to non-proportional mode,
so some distortion may be seen after import.
To enlarge the image proportionally, press CTRL key while editing.
Tested with scribus 1.3.3.3
Author: Konrad Stania
some modifications 2009 by Gregory Pittman, tested on Scribus 1.3.3.13svn
This newer version uses the Python Imaging Library to get the dimensions of the
image to be imported, and adjusts the frame accordingly. Initially the frame will
be created centered, at 80% of the page's width or height, whichever is smaller.
There is an adjustment to 80% of the height of the page in case this is exceeded
by the initial calculation.

USAGE:

You must have a document open. Run the script, a dialog asks you to choose an
image to load. A proportional frame is automatically created and image loaded,
then adjusted to frame size.

FontSample

DESCRIPTION & USAGE:

This script needs Tkinter. It will create a GUI with an alphabetical list
of fonts using the names as they will be shown in Scribus. User can select
one or more fonts and create an example sheet(s) to print or create a PDF
from. It is heavily commented to make it easier for the user to adjust it
for his / her own needs.
Note: this version needs read/write access to .scribus directory in users
home. You will also need Python Imaging Library (PIL) installed.
If your system does not meet these requirements then change showPreviewPanel
to a value of 0. This will disable the new preview features.

importcsv2table

ABOUT THIS SCRIPT:

Import CSV data files as tables into Scribus

  1. Create any frame of any size on your page but positioned where you want the table to be located (upper left corner)
  2. Make sure it is selected
  3. Execute this script:
    You will be prompted first for the width of the left column in mm, then the right column in mm, then height of all cells, and finally for a csv filename
  4. The data from the csv file will be imported and a table of textboxes will be drawn on the page.

LIMITATIONS:

  1. You are limited to two-column CSV data in your file.
  2. In Scribus versions 1.3.5svn, when the script ends, you cannot adjust text, colors, and line features for a group, whereas in 1.3.3.x, all of these can be done without ungrouping.

HINTS:

Postgresql:
You can easily create a CSV file with a Postgresql database. From Postgresql,
toggle unaligned output with the '\a' switch, then activate a comma as
a separator with '\f ,' (without apostrophes). Send output to a file
with '\o myfile.csv', then query your database.

Sqlite3:
You can use "sqlite3 -csv" in the command line or ".mode csv" in sqlite's
interactive shell.

InfoBox

A simple script for exact placement of a frame (infobox) over the current textbox,
asking the user for the width of the infobox and in which column to place it.

Some enhancements:

USAGE

Select a textframe, start the script and have phun
Default name for the infobox is 'infobox' + name_of_selected_frame, but this can be changed.

Ligatursatz

Unfortunately, this script has no usage information. It appears to be designed to
automatically create ligatures from certain letter combinations, in particular
for the German language.