File Format Specification for Scribus 1.4

From Scribus Wiki
Revision as of 18:25, 6 November 2009 by Jainbasil1 (talk | contribs) (→‎Tags)
Jump to navigation Jump to search

This is an ongoing effort to create a complete documentation of the file formats of Scribus 1.3.5–1.4. Once it is completed, it will be added to the Scribus Help Browser Documentation. Anyone who wants to contribute should be aware of the fact that we reserve the right to relicense this document under the Open Documentation License with elected options as used for the majority of the Help Browser documents.

Scribus Documents (SLA)

Document Structure

Tags

TAGS
EXPLANATION
SCRIBUSUTF8NEW
DOCUMENT
ANZPAGES
Count of Pages
PAGEWIDTH
Page Width
PAGEHEIGHT
Page Height
BORDERLEFT
Left Border Measure
BORDERRIGHT
Right Border Measure
BORDERTOP
Top Border Measure
BORDERBOTTOM
Bottom Border Measure
PRESET
Margin Preset
BleedTop
Top Bleed Measure
BleedLeft
Left Bleed Measure
BleedRight
Right Bleed Measure
BleedBottom
Bottom Bleed Measure
ORIENTATION
Page Orientation
PAGESIZE
Page Size
FIRSTNUM
First Page Number
BOOK
Current Page Layout
AUTOTEXT
Uses automatic textframes if value = 1
AUTOSPALTEN
ABSTSPALTEN
UNITS
Unit Index
DFONT
Text Font
DSIZE
Text Size
DCOL
Text Columns
DGAP
Text Column Gap
TabFill
Text Tab fill character
TabWidth
Text tab width
AUTHOR
Author Name
PUBLISHER
Publisher Name
COMMENTS
Comments
KEYWORDS
Keywords
DOCDATE
Document Date
DOCTYPE
Document Type
DOCFORMAT
Document Format
DOCIDENT
Document Identifier
DOCSOURCE
Document Source
DOCLANGINFO
Document Language Info
DOCRELATION
Document Relation
DOCCOVER
Document Coverage
DOCRIGHTS
Document Rights
DOCCONTRIB
Document Contributors
TITLE
Document Title
SUBJECT
Document Subject
VHOCH
SuperScript Value
VHOCHSC
Superscript scaling value
VTIEF
Subscript value
VTIEFSC
Subscript scaling value
VKAPIT
Small Caps value
BASEGRID
Baseline Grid value
BASEO
Baseline Grid offset value
AUTOL
Auto Line Spacing
UnderlinePos
Underline Displacement Value
UnderlineWidth
Underline Width Value
StrikeThruPos
Strike Through Displacement Value
StrikeThruWidth
Strike Through Width Value
GROUPC
Group Counter
HCMS
Has CMS
DPSo
DPSFo
DPuse
CMS in Use
DPgam
DPbla
DPMo
Default Monitor Profile
DPPr
Default Printer Profile
DPIn
Default Image RGB Profile
DPInCMYK
Default Image CMYK Profile
DPIn2
Default Solid Color RGB Profile
DPIn3
Default Solid Color CMYK Profile
DISc
Default Indent Colors
DIIm
Default Intent Images
ALAYER
Active Layer
LANGUAGE
Language
MINWORDLEN
Minimum Word Length
HYCOUNT
AUTOMATIC
AUTOCHECK
Autocheck
GUIDELOCK
SnapToGuides
SnapToGrid
Use Raster
MINGRID
Minor Grid Spacing
MAJGRID
Major Grid Spacing
SHOWGRID
Show Grid
SHOWGUIDES
Show Guide
showcolborders
Show Color Borders
SHOWFRAME
Show Frames
SHOWLAYERM
Show Layer Markers
SHOWMARGIN
Show Margins
SHOWBASE
Show Baseline Grid
SHOWPICT
Show Pictures
SHOWControl
Show Controls
SHOWLINK
Show Links
rulerMode
Ruler Mode
showrulers
Show Rulers
showBleed
Show Bleed
rulerXoffset
X Offset of Ruler
rulerYoffset
Y Offset of Ruler
GuideRad
GRAB
Grab Radius
POLYC
Polygon Corners( Not Sure)
POLYF
Polygon Factor
POLYR
Polygon Rotation
POLYCUR
Polygon Curvature
POLYFD
POLYS
AutoSave
Document Autosave
AutoSaveTime
Document Autosave time
ScratchBottom
Scratch Bottom
ScratchLeft
Scratch Left
ScratchRight
Scratch Right
ScratchTop
Scratch Top
GapHorizontal
Horizontal Gap
GapVertical
Vertical Gap
StartArrow
Linestart Arrow
EndArrow
LineEnd Arrow
PEN
Shape Line Color
BRUSH
Shape Fill Color
PENLINE
Line Color
PENTEXT
Text Color
StrokeText
Text Stroke Color
TextBackGround
Text Fill Color
TextLineColor
Text Line Color
TextBackGroundShade
Text fill color shade
TextLineShade
Text line color shade
TextPenShade
Text Shade
TextStrokeShade
Text stroke shade
STIL
Shape Line Shade
STILLINE
Line Style
WIDTH
Shape Line Width
WIDTHLINE
Line Width
PENSHADE
Shape Line ColorShade
LINESHADE
LineColor Shade
BRUSHSHADE
Shape Fill Color Shade
MAGMIN
MAGMAX
MAGSTEP
CPICT
Image Fill Color
PICTSHADE
Image FillColor Shade
PICTSCX
Image Scale X
PICTSCY
Image Scale Y
PSCALE
Image Scale Type
PASPECT
Image Aspect Ratio
EmbeddedPath
Image Use embedded path
HalfRes
Image Low Resolution type
dispX
DispX
dispY
Disp Y
constrain
Constrain
MINORC
Minor Grid Color Name
MAJORC
Major Grid Color Name
GuideC
Guide Color Name
BaseC
Baseline Grid Color Name
GuideZ
Guide Rad
BACKG
Guide Placement
PAGEC
Paper Color Name
MARGC
Margin Color Name
RANDF
Margin Colored
currentProfile
Current check profile
CheckProfile
Name
Check profile name
ignoreErrors
Ignore Errors (int value)
autoCheck
Auto Check (int value)
checkGlyphs
Check Glyphs (int value)
checkOrphans
Check Orphans (int value)
checkOverflow
Check Overflow (int value)
checkPictures
Check Pictures (int value)
checkResolution
Check Resolution (int value)
checkTransparency
Check Transparency (int value)
minResolution
Minimum Resolution
maxResolution
Maximum Resolution
checkAnnotations
Check Annotations (int value)
checkRasterPDF
Check Raster PDF (int value)
checkForGIF
Check For GIF (int value)
ignoreOffLayers
Ignore Off Layers (int value)
MultiLine
Line Styles
Name
Name
Color
Color
Shade
Shade
Dash
Dash
LineEnd
Line End
LineJoin
Line Join
Width
Width
Shortcut
Shortcut
Arrows
NumPoints
Points
Points
Name
Name
JAVA
Javascripts
NAME
Javascript Name
SCRIPT
Script
Bookmark
Bookmark Section
Title
Bookmark Title
Text
Bookmark Title
Aktion
Action
ItemNr
Item Number (but not sure)
Element
Element
First
First
Last
Last
Prev
Previous
Next
Next
Parent
Parent
COLOR
Colors
NAME
Color Name
RGB*
Color Model is RGB
CMYK*
Color Model is CMYK
Spot
Spot
Register
Register
Gradient
Gradient Section
Name
Gradient Name
CSTOP
Color Stops
RAMP
Color Stop Ramp Point
NAME
Color Stop name
SHADE
Color Stop shade
TRANS
Opacity
HYPHEN
Hyphenator Lists
EXCEPTION
Special Words
WORD
HYPHENATED
Whether Hyphenated
IGNORE
Ignored Words
WORD
Word
STYLE
Paragraph Styles
NAME
Paragraph Style Name
PARENT
Parent Style Name
DefaultStyle
Is this a default style? (boolean value)
ALIGN
Alignment
LINESPMode
Line Spacing Mode
LINESP
Line Spacing
INDENT
Left Margin
RMARGIN
Right Margin
FIRST
First Indent
VOR
Gap Before
NACH
Gap After
DROP
Has drop cap
DROPLIN
Drop Cap Lines
DROPDIST
Drop Cap offset
OpticalMargins
Optical Margins
HyphenationMode
Hyphenation Mode
MinWordTrack
Minimum Word Tracking
MinGlyphShrink
Minimum Glyph Extend
MaxGlyphExtend
Maximum Glyph Extend
PSHORTCUT
Paragraph Style Shortcut
Tabs
Type
Tab Type
Pos
Tab Position
Fill
Tab Fill character
CHARSTYLE
Character Style
CNAME
Character Style Name
CPARENT
Character style parent
FONT
Font name
FONTSIZE
Font size
FEATURES
Character style features
FCOLOR
Fill Color
FSHADE
Fill shade
SCOLOR
Stroke color
SSHADE
Stroke shade
TXTSHX
Shadow X Offset
TXTSHY
Shadow Y Offset
TXTOUT
Outline Width
TXTULP
Underline Offset
TXTULW
Underline Width
TXTSTP
Strike Through offset
TXTSTW
Strike Through Width
SCALEH
Horizontal Scale
SCALEV
Vertical Scale
BASEO
Baseline offset
KERN
Kerning
wordTrack
Word Tracking
SHORTCUT
Character Style shortcut
LAYERS
NUMMER
Layers ID
LEVEL
Layer level
NAME
Layer Name
SICHTBAR
Is viewable ?
DRUCKEN
Is printable ?
EDIT
Is editable ?
FLOW
Flow control
TRANS
Transparency
BLEND
Blend Mode
OUTL
Outline mode
LAYERC
Marker color name
Printer
Printer Options
firstUse
First Use
toFile
Print to file
useAltPrintCommand
Use Alt Print Command
outputSeparations
Output separations
useSpotColors
Use spot colors
useColor
Use color
mirrorH
Mirror horizontal
mirrorV
Mirror vertical
useICC
Use ICC
doGCR
Do GCR
doClip
Do clip
setDevParam
useDocBleeds
use document bleeds
cropMarks
Crop marks
bleedMarks
Bleed marks
registrationMarks
Registration marks
colorMarks
Color marks
includePDFMarks
Include pdf marks
PSLevel
PostScript Level
PDLanguage
Printer Engine
markOffset
Mark Offset
BleedTop
Bleed top
BleedLeft
Left bleed
BleedRight
Right bleed
BleedBottom
Bottom bleed
printer
Printer
filename
Filename
separationName
Separation Name
printerCommand
Printer Command
Separation
Name
PDF
PDF Options
firstUse
First Use
Thumbnails
Thumbnails
Articles
Articles
Bookmarks
Bookmarks
Compress
Compress
CMethod
Compress Method
Quality
Quality
MirrorH
Mirror Horizontal
MirrorV
Mirror Vertical
Clip
Do clip
RotateDeg
Rotation Degree
PresentMode
RecalcPic
Grayscale
Gray scale
RGBMode
RGB Mode
UseProfiles
Use Profiles
UseProfiles2
Use profiles 2
Binding
Binding
PicRes
Picture resolution (not sure)
Resolution
Resolution
Version
PDF Version
Intent
Intent
Intent2
Intent2
SolidP
Solid Profile
ImageP
Image Profile
PrintP
Print Profile
InfoString
Information
BTop
Bleed top
BLeft
Bleed left
BRight
Bleed right
BBottom
Bleed bottom
useDocBleeds
Use documnet bleeds
cropMarks
Crop Marks
bleedMarks
Bleed marks
registrationMarks
Registration Marks
colorMarks
Color marks
docInfoMarks
Document information marks
markOffset
<centerMark offset>
ImagePr
Embedded Image
PassOwner
Pass Owner
PassUser
Pass User
Permissions
Permissions
Encrypt
Encrypt or not
UseLayers
Whether use layers or not
UseLpi
Whether use LPI or not
UseSpotColors
Use spot colors or not
doMultiFile
Do Multi file
displayBookmarks
Display bookmarks or not
displayFullscreen
Display fullscreen
displayLayers
Display Layers
displayThumbs
Display Thumbnails
hideMenuBar
Hide Menu Bar or not
hideToolBar
Hide toolbar or not
fitWindow
Fit window or not
PageLayout
Page Layout
openAction
Open action
Fonts
Name
Embedded Font Name
Subset
Name
Effekte
pageEffectDuration
Page effect duration
pageViewDuration
Page view duration
effectType
Effect type
Dm
M
Di
LPI
Color
Color
Frequency
Frequency
Angle
Angle
SpotFunction
Spot function
DocItemAttributes
Document Item attributes
ItemAttribute
Item attribute
Name
Attribute name
Type
Type
Value
Value
Parameter
Document item parameter
Relationship
Document item Relationship
RelationshipTo
Relationship to
AutoAddTo
Auto add to
TablesOfContents
Name
Table of contents name
ItemAttributeName
Item attribute name
FrameName
Frame name
ListNonPrinting
List non-printing frames
Style
Text Style
NumberPlacement
Beginning
Number placement begining
End
Number placement end
NotShown
Number placement not shown
Sections
Section
Number
Section Number
Name
/Section name
From
From
To
To
Type
Type_1_2_3
Type_i_ii_iii
Type_I_II_III
Type_a_b_c
Type_A_B_C
TypeNone
Start
Start
Reversed
Reversed
Active
Active or not
PageSets
Pagesets section
Set
Name
Pageset name
FirstPage
First Page
Rows
Rows
Columns
Columns
PageNames
Page Names list
Name
Name
Pattern
Pattern section
Name
Pattern Name
width
Width
height
Height
scaleX
Scale X
scaleY
Scale Y
xoffset
X Offset
yoffset
Y Offset
MASTERPAGE / PAGE
Pages Section
PAGEXPOS
Page X Position
PAGEYPOS
Page Y position
PAGEWIDTH
Page Width
PAGEHEIGHT
Page Height
BORDERLEFT
Left Border
BORDERRIGHT
Right Border
BORDERTOP
Top Border
BORDERBOTTOM
Bottom Border
NUM
Page Number
NAM
Page Name
MNAM
Master Page Name
Size
Page Size
Orientation
Page Orientation
LEFT
Left Page
PRESET
Margin Preset
VerticalGuides
Vertical Guides
HorizontelGuides
Horizontel Guides
AGhorizontalAutoGap
Horizontal Auto Gap
AGVerticalAutoGap
Vertical Auto Gap
AGhorizontalAutoCount
Horizontal Auto Count
AGverticalAutoCount
Vertical Auto Count
AGhorizontalAutoRefer
Horizontal Auto Refer
AGverticalAutoRefer
Vertical Auto Refer
AGSelection
Selection
ITEXT
Item Text
CH
Text with smart hyphens
Unicode
Unicode
COBJ
tab
Tab
breakline
Line Break
breakcol
Column Break
breakframe
Frame Break
nbhyphen
nbspace
zwnbspace
var
name
pgno
Page number
pgco
Page count
MASTEROBJECT / PAGEOBJECT / FRAMEOBJECT / PatternItem
Objects Section
OnMasterPage
Item on masterpage (type : QString)
ImageClip
Image used path
ImageRes
Image resolution type (int : 0 = full resolution, 1 = 72dpi, 2 = 36 dpi)
PageNumber
Actual Pagenumber
isInline
Is embedded
fillRule
Fill Rule
doOverprint
Do over print or not? (boolean value)
gXpos
X Position
gYpos
Y Position
gWidth
Width
gHeight
Height
pattern
Pattern
pScaleX
Pattern Scale X
pScaleY
Pattern Scale Y
pOffsetX
Pattern X Offset
pOffsetY
Pattern Y Offset
pRotation
Pattern Rotation
GRSTARTX
Gr Start X
GRSTARTY
Gr. Start Y
GRENDX
Gr. End X
GRENDY
Gr. End Y
GRNAME
Gr. Name
PSTYLE
Parent Style
ALIGN
Alignment
LAYER
Layer ID
BOOKMARK
Is Bookmark ? (boolean value)
NEXTITEM
Next Item
BACKITEM
Previous Item
ImageEffect
Image effect
Code
Image effect code
Param
Image effect parameters
PSDLayer
Layer
Layer
Visible
Whether visible (int value)
useMask
Use Mask ? (int value)
Opacity
Layer opacity
Blend
Layer Blend
Tabs
Type
Tab Type
Pos
Tab Position
Fill
Tab Fill character
CSTOP
Color Stops
RAMP
Ramp Point
NAME
Name
SHADE
Color Stop Shade
TRANS
Color Stop Opacity
LATEX
ConfigFile
DPI
USE_PREAMBLE
PROPERTY
name
value
PageItemAttributes
ItemAttribute
Name
Type
Value
Parameter
Relationship
RelationshipTo
AutoAddTo
OwnPage
PTYPE
XPOS
YPOS
WIDTH
HEIGHT
RADRECT
CLIPEDIT
PWIDTH
PCOLOR
PCOLOR2
TXTFILL
TXTSTROKE
TXTSTRSH
TXTFILLSH
TXTSCALE
TXTSCALEV
TXTBASE
TXTSHX
TXTSHY
TXTOUT
TXTULP
TXTULW
TXTSTP
TXTSTW
TXTKERN
wordTrack
MinWordTrack
MinGlyphShrink
MaxGlyphExtend
OpticalMargins
HyphenationMode
leftMargin
rightMargin
firstIndent
COLUMNS
COLGAP
NAMEDLST
SHADE
SHADE2
GRTYP
ROT
PLINEART
PLINEEND
PLINEJOIN
LINESP
LINESPMode
LOCALSCX
LOCALSCY
LOCALX
LOCALY
PICART
PLTSHOW
BASEOF
textPathType
textPathFlipped
FLIPPEDH
FLIPPEDV
IFONT
ISIZE
SCALETYPE
RATIO
PRINTABLE
ANNOTATION
ANTYPE
ANACTION
ANEACT
ANXACT
ANDACT
ANFOACT
ANBLACT
ANKACT
ANFACT
ANVACT
ANCACT
ANEXTERN
ANZIEL
ANACTYP
ANATOOLTIP
ANBWID
ANBSTY
ANFEED
ANFLAG
ANFONT
ANFORMAT
ANROLL
ANDOWN
ANVIS
ANMC
ANCHK
ANAA
ANCHKS
ANBCOL
ANHTML
ANICON
ANPLACE
ANSCALE
ANNAME
TEXTFLOWMODE
TEXTFLOW
TEXTFLOW2
TEXTFLOW3
AUTOTEXT
EXTRA
TEXTRA
BEXTRA
REXTRA
FLOP
PFILE
isInlineImage
inlineImageExt
ImageData
PFILE
PFILE2
PFILE3
PRFILE
EPROF
IRENDER
EMBEDDED
LOCK
LOCKR
REVERS
TransValue
TransValueS
TransBlend
TransBlendS
isTableItem
TopLine
LeftLine
RightLine
BottomLine
TopLINK
LeftLINK
RightLINK
BottomLINK
OwnLINK
isGroupControl
groupsLastItem
NUMDASH
DASHS
DASHOFF
NUMPO
POCOOR
NUMCO
COCOOR
NUMGROUP
GROUPS
LANGUAGE
startArrowIndex
endArrowIndex

Scribus Colour Palettes (XML)

Scribus Scrapbooks (SCS)

Scribus Keyboard Shortcut Sets (XML)

Scribus Unicode Character Palettes (UCP)

Scribus Template Files (XML)

Scribus Objects (SCE)

Scribus Patterns (SCE)

Scribus Colour Curves (SCU)

Configuration Files for Render Frames (XML)

Scribus Sample Text Files (XML)

Configuration Files for the Help Browser (XML)