Beginners Scripts

This article is part of the Scripts series.

Script (w/ Screenshot)	Scripter commands demonstrated
Elementary Rectangle Elementary Rectangle generated from python	newDocument, createRect, setCornerRadius, setLineWidth, setFillColor, setLineColor, saveDocAs
Drawing Circles with Radii Drawing Circles with Radii generated from python	newDocument, createLine, setLineWidth, setLineColor, zoomDocument, saveDocAs
Making a dot gradient Making a dot gradient generated from python	newDocument, createEllipse, setLineWidth, setFillColor, setFillShade, saveDocAs, currentPage, setHGuides, messageBox, statusMessage, progressReset
Adding 'DRAFT' to a document Adding 'DRAFT' to a document generated from python	haveDoc, createLayer, getActiveLayer, setActiveLayer, createText, setUnit, setText, setTextColor, setFontSize, rotateObject
Making layout grid with guides	haveDoc, valueDialog, getUnit, setUnit, getPageSize, getPageMargins,
Creating Markers for positioning and cutting	defineColor, createEllipse, setLineWidth, setLineColor, setFillColor, createLine, getPageSize, createRect
Creating Markers - another version	valueDialog, getColor, getLayers, createLayer, setActiveLayer, setHGuides, setVGuides, getHGuides, getVGuides, createText, setTextColor, insertText, setFontSize, setLineSpacing, defineColor, createRect, groupObjects, createLine, setLineColor, setLineWidth, createEllipse, haveDoc, messageBox
Bleed, create markers and export a document to pdf
Drawing Lines and Python "For loops"	newDocument, createLine, setLineWidth, setLineColor, setFillShade, createRect, saveDocAs
Making margins in Guttenberg way	haveDoc, getUnit, setUnit, getPageSize, getPageMargins, setMargins, messageBox, statusMessage, progressReset
Generate a ten page layout with three columns on each page
Generating a Postnet barcode	haveDoc, setUnit, valueDialog, createLine, setLineWidth, setLineColor, setFillColor
Generating a Code39 Barcode	haveDoc, createLine, setLineWidth, setLineColor, setFillColor, createText, setFont, setFontSize, setTextAlignment, valueDialog, messageBox, docChanged
createColor(), A Standard Form with Barcodes and Custom Entries	newDoc, createLine, setLineWidth, setLineColor, setFillColor, createLayer, setActiveLayer, createText, setFont, setFontSize, setTextAlignment, selectText, setTextDistances, valueDialog, messageBox
Automatically Creating a Graph	haveDoc, valueDialog, createLine, setLineWidth, setLineColor, setFillColor, createText, setTextColor, setText, setTextAlignment, setFont, setFontSize, rotateObject
Creating a Graph, Part 2	haveDoc, valueDialog, setUnit, createLine, setLineWidth, setLineColor, setFillColor, createText, setTextColor, setText, setTextAlignment, setFont, setFontSize
Advanced Graphing	fileDialog, haveDoc, setUnit, valueDialog, createLine, setLineWidth, setLineColor, setFillColor, createPolyLine
Making a Pie Chart	valueDialog, messageBox, haveDoc, importSVG – much of the script involves mathematical calculations
Import an image in the way office-programs do	getPageSize, fileDialog, createImage, setScaleImageToFrame, setFillColor, setLineColor, getImageScale, sizeObject, haveDoc, messageBox This is an old script (Scribus 1.3.3.3), so be sure to check the precise names of commands. If you find errors, let us know or edit the wiki page to correct.
Drawing a grid	messageBox, createLine, setLineColor, haveDoc, statusMessage, progressReset There is a minor usage of Scribus commands here, but it does show how to set up a Tkinter dialog for multiple variable entry.
Importing addresses from a text file	newDoc, newPage, createText, setText, setTextAlignment, setFont, setFontSize This is almost a script fragment even though it could work on its own. What it shows is the basic operation to import information from a simple structured text file and incorporate into a document. Could be adapted for mail merge, for example.
Scale an Image to Fill a Frame Proportionally	haveDoc, selectionCount, getSelectedObject, setScaleImageToFrame, getImageScale, scaleImage, docChanged
Align an Image in its Frame
Image Wizard: Scale and Align an Image
Image Wizard Advanced
Split Image Across Gutter
Discovering an Item's Properties	not sure if this script works
Un-Flip all Selected Items	haveDoc, selectionCount, getSelectedObject, setProperty, moveObject, docChanged
Remove Magenta Color	replaceColor, docChanged This is a "script-let" really, but quickly shows how to change or delete colors in a document. No checking for errors.
Extracting All Text from a Document	haveDoc, fileDialog, messageBox, pageCount, getPageItems, gotoPage, getAllText, getImageFile
Convert RGB value to Hex	valueDialog, messageBox This is a utility that just happens to run in Scribus, using the valueDialog and messageBox to do what the title says.
Color Chart	getPageSize, getPageMargins, createText, setFontSize, setTextAlignment, insertText, getColorNames, statusMessage, progressTotal, getColor, progressSet, haveDoc, openDoc, fileDialog, messageBox, getColorsFromDocument, newDocument, setUnit, deleteColor, defineColor, valueDialog, newPage, createRect, setFillColor, setLineColor
Book Spine Calculator	messageBox, valueDialog
create tables out of csv data
Reduce the size of Scribus generated PDFs
Convert Typewriter Quotes to Typographic Quotes
Autoquote2 – a new and improved Autoquote.py
copyObject() and pasteObject()	haveDoc, selectionCount, messageBox, valueDialog, getSelectedObject, pageCount, currentPage, gotoPage. Also shows use of Python split function for parsing the input from valueDialog. copyObject and pasteObject are new commands that you will only have once you follow the directions to install them into your svn directory and rebuild Scribus.
Convert RGB imported colors to CMYK	getColors(), defineColor(), replaceColor(), deleteColor()
Convert all colors to CMYK	getColors(), defineColor(), replaceColor(), deleteColor()