insert
insertbreak
insertchar
insertcontrol
insertdash
insertdate
insertindexmark
insertmark
insertname
insertnumber
insertpage
insertrevision
insertsoft
insertspace
inserttext
inserttime
Inserts text at the insertion point.
insert <text> [DOCUMENT name | WINDOW name]
text/s The text string to insert.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
insert 'Now is the time' document 'project.doc' insert "I can't get no satisfaction." insert 'She said "Use quotations in strings."'
Inserts a break at the insertion point.
insertbreak <break> [DOCUMENT name | WINDOW name]
break/k The type of break to insert.
Options: COLUMN | PAGE.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
insertbreak column insertbreak page document 'project.doc'
Inserts special characters at the insertion point.
insertchar <symbol | UNICODE number> [DOCUMENT name | WINDOW name]
symbol/k The character to insert.
Options: OPENDBLQUOTE Double open quote.
CLOSEDBLQUOTE Double close quote.
OPENSNGLQUOTE Single open quote.
CLOSESNGLQUOTE Single close quote.
OPENDBLGUILLEMOT Double open guillemot.
CLOSEDBLGUILLEMOT Double close guillemot.
OPENSNGLGUILLEMOT Single open guillemot.
CLOSESNGLGUILLEMOT Single close guillemot.
INCH Single prime.
FOOT Double prime.
TM Trademark.
SM Service mark.
R Registration mark.
C Copyright.
P Sound recording copyright.
UNICODE/i The unicode number of the character to insert.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
insertchar opendblquote document 'project.doc' insertchar unicode 8223
Inserts a control character at the insertion point.
insertcontrol <control> [DOCUMENT name | WINDOW name]
control/k The control to insert.
Options: TAB Tab.
RIGHTINDENTTAB Right indent tab.
NEWLINE New line.
NEWPARAGRAPH New paragraph.
INDENTHERE Paragraph indent.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
insertcontrol tab insertcontrol newline document 'project.doc'
Inserts a dash at the insertion point.
insertdash <dash> [DOCUMENT name | WINDOW name]
dash/k The dash to insert.
Options: HYPHEN Normal hyphen.
NBHYPHEN Non-breaking normal hyphen.
SOFTHYPHEN Soft normal hyphen.
EN En dash.
NBEN Non-breaking en dash.
SOFTEN Soft en dash.
EM Em dash.
NBEM Non-breaking em dash.
SOFTEM Soft em dash.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
insertdash soften insertdash nbhyphen document 'project.doc'
Inserts a date variable at the insertion point.
insertdate <date> [FORMAT format] [LANGUAGE name] [DOCUMENT name | WINDOW name]
date/k The date to insert. All options except current and created are updated when applicable.
Options: CURRENT Current date. Default.
CREATED Creation date.
MODIFIED Modification date.
SAVED Saved date.
LOADED Loaded date.
PRINTED Printed date.
DOCUMENTREVISION Document log entry date.
CHAPTERREVISION Chapter log entry date.
PAGEREVISION Page log entry date.
ARTICLEREVISION Article log entry date.
FORMAT/s The date format. See below.
Default='mm/dd/yy'.
LANGUAGE/k The language of the date variable.
Options: DEFAULT Document/chapter default.
AMERICAN American English.
ENGLISH International English.
FRANCAIS French.
DEUTSCH German.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Notes:
The FORMAT string contains the order, length and separators for the date.
/ Separate with a slash.
- Separate with a hyphen.
, Separate with a comma.
Separate with a space.
\ One character following a backslash or text inside double " "quotation marks will appear as is.
The capitalization of the format string determines the capitalization of the date, if applicable.
y Last 2 digits of the year. 94, 95, 9
yy Same as y
yyy All 4 digits of the year. 1994, 199
yyyy Same as yyy
m Month number, no leading zero. 1, 6, 7, 1
mm Month number, leading zero. 01, 06, 07, 10
mmm 3 letter abbreviated month. jan, ju
mmmm 3-4 letter abbreviated month. jan, jun
mmmmm Full name of the month. january, jun
d Day number, no leading zero. 1, 2, 1
dd Day number, leading zero. 01, 02, 1
dddd Ordinal day number. 1st, 2nd, 12t
w Week day number. 1, 2,
ww 1-2 letter abbreviated week day. su, m, t
www 3 letter abbreviated week day. sun, mon, tu
wwww Full day of the week. sunday, monday
Format Examples:
y-m-d 94-12-19, 1-2-
mm/dd/yy 12/19/94, 02/03/0
d/mm/yyyy 19/12/1994, 3/02/200
Mmm d, yyyy Dec 19, 1994, Feb 3, 200
Wwww "the" ddd Monday the 19th, Saturday the 3rd
Examples:
insertdate current format 'Wwww "the" ddd' insertdate saved format 'Wwww' language 'francais' insertdate printed format 'd/Mmm/yyy' insertdate current document 'project.doc'
Inserts an index mark at the insertion point.
insertindexmark <NAME format> [DOCUMENT name | WINDOW name]
NAME/s The index entry format.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Results:
The mark number is returned to RESULT.
Examples:
insertindexmark name 'next, "Heading 1","Government"'
Inserts a text mark at the insertion point.
insertmark <NAME name> [DOCUMENT name | WINDOW name]
NAME/s The name of the text mark.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Results:
the mark number is returned to RESULT.
Examples:
insertmark name "This is a test."
Inserts a name variable at the insertion point.
insertname <name | MARK number | INDEXMARK number | VARIABLE name> [DOCUMENT name | WINDOW name]
name/k The name variable to insert.
Options: DOCUMENTNAME Document name.
CHAPTER Chapter name.
MASTERPAGE Master page name.
PAGE Page name.
MARK/i The text mark name.
INDEXMARK/i The index mark string.
VARAIBLE/s The user variable name.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
insertname document insertname chapter document 'project.doc'
Inserts a number variable at the insertion point.
insertnumber <variable | MARK number | INDEXMARK number>[LANGUAGE name] [PREFIX text] [DOCUMENT name | WINDOW name]
variable/k The number to insert.
Options: PAGE Current frame page #.
PREVPAGE Previous frame page #.
NEXTPAGE Next frame page #.
FIRSTPAGE First frame page #.
LASTPAGE Last frame page #.
PAGECOUNT Number of pages.
PAGESTART Starting page #.
PAGEEND Ending page #.
CHAPTER Current chapter #.
CHAPTERCOUNT Number of chapters.
CHAPTERSTART Starting chapter #.
CHAPTEREND Ending chapter #.
SUBCHAPTERCOUNT Number of subchapters.
SUBCHAPTERSTART Starting subchapter #.
SUBCHAPTEREND Ending subchapter #.
COLUMN Current frame #.
PREVCOLUMN Previous frame #.
NEXTCOLUMN Next frame #.
COLUMNCOUNT Number of columns.
MARK/i The text mark number to insert.
INDEXMARK/i The index mark number to insert.
FORMAT/k The numbering format.
Options: DEFAULT Document/chapter default.
LONG One, Two, Three
ARABIC 1, 2, 3 (Default)
ROMANUPPER I, II, III
ROMANLOWER i, ii, iii
ALPHAUPPER A, B, C
ALPHALOWER a, b, c
LANGUAGE/k The language of the number variable.
Options: DEFAULT Document/chapter default.
AMERICAN American English.
ENGLISH International English.
FRANCAIS French.
DEUTSCH German.
PREFIX/s The page number prefix.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Notes:
The variable parameters refer to the current document level. i.e., PAGECOUNT is the number of pages in the current chapter or subchapter. If the document is the current level, then it refers to the number of pages in the document.
Examples:
insertnumber page insertnumber pagecount document 'project.doc'
Inserts page(s) in a document or chapter.
insertpage [where] [PAGE number | DOCUMENT name | WINDOW name] [COUNT number] [INSPREAD [type]]
PAGE/s The reference page number.
Default=current.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
where/k The position of the inserted pages relative to the reference page.
Options: BEFORE (default) | AFTER.
COUNT/i The number of pages to insert.
(Default=1)
INSPREAD/k How to insert the pages: DEFAULT(default) | HORIZONTAL | VERTICAL.
Notes:
Default inserts normal pages, while Horizontal and Vertical insert pages as part of a spread.
Examples:
insertpage before page 1 insertpage after page 5 count 2 inspread vertical
Inserts a revision number variable at the insertion point.
insertrevision [revision] [FORMAT format] [LANGUAGE name] [DOCUMENT name | WINDOW name]
revision/k The type of revision log.
Options: DOCUMENTREVISION (default) | CHAPTERREVISION | PAGEREVISION | ARTICLEREVISION.
FORMAT/s The numbering format. See below.
Default='j.n'.
LANGUAGE/k The language of the revision number variable.
Options: DEFAULT Document/chapter default.
AMERICAN American English.
ENGLISH International English.
FRANCAIS French.
DEUTSCH German.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Notes:
The FORMAT string contains the order, length and separators for the date.
/ Separate with a slash.
- Separate with a hyphen.
, Separate with a comma.
Separate with a space.
\ One character following a backslash or text inside
double " " quotation marks will appear as is.
The capitalization of the format string determines the capitalization of the number, if applicable.
j Major revision, no leading zero. 1, 2... 10
jj Major revision, leading zero. 01, 02... 10
jjj Major revision, long format. one, two... ten
n Minor revision, no leading zero. 1, 2... 10
nn Minor revision, leading zero. 01, 02... 10
nnn Minor revision, long format. one, two... ten
Format Examples:
j.n 6.2
j/nn 6/02
jj.nn 06.02
jjj-nnn six-two
Jjj."Oh" Six.Oh
JJJ,n SIX,2
Examples:
insertrevision format 'j.nn' insertrevision chapterrevision format 'JJJ.nn'
Inserts a soft (conditional) control at the insertion point. If a line could break at the soft control position, then PageStream will break it and insert the specified text if any.
insertsoft <soft | TEXT text> [DOCUMENT name | WINDOW name]
soft/k What to insert when breaking the line:
NEWLINE Soft new line only.
HYPHEN Soft normal hyphen and new line.
TEXT/s Inserts this string before the newline.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Notes:
INSERTDASH SOFT is equivalent to INSERTSOFT HYPHEN.
Examples:
insertsoft newline insertsoft hyphen document 'project.doc' /* inserts a bullet */ insertsoft text \08226
Inserts a space at the insertion point.
insertspace <type> [DOCUMENT name | WINDOW name]
type/k The type of space to insert.
Options: SPACE Breaking space.
NBSPACE Non-breaking space.
THIN Breaking thin space.
NBTHIN Non-breaking thin space.
EN Breaking en space.
NBEN Non-breaking en space.
EM Breaking em space.
NBEM Non-breaking em space.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
insertspace thin insertspace nben document 'project.doc'
Inserts text from a text file at the insertion point.
inserttext [FILE filepath] [FILTER name] [progress] [charset] [CONVERTQUOTE toggle] [CONVERTDASH toggle] [LINEHASLF toggle] [RETAINFORMAT toggle] [TEXTCODE code] [DOCUMENT name | WINDOW name]
FILE/s The filename and path of the file.
FILTER/k The filter to use.
Options: ASCII | IFFCTXT | IFFFTXT | WORDWORTH | EXCELLENCE | PROWRITE | WORD | WORDPERFECT | WORDPERFECT5 | FINALWRITER.
charset/k The character set to use.
Options: AMIGA | WINDOWS | MSDOS | MACINTOSH.
ASCII only.
progress/k Toggle to display a progress meter.
Options: STATUS |NOSTATUS (default).
toggle/k Toggles a feature.
Options: TRUE | FALSE.
CONVERTQUOTE Converts typewriter quotation marks to typographic quotation marks. Not applicable to iffctxt. Default=true.
CONVERTDASH Converts double dashes to en dashes and triple dashes to em dashes. Not applicable to iffctxt. Default=true.
LINEHASLF Assumes that each line ends with a line feed rather than each paragraph. Applicable to ascii|iffftxt only.
Default=false.
RETAINFORMAT Exports the attributes as well as the text. Not applicable to ascii.
Default=true.
TEXTCODE/k The text code engine to use.
Options: PAGESTREAM | PAGEMAKER | XPRESS | PROPAGE | NONE
(default).
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Notes:
If the FILE parameter is not specified, a file selector will open.
If the FILTER paragraph is not specified, the Insert Text dialog box will open.
Examples:
inserttext file text:lorem.txt filter ascii status
Inserts a time variable at the insertion point.
inserttime <time> [FORMAT format] [LANGUAGE name] [DOCUMENT name | WINDOW name]
time/k The date to insert. All options except current and created are updated when applicable.
Options: CURRENT Current date. Default.
CREATED Creation date.
MODIFIED Modification date.
SAVED Saved date.
LOADED Loaded date.
PRINTED Printed date.
DOCUMENTREVISION Document log entry date.
CHAPTERREVISION Chapter log entry date.
PAGEREVISION Page log entry date.
ARTICLEREVISION Article log entry date.
FORMAT/s The time format. See below.
Default='h:m PM'.
LANGUAGE/k The language of the time variable.
Options: DEFAULT Document/chapter default.
AMERICAN American English.
ENGLISH International English.
FRANCAIS French.
DEUTSCH German.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Notes:
The FORMAT string contains the order, length and separators for the time.
: Separate with a colon.
Separate with a space.
\ One character following a backslash or text inside double " "quotation marks will appear as is.
The capitalization of the format string determines the capitalization of the time, if applicable.
h Hour, no leading zero. 5
hh Hour, leading zero. 05
m Minutes, no leading zero. 8
mm Minutes, leading zero. 08
s Seconds, no leading zero. 3
s Seconds, leading zero. 03
ampm Shows am or pm as appropriate. 5 am
pm Shows only pm when time>12:00. 7 pm
No indicator specifies 24 hour time. 19
Format Examples:
h:m 5:15, 19:3
h:m ampm 5:15 am, 7:30 p
h:m PM 5:15, 7:30 P
hh:mm:ss 05:15:21, 19:30:4
hh\hmm 5h15
Examples:
inserttime current format 'hh:mm:ss' inserttime printed