TWiki> FipDoc Web>FolioMarkup (02 Mar 2006, DotFingerPost? )EditAttach

Markup for Folios

Why ?

When MediaPlanner sends its page(s), an Ad list and some information about the page is output to MediaPlanner Paginator.

MPPaginator (aka Fip) uses that information to determine if a Folio is required, which template to use and then fills it in and outputs folios, ads and any other page furniture to the output device.

How ?

  • Edit the files in /fip/customer/folios and resend the pages or
  • use the Web editor/viewer

Structure of this document

Naming Convention of Folios

  • (Pub) - (Section or PageDefn) - L/R .fip

  • Pub is the Owner/Publication code : LO-ILF

  • Section or Page Definition is the 3 letter code : CLA

  • L/R is either L for the Left page and R for the Right

  • '.fip' is a fixed extension. Any file with a '.fip' extension should be opened by NotePad (or better TextPad)

  • Pub and Section both default to the code 'DEF'. So there are 2 default folios :
    • DEF-DEF-L.fip
    • DEF-DEF-R.fip

  • When a page is output - and Folio is requested - Fip will pick the Folio template to use by looking for the first one that matches :
    • (Pub) '-' (Section) '-X.fip' (where X is L or R)
    • (Pub) '-DEF-X.fip'
    • 'DEF-DEF-X.fip'

Sending Pages in MediaPlanner

  • Select 'Output'

  • Select 'MP Paginator'

  • Select options you require :
    • If you want a folio, select the 'Output folio' box

  • Finally name the file and save into the correct drop folder

Using the Web Folio Viewer

  • log on to the server using the logon and password specified

Beforehand - Things to know before writing the Folio template

There are 3 main types of information which can be put into a Folio :

  • Ordinary text - which you just type in
    • this is standing type like a banner or telephone number or web address

  • Markup Commands - which are all defined with angle brackets :

  • Variable information about that particular page in that publication - these are specific 2 letter codes (outlined at the end of this document) which can be output by using a preceeding backslash : \PP for the Publication Code

Syntax - Formatting commands use the syntax : 

   < (cmd) [ optional (: or =) (parameter) ] >
Only the first letter of the command is required.

All measurements can be specified in points; most can be spcified in mm.

End-of-lines - like [[Carriage Return][CR] and NL - are ignored]. So you can use blank lines to make the file more readable.

The Starting position is at the Top Left hand corner of the Ad box. So you will have to move UP the page to add the folio.

As the < or > characters are used for the start and end Commands, if you need to display these, specify them as Hex chrs by typing the four chrs : \xFE for < and \xFF for >.

Brief overview of Markup Commands

Basic Commands

c - Change Column width - <c=174>

This takes effect immediately so take care to set only at the start of a line or before any text

eg 

      <c:119>
      This text will wrap
      at 119 points

      <c:444>
      444 pts is quite wide and will easily take this

f - Change Font - <font=times>

Font name MUST be in the SETTER table

eg 

      <f:Helvetica>this is in Helvetica
      <f:HelveticaBold>this is in HelveticaBold

p - Change Point size <p=20>

This sets both Point and Set size to the same.

eg <p:15>15 pt text is used for subheads <p:3>3 pt text is almost unreadable

l - Change Leading <l=8>

The leading value is that moved in the Y or down direction after a Quad. It is normally roughly the same (or slightly less) than the point size of the type. It can be any value from 1 to 1000. For gridded designs, the leading will be set to the grid amount. If you need to set negative leading - well it can happen - note that you need to specify option 'L' first with '<o:l>' - see options below.

q - Quad (default is Quad Left) <q>, <q:l>, <q:r>, <q:c>, <q:m>, <q:z>

All quads except Zero will position the type and then Lead down the amount defined in the last Leading ie '<l:99>'. Quad may have a parameter (only the first letter is necessary): Left - shift all type left (default) Right - shift all type right Centre - centre the type Middle - stretch to fill the column width Zero - shift all left with no leading

Quad zero '<q:z>' formats text on the line and then returns to the left hand margin at the same Y position.

n - Notes or Comment <n:Next Section here Please>

This will appear in the output file as a PostScript comment complete with preceeding '%' : 
            <n: Next Section here Please>
      becomes      % FipComment - Next Section here Please

Movement

w - White and Fixed Horizontal Space <w>, <w:12>

There are 3 uses for WhiteSpace : - with a positive value : move RIGHT that exact amount eg <w:2.5mm> - with a negative value : move LEFT that exact amount eg <w:-2.5mm> - with NO parameter : push all type left to the left and right to the right eg <c:200> This is left<w>This is right<q> This is left This is right

This can also be used with Tabs (see below). Note that if specified with no parameter this is a White Space command which will force any data left and/or right within the quad or tab irrespective of whether the Quad/tab is L,R or C.

x - eXtra Lead command <x:72>, <x:-123.1>

This is an immediate one-off movement DOWN the page of the amount specified. Ths value may be negative to force the movement UP the page.

Rules Boxes and Fills

r - Rules <r:10:174>

Specify width (default is column width) then height. Specify up and back using a '-' <r:10:-99.5> Optionally specify a tint percentage is the third parameter eq a 25% tinted box 10 points wide and 200 up: <r:10:200:25> Note that rules go to the RIGHT (x direction) and UP (y dir) To force LEFT or DOWN, use negative values.

z - Pass thru command <z:\n%%Include:JimmysFile\n>

Use this to access PostScript routines you have written in your PSHDR or USER file. The whole string assumed to be in FipSeq and is parsed before output. This does assume you know a little bit about PostScript, so use with care. 

      So for color :
         <n: Orange pls><z: 0 1 0.5 0 setcmykcolor >
      To reset
         <n: Back to all Colours><z: 1 1 1 1 setcmykcolor >

z - Colour and tints using Pass thru command

The 'z' command can be used for both tints and setting colour. 

      For tints the 'setgray' command can be used. Confusingly this
is a valid between 0 (black) and 1 (white). Specify the value BEFORE the
string as with all !PostScript commands.
      Remember to reset to black afterwards

      Eg
         <n: 35% tint pls pls><z: 0.65  setgray >

         <n: black rule first><r:100:10><q:z>
         <n: white on black><z: 1 setgray ><x:-2>Some Text<q:z>
         <n: Back to black><z: 0 setgray >
         
      To reset
         <n: Back to black><z: 0 setgray >

      So for color, the 'setcmykcolor' !PostScript command is used -
thats color without a 'u'.
      This uses a value between 0 (no colour) and 1 (full colour) to set the following in order :
         cyan
         magenta
         yellow
         black
      So 0.2 is a 20% tint in that colour.
      Remember to reset to all colours afterwards

      Eg
         <n: Orange pls><z: 0 1 0.5 0 setcmykcolor >
      To reset
         <n: Back to all Colours><z: 1 1 1 1 setcmykcolor >

Other Commands

m - Set mark <m:24>

This saves the exact x and y position at that point. You can use JUMP to return to that point. There is an implicit mark '<m:1>' at the top left of the folio. Up to 100 marks are permitted. Note that both X and Y values of the current position are saved. Note that the X value normally includes any text or spaces on the line up to the point where the Mark is made. To use the X from the start of the column (or tab stop) use the option <o:x:no> (and to turn back on <o:x:yes>)

j - Jump to Mark <j:24>

The Mark should have been set beforehand. There is an implicit mark '<m:1>' at the top left of the folio. Jumping back to a fixed set point allows complicated markup with lots of movements to be exactly lined up.

s - Change Set size <s:20>

Shrinking type - this alters the width or set size of the type. So to alter to 10pt points size with 90% width: <p:10><s:9>

k - include graphics or another EPS file <k:name>

If you have a logo or another complex graphic that needs to be printed on the Folios, use the K command to specify it. Note that the currentpoint is NOT set explictly so that you may insert after text. However normally you will want to <q> just before. 
      eg for a 32 pt blob :
         GOOD   :  <x:32><q><k:widget>
         BAD   :  <q><x:32><k:widget>
            32pt xlead will be ignored
The pathname should be fully specified unless it exists in /fip/spool/epsf. Note also that the filename is exactly that specfied. So if you specify spaces, they will need to be in the file : 
         <k:A Long EPSF>   "/fip/spool/epsf/A Long EPSF"
         <k:  A Long EPSF>   "/fip/spool/epsf/  A Long EPSF"
         <k:/data1/oinky/01234.eps>   "/data1/oinky/01234.eps"
         <k:../oinky/01234.eps>   "/fip/spool/oinky/01234.eps"

These can be OPI calls if the Option 'k' flag is set: 

         <q><j><q:z>
         <x:325.980000><w:150.240000>
         <o:k:OPI-STUB-D>
         <k:150.240000:-467.720000:293.390000:595.280000:10945-1.EPS>
         <q:z>
         <o:k>
Here we have a Jump back to a 'marked' position. Then and X and Y movement Then we state we want this to be an OPI call using OPI-STUB-D as a parameter file (see the Options section above) The 4 numbers in the 'k' are the Aldus corner positions bottom left 150.24,-467.72 top right 293.39,595.28 Actual OPI filename 10945-1.EPS Finally we turn OFF opi calls with <o:k>

t - Tab <t:z>, <t:s 10,15,25,40>

Tab may be Left, Right, Centre, Set, Clear, Save or Restore. Tab Left, Right and Centre do just that. Remember to set tabs beforehand using one of the three Tab Set commands. If no tabs have been set, a Tab LRorC becomes a Quad.

    • There are 3 different ways of specifying tabs :
      • X position. ie distance from lefthand margin.
      • Width of each field
      • Divide the column width proportionally

    • Tab-Set <t:s ...> : Each tab is the X distance from the left hand margin in points. The righthand margin need not be specified. <t:s 12,24,66,78,90>

    • Tab-Set-Width <t:w ...> : Each tab is the width of that tab in points. <t:w 12,12,42,12,12> Tab Set-Width can also have a REMAINDER flag set in 1 of the fields. In this case, if the total width of all the tabs is less that the column width, the extra is added to this tab. eg <t:w 10,20R,10> <t:w 25,R,10>

    • Tab-Set-Proportional <t:p ...> : Each tab is a proportion of the whole width : <t:p 1,1,2,1,1>

    • Tab-Clear is <t:z> This clears and ignores all tabs.

    • Tab-Save <t:x> notes the current settings and clears.
    • Tab-Restore <t:y> restores to last settings. This only works after a Tab-Save (x) NOT a Tab-Clear (z)

    • If you change Column width, respecify (ie t:S, t:P or t:W) the tabs.

d - Leader dots <d>, <d:0>

The parameter is the leader character and defaults to '.'. It work in the same way as a WhiteSpace command, , with no parameters.

i - Indent <i>, <i:l:12>, <i:12>

Specify whether left (default) or right or both. To clear indent, use WITHOUT parameters <i>. Indent can be used with an optional delay and/or maximum number of lines.

    • Syntax: <i : left/right/both : (width) [opt : (startingLine) : (forLines)] > where width is is points, starting at line is where the line may not be the first; forLines is the indent stops after x lines A line is considered a Quad-with-depth which is any <q:?> except for a ZeroLead quad : <q:z>.

If the indent command is specified as the first command on the line, it takes effect immediately. If not it starts on the next line. However the StartingLine does NOT alter.

o - Options :

There are a number of Options which all use a 2nd parameter and often a 3rd/4th. Note that an <o> with no other parameters will reset most options to defaults :
      • Disable PointSize squeeze.
      • Set Line Justified (Ragged Off).
      • Set Word/LetterSpacing to 10% maximum.
      • Zap PassThru CurrentPoint.
      • Turn Columns on any quad, turn-point.
      • Disable Wrap within a tab.
      • Disable negative leading.
      • Allow line break.
      • Allow VJ.
      • Set min and max values for leading in VJ

    • Create an unprintable character <o:unprintable:\321>, <o:u=\xFD>

Use this option to create characters which cannot be typed in your word processor - or that get translated somewhere. The default number system is (normally) octal unless changed. For Hex, use the '\xZZ' notation where ZZ is 2 hex chrs : 0-9, a-f. Only one chr at a time can be typed in.

    • Reduce Point and Set Size to squeeze data into tab or column.
      • Allow <o:p:3>
      • Disable <o:p>

These allow/stop squeeze of data into a tab column where normally the data would wrap to the next line or overprint the next tab. The value is the minimum point size acceptable. The program will start by shrinking SetSize up to 25% less than current SetSize and then start shrinking both Point and Set proportionally. Note that you can also wrap text onto the next line of a column using 'Allow Wrap' (see below).

    • Set Ragged Left, Centre or Right
      • To set ragged <o:r:left>. <o:r:r>, <o:r:c>
      • To set justified (default) <o:r>

    • Allow Word and Letter Spacing
      • Allow or Squeeze <o:c:5> - to 5 %
      • Disable <o:c>

The default is <o:c:10> for 10% allowable squeezeover the whole line.

    • Disable any and all Vertical Justification at all
      • Disable all <o:j> <o:justOFF>
      • Ignore any Over Matter in the last column <o:j:over>

This just ignores any VJ command '<v>' and does NOT add extra leading. Columns, if specified, are turned with no stretching/shrinking. Any over matter is run on at the end of the last column. The Bounding Box will be that of the whole job. So to force use 'bboxX', 'bboxY' (and possibly 'bboxX-zero' and 'bboxY-zero' in the SETPAGE file. The second variant <o:j:over> still allows small VJ adjustments to a column where it does not fit exactly.

    • Enable zero and negative leading <o:l>
      • Normally <l:0> and <l:-40> are ignored so that quads always increment down the page.
      • This affects ONLY Leading ie '<l:99>' as xtra lead like '<x:24>' can have positive or negative movements at any time.

    • Reset Page Number for book/document work <o:n:58>
    • Output Page Number for book/document work <o:n>
      • This is the format used for pass thrus - <o:n><z: ResetOnNewPage>
    • Output Page Number for book/document work <o:n:text>
      • Use this for inserting the text in-line as though it was an ordinary string "This Page is Number <o:n:text> of millions"

    • Make default quad Left, Centre, Right <o:q:r> The normal default is Left. Use this for setting the currentpoint for PassThru commands to the left, centre or right of tab or column. (This is ONLY used if the PassThru Fudge flag is ON - otherwise the PassThru is placed exactly where you specify).

    • For PassThru, assume the currentpoint is preserved or zapped :
      • <o:z:preserve> or <o:z:p> and <o:z:zap or <o:z:z> Zap is the default. Zap will force a MOVETO before the next text while Preserve will place any text following.

    • Create Fraction <o:f:1/3>, <o:f:1 2> with bar or without (use space as separator) This will create a fraction chr by shrinking font and moving The advantage is that setter can determine the width. The Fraction Bar can be any valid chr except space and numbers. If it is not-printable, use \XXX format to specify an hex or octal number.

    • Allow/Disable Line break
      • Allow line to broken at any suitable point <o:b>, <o:b:y>
      • Do NOT break line <o:b:n> Use this to group text which MUST not turn. The default, naturally enough, is 'Allow'.

    • Allow Wrap within tab <o:w:yes> <o:wrap>
    • Disable Wrap within tab <o:w:no> <o:wrap:no> Normally the program tries to squeeze data into a tab column for 10% reduction (or more if using the Option Squeeze Pointsize (see above). This will wrap text within a tab stop. Care should be taken to make sure that a wrapped tab does not drop lower than the column depth as it will NOT be checked.

    • Wrap leaders <o:w:leaders> or <o:w:topleaders> or <o:w:bottomleaders>
      • Only if Allow Wrap is ON, if a leader is specified the break will occur on the leader and the leader continued on the next line. The 'leaders' option sets leaders on both lines. The 'topleaders' option sets leaders on the top only. The 'bottomleaders' option sets leaders on the bottom only.

    • Turn columns ONLY at specified (Opt) Col Turn points <o:a:15>
    • Turn columns normally on Quads, Col Turns etc <o:a:no> (default)
      • Normally columns are turned at the nearest line OR at the nearest Opt Col Turn (<a:5> for example). Specify <o:a:99> to IGNORE quads and turn ONLY on

    • For EPSF, Create an OPI call rather than including the EPSF <o:k:(OPI stub file)>
      • The Stub file should be in tables/form/postscript if not preceeded by a '/'. 
         Specify &lt;o:k&gt; to turn OFF.
         Some Extra FipHdr fields are available for the OPI call
            Bounding Box parameters      - F1, F2, F3, F4
            Bounding Box plus x/y offset   - F5, F6, F7, F8
            Just the filename name      - FJ
            Full path and name      - FR
      eg :
         %%BeginObject: FipOpi \$V
         %ALDImageFileName: /\FJ
         %ALDImageCropRect: \F1 \F2 \F3 \F4
         %ALDImagePosition: \F5 \F6 \F5 \F8 \F7 \F8 \F7 \F6
         %%EndObject

    • For setting the maximum or minimum leading acceptable
      • Minimum <o:min:3.3>
      • Maximum <o:max:9.3>
      • To reset max <o:max>
      • To reset both <o:m>

    • To ignore text on the line for a Mark <o:x:no>
    • To account for text on the line for a Mark <o:x:yes> default
    • Note that the X value normally includes any text or spaces on the line up to the point where the Mark is made. To use the X from the start of the column (or tab stop) use the option <o:x:no> (and to turn back on <o:x:yes>)

FipHdr? fields created by ipxmp for Folios

  • Call using \XX notation
  • Use FipSeq to force upper/lowercase, add conditionals etc

  • PP Pubcode.
  • PS Section.
  • PE Name of Section (optional) (versions 03t onwards)
  • PR Routing code from MediaPlanner (optional)
  • FQ Folder for routing from the routing match table.
  • PN Page Number (may be offset)
  • FP Page Number (same as PN)
  • PV Page Number or Roman Numeral Page Number if flagged.
  • PO Page Number - original, on the MP plan, no offsets
  • PC Class Folio name
  • PF FullPathName of the Ad (used for Adlist file only)
  • PA Name of the Ad generally used in the missing Ad comment
  • PY Ad comment
  • PT Type of the Ad
  • PX No Of Colours specified for the page - 1,2,3 or 4
  • PZ No of Copies required (default 1)
  • PH Round-Robin Number - a sequence number from 1 to (max) where max defaults to 2 (see route-round-robin-max above)
  • PG PART or FULL for Partial Page (or Normal, Full Page)
  • PD Pair flag
    • PD:single Page is single
    • PD:pairprinters Page is a Printer Pair
    • PD:pairbacking Page is a Backing Pair
    • PD:pairdbltruck Page is a Double-Trucked Pair
    • The same string is also added as a comment as the last line of the data eg. <n: FipPageType-pairbacking>
  • PI ODD or EVEN or BOTH (for pairs)
  • SX Original input file name.
  • Z* all the date fields for the PUBDATE.
    • (These can be T* if you set parameter 'use-alt-dates:')
    • ZD - 1 or 2 digit day of month
    • ZG - 2 digit day of month (with leading zero)
    • ZM - 2 digit month
    • ZY - 2 digit Year 92
    • ZZ - 4 digit Year 1992
    • ZW - Day of week as in Monday, Tuesday etc
    • ZS - 3 chr Day of week as in Mon, Tue etc
    • ZN - Month as in January, February
    • ZT - 3 chr Month as in Jan, Feb, Mar etc
    • ZJ - Julian day of year
    • ZH - Hour 00-23
    • ZI - Hour 00-12
    • ZF - Minute 00-59
    • ZE - Second 00-59
    • ZX - 8 digit time since 1-Jan-1970 in Seconds
    • ZU - 1st, 2nd, 3rd, 24th for the day of the month plus ZA, ZB, ZC for Week of year x2 and Dow and ZP for AM/PM. Note that actual Day and Month names depend on your LOCALE

Other Hints

  • use q:z

Further information

  • www.fingerpost.co.uk
  • information on variables used
    • FipHdr? - information which will only available for that Pub/Page when it goes thru the system (also see below)
    • FipSeq - mangling these FipHdr? fields more

  • fonts and other settings
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r2 - 02 Mar 2006 - 11:00:00 - DotFingerPost?
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback