├── PhotoBookTools.jpg ├── PhotoBookTools ├── Instructions.pdf ├── PhotoBookLayoutMaker.cfg ├── PhotoBookFillFramesCentered.py ├── PhotoBookImageCropResize.py └── PhotoBookLayoutMaker.py ├── README.md └── LICENSE /PhotoBookTools.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RaffertyR/PhotoBookTools-for-Scribus/HEAD/PhotoBookTools.jpg -------------------------------------------------------------------------------- /PhotoBookTools/Instructions.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RaffertyR/PhotoBookTools-for-Scribus/HEAD/PhotoBookTools/Instructions.pdf -------------------------------------------------------------------------------- /PhotoBookTools/PhotoBookLayoutMaker.cfg: -------------------------------------------------------------------------------- 1 | [DEFAULT] 2 | cols = 2 3 | rows = 1 4 | gap = 5.0 5 | aspectwidth = 0 6 | aspectheight = 0 7 | scale = 100.0 8 | alignh = Center 9 | alignv = Center 10 | caption = 0 11 | captionh = 5.0 12 | removeframe = 1 13 | alternateborder = 0 14 | 15 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PhotoBookTools-for-Scribus 2 | 3 | ‘PhotoBook Tools’ is a collection of scripts and tricks intended to create photo album pages in a fast and flexible way with Scribus. Please read the ‘Instructions’-file for installation and use! 4 | 5 | Summary of workflow: 6 | 1) ‘PhotoBookLayoutMaker’-script generates image frame layouts (you can save them in the Scrapbook for future use). 7 | 2) Insert images in bulk into your image frames. 8 | 3) ‘PhotoBookFillFramesCentered’-script performs automatically a maximal fill of the selected image frames. If needed you can manually adjust. 9 | 4) ‘PhotoBookImageCropResize’-script will crop your images to the image frames and resize them to the desired dpi (reduction of file size). 10 | 5) Edit caption texts (if you have created them in step 1). 11 | 6) Export your photo book to pdf or other formats. 12 | 13 | A little demo video: https://www.youtube.com/watch?v=3bcF4KhCCJg 14 | 15 | For Scribus 1.5.6 and higher (needs Python 3; tested in Windows 10 and Linux). 16 | 17 | ![PhotoBookTools.jpg](https://raw.githubusercontent.com/RaffertyR/PhotoBookTools-for-Scribus/main/PhotoBookTools.jpg) 18 | -------------------------------------------------------------------------------- /PhotoBookTools/PhotoBookFillFramesCentered.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | 4 | """ 5 | VERSION: 1.0 of 2021-07-31 6 | AUTHOR: Rafferty River. 7 | LICENSE: GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007. 8 | This program is distributed in the hope that it will be useful, 9 | but WITHOUT ANY WARRANTY. 10 | 11 | DESCRIPTION & USAGE: 12 | This script loops over every selected object, and for all image frames that 13 | are not empty, it scales the image proportionally, filling the entire frame 14 | with your image. This means that some of the image will be cropped by 15 | the frame in either the horizontal or vertical dimension. Then the scaled 16 | image will be centered in its frame. 17 | 18 | This is an adapted version of an old Scribus script from Jeremy Brown. 19 | """ 20 | ################################################## 21 | 22 | from scribus import * 23 | 24 | if haveDoc(): 25 | nbrSelected = selectionCount() 26 | else: 27 | scribus.messageBox("Error: No document open", 28 | "Please, create (or open) a document before running this script ...", 29 | scribus.ICON_WARNING,scribus.BUTTON_OK) 30 | sys.exit(1) 31 | 32 | scribus.progressTotal(nbrSelected) 33 | # since there is an issue with units other than points, we switch to points then restore later. 34 | restore_units = scribus.getUnit() 35 | scribus.setUnit(0) 36 | 37 | objList = [] 38 | for i in range(nbrSelected): 39 | objList.append(getSelectedObject(i)) 40 | 41 | for i in range(nbrSelected): 42 | try: 43 | scribus.progressSet(i) 44 | obj = objList[i] 45 | setScaleImageToFrame(True, False, obj) 46 | setScaleImageToFrame(False, False, obj) 47 | scale = getImageScale(obj) 48 | max_scale = max(scale) 49 | setImageScale(max_scale, max_scale, obj) 50 | # center scaled image in frame: 51 | frameX, frameY = getPosition(obj) 52 | frameWidth, frameHeight = getSize(obj) 53 | setImageOffset((frameWidth * (1 - max_scale / scale[0])) / 2, 54 | (frameHeight * (1 - max_scale / scale[1])) / 2, obj) 55 | docChanged(1) 56 | setRedraw(True) 57 | except: 58 | nothing = "nothing" 59 | 60 | scribus.setUnit(restore_units) 61 | scribus.progressReset() 62 | -------------------------------------------------------------------------------- /PhotoBookTools/PhotoBookImageCropResize.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env python 2 | #-*- coding: utf-8 -*- 3 | ''' 4 | VERSION: 1.0 of 2021-07-31 5 | AUTHOR: Rafferty River. 6 | LICENSE: GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007. 7 | This program is distributed in the hope that it will be useful, 8 | but WITHOUT ANY WARRANTY. 9 | 10 | DESCRIPTION & USAGE: 11 | This script loops over every selected object, and for all image 12 | frames that are not empty, it will crop and resize a COPY of 13 | the image file and add the suffix "_cropped" to it. 14 | 15 | This is a reworked version of an old Scribus script 16 | 'Image_crop_resize_and_color_conversion_GUI.py' of 17 | prof. MS. José Antonio Meira da Rocha of 2011-01-05a with 18 | License GPL. 19 | 20 | IMPORTANT REMARK: this script needs the Pillow (PIL) package 21 | to be installed in (Scribus) Python (https://python-pillow.org). 22 | ''' 23 | ################################################## 24 | # imports 25 | import sys, os 26 | 27 | try: 28 | from scribus import * 29 | except ImportError: 30 | scribus.messageBox("Script failed", 31 | "This Python script can only be run from within Scribus.", 32 | scribus.ICON_WARNING,scribus.BUTTON_OK) 33 | sys.exit(1) 34 | 35 | try: 36 | from tkinter import * # python 3 syntax 37 | #from tkinter import messagebox 38 | from tkinter import ttk # for ComboBox 39 | except ImportError: 40 | print("This script requires Python Tkinter properly installed.") 41 | messageBox('Script failed', 42 | 'This script requires Python Tkinter properly installed.', 43 | ICON_CRITICAL) 44 | sys.exit(1) 45 | 46 | try: 47 | # if PIL-package installed but not found, uncomment one of following lines: 48 | #sys.path.append('C:\\Users\\Python37\\Lib\\site-packages') # Windows 49 | #sys.path.append('/usr/lib/python3/dist-packages') # Linux 50 | from PIL import Image 51 | except ImportError: 52 | scribus.messageBox("Script failed", 53 | "This script needs the PIL (Pillow) package \n\ 54 | (compatible to your Python version) to be installed.", 55 | scribus.ICON_CRITICAL,scribus.BUTTON_OK) 56 | sys.exit(1) 57 | 58 | ################################################## 59 | class ScPhotoBookImageCropResize: 60 | """ PhotoBookImageCropResize itself.""" 61 | 62 | def __init__(self, resolution='300', mode='RGB', fileFormat='.jpg', resample='BICUBIC'): 63 | """ Setup basic things """ 64 | self.resolution = resolution 65 | if mode == 'B&W': 66 | self.mode = '1' 67 | elif mode == 'Grey scale': 68 | self.mode = 'L' 69 | else: 70 | self.mode = mode 71 | self.fileFormat = fileFormat 72 | self.resample = resample 73 | 74 | def handleImage(self, imageFrame): 75 | """ Crop, resize, convert and save Image function.""" 76 | imgFile = scribus.getImageFile(imageFrame) 77 | try: 78 | image = Image.open(imgFile) 79 | # Calculate DPI 80 | unit = scribus.getUnit() 81 | scribus.setUnit(UNIT_INCHES) 82 | imageResolution = int(self.resolution) 83 | frameSizeX,frameSizeY = scribus.getSize(imageFrame) 84 | newWidth = int(frameSizeX * imageResolution) 85 | newHeight = int(frameSizeY * imageResolution) 86 | scribus.setUnit(UNIT_POINTS) 87 | 88 | # Calculate cropping 89 | imageXOffset = scribus.getProperty(imageFrame,'imageXOffset') 90 | imageYOffset = scribus.getProperty(imageFrame,'imageYOffset') 91 | frameSizeX,frameSizeY = scribus.getSize(imageFrame) 92 | imageXScale = scribus.getProperty(imageFrame,'imageXScale') 93 | imageYScale = scribus.getProperty(imageFrame,'imageYScale') 94 | imageSizeX, imageSizeY = image.size 95 | 96 | # calculate crop box 97 | left = int(imageXOffset * -1) 98 | top = int(imageYOffset * -1) 99 | right = int(left + (frameSizeX / imageXScale)) 100 | bottom = int(top + (frameSizeY / imageYScale)) 101 | 102 | # Limit crop to image area 103 | # (avoid black areas due to crop bigger than image) 104 | if right > imageSizeX: 105 | right = imageSizeX 106 | if bottom > imageSizeY: 107 | bottom = imageSizeY 108 | if imageXOffset > 0: 109 | left = 0 110 | if imageYOffset > 0: 111 | top = 0 112 | 113 | # Recalculate new image dimensions 114 | # to fit proportionaly 115 | proportionX = newWidth / (right-left) 116 | proportionY = newHeight / (bottom-top) 117 | if proportionX > proportionY: 118 | newHeight = int(newWidth * (bottom-top) /(right-left)) 119 | else: 120 | newWidth = int(newHeight * (right-left) / (bottom-top)) 121 | 122 | # Cropping 123 | newImage = image.crop((left,top,right,bottom)) 124 | 125 | # Resize 126 | if self.resample == 'BICUBIC': 127 | newImage = newImage.resize((newWidth,newHeight),Image.BICUBIC) 128 | elif self.resample == 'LANCZOS': 129 | newImage = newImage.resize((newWidth,newHeight),Image.LANCZOS) 130 | else: 131 | newImage = newImage.resize((newWidth,newHeight),Image.BILINEAR) 132 | 133 | # Color space conversion 134 | if newImage.mode != self.mode: 135 | newImage = newImage.convert(self.mode) 136 | 137 | # Save new image with suffix '_cropped' 138 | scribus.setUnit(unit) # restore original document unit 139 | name,ext = os.path.splitext(imgFile) 140 | newImageFile = (name + '_cropped'+ self.fileFormat) 141 | if os.path.exists(newImageFile): 142 | overwrite = scribus.messageBox('Warning:','Overwrite '+newImageFile+'?', 143 | ICON_WARNING, button2=scribus.BUTTON_NO, button1=scribus.BUTTON_YES) 144 | if int(overwrite) > 16384: # BUTTON_NO was clicked 145 | return 146 | newImage.save(newImageFile, dpi=(imageResolution,imageResolution)) 147 | 148 | # Reload new image in image frame 149 | scribus.loadImage(newImageFile,imageFrame) 150 | 151 | except: 152 | scribus.messageBox('Warning:', imgFile + '\n will be skipped (processing error).', 153 | ICON_WARNING, BUTTON_OK) 154 | return 155 | 156 | def handleSelection(self): 157 | """ Handle selected frames.""" 158 | selectionList = [] 159 | nbrSelected = scribus.selectionCount() 160 | scribus.progressTotal(nbrSelected) 161 | if nbrSelected == 0: 162 | scribus.messageBox('Warning', 'Nothing selected', ICON_WARNING) 163 | else: # one or more items selected 164 | for i in range (0, selectionCount()): 165 | scribus.progressSet(i) 166 | obj = getSelectedObject(i) 167 | selectionList.append(obj) 168 | objectType = getObjectType(obj) 169 | if objectType == 'Group': 170 | messageBox('Warning', 'Grouped items will be skipped.\nPlease ungroup "' 171 | +obj+'" and try again.', ICON_WARNING) 172 | elif (objectType == 'ImageFrame') and (getImageFile(obj) != ""): 173 | self.handleImage(obj) 174 | else: # not an image frame -> skip 175 | pass 176 | return 177 | 178 | ################################################## 179 | class TkPhotoBookImageCropResize(Frame): 180 | """ GUI interface for PhotoBookImageCropResize.py with Tkinter""" 181 | 182 | def __init__(self, master=None): 183 | """ Setup the dialog """ 184 | Frame.__init__(self, master) 185 | self.grid() 186 | self.master.resizable(0, 0) 187 | self.master.title('Crop and Resize') 188 | 189 | # define variables 190 | self.statusVar = StringVar(self, value='Enter Options and press OK.') 191 | self.statusLabel = Label(self, fg="red", textvariable=self.statusVar) 192 | self.resolutionLabel = Label(self, text='Resolution: ') 193 | self.resolutionVar = ttk.Combobox(self, values = ['72','75','96','144','150', 194 | '200','288','300','600','1200'], width=9) 195 | self.modeLabel = Label(self, text='Color mode: ') 196 | self.modeVar = ttk.Combobox(self, values = ['RGB','CMYK','B&W','Grey scale'], width=9) 197 | self.fileFormatLabel = Label(self, text='File format: ') 198 | self.fileFormatVar = ttk.Combobox(self, values = ['.jpg','.png','.tif'], width=9) 199 | self.resampleLabel = Label(self, text='Resampling: ') 200 | self.resampleVar = ttk.Combobox(self, values = ['BICUBIC','BILINEAR','LANCZOS'], width=9) 201 | self.okButton = Button(self, text="OK", width=6, command=self.okButton_pressed) 202 | self.cancelButton = Button(self, text="Cancel", command=self.quit) 203 | 204 | # set default values 205 | self.resolutionVar.set('300') 206 | self.modeVar.set('RGB') 207 | self.fileFormatVar.set('.jpg') 208 | self.resampleVar.set('BICUBIC') 209 | 210 | # make interface layout 211 | self.columnconfigure(0, pad=6) 212 | currRow = 0 213 | self.statusLabel.grid(column=0, row=currRow, columnspan=2) 214 | currRow += 1 215 | self.resolutionLabel.grid(column=0, row=currRow, sticky=S+E) 216 | self.resolutionVar.grid(column=1, row=currRow, sticky=S+W) 217 | currRow += 1 218 | self.modeLabel.grid(column=0, row=currRow, sticky=S+E) 219 | self.modeVar.grid(column=1, row=currRow, sticky=S+W) 220 | currRow += 1 221 | self.fileFormatLabel.grid(column=0, row=currRow, sticky=S+E) 222 | self.fileFormatVar.grid(column=1, row=currRow, sticky=S+W) 223 | currRow += 1 224 | self.resampleLabel.grid(column=0, row=currRow, sticky=S+E) 225 | self.resampleVar.grid(column=1, row=currRow, sticky=S+W) 226 | currRow += 1 227 | self.rowconfigure(currRow, pad=6) 228 | self.cancelButton.grid(column=0, row=currRow, sticky=E) 229 | self.okButton.grid(column=1, row=currRow, sticky=W) 230 | 231 | def okButton_pressed(self): 232 | """ Do PhotoBookImageCropResize """ 233 | 234 | spbicr = ScPhotoBookImageCropResize(self.resolutionVar.get(), 235 | self.modeVar.get(), self.fileFormatVar.get(), self.resampleVar.get()) 236 | self.master.withdraw() 237 | err = spbicr.handleSelection() 238 | 239 | if err != None: 240 | self.master.deiconify() 241 | self.statusVar.set(err) 242 | else: 243 | self.quit() 244 | 245 | def quit(self): 246 | self.master.destroy() 247 | 248 | ################################################## 249 | # Start program 250 | 251 | def main(): 252 | if scribus.haveDoc() == 0: 253 | scribus.messageBox("Script failed", 254 | "Please open a Scribus document before running this script.", 255 | scribus.ICON_WARNING,scribus.BUTTON_OK) 256 | return 257 | 258 | try: 259 | scribus.statusMessage('Running script...') 260 | scribus.progressReset() 261 | unit = scribus.getUnit() 262 | root = Tk() 263 | app = TkPhotoBookImageCropResize(root) 264 | root.mainloop() 265 | finally: 266 | if scribus.haveDoc(): 267 | scribus.redrawAll() 268 | scribus.setUnit(unit) 269 | scribus.statusMessage('Done.') 270 | scribus.progressReset() 271 | 272 | if __name__ == '__main__': 273 | main() 274 | -------------------------------------------------------------------------------- /PhotoBookTools/PhotoBookLayoutMaker.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | 4 | """ 5 | VERSION: 1.0 of 2021-07-31 6 | AUTHOR: Rafferty River. 7 | LICENSE: GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007. 8 | This program is distributed in the hope that it will be useful, 9 | but WITHOUT ANY WARRANTY. 10 | 11 | DESCRIPTION & USAGE: 12 | (tested on Scribus 1.5.6+ with Python 3 on Windows 10 and Linux). 13 | 14 | PhotoBookLayoutMaker is a script for creating Image Frames in Scribus in 15 | a fast and flexible way. Many options are available in the interface. 16 | """ 17 | ################################################## 18 | # imports 19 | import sys, platform, os 20 | from configparser import ConfigParser 21 | 22 | try: 23 | from scribus import * 24 | except ImportError: 25 | print("This Python script is written for the Scribus \ 26 | scripting interface.") 27 | print("It can only be run from within Scribus.") 28 | sys.exit(1) 29 | 30 | python_version = platform.python_version() 31 | if python_version[0:1] != "3": 32 | print("This script runs only with Python 3.") 33 | messageBox("Script failed", 34 | "This script runs only with Python 3.", 35 | ICON_CRITICAL) 36 | sys.exit(1) 37 | 38 | try: 39 | from tkinter import * # python 3 syntax 40 | from tkinter import messagebox 41 | from tkinter import ttk # for ComboBox 42 | 43 | except ImportError: 44 | print("This script requires Python Tkinter properly installed.") 45 | messageBox('Script failed', 46 | 'This script requires Python Tkinter properly installed.', 47 | ICON_CRITICAL) 48 | sys.exit(1) 49 | 50 | ################################################## 51 | class ScPhotoBookLayoutMaker: 52 | """ PhotoBookLayoutMaker itself.""" 53 | 54 | def __init__(self, cols=0, rows=0, gap=0.0, aspectratio=0, scale=0.0, 55 | alignh="", alignv="", captionh=0.0, removeframe=1, alternateborder=0): 56 | """ Setup basic things """ 57 | # params 58 | self.cols = cols 59 | self.rows = rows 60 | self.gap = gap 61 | self.aspectratio = aspectratio 62 | self.scale = scale / 100 63 | self.alignh = alignh 64 | self.alignv = alignv 65 | self.captionh = captionh 66 | self.removeframe = removeframe 67 | self.alternateborder = alternateborder 68 | defineColorCMYK("frameFillColor", 0, 0, 0, 64) # default is Light Grey 69 | 70 | # create 2 frame border styles (line width is measured in points) 71 | defineColorCMYK("frameBorderColor1", 0, 0, 0, 200) # default is Dark Grey 72 | self.frameBorderLineStyle1 = "frameBorderLineStyle1" 73 | createCustomLineStyle(self.frameBorderLineStyle1, [ 74 | { 75 | 'Color': "frameBorderColor1", 76 | 'Width': 1 77 | } 78 | ]); 79 | defineColorCMYK("frameBorderColor2", 0, 0, 0, 0) # default is White 80 | self.frameBorderLineStyle2 = "frameBorderLineStyle2" 81 | createCustomLineStyle(self.frameBorderLineStyle2, [ 82 | { 83 | 'Color': "frameBorderColor2", 84 | 'Width': 1 85 | } 86 | ]); 87 | 88 | # create character and paragraph style for caption text (if needed) 89 | if self.captionh != 0: 90 | unit = [pt, mm, inch, p, cm, c] # Scribus units 91 | self.cStyleCaption = "characterStyleCaptionText" 92 | scribus.createCharStyle(name=self.cStyleCaption, 93 | fontsize=abs(self.captionh / unit[getUnit()]) // 1.5) 94 | self.pStyleCaption = "paragraphStyleCaptionText" 95 | scribus.createParagraphStyle(name=self.pStyleCaption, linespacingmode=0, 96 | alignment=ALIGN_CENTERED, charstyle=self.cStyleCaption) 97 | 98 | def createLayout(self): 99 | """ Draw image frame(s) within a rectangular selection or within page margins.""" 100 | 101 | # current page measures 102 | pageWidth, pageHeight = getPageNSize(currentPage()) 103 | marginTop, marginLeft, marginRight, marginBottom = getPageNMargins(currentPage()) 104 | 105 | # source frame measures 106 | selectionList = [] 107 | nbrSelected = scribus.selectionCount() 108 | if nbrSelected == 0: # nothing selected: select area within page margins 109 | frameX = marginLeft 110 | frameY = marginTop 111 | frameWidth = pageWidth - marginLeft - marginRight 112 | frameHeight = pageHeight - marginTop - marginBottom 113 | else: # one or more items selected 114 | for i in range (0, nbrSelected): 115 | obj = getSelectedObject(i) 116 | selectionList.append(obj) 117 | if getObjectType(obj) == 'Group': 118 | messageBox('Warning', 'Grouped items are not allowed as source.\nPlease ungroup "' 119 | +obj+'" and try again.', ICON_CRITICAL) 120 | sys.exit(1) 121 | frameX, frameY = getPosition(obj) 122 | frameWidth, frameHeight = getSize(obj) 123 | if i == 0: 124 | posXmin, posYmin = getPosition(obj) 125 | posXmax = posXmin + frameWidth 126 | posYmax = posYmin + frameHeight 127 | else: 128 | if frameX < posXmin: 129 | posXmin = frameX 130 | if frameY < posYmin: 131 | posYmin = frameY 132 | if frameX + frameWidth > posXmax: 133 | posXmax = frameX + frameWidth 134 | if frameY + frameHeight > posYmax: 135 | posYmax = frameY + frameHeight 136 | frameX = posXmin 137 | frameY = posYmin 138 | frameWidth = posXmax - posXmin 139 | frameHeight = posYmax - posYmin 140 | 141 | # generated frame(s) measures 142 | newFrameW = (self.scale * frameWidth - (self.gap * (self.cols - 1))) / self.cols 143 | if self.captionh > 0: 144 | newFrameH = (self.scale * frameHeight - self.gap * (self.rows - 1) - self.captionh * self.rows) / self.rows 145 | else: 146 | newFrameH = (self.scale * frameHeight - (self.gap * (self.rows - 1))) / self.rows 147 | newAspectR = newFrameW / newFrameH 148 | 149 | # aspect ratio 150 | if self.aspectratio == 0.0: 151 | pass 152 | else: 153 | if self.aspectratio < newAspectR: 154 | newFrameW = newFrameH * self.aspectratio 155 | else: 156 | newFrameH = newFrameW / self.aspectratio 157 | 158 | # alignment 159 | if self.alignh == "Center": 160 | offsetX = frameX + (frameWidth - newFrameW * self.cols - self.gap * (self.cols - 1))/2 161 | elif self.alignh == "Right": 162 | offsetX = frameX + frameWidth - newFrameW * self.cols - self.gap * (self.cols - 1) 163 | else: 164 | offsetX = frameX 165 | if self.alignv == "Center": 166 | if self.captionh > 0: 167 | offsetY = frameY + (frameHeight - (newFrameH + self.captionh) * self.rows - self.gap * (self.rows - 1))/2 168 | else: 169 | offsetY = frameY + (frameHeight - newFrameH * self.rows - self.gap * (self.rows - 1))/2 170 | elif self.alignv == "Bottom": 171 | if self.captionh > 0: 172 | offsetY = frameY + frameHeight - (newFrameH + self.captionh) * self.rows - self.gap * (self.rows - 1) 173 | else: 174 | offsetY = frameY + frameHeight - newFrameH * self.rows - self.gap * (self.rows - 1) 175 | else: 176 | offsetY = frameY 177 | 178 | # border style 179 | if self.alternateborder: 180 | frameBorderLineStyle = self.frameBorderLineStyle2 181 | else: 182 | frameBorderLineStyle = self.frameBorderLineStyle1 183 | 184 | # draw the frames 185 | for i in range (1, self.cols + 1): 186 | resetY = offsetY 187 | for j in range (1, self.rows + 1): 188 | newFrame = createImage(offsetX, offsetY, newFrameW, newFrameH) 189 | setFillColor("frameFillColor", newFrame) 190 | setCustomLineStyle(frameBorderLineStyle, newFrame) 191 | # draw caption text (if needed): 192 | if self.captionh != 0: 193 | if self.captionh > 0: 194 | captionTxt = createText(offsetX, offsetY + newFrameH, newFrameW, self.captionh) 195 | offsetY = offsetY + self.captionh 196 | else: #self.captionh < 0 197 | captionTxt = createText(offsetX, offsetY + newFrameH + self.captionh, 198 | newFrameW, - self.captionh) 199 | setText(newFrame, captionTxt) 200 | selectObject(captionTxt) 201 | setParagraphStyle(self.pStyleCaption, captionTxt) 202 | setTextVerticalAlignment(ALIGNV_CENTERED, captionTxt) 203 | offsetY = offsetY + self.gap + newFrameH 204 | offsetX = offsetX + self.gap + newFrameW 205 | j = 1 206 | offsetY = resetY 207 | 208 | # remove source items 209 | if self.removeframe: 210 | for i in range (0, len(selectionList)): 211 | deleteObject(selectionList[i]) 212 | else: 213 | pass 214 | 215 | return None 216 | 217 | ################################################## 218 | class TkPhotoBookLayoutMaker(Frame): 219 | """ GUI interface for PhotoBook Layout Maker with Tkinter""" 220 | 221 | def __init__(self, master=None): 222 | """ Setup the dialog """ 223 | Frame.__init__(self, master) 224 | self.grid() 225 | self.master.resizable(0, 0) 226 | self.master.title('Scribus PhotoBook Layout Maker') 227 | 228 | # define variables 229 | self.statusVar = StringVar(self, value='Enter Values and Options and press OK.') 230 | self.statusLabel = Label(self, fg="red", textvariable=self.statusVar) 231 | self.colsVar = StringVar() 232 | self.colsLabel = Label(self, text='Split/merge rectangle of selected item(s)\n\ 233 | or area within page margins in columns:') 234 | self.colsEntry = Entry(self, textvariable=self.colsVar, width=9) 235 | self.rowsVar = StringVar() 236 | self.rowsLabel = Label(self, text=' and rows:') 237 | self.rowsEntry = Entry(self, textvariable=self.rowsVar, width=9) 238 | self.gapVar = DoubleVar() 239 | self.gapLabel = Label(self, text='Gap in document units:') 240 | self.gapEntry = Entry(self, textvariable=self.gapVar, width=9) 241 | self.aspectwidthVar = StringVar() 242 | self.aspectLabel = Label(self, text='New frame(s) aspect ratio (0=maximum area)') 243 | self.aspectwidthLabel = Label(self, text='width:') 244 | self.aspectwidthEntry = Entry(self, textvariable=self.aspectwidthVar, width=9) 245 | self.aspectheightVar = StringVar() 246 | self.aspectheightLabel = Label(self, text=' to height:') 247 | self.aspectheightEntry = Entry(self, textvariable=self.aspectheightVar, width=9) 248 | self.scaleVar = DoubleVar() 249 | self.scaleLabel = Label(self, text='New frame(s) scaling in % of selected rectangle:') 250 | self.scaleEntry = Entry(self, textvariable=self.scaleVar, width=9) 251 | self.alignhLabel = Label(self, text='New frame(s) alignment - horizontal:') 252 | self.alignhVar = ttk.Combobox(self, values = ["Left", "Center", "Right"], width=6) 253 | self.alignvLabel = Label(self, text=' vertical:') 254 | self.alignvVar = ttk.Combobox(self, values = ["Top", "Center", "Bottom"], width=6) 255 | self.captionVar = IntVar() 256 | self.captionLabel = Label(self, text='Text caption below image frame:') 257 | self.captionCheck = Checkbutton(self, variable=self.captionVar) 258 | self.captionhVar = DoubleVar() 259 | self.captionhLabel = Label(self, text='Caption height\n in document units:') 260 | self.captionhEntry = Entry(self, textvariable=self.captionhVar, width=9) 261 | self.removeframeVar = IntVar() 262 | self.removeframeLabel = Label(self, text='Remove source items:') 263 | self.removeframeCheck = Checkbutton(self, variable=self.removeframeVar) 264 | self.alternateborderVar = IntVar() 265 | self.alternateborderLabel = Label(self, text='Alternative border style for new frame(s):') 266 | self.alternateborderCheck = Checkbutton(self, variable=self.alternateborderVar) 267 | self.saveparamsVar = IntVar() 268 | self.saveparamsLabel = Label(self, text='Save above parameters for future use:') 269 | self.saveparamsCheck = Checkbutton(self, variable=self.saveparamsVar) 270 | 271 | self.okButton = Button(self, text="OK", width=6, command=self.okButton_pressed) 272 | self.cancelButton = Button(self, text="Cancel", command=self.quit) 273 | 274 | # open 'PhotoBookLayoutMaker.cfg' - parameters file and read values 275 | self.config = ConfigParser() 276 | self.configFile = (os.path.join(os.path.dirname(__file__), 'PhotoBookLayoutMaker.cfg')) 277 | self.config.read(self.configFile) 278 | self.configItems = self.config.items('DEFAULT') 279 | self.colsVar.set(self.configItems[0][1]) 280 | self.rowsVar.set(self.configItems[1][1]) 281 | self.gapVar.set(self.configItems[2][1]) 282 | self.aspectwidthVar.set(self.configItems[3][1]) 283 | self.aspectheightVar.set(self.configItems[4][1]) 284 | self.scaleVar.set(self.configItems[5][1]) 285 | self.alignhVar.set(self.configItems[6][1]) 286 | self.alignvVar.set(self.configItems[7][1]) 287 | self.captionVar.set(self.configItems[8][1]) 288 | if (self.configItems[8][1] == '1'): 289 | self.captionCheck.select() 290 | self.captionhVar.set(self.configItems[9][1]) 291 | self.removeframeVar.set(self.configItems[10][1]) 292 | if (self.configItems[10][1]) == '1': 293 | self.removeframeCheck.select() 294 | self.alternateborderVar.set(self.configItems[11][1]) 295 | if (self.configItems[11][1]) == '1': 296 | self.alternateborderCheck.select() 297 | #self.saveparamsCheck.select() 298 | 299 | # make interface layout 300 | self.columnconfigure(0, pad=6) 301 | currRow = 0 302 | self.statusLabel.grid(column=0, row=currRow, columnspan=4) 303 | currRow += 1 304 | self.colsLabel.grid(column=0, row=currRow, sticky=S+E) 305 | self.colsEntry.grid(column=1, row=currRow, sticky=S+W) 306 | self.rowsLabel.grid(column=2, row=currRow, sticky=S+E) 307 | self.rowsEntry.grid(column=3, row=currRow, sticky=S+W, padx=5) 308 | currRow += 1 309 | self.gapLabel.grid(column=0, row=currRow, sticky=S+E) 310 | self.gapEntry.grid(column=1, row=currRow, sticky=S+W) 311 | currRow += 1 312 | self.aspectLabel.grid(column=0, row=currRow, sticky=S+E) 313 | currRow += 1 314 | self.aspectwidthLabel.grid(column=0, row=currRow, sticky=S+E) 315 | self.aspectwidthEntry.grid(column=1, row=currRow, sticky=S+W) 316 | self.aspectheightLabel.grid(column=2, row=currRow, sticky=S+E) 317 | self.aspectheightEntry.grid(column=3, row=currRow, sticky=S+W, padx=5) 318 | currRow += 1 319 | self.scaleLabel.grid(column=0, row=currRow, sticky=S+E) 320 | self.scaleEntry.grid(column=1, row=currRow, sticky=S+W) 321 | currRow += 1 322 | self.alignhLabel.grid(column=0, row=currRow, sticky=S+E) 323 | self.alignhVar.grid(column=1, row=currRow, sticky=S+W) 324 | self.alignvLabel.grid(column=2, row=currRow, sticky=S+E) 325 | self.alignvVar.grid(column=3, row=currRow, sticky=S+W, padx=5) 326 | currRow += 1 327 | self.captionLabel.grid(column=0, row=currRow, sticky=S+E) 328 | self.captionCheck.grid(column=1, row=currRow, sticky=S+W) 329 | self.captionhLabel.grid(column=2, row=currRow, sticky=S+E) 330 | self.captionhEntry.grid(column=3, row=currRow, sticky=S+W, padx=5) 331 | currRow += 1 332 | self.removeframeLabel.grid(column=0, row=currRow, sticky=S+E) 333 | self.removeframeCheck.grid(column=1, row=currRow, sticky=S+W) 334 | currRow += 1 335 | self.alternateborderLabel.grid(column=0, row=currRow, sticky=S+E) 336 | self.alternateborderCheck.grid(column=1, row=currRow, sticky=S+W) 337 | currRow += 1 338 | self.saveparamsLabel.grid(column=0, row=currRow, sticky=S+E) 339 | self.saveparamsCheck.grid(column=1, row=currRow, sticky=S+W) 340 | currRow += 1 341 | self.rowconfigure(currRow, pad=6) 342 | self.okButton.grid(column=1, row=currRow, sticky=E) 343 | self.cancelButton.grid(column=2, row=currRow, sticky=W) 344 | 345 | def okButton_pressed(self): 346 | """ User variables testing and preparing """ 347 | # create PhotoBook Layout 348 | 349 | # checks for input errors 350 | if (self.colsVar.get().isdigit() == False or self.colsVar.get().isdigit() == False 351 | or int(self.colsVar.get()) == 0 or int(self.rowsVar.get()) == 0): 352 | self.statusVar.set('Columns and Rows must be integers > 0.') 353 | return 354 | 355 | if (self.aspectwidthVar.get().isdigit() == False 356 | or self.aspectheightVar.get().isdigit() == False): 357 | self.statusVar.set('Aspect ratio figures must be integers.') 358 | return 359 | if int(self.aspectheightVar.get()) == 0: 360 | aspectratio = 0 # fill entire frame 361 | else: 362 | aspectratio = int(self.aspectwidthVar.get()) / int(self.aspectheightVar.get()) 363 | 364 | if int(self.removeframeVar.get()) == 0: 365 | removeframe = 0 366 | else: 367 | removeframe = 1 368 | 369 | if int(self.alternateborderVar.get()) == 0: 370 | alternateborder = 0 371 | else: 372 | alternateborder = 1 373 | 374 | if self.saveparamsVar.get() == 1: # save parameters to 'PhotoBookLayoutMaker.cfg' 375 | self.config = ConfigParser() 376 | self.configFile = (os.path.join(os.path.dirname(__file__), 'PhotoBookLayoutMaker.cfg')) 377 | self.config.read(self.configFile) 378 | self.configItems = self.config.items('DEFAULT') 379 | self.config.set('DEFAULT', self.configItems[0][0], self.colsVar.get()) 380 | self.config.set('DEFAULT', self.configItems[1][0], self.rowsVar.get()) 381 | self.config.set('DEFAULT', self.configItems[2][0], str(self.gapVar.get())) 382 | self.config.set('DEFAULT', self.configItems[3][0], self.aspectwidthVar.get()) 383 | self.config.set('DEFAULT', self.configItems[4][0], self.aspectheightVar.get()) 384 | self.config.set('DEFAULT', self.configItems[5][0], str(self.scaleVar.get())) 385 | self.config.set('DEFAULT', self.configItems[6][0], self.alignhVar.get()) 386 | self.config.set('DEFAULT', self.configItems[7][0], self.alignvVar.get()) 387 | self.config.set('DEFAULT', self.configItems[8][0], str(self.captionVar.get())) 388 | self.config.set('DEFAULT', self.configItems[9][0], str(self.captionhVar.get())) 389 | self.config.set('DEFAULT', self.configItems[10][0], str(removeframe)) 390 | self.config.set('DEFAULT', self.configItems[11][0], str(alternateborder)) 391 | with open(self.configFile, 'w') as configfile: 392 | self.config.write(configfile) # converts all items to lowercase ! 393 | #self.configItems = self.config.items('DEFAULT') 394 | #msg = messagebox.showinfo("INFO:", self.configItems) ################# 395 | 396 | if not int(self.captionVar.get()) == 1: 397 | self.captionhVar.set("0.0") 398 | 399 | spblm = ScPhotoBookLayoutMaker(int(self.colsVar.get()), int(self.rowsVar.get()), 400 | float(self.gapVar.get()), float(aspectratio), float(self.scaleVar.get()), 401 | self.alignhVar.get(), self.alignvVar.get(), float(self.captionhVar.get()), 402 | removeframe, alternateborder) 403 | self.master.withdraw() 404 | err = spblm.createLayout() 405 | 406 | if err != None: 407 | self.master.deiconify() 408 | self.statusVar.set(err) 409 | else: 410 | self.quit() 411 | 412 | def quit(self): 413 | self.master.destroy() 414 | 415 | ################################################## 416 | # Start program 417 | 418 | def main(): 419 | if scribus.haveDoc() == 0: 420 | scribus.messageBox("Error: No document open", 421 | "Please, create (or open) a document before running this script ...", 422 | scribus.ICON_WARNING,scribus.BUTTON_OK) 423 | return 424 | 425 | try: 426 | scribus.statusMessage('Running script...') 427 | scribus.progressReset() 428 | unit = scribus.getUnit() 429 | root = Tk() 430 | app = TkPhotoBookLayoutMaker(root) 431 | root.mainloop() 432 | finally: 433 | if scribus.haveDoc(): 434 | scribus.redrawAll() 435 | scribus.setUnit(unit) 436 | scribus.statusMessage('Done.') 437 | scribus.progressReset() 438 | 439 | if __name__ == '__main__': 440 | main() 441 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------