call_parameters
| Contains par elements controlling the output.
Parameters are defined in the main start file ‘autostart.jt’ or dynamically in ‘overrideX.jt’ files. JobTicket files are automatically detected and processed by BatchXSLT. | |
par
| The following parameters automatically are passed to the transform XSL by the BatchXSLT transformer engine:
| |
name="XMLSRC_VERSION"
| 1.0
| |
name="XMLSRC_ENCODING"
| UTF-8
| |
name="XMLSRC_DOCTYPE_DECLARATION"
| empty for ‘automatic’
| |
name="SYSTEM_OS_NAME"
| Mac OS X or Windows
| |
name="SYSTEM_VM_VERSION"
| Java VM version like: 1.5.0_16
| |
name="SYSTEM_DEFAULT_CHARSET"
| like ‘MacRoman’ or ‘windows-1252’
| |
name="TRANSFORM_ENGINE"
| BatchXSLT VV.vv
| |
name="INPUT_PATH"
| main source path
| |
name="INPUT_SUB_PATH"
| subpath below INPUT_PATH
| |
name="INPUT_NAME"
| name of IDML file
| |
name="OUTPUT_PATH"
| path to output directory
| |
name="OUTPUT_NAME"
| name of xml file
| |
name="STYLESHEET_PATH"
| path to main xsl ‘IMXepeper.xse’
| |
name="STYLESHEET_NAME"
| IMXepaper.xse
| |
name="LOGFILE_WRITE"
| 1 to write messages into log file
| |
name="LOGFILE_PATH"
| path to such log files
| |
name="LOGFILE_NAME"
| name of a log file
| |
name="USER_NAME"
| the user’s login name
| |
name="USER_HOME"
| the user’s home folder
| |
name="USER_DIR"
| current program’s directory
| |
name="LOCAL_MACHINE_NAME"
| the machine’s name
| |
name="GS_VERSION"
| Ghostscript version string
| |
name="GS_VERSION_NUM"
| Ghostscript version number
| |
name="GS_PGM_PATH"
| path to Ghostscript
| |
name="GS_ENVIR"
| Environment for Ghostscript
| |
name="IM_VERSION"
| ImageMagick version string
| |
name="IM_VERSION_NUM"
| ImageMagick version number
| |
name="IM_PGM_PATH"
| path to ImageMagick
| |
name="IM_ENVIR"
| Environment for ImageMagick
| |
name="USERLICENSE_TYPE"
| license type: 0 = normal, 1 = DEMO
| |
par
| The following parameters are passed to the transform XSL using ‘tp_xx’ statements.
| |
Debugging and intermediary files
| ||
name="DEBUG"
| 1 to show DEBUG messages in console window.
if set, ‘INTERMEDIARY_XML_preserve’ will be set automatically
| |
name="DEBUGIMAGES"
| 1 to show messages from image converters only
| |
name="DEBUG_cssfile"
| 1 to show debug info for CSS file creation
| |
name="INTERMEDIARY_XML_only"
| 1 to create the intermediary XML file only. default = 0
|
name="INTERMEDIARY_XML_preserve"
| 1 to not to delete the intermediary XML file. default = 0
| |
Output type and final transform
| ||
name="outputMode"
| output view mode:
0 = flipbook 1 = as pages ePaper 2 = as article list 3 = as XML tree all output modes are created from the same main intermediary XML file
| |
name="outputModeCustomXSL"
| name of a custom transform XSL if outputMode > 3
| |
name="OUTPUT_FEATURES"
| 0 = export elements and attributes of Standard version only,
2 = in addition export all PRO Elements and attributes | |
Page previews
| ||
name="pageJPEGScale"
| Scale for page JPEGs or fixed width in pixels. default = 330x
means: 330 pixels in width.
| |
name="pageJPEGQuality"
| Quality of page JPEGs (1..100), default = 90.
the lower this value, the poorer the image quality, the smaller the file size
| |
name="pageJPEGdpi"
| DPI of page JPEGs. default = 150
the lower this value, the poorer the image quality, the smaller the file size
| |
name="pageJPEGParams"
| custom parameters for page JPEG creation (see ImageMagick manual)
| |
name="documentPDFname"
| name of document PDF or empty for no document PDF
| |
Image exports and conversion
| ||
name="imageTYPE"
| Type of image conversion:
0 = don’t export images, 1 = JPEG, 2 = GIF, 3 = PNG, 4 = TIFF | |
name="imageQUALITY"
| JPEG quality (1..100), default = 90
| |
name="imageDPI"
| JPEG DPI (default = 400,300).
images are read in with 400 dpi, the output image will be 300 dpi.
the lower these values, the poorer the image quality, the smaller the file size
| |
name="imageSCALE"
| JPEG scale: 1.0 = default = original size
Any decimal number like 2.0, 3.32 as a scale factor or
a fixed width like "300x" for 300 pixels in width
a fixed height like "x250" for 250 pixels in height
| |
name="imageDoROTATE"
| rotate outout images: 0 = default = don’t rotate, otherwise rotate them
| |
name="imageCUT2imagebox"
| cut images to containing image box:
1 = default = cut to image box, 0 = cut to original image | |
name="imagePARAMS"
| JPEG custom parameters (see ImageMagick manual)
| |
name="imageCopyToOutput"
| 1 to copy original images to output folder.
Used also to extract text from PDF for full-text search | |
name="imageEXCLUDE"
| semicolon separated list of patterns to exclude images.
images whose file names start with one these patterns are not exported: default = excl_;555 | |
name="imageCROP"
| 1 = default = crop images to box size,
0 = don’t crop, use original image | |
name="imagesMORE"
| Parameters for additional images
| |
name="imageNOCONVERT"
| 1 to export imag boxes but not converted image
|
name="CROPBOXmode"
| How to handle PDF Crop and Trim boxes. Addable flags (default = 124):
0 = convert PDFs ‘as is’ - don’t touch them.
1 = try to replace ArtBox with CropBox if no CropBox and not TrimBox is defined.
2 = do crop PDFs to CropBox or TrimBox if defined.
4 = ad a crop command to trim to imagebox
| |
name="PDFhasCropBox"
| 1 to indicate, that PDFs always have a CropBox. default = 0
|
name="PDFhasTrimBox"
| 1 to indicate, that PDFs always have a TrimBox. default = 0
| |
name="COLORPROFILE_remove"
| color profiles REMOVE command for ImageMagick
default = empty to not to remove profiles | |
name="COLORPROFILE_TIFF"
| Path to color profile to use for specific image types
| |
name="COLORPROFILE_EPS"
| ||
name="COLORPROFILE_AI"
| ||
name="COLORPROFILE_PSD"
| ||
name="COLORPROFILE_ALL"
| ||
name="COLORPROFILE_OUTPUT"
| the output color profile to use
default = empty = Utilities/Profiles/ColorMatchRGB.icc | |
name="COLORSPACE"
| ImageMagik command for output color space.
default = empty = -colorspace RGB | |
name="MAX_IMAGENAME_LENGTH"
| max length of image names, default = 31
| |
CSS and XSL
| ||
name="XSLCSSPath"
| relative path or absolute URL to external files like XSL, JavaScripts, CSS and helpers.
default = empty, which wil result in a path like ../../../XSLCSS/’ depending on the nested output folder structure
| |
name="CSSpath"
| path to linked external CSS. default is the content of ‘XSLCSSPath’
| |
name="CSSname"
| name of linked CSS or empty to auto-generate.
if empty, a CSS is generated with a similar name like the document’s name.
to use a (manually) adapted CSS state the name of this CSS.
existing CSS files by default are not overwritten.
| |
name="CSSnameFinal"
| the name of the final linked CSS.
if "CSSname " was empty, a CSS was generated with a similar name like the document’s name.
| |
name="overwriteCSSfiles"
| 1 to always recreate the CSS.
0 = default = don’t overwrite existing CSS | |
name="CSSexpanded"
| 1 to export enhanced CSS infos. all style attributes are exported into a commented section within a CSS declaration of a style.
| |
Box catching and sorting
| ||
name="catchRadius"
| the box catch radius. default = 0
Zero means, that all boxes at least touching a neighbour box are captured into the same article.
set to any value like for example 3 to also catch boxes into the same article even if the boxes don’t directly touch each other.
box catching can be turned of by the following ‘allBoxesNoCatch’ parameter.
| |
name="allBoxesNoCatch"
| combined flags for the following 4 catch types
0 = normal 1 = catch for all box types turned off 2 = catch for empty boxes types turned off 4 = catch for image boxes types turned off 8 = catch for chained text boxes types turned off 16= catch for text boxes types turned off | |
name="emptyBoxesNoCatch"
| 1 = empty boxes don’t catch. default = 1
| |
name="textBoxesNoCatch"
| 1 = text boxes don’t catch. default = 0
| |
name="chainedBoxesNoCatch"
| 1 = chained text boxes don’t catch. default = 0
| |
name="imageBoxesNoCatch"
| 1 = image boxes don’t catch. default = 0
| |
name="groupBoxesToArticles"
| 1 to create article groups from touching boxes. default = 1
| |
name="sortBoxesByAreaSize"
| 1 to sort boxes by surrounding area box. default = 1
| |
name="sortBoxesByYposition"
| 1 to sort boxes by Y position. default = 1
|
name="sortBoxYtolerance"
| the tolerance for Y sorting. default = 1.5
| |
Font handling
| ||
name="replaceFont"
| list of fonts to replace. default = empty
| |
name="fontsizeFactor"
| font size resize factor. default = empty
|
name="fontsizeMinimum"
| smallest font size. default = 8
| |
name="wwwLinkStyles"
| list of styles acting as www links. default = ‘wwwLink’
| |
name="continuedArticleStyles"
| style names linking to the next part of an article. default = empty
| |
Tables handling
| ||
name="TABLE_CELLS_WIDTH_PRESERVE"
| non empty to resize cells by a factor
| |
name="TABLE_BORDER_COLLAPSE"
| 1 = default to collaps cell borders
| |
name="TABLE_AS_BLOCK"
| 1 to export tables always on a new line
| |
Text and styles handling
| ||
name="ALLOW_PARACLASS_OVERRIDES"
| 1 to allow overriding paragraph classes.
0 to suppress overridden styles of classes | |
name="preserverControlCharacters"
| 1 to preserve all control characters. dafault = 0
| |
name="preconvertTextFlags"
| see ‘public.js’ for a description of flags
| |
Flip book look and behaviour
| ||
name="addMissingPages"
| 1 to add missing pages in a flipbook
| |
name="showArticleInNewWindow"
| 1 to open clicked article in new window
| |
name="suppressSiteElements"
| addable flags to suppress elements in output html flipbook web site
0 = default to show all flipbook site elements 1 to suppress the whole top head - page navigation 2 to suppress the bottom PDF toolbar 4 to suppress the loading progress 8 to suppress the info message text below pages add each flag with its own char like: ‘148’ | |
name="suppressExportMouseOvers"
| addable flags to suppress export and mouse overs in output html flipbook web site (processed by flipbook.xsl)
1 to completely suppress the mouse over function 2 to suppress all text and the mouse over text 4 to suppress all images and the mouse over images add each flag as it own char like: ‘14’ | |
Layers handling
| ||
name="includeLayers"
| 1 to include layers info in resulting XML
| |
name="excludeHiddenLayers"
| 1 to not to export hidden layers. dafault = 0
| |
Special information
| ||
name="includeMetaData"
| 1 to include meta data info. dafault = 0
| |
name="excludeNotes"
| 1 to not to export Notes. dafault = 0
| |
name="includeDescription"
| 1 to include simple output description at end of output
| |
name="XPLATFORM_NAMES"
| 0 or blank = do not encode filenames
1 = URI encode (%XX), 2 = default = Xplatform safe URI encode to (xXX) | |
name="FOLDERINDEXNAME"
| non empty to create an output index.htm file. default = index.htm
| |
name="INTERNET_AWARE_FONTNAMES"
| 1 to remove unsafe characters from font names. default = empty
| |
User definable parameters
| ||
name="userVar1"
| user definable parameters
| |
name="userVar2"
| ||
name="userVar3"
|
The Printer’s Side
During the discussed production process, when a page is approved to be output for print, the base export for BatchXSLT for InDesign is created in a more or less automated way.
Once the production of the entire print product is complete, the base data from all InDesign pages is ready on the "Data Server" to be fetched by the Data Provider.
| The Data Provider’s Side
Sometime at night, the Data Provider will fetch all data from the Data Server to convert it to ePaper.
|
Exported XML Elements and Attributes
| ||
Complete list of elements and attributes exported by BatchXSLT for InDesign.
All units (where not marked) are in PostScript (72 pts/inch). ‘PRO’ marked elements/attributes are for checked “Export PRO Attributes”.
| ||
BatchXSLT4InDesign XML
| ||
Element
| Attributes
| Function
|
indd_document
| the all enclosing document element
| |
call_parameters
| info on how the transform was called (see below)
| |
doctypeinfos
| also see call_parameters
| |
xslbasepath
| path to XSLCSS folder like: "../../../XSLCSS/"
| |
csspath
| Path to CSS to link to document
| |
xslpath
| Path to XSL for resulting view mode
| |
encoding
| UTF-8 always
| |
CONTENT
| empty
| |
header
| the header element with headerfield childs
| |
type="layout"
| the layout header
| |
CONTENT
| ‘headerfield’ elements
| |
headerfield
| header fields within header tag CONTENT
| |
name="creationYear"
| 4-digits creation year like 2009
| |
name="creationDate"
| 8-digits creation date YYYYMMDD like 20090623
| |
name="creationTime"
| creation time HH:MM:SS
| |
name="outputVersion"
| output version
| |
name="filename"
| this output XML file’s name
| |
name="inputPath"
| full path to export folder
| |
name="sourceINXfileName"
| name of IDML file
| |
name="operatingSystem"
| creator operating system
| |
name="vmVersion"
| Java VM version
| |
name="transformEngine"
| name and version string of transformer
| |
name="xsltVersion"
| main transform version
| |
name="xsltVersionDate"
| main transform version date
| |
name="creator"
| InDesign document file infos
| |
name="description"
| „
| |
name="title"
| „
| |
name="rights"
| „
| |
name="AuthorsPosition
| „
| |
name="CaptionWriter"
| „
| |
name="copyrightStatus"
| „
| |
name="WebStatement"
| „
| |
name="subject"
| „
| |
page
| page elements
| |
Self
| internal page ID
| |
page_sequence
| physical page sequence in document. starts with1
| |
page_name
| chapter page name
| |
pageOnSpread
| number of this page on the spread
| |
page_side
| page side: "lfth", "rgth" or "usex"
| |
w
| page width
| |
h
| page height
| |
page_left
| position of left paper border from center spread
| |
page_right
| position of right paper border from center spread
| |
spread
| spread number of this page is located
| |
PRO
| master
| master this page is based on
|
PRO
| colcnt
| column count
|
PRO
| colgutt
| column gutter width
|
PRO
| coldir
| column direction
|
PRO
| margtop
| margin top
|
PRO
| margbott
| margin bottom
|
PRO
| margleft
| margin left
|
PRO
| margright
| margin right
|
PRO
| numbtypesc
| page numbering type shortcut
|
PRO
| sectprefix
| section prefix
|
PRO
| numbtype
| numbering type like "1,2,3,4..."
|
PRO
| autonumb
| automatic page numbering [t..f]
|
PRO
| startpage
| the page number if startnumb is ‘t’
|
PRO
| addsectionmarker
| start with page number with section marker [t..f]
|
PRO
| sectmark
| section marker
|
CONTENT
| elements: ‘pageJPEG’, ‘pagePDF’, ‘articles’, ‘group’
| |
pageJPEG
| the JPEG view of a page
| |
name
| unencoded disk file name
| |
page_sequence
| physical page sequence in document
| |
page_name
| chapter page name
| |
sizefactor
| the resize factor compared to original page size
| |
scale
| same as sizefactor but in %
| |
original
| name of the original size JPEG
| |
w
| page JPEG width
| |
h
| page JPEG height
| |
CONTENT
| URI-encoded name of JPEG file without path
| |
pagePDF
| the PDF view of a page
| |
name
| unencoded disk file name
| |
page_sequence
| physical page sequence in document
| |
page_name
| chapter page name
| |
fullpath
| The path to the PDF during export time
| |
CONTENT
| name of PDF file without path
| |
articles
| a container for articles on a page
| |
page_sequence
| the page sequence
| |
CONTENT
| element: ‘article’
| |
article
| an article constructed of one or several boxes
| |
idx
| article index in document starting with 0
| |
page_sequence
| physical page sequence in document
| |
page_name
| chapter page name
| |
coords
| the enclosing coordinates unscaled: left, top, right, bottom
| |
ls
| left position scaled to page JPEG size
| |
ts
| top position scaled to page JPEG size
| |
rs
| right position scaled to page JPEG size
| |
bs
| bottom position scaled to page JPEG size
| |
l
| left position unscaled
| |
t
| top position unscaled
| |
r
| right position unscaled
| |
b
| bottom position unscaled
| |
CONTENT
| elements: ‘boxchain’, ‘content’
| |
boxchain
| the boxes which build this article
| |
CONTENT
| element: ‘box’
| |
box
| type="empty"
type="imag" type="text" type="chained_text" type="line" (PRO) type="push" | empty box
image box text box chained text box line pusg button |
cont
| content type of box:
‘unas’ = unassigned content (including line boxes) ‘empty’ = empty image or text box ‘text’ = a text box ‘anchored_text’ = an anchored text box ‘chained_text’ = a chained text box ‘imag’ = an image box ‘anchored_imag’ = an anchored image box | |
Self
| box id
| |
spread
| spread number
| |
page_sequence
| physical page number
| |
page_name
| page section number
| |
groupid
| group box id if box is in a group
| |
anchorid
| anchor id. For anchored box non empty
| |
angle
| angle if box is rotated
| |
coords
| html coords rounded pixels: left,top,right,bottom
| |
bbox
| bounding box as doubles: left,top,right,bottom
| |
shape
| box shape points scaled/rounded to size of page jpeg
| |
shape_orig
| box shape points
| |
pageJPEGScale
| scale factor of output page jpeg
| |
y1 (px)
| top rounded
| |
x1 (px)
| left rounded
| |
y2 (px)
| bottom rounded
| |
x2 (px)
| right rounded
| |
matrix
| box transform matrix of scaled box:
(scale, rotation, displace) | |
matrix_orig
| box transform matrix unscaled original
| |
layerID
| layer id the box is placed on
| |
layerName
| name of this layer
| |
layerVis
| visibility of layer: ‘t’ = visible
| |
label
| box label text
|
backgroundColor
| box background color
| |
PRO
| backgroundColorID
| box background color ID pointing into the color table:
extended_infos/colors/color/@Self |
PRO
| backgroundColorFilt
| box background color tint value
|
frameWeightX
| frame border weight unrounded
| |
frameWeight
| frame border weight
| |
frameColor
| frame border color
| |
PRO
| frameColorID
| box background color ID pointing into the color table:
extended_infos/colors/color/@Self |
PRO
| frameColorFilt
| filter / shade value -1...100, (-1 is 100)
|
PRO
| frameStyleName
| name of frame style
|
PRO
| frameStyleHTML
| html style frame: solid, double, dotted, dashed
|
PRO
| frameGapColor
| frame gap color RGB
|
PRO
| frameGapColorID
| frame gap color ID
|
PRO
| frameGapColorTint
| frame gap color tint / filter / shade value -1...100, (-1 is 100)
|
line PRO
| leftFrameEnd
| line ending left:
attribute not present if no line ending
‘brah’ =Bar ‘ssah’ = SquareSolid ‘sqah’ = Square ‘csah’ = CircleSolid ‘crah’ = Circle ‘cvah’ = Curved ‘barb’ = Barbed ‘twah’ = TriangleWide ‘trin’ = Triangle ‘swah’ = SimpleWide ‘simp’ = Simple |
line PRO
| rightFrameEnd
| line ending right (see line ending left)
|
box @type=’text’ cont.
| additional attributes for text boxes
| |
insetTopR
| text inset top rounded
| |
insetLeftR
| text inset left rounded
| |
insetBottomR
| text inset bottom rounded
| |
insetRightR
| text inset right rounded
| |
insetTop
| text inset top as double
| |
insetLeft
| text inset left as double
| |
insetBottom
| text inset bottom as double
| |
insetRight
| text inset right as double
| |
chainidx
| 0-based index in box in a chain
| |
firstflowid
| id of first box in a chain
| |
lastflowid
| id of last box in a chain
| |
textflowid
| id of this box in a chain points to it’s content: content/@id
| |
previousflowid
| id of previous box in chain or ‘n’ if none
| |
nextflowid
| id of next box in chain or ‘n’ if none
| |
colcnt
| number of columns in textbox
| |
colwidth
| width of a column
| |
colgutter
| width of column gutter
| |
vjust
| vertical justification of text within box:
top = Align Top
middle = Align Center
bottom = Align Bottom
vjust = Justify Vertically
| |
paraspacelimit
| maximum paragraph space
| |
CONTENT
| empty
| |
box @type=
’anchored_text’ or ’anchored_imag’ cont. | additional attributes for anchored text and image boxes
| |
PRO
| ao_NoManualPos
| prevent manual positioning: [t | f]
|
PRO
| ao_Position
| positioning: AOPi = inline, AOPa = Above Line, AoPa = custom
|
PRO
| ao_yOffset
| inline y offset or ‘above line: space after’
|
PRO
| ao_yOffsetAfter
| above line: space before
|
PRO
| ao_xOffset
| custom x offset
|
PRO
| ao_horizAlign
| left, cent, rght, txal (also see ao_relSpine)
|
PRO
| ao_relSpine
| relative to spine [t | f]
|
PRO
| ao_refPoint
| reference Point of Anchored Object:
ANtl = top left
ANtc = top center
ANtr = top right
ANlc = left center
ANbl = bottom left
ANbc = bottom center
ANtr = top right
ANrc = right center
ANct = center
|
PRO
| ao_xRelTo
| anchored position X relative to:
txtf = text frame
APan = anchor marker
APco = column edge
APmg = page margin
APpg = page edge
|
PRO
| ao_yRelTo
| anchored position Y relative to:
AVba = baseline
AVxc = Cap Height
AVbl = Top of Leading
APco = column edge
txtf = Text Frame
APmg = page margin
APpg = page edge
|
PRO
| ao_keepColBound
| keep with top/bottom coulumn boundaries [t | f]
|
box @type=’push’
| additional attributes for push button boxes
| |
buttonname
| name of this button
| |
onaction
| the action event
| |
button
| all box attributes as well as...
| ... the content and action of buttons
|
type
| push
| |
cont
| push
| |
buttonname
| name of this button
| |
onaction
| the action event
| |
moviewidth
| width of the movie frame
| |
movieheight
| height of the movie frame
| |
CONTENT
| action, buttonstate
| |
button/action
@type="Movie" | push button actions for movies
| |
event
| event actions:
muev=onMouseUp mdev=onClick meev=onMouseOver mxev=onMouseOut ofev=onFocus obev=onBlur | |
operation
| what to do on event:
play, stop, paus, resu |
movieID
| ID of the movie
| |
name
| name of the movie file
| |
path
| path to the movie file
| |
CONTENT
| empty
| |
button/action
@type="Sound" | push button actions for sound
| |
event
| event actions:
muev=onMouseUp mdev=onClick meev=onMouseOver mxev=onMouseOut ofev=onFocus obev=onBlur | |
operation
| what to do on event:
play, stop, paus, resu | |
soundID
| ID of the sound
| |
name
| name of the sound file
| |
path
| path to the sound file
| |
CONTENT
| empty
| |
button/ buttonstate
| push button states
| |
id
| the id of this state
| |
name
| ‘Up’ or ‘Rollover’
| |
CONTENT
| content
| |
content
| the content of article / box
| |
type
| ‘text’ or ‘image’
| |
Self
| a reference
| |
idx
| content id (usually same as Self) points to box/@ textflowid
| |
anchor_id
| non empty if containing box is anchored
| |
exist
| for image boxes set to 1 if image exists
| |
label
| box label text
| |
insetTopR
| box inset real values
| |
insetLeftR
| ||
insetBottomR
| ||
insetRightR
| ||
insetTop
| box inset rounded pixel values
| |
insetLeft
| ||
insetBottom
| ||
insetRight
| ||
backgroundColor
| the box background color if any
| |
image
| angle
| angle of image
|
image
| scaleX
| image scale X
|
image
| scaleY
| image scale Y
|
PRO image
| displaceX
| image displace X within image box
|
PRO image
| displaceY
| image displace Y within image box
|
CONTENT
| element ‘div’ for text boxes
| |
‘img’, ‘img2’ for image boxes
| ||
div
| if content @type=’text’
| paragraph attributes
|
class
| CSS class name
| |
style="margin-left:#px;"
| combinable HTM style attributes: left margin
|
style="text-indent:#px;"
| first line indent
| |
style="margin-right:#px;"
| right margin
| |
style="margin-top:#px;"
| top margin
| |
style="margin-bottom:#px;"
| bottom margin
| |
style="text-align:xxx"
| where xxx: left, center, right, justify
| |
PRO
| pstyID
| paragraph style id. points to
//extended_infos/stylesheets/paragraphs/@Self
|
PRO
| cstyID
| character style id. points to
//extended_infos/stylesheets/characters/@Self
|
PRO
| fontSize
| font real size in pt
|
PRO
| fontColorID
| font color ID (points into <colors> section)
|
PRO
| fontColorFilt
| font color tint
|
PRO
| fontStyle
| font style: Roman, Regular, Italic..., 1,2...
|
PRO
| fontSkew
| font skew/angle (false italic) in degrees
|
PRO
| underline
| underline = ‘t’ or ‘f’ for true or false
|
PRO
| capsMode
| caps mode: ‘alcp’ = All Caps, ‘smcp‘ = Small Caps
|
PRO
| charPos
| position: ‘spsc ‘ = Superscript, ‘sbsc‘ = Subscript
|
PRO
| strike
| strikethrough: ‘t‘ = strike
|
PRO
| fontFamily
| font family like ‘Times’, ‘Verdana’, ‘Mignon’...
|
PRO
| fontName
| font name incl. style: ‘Times Roman’, ‘Mignon Italic’...
|
PRO
| fontNamePS
| postscript font name: ‘Times-Roman’, ‘Minion-Italic ‘...
|
PRO
| baseShift
| base line shift value
|
PRO
| scaleHoriz
| horizontal font scale value in percent
|
PRO
| scaleVert
| vertical font scale value in percent
|
PRO
| leading
| line leading in pt
|
PRO
| kerning
| kerning in 1/1000th em
|
PRO
| nobreak
| non breaking text section = ‘t’
|
PRO
| ligatures
| ligatures: ‘t’ if ligatures should be used, ‘f’ for no ligatures
|
PRO
| tracking
| tracking in 1/1000th em
|
PRO
| margtop
| margin top
|
PRO
| margleft
| margin left
|
PRO
| margbott
| margin bottom
|
PRO
| margright
| margin right
|
PRO
| firstLineIndent
| first line text indent
|
PRO
| conditionID
| if conditional text, this ID points into element:
extended_infos/textconditions/condition[@Self=conditionID]
|
CONTENT
| elements: ‘span’, ‘br’, text
| |
PRO paraopts
| paragraph options containing elements:
parasets, pararules, paralist, paratabs
| |
PRO parasets
| paraStyleID, charStyleID, insetLeft, insetRight, insetFirstline, insetLastLineRight, lineLeading, dropCapsChars, dropCapLines, hyph, adjustBaseLine, aligneToSpine
| general paragraph settings
|
PRO pararules
| colorID, size, tint, offset, leftIndent, rightIndent, overprint, on, keepInFrame
| paragraph rules elements: paraRuleAbove, paraRuleBelow
|
PRO paralist
| type, styleID, align, textAfter, numberStyle, contStyle, numberFormat, level
| paragraph list definistions
|
PRO paratabs
| align, alignChar, leaderChar, pos
| tab attributes for each set tab
|
span
| text attributes change
| |
class
| CSS class name of character style
|
style="font-family:’Arial’,..."
| font name
| |
style="font-family:...,’Arial Bold Italic’;"
| Mac style name
| |
style="font-style:italic; "
| font style (normal, italic...)
| |
style="font-weight:bold;"
| font weight (normal, bold...)
| |
style="color:#ff0000; "
| font color RGB
| |
style="font-size:xxpt; "
| size in pt
| |
style="vertical-align:super;"
| supper script
| |
style="vertical-align:sub;"
| sub script
| |
PRO
| cstyID
| character style id. points to
//extended_infos/stylesheets/characters/@Self
|
PRO
| fontStyle
| font style: Roman, Regular, Italic..., 1,2...
|
PRO
| fontSkew
| font skew/angle (false italic) in degrees
|
PRO
| underline
| underline = ‘t’ or ‘f’ for true or false
|
PRO
| capsMode
| caps mode: ‘alcp’ = All Caps, ‘smcp ‘ = Small Caps
|
PRO
| charPos
| position: ‘spsc ‘ = Superscript, ‘sbsc ‘ = Subscript
|
PRO
| strike
| strikethrough: ‘t‘ = strike
|
PRO
| fontFamily
| font family like ‘Times’, ‘Verdana’, ‘Mignon’...
|
PRO
| fontName
| font name incl. style: ‘Times Roman’, ‘Mignon Italic’...
|
PRO
| fontNamePS
| postscript font name: ‘Times-Roman’, ‘Minion-Italic ‘...
|
PRO
| baseShift
| base line shift value
|
PRO
| scaleHoriz
| horizontal font scale value in percent
|
PRO
| scaleVert
| vertical font scale value in percent
|
PRO
| leading
| line leading in pt
|
PRO
| kerning
| kerning in 1/1000th em
|
PRO
| nobreak
| non breaking text section = ‘t’
|
PRO
| ligatures
| ligatures: ‘t’ if ligatures should be used, ‘f’ for no ligatures
|
PRO
| tracking
| tracking in 1/1000th em
|
CONTENT
| elements: ‘span’, ‘br’, text
| |
img, img2
| image and 2nd image element
| |
src
| name of converted JPEG
| |
alt
| original image name
| |
CONTENT
| empty
| |
table
| InDesign tables tagged linke HTML
| |
class
| table css class name
| |
style="border-left-style:html style"
| solid, double, dashed, dotted
| |
style="border-right-style:html style"
| ||
style="border-top-style:html style"
| ||
style="border-bottom-style:html style"
| ||
style="border-left-width:rounded px"
| up-rounded to full pixels
| |
style="border-right-width:rounded px"
| ||
style="border-top-width:rounded px"
| ||
style="border-bottom-width:rounded px"
| ||
style="border-left-color:#rgb"
| RGB color
| |
style="border-right-color:#rgb"
| ||
style="border-top-color:#rgb"
| ||
style="border-bottom-color:#rgb"
|
style="padding-left"
| Text inset left
| |
style="padding-top"
| ||
style="padding-right"
|
style="padding-bottom"
| ||
PRO
| Self
| this table’s ID
|
PRO
| anchor_id
| anchor ID
|
PRO
| tablestyleID
| table style ID applied to this table
|
PRO
| rows
| number of rows in table
|
PRO
| cols
| number of columns in table
|
PRO
| headerrows
| number of head rows in table
|
PRO
| footerrows
| number of foot rows in table
|
PRO
| rowfillFirstcolorID
| row fill first color ID
|
PRO
| rowfillFirstcolorTint
| row fill first color tint
|
PRO
| rowfillFirstcolorCount
| row fill first color count
|
PRO
| rowfillStartcolorSkip
| how many rows to skip at top until color fill
|
PRO
| rowfillSecondcolorID
| row fill second color ID
|
PRO
| rowfillSecondcolorTint
| row fill second color tint
|
PRO
| rowfillSecondcolorCount
| row fill second color count
|
PRO
| rowfillEndcolorSkip
| how many rows at bottom to not to fill with colo
|
PRO
| borderLeftStyle
| name of left border style: solid, dashed....
|
PRO
| borderLeftStyleID
| left border style ID
|
PRO
| borderLeftWidth
| left border width
|
PRO
| borderLeftColorID
| left border color ID
|
PRO
| borderLeftColorTint
| left border color tint
|
PRO
| borderLeftGapColorID
| left border gap color ID
|
PRO
| borderLeftGapColorTint
| left border gap color tint
|
PRO
| borderLeftColor
| left border RGB color
|
PRO
| borderTopStyle
| name of top border style: solid, dashed....
|
PRO
| borderTopStyleID
| top border style ID
|
PRO
| borderTopWidth
| top border width
|
PRO
| borderTopColorID
| top border color ID
|
PRO
| borderTopColorTint
| top border color tint
|
PRO
| borderTopGapColorID
| top border gap color ID
|
PRO
| borderTopGapColorTint
| top border gap color tint
|
PRO
| borderTopColor
| top border RGB color
|
PRO
| borderRightStyle
| name of right border style: solid, dashed....
|
PRO
| borderRightStyleID
| right border style ID
|
PRO
| borderRightWidth
| right border width
|
PRO
| borderRightColorID
| right border color ID
|
PRO
| borderRightColorTint
| right border color tint
|
PRO
| borderRightGapColorID
| right border gap color ID
|
PRO
| borderRightGapColorTint
| right border gap color tint
|
PRO
| borderRightColor
| right border RGB color
|
PRO
| borderBottomStyle
| name of bottom border style: solid, dashed....
|
PRO
| borderBottomStyleID
| bottom border style ID
|
PRO
| borderBottomWidth
| bottom border width
|
PRO
| borderBottomColorID
| bottom border color ID
|
PRO
| borderBottomColorTint
| bottom border color tint
|
PRO
| borderBottomGapColorID
| bottom border gap color ID
|
PRO
| borderBottomGapColorTint
| bottom border gap color tint
|
PRO
| borderBottomColor
| bottom border RGB color
|
PRO - tablesettings
| additional table setup infos element
| |
PRO - tablesettings/
rowheights/row | rownum
| row number
|
minheight
| minimum height (row height at export time)
| |
PRO - tablesettings/ rowheights/total
| height
| total height of all rows (table height)
|
PRO - tablesettings/
colwidths/col | colnum
| column number
|
width
| column width
| |
PRO - tablesettings/ colwidths/total
| width
| total width of all columns (table width)
|
table/tr
| table row
| |
HTML style attributes:
| ||
style="border-left-style:html style"
| solid, double, dashed, dotted
| |
style="border-right-style:html style"
| ||
style="border-top-style:html style"
| ||
style="border-bottom-style:html style"
| ||
style="border-left-width:rounded px"
| up-rounded to full pixels
| |
style="border-right-width:rounded px"
| ||
style="border-top-width:rounded px"
| ||
style="border-bottom-width:rounded px"
| ||
style="border-left-color:#rgb"
| RGB color
| |
style="border-right-color:#rgb"
| ||
style="border-top-color:#rgb"
| ||
style="border-bottom-color:#rgb"
| ||
PRO
| height
| row height
|
PRO
| backgroundColor
| background color RGB
|
table/tr/td
| table cell
| |
colwidth
| width of cell
| |
colspan
| number of columns to span
| |
rowspan
| number of rows to span
| |
valign
| vertical justification of text within cell:
top = Align Top
middle = Align Center
bottom = Align Bottom
vjust = Justify Vertically
| |
HTML style attributes:
| ||
style="border-left-style:html style"
| border styles: solid, double, dashed, dotted
| |
style="border-right-style:html style"
| ||
style="border-top-style:html style"
| ||
style="border-bottom-style:html style"
| ||
style="border-left-width:rounded px"
| border width up-rounded to full pixels
| |
style="border-right-width:rounded px"
| ||
style="border-top-width:rounded px"
| ||
style="border-bottom-width:rounded px"
| ||
style="border-left-color:#rgb"
| border RGB color
| |
style="border-right-color:#rgb"
| ||
style="border-top-color:#rgb"
| ||
style="border-bottom-color:#rgb"
| ||
style="background-color:#rgb"
| cell color
| |
style="padding-left"
| text inset left
|
style="padding-top"
| text inset top
| |
style="padding-right"
| text inset right
| |
style="padding-bottom"
| text inset bottom
|
PRO
| textInsetLeft
| cell text insets
|
PRO
| textInsetTop
| |
PRO
| textInsetRight
| |
PRO
| textInsetBottom
| |
PRO
| borderLeftWidthX
| left cell border as unrounded double value
|
PRO
| borderLeftWidth
| left cell border as uprounded full pixels
|
PRO
| borderLeftColorID
| left cell border color ID
|
PRO
| borderLeftStyleID
| left cell border stroke style ID
|
PRO
| borderLeftGapColor
| left cell border gap color RGB
|
PRO
| borderLeftGapColorID
| left cell border gap color ID
|
PRO
| borderLeftGapColorTint
| left cell border gap color tint
|
PRO
| borderTopWidthX
| top cell border as unrounded double value
|
PRO
| borderTopWidth
| top cell border as uprounded full pixels
|
PRO
| borderTopColorID
| top cell border color ID
|
PRO
| borderTopStyleID
| top cell border stroke style ID
|
PRO
| borderTopGapColor
| top cell border gap color RGB
|
PRO
| borderTopGapColorID
| top cell border gap color ID
|
PRO
| borderTopGapColorTint
| top cell border gap color tint
|
PRO
| borderRightWidthX
| right cell border as unrounded double value
|
PRO
| borderRightWidth
| right cell border as uprounded full pixels
|
PRO
| borderRightColorID
| right cell border color ID
|
PRO
| borderRightStyleID
| right cell border stroke style ID
|
PRO
| borderRightGapColor
| right cell border gap color RGB
|
PRO
| borderRightGapColorID
| right cell border gap color ID
|
PRO
| borderRightGapColorTint
| right cell border gap color tint
|
PRO
| borderBottomWidthX
| bottom cell border as unrounded double value
|
PRO
| borderBottomWidth
| bottom cell border as uprounded full pixels
|
PRO
| borderBottomColorID
| bottom cell border color ID
|
PRO
| borderBottomStyleID
| bottom cell border stroke style ID
|
PRO
| borderBottomGapColor
| bottom cell border gap color RGB
|
PRO
| borderBottomGapColorID
| bottom cell border gap color ID
|
PRO
| borderBottomGapColorTint
| bottom cell border gap color tint
|
CONTENT
| element: ‘div’
| |
Note
| hidden notes
| |
user
| name of user who created this note
| |
created
| cration date and time
| |
modified
| modification date and time
| |
stof
| id
| |
Note/content
| ||
type="Note"
| type of content
| |
Note/content/div
| ||
class
| CSS class name
| |
Note/content/div/.
| the note’s text
| |
footnote
| ||
footnote/footnote_num/.
| footnote number
| |
footnote/div/.
| the footnote text
|
documentPDF
| the PDF of the whole document
| |
name
| unencoded disk file name
|
fullpath
| the path to the PDF
| |
CONTENT
| URI encoded name of PDF file without path
| |
text variables are not marked but directly inserted into the text
| ||
layers
| layers descriptions
| |
name
| layer name
| |
visible
| ‘t’ for visible
| |
locked
| ‘t’ for locked
| |
print
| ‘t’ to print this layer content
| |
showguides
| ‘t’ to show guides on this layer
| |
lockguides
| ‘t’ to lock guides on this layer
| |
supptextwrap
| suppress text wrap when layer is hidden
| |
CONTENT
| empty
| |
metadata
| XML content with meta data
| |
image references
| ||
<rdf:li rdf:parseType="Resource">
<stMfs:linkForm>ReferenceStream</stMfs:linkForm> <stMfs:reference rdf:parseType="Resource"> <stRef:lastURL>file:///Users/andreasimhof/BatchXSLT4InDesign/BatchXSLT/_TestData/in/28_03chirac.eps</stRef:lastURL> </stMfs:reference> <xmpMM:placedXResolution>72.00</xmpMM:placedXResolution> <xmpMM:placedYResolution>72.00</xmpMM:placedYResolution> <xmpMM:placedResolutionUnit>Inches</xmpMM:placedResolutionUnit> </rdf:li> | ||
color references
| ||
<rdf:li rdf:parseType="Resource">
<xmpG:swatchName>C=100 M=0 Y=0 K=0</xmpG:swatchName> <xmpG:mode>CMYK</xmpG:mode> <xmpG:type>Process</xmpG:type> <xmpG:cyan>100</xmpG:cyan> <xmpG:magenta>0</xmpG:magenta> <xmpG:yellow>0</xmpG:yellow> <xmpG:black>0</xmpG:black> </rdf:li> | ||
font references
| ||
<rdf:li rdf:parseType="Resource">
<stFnt:fontName>Times-Italic</stFnt:fontName> <stFnt:fontFamily>Times</stFnt:fontFamily> <stFnt:fontFace>Italic</stFnt:fontFace> <stFnt:fontType>TrueType</stFnt:fontType> <stFnt:versionString>Times-Italic5.0d10e1</stFnt:versionString> <stFnt:composite>false</stFnt:composite> <stFnt:fontFileName>Times.dfont</stFnt:fontFileName> </rdf:li> | ||
Extended information elements PRO
All following elements are exported only when you have checked “Export PRO Attributes”.
| ||
extended_infos
| contained sub-elements
| The extended information element block
|
colors
| detailed information on a document’s colors
| |
fonts
| detailed information on a document’s fonts
| |
stylesheets
| detailed information on a document’s stylesheets
| |
textconditions
| detailed information on a document’s text conditions
| |
colors
| contained sub-elements
| |
color
| information for:
- color type
- color space - tints
- gradients | |
fonts
| contained sub-elements
| |
font-family
| The family containing the font
| |
font
| - font name
- postscript name - font style - font version and more | |
stylesheets
| contained sub-elements
| contained information
|
paragraphs
| - class name
- InDesign name - style id it is based on - font name - font color - font size - insets - hyphenation info - rules and more | |
characters
| - class name
- InDesign name - style id it is based on - font name - font color - font size and more | |
tables
| - background color
- row and column fills and strokes and more | |
objects
| - background color
- borders - position and more | |
strokes
| available stroke types
| |
textconditions
| contained sub-elements
| contained information
|
condition
| an element describing the text condition
Self="ID of this condition"
pnam="Condition name"
pvis="[t][f]" visibility true or false
pCTm="highlight mode"
ctTc="highlight color"
| |
Hook event names (folder names)
| Call point / Description
| Usage / Example
|
afterInit
| After all main initialization is done.
| args : null
Set new access paths, load a JobTicket matching the document name.
Ex. actions: modify settings matching a publications export requirements
|
beforeExport
| Before every document export is initialized (also before the main menu)
| args : null
If the retval is set to -1, this export is skipped - next hook is ‘afterExport’
Ex. actions: skip certain documents which should not be exported
|
beforeInitMainDialog
| Before the main dialog is initialized
| args : null
If the retval is set to -1, the dialog is silently skipped
|
beforeShowMainDialog
| After the main dialog is initialized but before it is shown
| args : null
|
afterShowMainDialog
| after the main dialog has been closed
| args : {"go":go}
Ex. actions: check the ‘go’ property to determine if the user has cancelled the export or if an export will stat
|
beforeDocExport
| before the actual Document Export Task starts
| args : null
Ex. actions: turn on/off conditional text, set text variables, check for overflow text
|
beforePageJPEGExport
| before the page JPEG preview image is created
| args : { "theFilePath": theFilePath, "jpegExportPreferences": jpegExportPreferences }
If the retval is set to -1, the page JPEG creation is skipped
Ex. actions: modify the JPEG export options
|
afterPageJPEGExport
| after a pge JPEG preview image has been created
| args : { "theFilePath": theFilePath }
Ex. actions: check if the JPEG file exists, create another page JPEG with different settings
|
beforePagePDFExport
| before the page PDF preview image is created
| args : { "theFilePath": theFilePath, "usepagepdfpresets": usepagepdfpresets }
If the retval is set to -1, the page PDF creation is skipped
Ex. actions: modify the PDF export options
|
afterPagePDFExport
| after a page PDF has been created
| args : { "theFilePath": theFilePath }
Ex. actions: check if the PDF file exists, create another page PDF with different settings
|
beforeDocPDFExport
| before the document PDF is created
| args : { "theFilePath": theFilePath, "usepagepdfpresets": usepagepdfpresets }
If the retval is set to -1, the document PDF creation is skipped
Ex. actions: modify the PDF export options
|
afterDocPDFExport
| after a document PDF has been created
| args : { "theFilePath": theFilePath }
Ex. actions: check if the PDF file exists, create another PDF with different settings
|
beforeSplitStories
| right before the check if all conditional text should be turned on
| args : null
If the retval is set to -1, this is skipped
Ex. actions: switch the type of story splitting
|
afterSplitStories
| after splitting is complete
| args : null
Ex. actions: restore the original story splitting flag
|
beforeTextCondVisible
| right before the check if all conditional text should be turned on
| args : null
If the retval is set to -1, this is skipped
Ex. actions: check/verify all conditional text
|
afterTextCondVisible
| after splitting is complete
| args : null
Ex. actions: restore the original text conditions
|
beforeExportImages
| before copying/preparing the original images
| args : null
If the retval is set to -1, image export is skipped
Ex. actions: check if all images exist or do something
|
afterExportImages
| after all original images have bee prepared
| args : null
|
beforeIDMLExport
| before the entire document ius exported to IDML
| args : null
Ex. actions: suppress some stuff in the XML
|
afterIDMLExport
| after IDML export completed
| args : null
|
afterDocExport
| after an export of a document has completed
| args : null
|
beforeWriteJobTickets
| before the JobTickets for the transformer will be written
| args : { "commpath":path }
where ‘path’ is the folder path to the communications folder
Ex. actions:
|
afterWriteJobTickets
| after the JobTickets have been written
| args : { "commpath":path }
where ‘path’ is the folder path to the communications folder
Ex. actions: write one or more JobTickets for the transformer to automatically create any number of dedicated XML output
|
afterExport
| After a document export successfully is completed
| args: null
Ex. actions: set and load a new JobTicket, set the variable ‘exportReRun’ = true; to loop to a next export run. Hook ‘beforeExport’ will be the next hook event.
|
afterExportError
| After a document export terminated with an error
| args: {"success":success}
where: success = errorcode
-1 = aborted
or other error codes
Ex. actions: notify user, write to log file, check the error, correct it and redo the export by setting the variable ‘exportReRun’ = true
|
beforeExit
| Before the exporter script terminates
| args: {"success":success}
Ex. actions: notify user, write to log file
|
Command
| Parameters
| Description
|
nothing
| nothing
| Call the Transformer without any parameters like
192.168.1.99:8180
Depending on the security setting
httpCommander_secure=0[1]
the httpCommander will return the following:
if httpCommander_secure=0
Return: ready if httpCommander_secure=1
Return: the html login screen defined in the file ‘login.htm’ from the folder CommanderHTTP |
User commands
| ||
user
| user name
| If
httpCommander_secure=1
is set in autostart.jt
The user’s name to log in.
Must provide password too - see below |
pass
| the password
| If
httpCommander_secure=1
is set in autostart.jt
The user’s password to log in
Example browser URL to login in:
192.x.x.x:8189/?user=myname&pass=mypassword |
logout
| log me out
Ex:
192.x.x.x:8189/?logout | |
lun
| get logged in user’s name
Returns:
the name of the logged in user.
if no login required: nothing
Example call: 192.168.1.99:8180/?lun
| |
luip
| get logged in user’s IP
Returns:
the IP address of the logged in user.
if no login required: nothing
Example call:
192.168.1.99:8180/?luip
| |
Transformer status commands
| ||
trans
| start the transform process
use this after having set:
- the source path name (the XML file) (command spn)
- the output path name (optional) (command opn)
- the output file name extension (optional) (command oext)
- the XSL path name to use (command xslpn)
| |
quit
| quit the transformer application
Returns:
nothing
Example call:
192.168.1.99:8180/?quit
| |
ts
| get transformer status
Returns:
busy or idle
busy means, that the transformer currently is transforming an XML file.
Example call:
192.168.1.99:8180/?ts
| |
debug
| 0 or 1
| set transformer debug mode
Returns:
0 or 1
Example call to turn debug mode on:
192.168.1.99:8180/?debug=1
|
Command
| Parameters
| Description
|
pdebug
| get transformer debug mode
Returns:
0 or 1
Example call to get current debug mode:
192.168.1.99:8180/?pdebug
| |
pwd
| print working directory
Returns:
the path of the current working directory Example call:
192.168.1.99:8180/?pwd
| |
pcd
| print communication directory
Returns:
the path to the folder where the transformer looks for JobTickets
Example call:
192.168.1.99:8180/?pcd
Returns:
/Users/username/BatchXSLT4InDesignComm/BatchXSLT/
| |
pcn
| print communication queue file name
Returns:
the name of the JobTickets queue file name
Example call:
192.168.1.99:8180/?pcn
Returns:
override.que
| |
pcf
| print content of the communication preferences file comm.prefs
Returns:
the content of the comm.prefs file
Example call:
192.168.1.99:8180/?pcf
| |
Transformer and Commander names
| ||
hcn
| print commander name
Returns:
httpCommandServer
Example call:
192.168.1.99:8180/?hcn
| |
hcappn
| print commander application name
Returns:
BatchXSLT
Example call:
192.168.1.99:8180/?hcn
| |
appn
| print commander application name and commander name
Returns:
BatchXSLT httpCommandServer
Example call:
192.168.1.99:8180/?appn
| |
hccp
| print http commander context path
Returns:
/
Example call:
192.168.1.99:8180/?hccp
| |
hcdr
| print http commander document root
Returns:
CommanderHTTP/
Example call:
192.168.1.99:8180/?hcdr
| |
hcip
| print commander local ip address
Returns:
/192.168.1.99:8180
Example call:
192.168.1.99:8180/?hcip
| |
LOG file
| ||
plf
| print content of log file as is
Returns:
the content of the log file (unwrapped, plain file contents)
Example call:
192.168.1.99:8180/?plf
| |
Command
| Parameters
| Description
|
plfp
| print content of log file as pre formatted text
Returns:
the content of the log file (wrapped in <pre></pre>)
Example call:
192.168.1.99:8180/?plfp
| |
plfh
| print content of log file as HTML text
Returns:
the content of the log file (each line ending with <br>)
Example call:
192.168.1.99:8180/?plfh
| |
plfn
| print log file name
Returns:
the name of the log file
Example call:
192.168.1.99:8180/?plfn
| |
plfpn
| print log file path and name
Returns:
the path/name of the log file
Example call:
192.168.1.99:8180/?plfpn
| |
clf
| delete (clear) the log file
Returns:
OK for success, otherwise any error code
Example call:
192.168.1.99:8180/?clf
| |
Working path names
| ||
spn
| path
or
path/name
| set the path or path/name of XML file(s)
Returns:
the path set
Example call:
192.168.1.99:8180/?spn=/Users/transformer/XMLtransforms/in
|
pspn
| print the path or path/name of XML file(s)
Returns:
the path set
Example call:
192.168.1.99:8180/?pspn
| |
opn
| path
or
path/name
| set the path or path/name of transformed output file(s)
Returns:
the path set
Example call:
192.168.1.99:8180/?opn=/Users/transformer/XMLtransforms/out
|
popn
| print the path or path/name of transformed output file(s)
Returns:
the path set
Example call:
192.168.1.99:8180/?popn
| |
oext
| set the file extension of the output file
Returns:
the extension set
Example call:
192.168.1.99:8180/?poext
| |
poext
| print the file extension of the output file
Returns:
the extension set (like .xml or .html or...)
Example call:
192.168.1.99:8180/?poext
| |
xslpn
| path/name
| set the path/name of XSL file to use
Returns:
the path/name set
Example call:
192.168.1.99:8180/?xslpn=XSL/IMXepaper.xse
|
pxslpn
| print the path/name of XSL file to use
Returns:
the path/name set
Example call:
192.168.1.99:8180/?pxslpn
|
Command
| Parameters
| Description
|
JobTickets
| ||
jt
| path/name
| load a JobTicket without executing it (no transform)
Returns:
-99 if successfully loaded (but no transform started)
or any other code than 0 on error
Example call:
192.168.1.99:8180/?jt=~/XMLtransforms/jt/autostart.jt
|
jtr
| path/name
| load a JobTicket without executing it (no transform)
Returns:
0 if successfully loaded and executed
or any other code than 0 on error
Example call:
192.168.1.99:8180/?jtr=~/XMLtransforms/jt/aJob.jt
|
pjf
or
pjfh
to get JobTicket content as HTML
| name
or
subfolder,name
or
path/name
| get the content of a JobTicket
Returns:
The content of the JobTicket if found, otherwise nothing.
Where does the httpCommander look for JobTickets?
If no path is given like: 192.168.1.99:8180/?pjf=override.jt
the communications folder is searched at:
~/BatchXSLT4InDesignComm/BatchXSLT/jobtickets/default/
If no path is given like: 192.168.1.99:8180/?pjf=myfolder,override.jt
the communications folder is searched at:
~/BatchXSLT4InDesignComm/BatchXSLT/jobtickets/myfolder/
If a path/name is given, this path is searched.
|
savejtfile
| path/name,content
| save a JobTicket
Returns:
0K on success, otherwise a non zero error code
Example call:
192.168.1.99:8180/?savejtfile=~/ajobticket.jt,The content of this file.
Writes this file into the user’s home folder.
NOTE:
If content is large, use a form to POST this content
|
File commands
| ||
flist
| path
| get the file list of given path
Returns:
a list of file names separated by \n (new line)
if no files available return *none*
Example call:
List files of ‘Export’ folder within home folder
http://192.168.1.99:8180/?flist=~/Export
|
dlist
| path
| get the directories list of given path
Returns:
a list of directory (folder) names separated by \n (new line)
if no directories available return *none*
Example call:
List directories of ‘Export’ folder within home folder
http://192.168.1.99:8180/?dlist=~/Export
|
existsfile
| path
| check if a file or directory exists
Returns:
‘true’ if exists
‘false’ if not exists
Example call:
http://192.168.1.99:8180/?existsfile=~/blabla.jt
tests if file blabla.jt exists at home folder
|
writefile
writefiledb64
(writefiledb64 is like writefile but the content is Base64 encoded - for binary content)
| path/name,content
| write to a file
Returns:
0K on success, otherwise a non zero error code
Example call:
192.168.1.99:8180/?writefile=~/ajobticket.jt,The content of this file.
Writes this file into the user’s home folder.
NOTE:
If content is large, use a form to POST the content
|
appendfile
| path/name,content
| append content to (existing) file
Returns:
0K on success, otherwise a non zero error code
Example call:
192.168.1.99:8180/?appendfile=~/ajobticket.jt,The content of this file.
Appends the content to this file.
NOTE:
If content is large, use a form to POST the content
|
copyfile
| pathname/targetpathname
| copy a file
Returns:
0K on success, otherwise a non zero error code
Example call:
192.168.1.99:8180/?copyfile=~/ajobticket.jt,~/bjobticket.jt
creates a copy of file ajobticket.jt as file bjobticket.jt within the user’s home folder
|
Screen Shots
| ||
winshot
| the image format. One of
jpg
png
gif
| get a screen shot of the transformer window at current state.
Returns:
the screen shot in reguested format
Example call:
192.168.1.99:8180/?winshot=gif
NOTE:
This command may not be used in debug mode.
|