IG command description

Description: This command creates an index in the specified text frame. If there is already an index or some text in this frame,it will be replaced by the up to date index.

Syntax: [ IG =  Block#  ;  Title  ;  TitleStyle  ;  IncludeHidLayer  ;  RunIn  ;  IncludeSection  ;  IncludeEmptySection  ;  TopicSep  ;  PageSep  ;  EntrySep  ;  XRefSep  ;  PageRangeSep  ;  EntryEndSep  ;  SectionStyle  ;  PageNumStyle  ;  XRefStyle  ;  XRefTopicStyle  ;  Level1Style  ;  Level2Style  ;  Level3Style  ;  Level4Style    ]

Block#
Integer 		• Reference of text frame to create/update the index in
     
Title
String 		• Index title
     
TitleStyle
Integer 		  Reference of paragraph style applied to the title of index, -1 for [No Paragraph Style]
     
IncludeHidLayer
Boolean 		  Specify whether to include or not text on hidden layers for the index generation
     
RunIn
Boolean 		  Specifie whether to display all entries in a single paragraph or not
     
IncludeSection
Boolean 		  Spécifies whether to include or not the index section headings
     
IncludeEmptySection
Boolean 		  Specifies whether empty index sections have to be generated or not
     
TopicSep
String 		  Separateur for the following topic
     
PageSep
String 		  Separateur between page numbers
     
EntrySep
String 		  Separator between entries
     
XRefSep
String 		  Separator before cross reference
     
PageRangeSep
String 		  Separator for page range
     
EntryEndSep
String 		  Separator for the entry end
     
SectionStyle
Integer 		  Reference of paragraph style applied to the section headings, -1 for [No Paragraph Style]
     
PageNumStyle
Integer 		  Reference of character style applied to the page numbers, -1 for [None]
     
XRefStyle
Integer 		  Reference of character style applied to the cross references, -1 for [None]
     
XRefTopicStyle
Integer 		  Reference of character style applied to the cross referenced topics, -1 for [None]
     
Level1Style
Integer 		  Reference of paragraph style applied to the level 1 entries, -1 for [No Paragraph Style]
     
Level2Style
Integer 		  Reference of paragraph style applied to the level 2 entries, -1 for [No Paragraph Style]
     
Level3Style
Integer 		  Reference of paragraph style applied to the level 3 entries, -1 for [No Paragraph Style]
     
Level4Style
Integer 		  Reference of paragraph style applied to the level 4 entries, -1 for [No Paragraph Style]
     

Note: If you want to create/update an index for a whole book, please create or open one (NL or LO) containing the document which owns the targeted text frame before calling this command.

Example: [SD=1;"NormalParagraphStyle";0;-1;TRUE][SF] [SD=2;"TitleStyle";0;1;TRUE][SF] [SD=3;"SectionStyle";0;1;TRUE][SF] [SD=4;"NumPageStyle";0;0][SF] [SD=5;"XRefStyle";0;0][SF] [SD=6;"XRefTopicStyle";0;0][SF] [SD=7;"Level1Style";0;1;TRUE][SF] [LO="C:\MyBook.indb] [IG= 91; "Title of index";2;TRUE;FALSE;TRUE;FALSE;" ";", ";"; ";". ";"^=";"";3;4;5;6;7;1;1;1] [FL] This command will create an index in the text frame referenced as 91 from the content of the book containing the document which owns this frame (Assumption : MyBook contains "Sommaire" frame's document)

See also:

The • sign indicates a mandatory parameter

 

 

©1993-2008 Trias.
All rights reserved.