Official:File Format 1.2

From Scribus Wiki
Jump to: navigation, search

File Format Specification for Scribus 1.2

This specification is based on the format used by Scribus 1.2.

It lists all Tags and Attributes, some of these are optional, depending on type of the Document. Optional Tags and Attributes are marked with a slight blue background, Scribus will insert a default value when one of these are missing.

Tags Attributes Meaning
SCRIBUSUTF8 Version Version Number for
Debugging
DOCUMENT ABSTSPALTEN Distance between Columns in
automatic Textframes
ALAYER Active Layer
ANZPAGES Number of Pages
AUTHOR Author of the Doc
AUTOCHECK Automatic Hyphenation during typing
0 = off, 1 = on
AUTOMATIC Automatic Hyphenation
0 = off, 1 = on
AUTOSPALTEN Number of Colums in automatic
Textframes
BASEGRID Width of the Baseline Grid
BASEO Startoffset for the Baseline Grid
BOOK Document has facing Pages
when this Attribute is present
BORDERBOTTOM Bottom Border of Doc
BORDERLEFT Left Border of Doc
BORDERRIGHT Right Border of Doc
BORDERTOP Top Border of Doc
COMMENTS Comments for the Doc
DCOL Number of Colums in Textframes
DFONT Default Font
DGAP Default Gap between Columns
in Textframes
DIMo Default Rendering Intent for the Monitor
0 = Perceptual
1 = Relative Colorimetric
2 = Saturation
3 = Absolute Colorimetric
DIMo2 Default Rendering Intent for Images
0 = Perceptual
1 = Relative Colorimetric
2 = Saturation
3 = Absolute Colorimetric
DIPr Default Rendering Intent for the Printer
0 = Perceptual
1 = Relative Colorimetric
2 = Saturation
3 = Absolute Colorimetric
DOCCONTRIB Person or organization making contributions to the document
DOCCOVER Extent of scope of the document
DOCDATE Date related to life-cycle of the document, YYYY-MM-DD
DOCFORMAT Physical or digital manifestation of the document
DOCIDENT An unambigious reference to the document, eg ISBN
DOCLANGINFO Language of content of document
DOCRELATION Reference to a related document
DOCRIGHTS Information about rights held in and over the document, eg copyright
DOCSOURCE Reference to a document from which this document is derived
DOCTYPE Nature or genre of the content of the document
Dpbla Use Blackpoint Compensation
0 = off, 1 = on
Dpgam Mark Colors out of Gamut
0 = off, 1 = on
DPIn Default ICC-Profile for solid Colors
DPIn2 Default ICC-Profile for Images
DPMo Default ICC-Profile for the Monitor
DPPr Default ICC-Profile for the Printer
DPSo Simulate the Printer on Screen
0 = off, 1 = on
Dpuse Use Colormanagement
0 = off, 1 = on
DSIZE Default Fontsize
FIRSTLEFT First page is a left page when this
attribute is present
FIRSTNUM First Pagenumber in the Doc
GROUPC Counter for Groups in the Doc
GUIDELOCK Guides locked
0 = off, 1 = on
HCMS Colormanagement available
0 = off, 1 = on
HYCOUNT Number of Hyphens allowed following each other
KEYWORDS Keywords for the Doc
LANGUAGE Language of the Doc
MAJGRID Distance of the major Gridlines
MINGRID Distance of the minor Gridlines
MINWORDLEN Minimum length of a Word to be hyphenated
ORIENTATION Orientation of the Doc
0 = Portrait
1 = Landscape
PAGEHEIGHT Height of the Doc
PAGEWITH Width of the Doc
PUBLISHER Person or organization responsible for making the document available
TITLE Title of the Doc
UNITS Measurement unit for the Doc
0 = Points
1 = Millimeters
2 = Inches
3 = Picas
VHOCH Percentage for Superscript
VHOCHSC Percentage for scaling of the Glyphs in Superscript
VKAPIT Percentage for scaling of the Glyphs in Small Caps
VTIEF Percentage for Subscript
VTIEFSC Percentage for scaling of the Glyphs in Subscript
MultiLine Name Name of the Linestyle
SubLine Color Name of the colour of that Line
Dash How the line is dashed
1 = Solid Line
2 = Dashed Line
3 = Dotted Line
4 = Dash Dot Line
5 = Dash Dot Dot Line
LineEnd Code for the line end rendering
0 = FlatCap
16 = SquareCap
32 = RoundCap
LineJoin Code for the line join rendering
0 = MiterJoin
64 = BevelJoin
128 = RoundJoin
Shade Shading of the line colour in percent
Width Linewidth in points
JAVA NAME Name of the Script
SCRIPT The JavaScript itself
Bookmark Aktion Action for this Bookmark
Element Number of the Scribus Object
First Number of first Bookmark at this Level
ItemNr Internal Number of this Bookmark
Last Number of last Bookmark at this Level
Next Number of next Bookmark at this Level
Parent Number of this Bookmarks Parent
Prev Number of previous Bookmark at this Level
Seite Page on which this Bookmark is located
Text Internal Text of that Bookmark
Title String which is exported to PDF
COLOR CMYK Value as hexadecimal String
NAME Name of the Colour
RGB Value as hexadecimal String
STYLE ALIGN Code for the alignment of text.
0 = Align Text Left
1 = Align Text Centered
2 = Align Text Right
3 = Align Text Justified
4 = Align Text Forced Justified
BASE Flag for adjusting to the Baseline Grid
0 = no adjusting, 1 = adjusting
DROP Flag for DropCaps
1 = DropCaps on
DROPLIN Number of Lines for the DropCaps
EFFECT Character Style for the Text
1 = Superscript
2 = Subscript
4 = Outline Text
8 = Underline
16 = Strike Out
64 = Small Caps
FCOLOR Name of the fill colour
FIRST Indent of the first Line
FONT Name of the Font
FONTSIZE Fontsize
FSHADE Shade of the fill colour in percent
INDENT Indent for all Lines
LINESP Linespacing
NACH Spacing after the paragraph
NAME Name of the style
NUMTAB Number of Tabs
SCOLOR Name of the stroke colour
SSHADE Shade of the stroke colour in percent
TABS List of defined Tabs, Tabcode and Position
Tabcodes:
0 = Left
1 = Right
2 = Full Stop
3 = Comma
4 = Center
VOR Spacing before the paragraph
LAYERS DRUCKEN Flag for printing
0 = Layer is not printed
1 = Layer is printed
LEVEL Level of the Layer
0 = Background
NAME Name of the layer
NUMMER Number of the layer
SICHTBAR Flag for visibility
0 = Layer is not visible
1 = Layer is visible
PDF Articles Flag, set to 1 when use PDF-Articles is
checked in the PDF-Options Dialog
BBottom Bottom Distance for the Bleed Box
Binding Binding for the PDF-Document
0 = Left Binding
1 = Right Binding
BLeft Left Distance for the Bleed Box
Bookmarks Flag, set to 1 when include Bookmarks is
checked in the PDF-Options Dialog
BRight Right Distance for the Bleed Box
BTop Top Distance for the Bleed Box
CMethod Compression Method for Pictures
0 = Automatic, Scribus tries to use the best Method
1 = JPEG Compression
2 = Flate Compression
3 = No Compression
Compress Flag, set to 1 when use Compress Text is
checked in the PDF-Options Dialog
Encrypt Flag, set to 1 when use Encryption is
checked in the PDF-Options Dialog
ImageP ICC-Profile for Images
ImagePr Flag, set to 1 when embedded ICC-Proflies should not be used for images
InfoString Info String for PDF-X/3 Output
Intent Rendering Intent for solid colours
0 = Perceptual
1 = Relative Colorimetric
2 = Saturation
3 = Absolute Colorimetric
Intent2 Rendering Intent for Images
0 = Perceptual
1 = Relative Colorimetric
2 = Saturation
3 = Absolute Colorimetric
PassOwner Owner Password for encrypted PDF's
PassUser User Password for encrypted PDF's
Permissions Value used for Encryption Settings
PicRes Resolution for downsampling Images
PresentMode Flag, set to 1 when Presentation effects should be used
PrintP ICC-Profile for the Printer, only used for PDF-X/3 output
Quality Quality setting for Image Compression
0 = Maximum (95%)
1 = High (85%)
2 = Medium (75%)
3 = Low (50%)
4 = Minimum (25%)
RecalcPic Flag, set to 1 when Downsample Images is
checked in the PDF-Options Dialog
Resolution Resolution for embedded EPS-Pictures or PDF's
RGBMode Flag, set to 1 when Output should be in RGB
SolidP ICC-Profile for solid colours
Thumbnails Flag, set to 1 when Generate Thumbnails is
checked in the PDF-Options Dialog
UseLpi Flag, set to 1 when the informations in the LPI tags should be used for Linescreening
UseProfiles Flag, set to 1 when ICC-Profiles should be used for solid colours
UseProfiles2 Flag, set to 1 when ICC-Profiles should be used for images
Version PDF-Version which should be generated
12 = PDF-X/3
13 = PDF-1.3
14 = PDF-1.4
Effekte AnzeigeLen Time how long the page is shown in Full Screen Mode in seconds
Di Direction of the Effect for Wipe and Glitter
0 = Left to right
1 = Top to bottom
2 = Bottom to top
3 = Right to left
4 = Top-left to bottom-right
Dm Direction of the Effect for Split and Blinds
0 = horizontal
1 = vertical
Effekt Type of Effect
0 = No Effect
1 = Blinds
2 = Box
3 = Dissolve
4 = Glitter
5 = Split
6 = Wipe
EffektLen Time how long the effect is shown in Full Screen Mode in seconds
M Direction of the motion for Split and Box
0 = towards inside
1 = towards outside
LPI Angle Linescreening angle
Color Name of the Colour for which these settings are ment
Frequency How many lines per Inch are used
SpotFunction Code for the used Spotfunction:
0 = Simple Dot
1 = Line
2 = Round
3 = Ellipse
Fonts Name Name of the Font to be embedded into the PDF
PAGE HorizontalGuides List of horizontal Guidelines
LEFT Is 1 if this page is a left Masterpage
MNAM Name of the attached Masterpage,
empty when this page is a Masterpage
NAM Name of the Masterpage, empty
when this page is a normal page
NUM Number of the page, counting starts with 0
NumHGuides Number of horizontal Guidelines
NumVGuides Number of vertical Guidelines
VerticalGuides List of vertical Guidelines
PAGEOBJECT ALIGN Alignment for text when no paragraph style is set
0 = No Style, left aligned
1 = Align Text Center
2 = Align Text Right
3 = Align Text Justified
4 = Align Text Forced Justified
ANAA Set to 1 if Annotations Action is a JavaScript Action
ANACTION Action for the PDF-Field, contains either a URL or a JavaScript
ANACTYP Type of the Action for a PDF-Field
0 = None
1 = Java Script
2 = Go To
3 = Submit Form
4 = Reset Form
5 = Import Data
ANBCOL Name of the border colour of the PDF-Button
ANBLACT JavaScript executed when the PDF-Field looses focus
ANBSTY Borderstyle for a PDF-Button
0 = Solid
1 = Dashed
2 = Underline
3 = Beveled
4 = Inset
ANBWID Borderwidth of a PDF-Button
0 = None
1 = Thin
2 = Normal
3 = Wide
ANCACT JavaScript executed when the PDF-Page is changed
ANCHK Set to 1 if the PDF-Checkbox is checked by default
ANCHKS Style of the checkmark in a PDF-Checkbox
0 = Check
1 = Cross
2 = Diamond
3 = Circle
4 = Star
5 = Square
ANDACT JavaScript executed when the mouse button is pressed
ANDOWN Text for Button Down of a PDF-Button
ANEACT JavaScript executed when the cursor enters the PDF-Field
ANEXTERN Path or URL for an external PDF-Link
ANFACT JavaScript executed before formatting the PFD-Field
ANFEED Feedback for PDF-Button press
0 = None
1 = Invert
2 = Outlined
3 = Push animation
ANFLAG Flags for Annotations, value is the bitwise or of the following constants
1 = Field is read-only
2 = Field must have a value
4 = Value is not exported
4096 = Field is a multiline Textfield
8192 = Field is a password field
262144 = Field is editable
4194304 = Don't spell check
8388608 = Do not scroll
ANFOACT JavaScript executed when the field receives focus
ANFONT Font for the PDF-Button or Annotation
0 = Courier
1 = Courier Bold
2 = Courier Italic
3 = Courier Bold Italic
4 = Helvetica
5 = Helvetica Bold
6 = Helvetica Italic
7 = Helvetica Bold Italic
8 = Times
9 = Times Bold
10 = Times Italic
11 = Times Bold Italic
12 = Zapf Dingbats
13 = Symbols
ANFORMAT Format of the Value in a PDF-Field
0 = Plain text
1 = Number
2 = Percentage
3 = Date
4 = Time
5 = Custom format
ANHTML Set to 1 if the PDF-Submit Action should send HTML instead of FDF
ANICON Set to 1 if the PDF-Button uses icons
ANKACT JavaScript for keypresses
ANMC Maximum number of characters in a PDF-Textfield
ANNAME Field name of the Annotation, also used for the object name
ANNOTATION Set to 1 if the object is a Annotation or a PDF-Field
ANPLACE How to display the Icon of a PDF-Button
0 = Caption only
1 = Icon only
2 = Caption below Icon
3 = Caption above Icon
4 = Caption right to Icon
5 = Caption left to Icon
6 = Caption overlays Icon
ANROLL Text for roll over of PDF-Buttons
ANSCALE Scaling of Icons on PDF-Buttons
0 = Always
1 = When Icon is too small
2 = When Icon is too big
3 = Never
ANTOOLTIP Tooltip for the PDF-Field
ANTYPE Type of the Annotation or PDF-Field
0 = Text annotation
1 = Link annotation
2 = PDF-Button
3 = PDF-Textfield
4 = PDF-Checkbox
5 = PDF-Combobox
6 = PDF-Listbox
7 = External Link
8 = External Weblink
ANVACT JavaScript to be performed when the fields value has changed
ANVIS The visiblity of the PDF-Field
0 = visible
1 = hidden
2 = don't print
3 = don't show, but print
ANXACT JavaScript when the mouse pointer leaves the field
ANZIEL Page number of a PDF-Link
AUTOTEXT Set to 1 if object is an automatic textframe
BACKITEM Number of the previous frame of linked textframe
BACKPAGE Number of the page of the previous frame in linked textframes
BASEOF Offset for the text from its path for text on a path
BBOXH Height of the bounding box, used only for EPS-Images
BBOXX Bounding box X-Value, used only for EPS-Images
BEXTRA Distance of text from the bottom edge of the frame
BOOKMARK Set to 1 if object is a PDF-Bookmark
BookNr Number of the Bookmark
BottomLine Set to 1 if the table item has a bottom line
BottomLINK Number of the object that is below of this object in tables
CLIPEDIT Set to 1 if the shape was edited
COLGAP Gap between text columns
COLUMNS Number of columns in text
COCOOR Coordinates of the objects contour line
DASHOFF Offset for the first dash
DASHS List of dash values, see the PostScript manual for details
EMBEDDED Set to 1 if embedded ICC-Profiles should be used
EPROF Embedded ICC-Profile for images
EXTRA Distance of text from the left edge of the frame
EXTRAV Kerning value
FLIPPEDH Set to an uneven number if object is flipped horizontal
FLIPPEDV Set to an uneven number if object is flipped vertical
FRTYPE Type of the shape of an object
0 = Rectangle
1 = Ellipse
2 = Rounded rectangle
3 = Free shape
GRENDX X-Value of the end position of the gradient
GRENDY Y-Value of the end position of the gradient
GROUPS List of group identifiers
GRSTARTX X-Value of the start position of the gradient
GRSTARTY Y-Value of the start position of the gradient
GRTYP Type of the gradient fill
0 = No gradient fill
1 = Horizontal gradient
2 = Vertical gradient
3 = Diagonal gradient
4 = Cross diagonal gradient
5 = Radial gradient
6 = Free linear gradient
7 = Free radial gradient
HEIGHT Height of the object
IFONT Name of the font for text
INVERS Image is inversed
IRENDER Rendering Intent for Images
0 = Perceptual
1 = Relative Colorimetric
2 = Saturation
3 = Absolute Colorimetric
ISIZE Fontsize for text
isTableItem Set to 1 if the object belongs to a table
LANGUAGE Language of the object
LAYER Layer number the object belongs to
LeftLine Set to 1 if the table item has a left line
LeftLINK Number of the object that is left to this object in tables
LINESP Linespacing for text
LOCALSCX Scaling of the image in the X-Direction
LOCALSCY Scaling of the image in the Y-Direction
LOCALX X-Position of the image in the image frame
LOCALY Y-Position of the image in the image frame
LOCK Set ot 1 if the object is locked
LOCKR Set to 1 if the object is protected against resizing
NAMEDLST Name of the custom line style
NEXTITEM Number of the next frame for linked textframes
NEXTPAGE Number of the page of the next frame in linked textframes
NUMCO Number of coordinates in COCOOR
NUMDASH Number of entries in DASH
NUMGROUP Number of grops in GROUPS
NUMPO Number of coordinates in POCOOR
NUMTAB Number of tabstops listed in TABS
OwnLINK Number of this object in tables
PCOLOR Name of the colour for fll
PCOLOR2 Name of the colour for stroke
PFILE Filename of the image
PFILE2 Filename of the pressed icon image for PDF-Buttons
PFILE3 Filename of the rollover icon image for PDF-Buttons
PICART Set to 1 if image should be shown
PLINEART How the line is dashed
1 = Solid Line
2 = Dashed Line
3 = Dotted Line
4 = Dash Dot Line
5 = Dash Dot Dot Line
PLINEEND Code for the line end rendering
0 = FlatCap
16 = SquareCap
32 = RoundCap
PLINEJOIN Code for the line join rendering
0 = MiterJoin
64 = BevelJoin
128 = RoundJoin
PLTSHOW Set to 1 if the path of a Text on a path should be shown
POCOOR Coordinates of the object shape
PRFILE ICC-Profile for the image
PRINTABLE Set to 1 if the object should be printed, 0 otherwise
PTYPE Type of object
2 = Image
4 = Text
5 = Line
6 = Polygon
7 = Polyline
8 = Text on a path
PWIDTH Line width of the object
RADRECT Corner radius for rounded Rectangles
RATIO Set to 1 if the image scaling should respect the aspect ratio
REVERS Text is rendered reverse, eg Arabic
REXTRA Distance of text from the right edge of the frame
RightLine Set to 1 if the table item has a right line
RightLINK Number of the object that is to the right of this object in tables
ROT Rotation of the object in degrees
SCALETYPE How the image can be scaled
0 = Free scaling
1 = Scaling bound to image frame dimensions
SHADE Shading for fill
SHADE2 Shading for stroke
TABS List of defined Tabs, Tabcode and Position
Tabcodes:
0 = Left
1 = Right
2 = Full Stop
3 = Comma
4 = Center
TEXTFLOW Set to 1 if text flows around this object
TEXTFLOW2 Set to 1 if text flows around the bounding box of this object
TEXTFLOW3 Set to 1 if text flows around the contour line of this object
TEXTRA Distance of text from the top edge of the frame
TopLine Set to 1 if the table item has a top line
TopLINK Number of the object that is above this object in tables
TransValue Transparency value for fill
TransValueS Transparency value for stroke
TXTFILL Name of the default text fill colour
TXTFILLSH Default shading for the text fill colour
TXTSCALE Default text scaling
TXTSTROKE Name of the default colour for stroking text
TXTSTRSH Default shading for stroking text
TXTSTYLE Default character style, value is the bitwise or of these constants:
1 = Superscript
2 = Subscript
4 = Outlined
8 = Underlined
16 = Strikeout
64 = Small Caps
WIDTH Width of the Object
XPOS X-Positon of the Object
YPOS Y-Position of the Object
CSTOP NAME Name of the stop colour
RAMP Position of the colour stop,
range from 0.0 till 1.0
SHADE Shading of the stop colour in Percent
TRANS Transparency of the colour stop,
range from 0.0 till 1.0
ITEXT CAB Paragraph style for the character
0 = No Style, left aligned
1 = Align Text Center
2 = Align Text Right
3 = Align Text Justified
4 = Align Text Forced Justified
higher values indicate a custom paragraph style
CCOLOR Name of the fill colour
CEXTRA Value for Kerning
CFONT Name of the Font
CH The character(s) itself
CSCALE Scaling in percent
CSHADE Shading of the fill colour
CSHADE2 Shading of the stroke colour
CSIZE Fontsize in points
CSTROKE Name of the stroke colour
CSTYLE The style of the character, value is the bitwise or of these constants:
1 = Superscript
2 = Subscript
4 = Outlined
8 = Underlined
16 = Strikeout
64 = Small Caps
128 = Word can be hyphenated here