Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

28 Working with macros > 28.3 Using macro variables > 28.3.4 Using predefined macro variables


28.3.4 Using predefined macro variables

Mif2Go provides a collection of predefined macro variables and user variables, listed in Table 28-3. Every predefined macro variable name begins with “$$_”. Predefined macro variables are read-only; you cannot assign values to them, and you cannot increment or decrement them. However, you can do the following:

Use predefined macro variables in expressions; see §28.6.1 Understanding macro expressions).

Format output of a predefined macro variable; see §28.6.3 Displaying expression results in output).

Note:  Only <$$_basename>, <$$_currpath>, and <$$_prjpath> can be used in system commands; other predefined macro variables do not work in system commands. See §34.4.6 Supplying system commands in a macro.

Table 28-3 Predefined macro variables

Macro variable

Where used

Description

­Ref

$$_basefile

HTML split files

Base name only of parent file, without extension

18.6

$$_basename

System commands

Base file name (without path or extension) of current FrameMaker file or book

34.4.2

$$_basetitle

HTML split files

Original document title, unaffected by splits

18.6

$$_chapnum

Macros

FrameMaker system-variable building block

28.3.6

$$_class

Elements (HTML)

CSS class name of current paragraph

28.6.6

$$_count

Loop constructs

Current iteration count for <$_repeat> loops

28.6.4.3

$$_currbase

Output files

File name of current file, without extension

18.6

$$_currfile

Output files

File name of current file, with extension,

18.6

$$_currfilepath

Output files

Path and name of current file, with extension

18.6

$$_currpath

System commands

Path, without trailing slash, to project directory

34.4.2

$$_currtitle

HTML split files

Current file title, unaffected by extracts

18.6

$$_dcount

Loop constructs

Down-count for <$_repeat> loops

28.6.4.3

$$_ditastart

DITA XML production

Start tag of the current topic

15.4.3.6

$$_element

Elements (HTML)

Name of the current element

28.6.6

$$_extrfile

HTML extract files

File name of extracted file

18.7.3

$$_extrgraph

HTML extract files

File name of first extracted graphic

18.7.3

$$_extrtitle

HTML extract files

Title of extracted file

18.7.3

$$_fileid

Output files

FileID of FrameMaker file, from mif2go.ini

34.8.5

$$_firstfile

HTML split files

1 if first split part after original file, otherwise 0

18.6

$$_graphbase

HTML graphics

File name for <img src= /> attribute, no extension

23.5.2

$$_graphorighigh

HTML graphics

Original height in pixels of the image

23.5.2

$$_graphorigwide

HTML graphics

Original width in pixels of the image

23.5.2

$$_graphsrc

HTML graphics

File name for <img src= /> attribute, with extension

23.5.2

$$_lastfile

HTML split files

1 if last part (regardless of splitting), or if unsplit; otherwise 0

18.6

$$_linksrc

HTML link attributes

href content of a link

19.2.4

$$_loctocfile

HTML split files

File name of subordinate file in local TOC entry

20.3

$$_loctoctitle

HTML split files

Title of subordinate file in local TOC entry

20.3

$$_macroparam

Macros

Value of parameter passed in parentheses

28.7

$$_nextfile

HTML split files

File name of split part that follows $$_currfile

18.6

$$_nexttitle

HTML split files

Title of $$_nextfile split part

18.6

$$_objectid

Marker reference

Object ID of current marker (HTML only)

29.8

$$_paratag

Formats

Name of current paragraph format; same as FrameMaker <$paratag> building block

28.6.6

$$_parauid

HTML link anchors

“X” followed by FileID (if any) followed by ObjectID of current paragraph

19.3.4

$$_prevfile

HTML split files

File name of split part that precedes $$_currfile

18.6

$$_prevtitle

HTML split files

Title of $$_prevfile split part

18.6

$$_prjname

Macros

Base name of Mif2Go .prj file

 

$$_prjpath

System commands

Path (without trailing slash) to the directory where the .prj file resides

34.4

$$_sectionnum

Macros

FrameMaker 9+ system-variable building block

28.3.6

$$_seqcurrtitle

HTML navigation links

Title of current file

20.4

$$_seqnextfile

HTML navigation links

Name of following file, with extension .htm

20.4

$$_seqnexttitle

HTML navigation links

Title of following file

20.4

$$_seqprevfile

HTML navigation links

Name of preceding file, with extension .htm

20.4

$$_seqprevtitle

HTML navigation links

Title of preceding file

20.4

$$_splitid

HTML split files

Base name of split file, excluding FileID portion

34.8.5

$$_splitnum

HTML split files

Sequential number in file-name prefix or suffix

34.8.5

$$_subsectionnum

Macros

FrameMaker 9+ system-variable building block

28.3.6

$$_tblcols

Tables

Count of columns in current table

24.6.6

$$_volnum

Macros

FrameMaker system-variable building block

28.3.6

$$_tblrows

Tables

Count of rows in current table

24.6.6

$$_wcount

Loop constructs

Iteration count for <$_while> loops

28.6.4.3

$$_xrefid

 

HTML link anchors

 

“R” followed by FileID (if any) followed by ObjectID of first cross-reference marker in current paragraph

19.3.4

 



28 Working with macros > 28.3 Using macro variables > 28.3.4 Using predefined macro variables