Copyright: Writed by Devil Chain  95/ 9/22


輔助說明檔製作

Windows Help

    輔助說明檔是一種超文字介面的檔案，其利用鍵值的觀念來聯結，可達到理想的速查效果，此外該類形的檔案可利用在線上輔助，達到即學即用又可免去查閱使用者手冊的不便。

    一般有如下之超文字檔：

用途	附檔名	文字格式	編譯器
Windows Help File	HLP	RTF	Help Compiler 3.10.505(HCP.EXE)
DOS Help File	HLP	RTF	Help Maker (HELPMAKE.EXE)
MicroStation Help File	HC	RTF	I/Help 8.0 Source
WWW(HTML)	HTM
其它	通常為 HLP

    能撰寫 RTF 格式的程式非常的多，例如 Ami Pro 及 Word 等文書處理軟體，在Freeware 中的 RTFGEN 2.03 亦是其中的姣姣者，此處將介紹利用 Word 6.0a 中文版製做 Windows 3.1 中文版之輔助說明檔。

輔助標題：

基本需求

快速製作

進階功能製作

參考文獻

作者

    附註：今天拿到很多參考資料，大部份的小問題大概都有解了！不過大概還要很久才能加入本檔吧！我還會去搜集 Windows 95 的相關資料的，有資料或有任何意見歡迎 E-Mail 給我，電子郵件信箱： Devil.bbs@vlsi1.iie.ncku.edu.tw ，我會努力的！另外先提一聲，若你有灌 Win32s 於你的中文 Windows 之中，有些功能會怪怪的，例如在 Windows Help 中的自動換行部份，你只要在沒灌 Win32s 的電腦上一試便知。另外一些錯誤的敘述及內容不足之處我還會再調整的！像今天拿到的資料有提到圖形相關的部份，我稍為試了一下加到作者的照片中，在這部份有些是原來的錯誤敘述，下次再調啦！我的工作環境為 中文 Windows + Win32s ， CPU 為 Pentium 75 超 90 ，RAM 為 32 MB ，SVGA Card 為 S3-868 2 MB ，視窗環境為 1024x768x32767 color。

T.L.Cheng 1995/ 9/20 10:38 pm


基本需求

    以 Word 6.0a 中文版製作 Windows Help 檔須以下的檔案：

Help Compiler 3.10.505 ( HC.EXE or HCP.EXE )	為輔助說明檔的編譯器，本檔在各大 Ftp 站均有，亦可上微軟之 FTP Server 取得。Visual BASIC 或Visual C/C++ 亦內含其程式。
Word 6.0a for Windows 中文版	該軟體是我們利用來編輯 RTF 格式的檔案。
Notepad.EXE ( 記事本 )	用來編輯 HPJ 檔之軟體，為 Windows 3.1 內附之軟體。此處亦可使用其它文書處理器，但存檔時務必存成 ASC II 的格式。
DOSPrmpt.PIF ( MS-DOS 模式 )	由於編譯 Windows Help 必須在 Windows 下進入 MS-DOS 模式方可編譯，故需本檔才能執行。吾人亦可自行建立一 PIF 檔來處理。
WinHelp.EXE	用來觀看 Windows Help 檔之軟體，為 Windows 3.1 內附之軟體。其 Windows Help 之附檔名為 HLP 。
SHED.EXE ( HotSpot Editor 3.50.784 )	非絕對必要檔，為圖形編修超連結的輔助程式，其檔案之附檔名為 SHG ，可上微軟之 FTP Server 取得。Visual BASIC 或Visual C/C++ 亦內含其程式。
WHAT6.DOT ( Windows Help Authoring Toolkit for Word 6.0 for Windows 3.x)	非絕對必要檔，為 Word 6.0 的樣版文件，其檔案可使我們更加方便的配合 Word 6.0 製作輔助說明檔，可上微軟之 FTP Server 取得。其內含一 Help Project Editor 1.10 可幫我們迅速建立一 HPJ 檔，另含極具參考價值的說明文件  Help Compiler Errors  ,  Help Authoring Guide 。

    其它條件則為上述程式能正常執行及其附屬檔和 Windows 能執行之必要條件。


快速製作

    若不求能製作複雜連結的輔助說明檔，可以利用下述方法依序完成。

    1. 將 DOC 檔以「另存新檔」存成 RTF 格式；輔助說明檔之編譯器無法編輯太過複雜的表格，尤其需將格線去除；另外檔案中若有圖檔的情形，可能會造成記憶體不足，若在編譯時期顯示出記憶體不足的錯誤訊息，請將圖形去除，圖形修改加入輔助說明檔的方法，將在進階功能製作中說明。

    2. 加入主題 ( Content ) 。去除整篇文章最前面的空白及跳行的字元，在整篇文章最前面的文字插入註腳；選取功能表「插入」的「註腳...」，選「自定標記」並打入「 # 」；之後會到註腳列，打入 contents 並去掉前面之空白。這裡並不一定必須為 contents ，不過通常都用 contents ，此文字為變數名，任何打入文字均需符合變數名命名原則即可；完成後存檔並關閉，未關閉的檔案是無法進行編譯的。

    3. 使用記事本編輯一個新檔，打入下列內容：

[OPTIONS]

CONTENTS=contents

[FILES]

filename.rtf

    為簡單起見，先將本檔與前述儲存之 filename.rtf 存於同一目錄下，並以附檔名 HPJ 儲存後關閉。

    4. 由程式管理員的主群組進入 MS-DOS 模式；檢查環境變數中的路徑是否有指到編譯器所在的目錄，並更改目錄區為上述的文字檔案目錄；打入下列內容：

C:\FILEPATH>HCP FILENAME[.HPJ] 或 C:\FILEPATH>HC FILENAME[.HPJ]

    5. 使用 WinHelp.EXE 開啟 FileName.HLP 或由檔案管理員對該檔以滑鼠雙觸擊即可。

    一個無任何功能的輔助說明檔已經完成了，是否很簡單呢？


進階功能製作

    進階功能製作將討論所有有關 Windows Help 的問題。

輔助標題：

HPJ 的節區

插入物件

巨集表

小技巧

鍵結的方法

註腳

不明疑問


參考文獻

    1. 桂思強，『深造 Excel VBA (I) 』，博碩， 11 章  製作輔助說明

    2. Blue Sky Software, The Windows Help Style Guide, RoboHELP

    3. 侯俊傑譯，『深入 Visual C++ 』，松崗， 20 章  Context Sensitive Help

    4. Steven Wallace, Help Authoring Guide for Winhelp 3.1, Diane Campbell


作者

文書處理：鄭子璉

美工處理：李娟娟


鄭子璉

專長：

水庫淹沒區土地利用調查

地理資訊分析

徐昇網法 ( Thiessen Method ) 自動化分析計算

丙級電腦軟體設計技術士（證照編號：119-017976）

學歷：

天主教耶穌會私立徐匯高級中學畢業

國立成功大學水利及海洋工程學系學士

國立成功大學水利及海洋工程學研究所

現職：

國立成功大學水利及海洋工程研究所碩士研究生

指導教授：

國立成功大學水利及海洋工程學系暨研究所  周乃昉副教授

電子郵件信箱：

Devil.bbs@vlsi1.iie.ncku.edu.tw


李娟娟

專長：

數值分析

統計分析

丙級電腦軟體設計技術士（證照編號：119-017985）

學歷：

市立中正高級中學

私立靜宜大學應用數學系學士

現職：

國立成功大學水利及海洋工程學系暨研究所研究助理

電子郵件信箱：

ChengL.bbs@vlsi1.iie.ncku.edu.tw


周乃昉

專長：

水庫最佳操作規則

區域性用水調配

水資源經營控制

灌溉最佳配水

水力發電

超級電腦之應用

水資源系統之營運管理與規劃

水文、水理分析與統計

學歷：

國立成功大學水利及海洋工程學系學士

國立台灣大學土木工程學研究所水利組碩士

美國科羅拉多州州立大學土木工程學研究所博士

經歷：

中興工程顧問社水工部工程師

現職：

國立成功大學水利及海洋工程學系暨研究所副教授

電子郵件信箱：

hyd049@hyd002.ncku.edu.tw

hyd049@hyd003.ncku.edu.tw


Windows Help

    利用 Windows 3.1 所提供的公用資源 WinHelp.EXE 來提供線上說明輔助，可利用 WinHelp.EXE 的「檔案」之「開啟」選項來啟動，亦可利用「檔案管理員」對欲開啟的檔案作滑鼠雙觸擊。


HPJ

    HPJ 是由 Help Project File 縮寫來的副檔名，此類型的檔案通常都用在 Help 檔的製作， Help Compiler 在編譯 Help 檔時會依據本檔所指定的資源來編譯，一般的 HPJ 檔會指定下列的某些資源在何處可以取得或將要在 Help 檔中使用：

‧ 用來建立 Help 檔的來源檔之路徑及檔名。例如影像檔及文字檔。

‧ 那一個標題 ( Topic ) 要被用在整個 Help 檔的主標題 ( Contents ) 。

‧ 那些將要加入 Help 檔的元件。例如加在選單、工具列或 Windows 的自訂元件。

‧ 那些將要加入 Help 檔的函數及其動態連結程式庫 ( DLL ) 。

‧ 那些資訊發生在建立或加入 Help 檔的過程。


HPJ 的節區

    HPJ 檔案為控制編譯的流向檔，在 HPJ 檔中可以有下列幾種節區，其中部份亦可省略不寫，每一特別的命令或資訊都該在其應屬的節區中，節區必須按下面的方法來使用：

語法	[sectionname]

    在 HPJ 亦可加入巨集控制，下面列出可以使用在 HPJ 檔中的各節區。

節區分類：

[Options]

[Files]

[Buildtags]

[Config]

[Bitmaps]

[Map]

[Alias]

[Windows]

[Baggage]

註解符號 ( ； )


巨集表

    巨集可以用在 Windows Help 的檔案中，在撰寫 RTF 或 HPJ 等之檔案均可加入，藉由巨集可達到許多效果，如你可引入一位元映射圖（ Bitmap ），你也可以建立一個按鈕、一段文字或一個圖示來結束 Windows 系統，由於巨集為一種語法，所以有部份仍保留為原來的英文語法，下面依分類列出各種巨集。

    巨集分類：

控制選單功能

控制按鍵功能

流程控制功能

判斷條件功能

控制對話盒功能

控制視窗環境功能

控制視窗環境特別功能

其它


註腳

    註角為 Windows Help 檔中的控制符號，分成「 # 」、「 $ 」、「 K 」、「 + 」。

#	主題 ( Content ) 文字，也是標題文字
$	標題 ( Topic ) 文字，但可做為「搜尋」按鈕尋找的標題依據
K	關鍵 ( Keyword ) 文字，可以是非標題文字，可做為「搜尋」按鈕尋找的主題依據
+	可作為歷程記錄 ( History ) 的主題，亦為向前翻頁或向後翻頁依據，不過要翻頁一定要建立有翻頁 ( Browse ) 的按鈕鍵於工具列，可參閱巨集表功能的 CreateButton


[OPTIONS]
HPJ 的節區

[OPTIONS]

    [OPTIONS] 節區的功能主要皆為編譯過程中的控制。本節區為主要節區，是不可以省略，但在本區不是很能接收中文字，使用中文常會出現無法預料的字元出現。在本節區下命令為：

語法	option=...

範例：

[OPTIONS]

errorlog = helpread.err

title =輔助說明製作法輔助說明視窗

contents = CONTENTS

copyright = Writed by Devil Chain  95/ 9/22

icon = hydr0001.ico

compress = 1

oldkeyphrase = false

warning = 2

節區分類：

[Options]	本節區可令使用如下的命令：

BMROOT

BUILD

CITATION

COMPRESS

CONTENTS

COPYRIGHT

ERRORLOG

FORCEFONT

ICON

LANGUAGE

MAPFONTSIZE

MULTIKEY

OLDKEYPHRASE

OPTCDROM

REPORT

ROOT

TITLE

WARNING

註解符號 ( ； )

[Files]

[Buildtags]

[Config]

[Bitmaps]

[Map]

[Alias]

[Windows]

[Baggage]

註解符號 ( ； )


[FILES]
HPJ 的節區

[FILES]

    [FILES] 節區的功能為指定 RTF 的標題檔及標題引入檔。本節區為主要節區，是不可以省略，在本節區下命令為：

語法	[drive:][\pathname\]filename.RTF

範例：

[FILES]

helpread.rtf

macro.rtf

hpjblock.rtf

節區分類：

[Options]

[Files]

本節區可令使用如下的命令：

RTFfilename

#INCLUDE

註解符號 ( ； )

[Buildtags]

[Config]

[Bitmaps]

[Map]

[Alias]

[Windows]

[Baggage]

註解符號 ( ； )


[BUILDTAGS]
HPJ 的節區

[BUILDTAGS]

    [BUILDTAGS] 建立標籤之節區。

語法	tags

範例：

[BUILDTAGS]

DEMO	;topics to include in demo build

MASTER	;topics to include in master Help file

DEBUGBUILD	;topics to include in debugging build

TESTBUILD	;topics to include in a mini-build for testing

說明：

    其實這功能我還沒用過，還不很清處狀況。

節區分類：

[Options]

[Files]

[Buildtags]

本節區可令使用如下的命令：

tags

註解符號 ( ； )

[Config]

[Bitmaps]

[Map]

[Alias]

[Windows]

[Baggage]

註解符號 ( ； )


[CONFIG]
HPJ 的節區

[CONFIG]

    [CONFIG] 在 Windows Help 檔下加入選單或工具列的節區。本節區亦為登錄其它動態連結檔在 Windows Help 檔下使用其函數或巨集，在本節區下命令為：

語法	macro

範例：

[CONFIG]

BrowseButtons()

CreateButton("作者", "作者(&W)", "JI(`helpread.hlp>Second', `HID_TOPICWinHelpWriter')")

CreateButton("關於","關於(&A)","About()")

CreateButton("離開","離開(&x)","Exit()")

RegisterRoutine("bmp","HDisplayBmp","USSS")

RegisterRoutine("bmp","CopyBmp", "v=USS")

CreateButton("btn_up", "&Up", "JumpContents(`HOME.HLP')")

SetHelpOnFile("APPHELP.HLP")

說明：

    前面四句是本檔使用的內容，先是一個加強的歷程控制或說成翻頁功能，再定義三個功能鍵，後面四句是來自參考文獻 4. 的範例。

節區分類：

[Options]

[Files]

[Buildtags]

[Config]

本節區可令使用如下的命令：

巨集表

註解符號 ( ； )

[Bitmaps]

[Map]

[Alias]

[Windows]

[Baggage]

註解符號 ( ； )


[BITMAPS]
HPJ 的節區

[BITMAPS]

    [BITMAPS] 節區的功能為引入圖形檔。如果圖檔過大是無法直接用在 RTF 檔中，必須以巨集 bmc, bml 及 bmr 來引入，若有使用到圖形引入巨集，則本節區是不可以省略，引入之圖檔必須為 BMP 或 SHG 的格式，在本節區下命令為：

語法	[drive:][\pathname\]filename.BMP

[drive:][\pathname\]filename.SHG

範例：

[BITMAPS]

tlc0001.shg

說明：

    本檔引入一圖檔，該圖檔使用 SHED.EXE ( HotSpot Editor ) 處理定義過，可在圖形中特定位置進行超連結。

參考：	BMROOT, ROOT

節區分類：

[Options]

[Files]

[Buildtags]

[Config]

[Bitmaps]

本節區可令使用如下的命令：

BMPorSHGfilename

註解符號 ( ； )

[Map]

[Alias]

[Windows]

[Baggage]

註解符號 ( ； )


[MAP]
HPJ 的節區

[MAP]

    [MAP] 節區假定一些編號給各主題，若是要與程式連結時，則本節區就比較重要，但亦可不透過本節區來連結程式，另外要注意編號不可重複，在本節區下命令為：

語法	context_string	 context number

範例：

[MAP]

CONTENTS    1

說明：

    這部份很多我還沒完全用過及看懂。

參考：	[Alias]

節區分類：

[Options]

[Files]

[Buildtags]

[Config]

[Bitmaps]

[Map]

本節區可令使用如下的命令：

context_string    context number

#include <filename>

#define  context-string  context-number

註解符號 ( ； )

[Alias]

[Windows]

[Baggage]

註解符號 ( ； )


[ALIAS]
HPJ 的節區

[ALIAS]

    [ALIAS] 節區的功能為指定一個或多個連接文字給同一個標題。在本節區下命令為：

語法	context_string=alias context string

範例：

[ALIAS]

sm_key=key_shrtcuts

cc_key=key_shrtcuts

st_key=key_shrtcuts	;combined into keyboard shortcuts topic

clskey=us_dlog_bxs

maakey=us_dlog_bxs	;covered in using dialog boxes topic

chk_key=dlogprts

drp_key=dlogprts

lst_key=dlogprts

opt_key=dlogprts

tbx_key=dlogprts	;combined into parts of dialog box topic

frmtxt=edittxt

wrptxt=edittxt

seltxt=edittxt	;covered in editing text topic

說明：

    這部份很多我還沒用過，上面為參考文獻 4. 的範例。

參考：	[Map]

節區分類：

[Options]

[Files]

[Buildtags]

[Config]

[Bitmaps]

[Map]

[Alias]

本節區可令使用如下的命令：

context_string=alias context string

註解符號 ( ； )

[Windows]

[Baggage]

註解符號 ( ； )


[WINDOWS]
HPJ 的節區

[WINDOWS]

    [WINDOWS] 節區的功能為定義輔助說明檔的視窗屬性及多重視窗。例如視窗的抬頭、顏色、位置、大小及其它屬性，在本節區下命令為：

語法	window-name="caption", (x-coord, y-coord, width, height), window-state, (scrolling-RGB), (nonscrolling-RGB), ontop-state

範例：

[WINDOWS]

main = "輔助說明製作法輔助說明視窗", (10,10,900,1000 ),,, (255,255,192 )

second = "輔助說明製作法第二輔助說明視窗", (100,80,550,830 ),, (255,255,192 ), (192,255,192 ), 1

說明：

    此為本檔之設定，若使用兩個以上的視窗則須以輸出轉向來指定，另外中文抬頭須在此設定，使用 TITLE 會產生不正常的字元。

參考：	TITLE

節區分類：

[Options]

[Files]

[Buildtags]

[Config]

[Bitmaps]

[Map]

[Alias]

[Windows]	本節區可令使用如下的命令：

window-name=...

註解符號 ( ； )

[Baggage]

註解符號 ( ； )


[BAGGAGE]
HPJ 的節區

[BAGGAGE]

    [BAGGAGE] 節區的功能還看不懂。在本節區下命令為：

語法	[drive:][\pathname\]filename

範例：

[BAGGAGE]

\.\ANIM\ASTER.AMF

\.\AUDIO\APATO.WAV

\.\AUDIO\PACHY.WAV

\.\AUDIO\STAR.WAV

\.\AUDIO\TREX.WAV

\.\AVI\APATO.AVI

\.\AVI\PACHY.AVI

\.\AVI\TREX.AVI

說明：

    這部份很多我還沒用過，上面為參考文獻 4. 的範例。

參考：	ROOT

節區分類：

[Options]

[Files]

[Buildtags]

[Config]

[Bitmaps]

[Map]

[Alias]

[Windows]

[Baggage]

filename

註解符號 ( ； )

註解符號 ( ； )


[WINDOWS]
HPJ 的節區

註解符號( ； )

    註解符號( ； ) 可以加在 HPJ 檔的任何位置，其符號後到該行尾的內容一律均視為註解，在任何節區或位置下命令為：

語法	; any string

節區分類：

[Options]

[Files]

[Buildtags]

[Config]

[Bitmaps]

[Map]

[Alias]

[Windows]

[Baggage]

註解符號 ( ； )


控制選單功能
巨集表

控制選單功能

控制選單功能

AppendItem

ChangeItemBinding

CheckItem

DeleteItem

DisableItem

EnableItem

ExtAbleItem

ExtInsertItem

ExtInsertMenu

FloatingMenu

InsertItem

InsertMenu

ResetMenu

UncheckItem

控制按鍵功能

流程控制功能

判斷條件功能

控制對話盒功能

控制視窗環境功能

控制視窗環境特別功能

其它


控制按鍵功能
巨集表

控制按鍵功能

控制選單功能

控制按鍵功能

BrowseButtons

ChangeButtonBinding

CreateButton

DestroyButton

DisableButton

EnableButton

流程控制功能

判斷條件功能

控制對話盒功能

控制視窗環境功能

控制視窗環境特別功能

其它


流程控制功能
巨集表

流程控制功能

控制選單功能

控制按鍵功能

流程控制功能

Back

Contents

GoToMark

JumpContents

JumpContext

JumpHash

JumpHelpOn

JumpId

JumpKeyword

Next

PopupContext

PopupHash

PopupId

Prev

判斷條件功能

控制對話盒功能

控制視窗環境功能

控制視窗環境特別功能

其它


判斷條件功能
巨集表

判斷條件功能

控制選單功能

控制按鍵功能

流程控制功能

判斷條件功能

DeleteMark

IfThen

IfThenElse

IsMark

Not

SaveMark

控制對話盒功能

控制視窗環境功能

控制視窗環境特別功能

其它


控制對話盒功能
巨集表

控制對話盒功能

控制選單功能

控制按鍵功能

流程控制功能

判斷條件功能

控制對話盒功能

About

Annotate

BookmarkDefine

BookmarkMore

CopyDialog

FileOpen

History

PrinterSetup

Search

控制視窗環境功能

控制視窗環境特別功能

其它


控制視窗環境功能
巨集表

控制視窗環境功能

控制選單功能

控制按鍵功能

流程控制功能

判斷條件功能

控制對話盒功能

控制視窗環境功能

CloseWindow

FocusWindow

HelpOn

HelpOnTop

PositionWindow

控制視窗環境特別功能

其它


控制視窗環境特別功能
巨集表

控制視窗環境特別功能

控制選單功能

控制按鍵功能

流程控制功能

判斷條件功能

控制對話盒功能

控制視窗環境功能

控制視窗環境特別功能

AddAccelerator

Command

CopyTopic

ExecProgram

Exit

Print

RegisterRoutine

RemoveAccelerator

SetContents

SetHelpOnFile

其它


其它
巨集表

其它

控制選單功能

控制按鍵功能

流程控制功能

判斷條件功能

控制對話盒功能

控制視窗環境功能

控制視窗環境特別功能

其它

bmc

bml

    我還不知道這兩個圖形引入巨集差在那。


About Macro
About

用途	Displays the WinHelp application's About topic.

語法	About()


AddAccelerator (AA)

用途	Assigns a help macro to an accelerator key or key or key combination so that the macro is executed when the accelerator key is pressed.

語法	AddAccelerator(key, shift-state, `macro')


Annotate

用途	Displays the WinHelp application's Annotate dialog box, as if the user had selected Annotate from the Edit menu.

語法	Annotate()


AppendItem

用途	Appends a menu item to the end of an existing menu - either one of the default menus or one created with the InsertMenu macro.

語法	AppendItem(`menu-id', `item-name', `macro')


Back

用途	Displays the previous topic in the history list. This is a list of the topics displayed since starting WinHelp. Topics displayed in popup windows are not included in this list. The function of this macro is identical to selecting the Back button.

語法	Back()


BookmarkDefine

用途	Displays the Bookmark Define dialog box. Executing this macro is the same as selecting Define from the Bookmark menu.

語法	BookmarkDefine()


BookmarkMore

用途	Displays the Bookmark dialog box. Executing this macro is the same as selecting More from the Bookmark menu. The More item appears on the Bookmark menu if there are more than nine bookmarks defined.

語法	BookmarkMore()


BrowseButtons

用途	Adds the browse buttons, << and >>, to the WinHelp button bar.

語法	BrowseButtons()


ChangeButtonBinding (CBB)

用途	Assigns a new macro or macro string to a help button, replacing the button's previously-defined action.

語法	ChangeButtonBinding(`button-id', `macro')


ChangeItemBinding (CIB)

用途	Assigns a new macro or macro string to a help menu item, replacing the item's previously-defined action.

語法	ChangeItemBinding(`item-id', `macro')


CheckItem (CI)

用途	Places a check-mark beside a help menu item.

語法	CheckItem(`menu-id')


CloseWindow

用途	Closes either a secondary window or the main help window.

語法	CloseWindow(`window-name')


Command

用途	Executes a WinHelp menu command, based on the command number passed to it.

語法	Command(command-number)


Contents

用途	Displays the Contents topic in the current help file. The Contents topic is defined by the CONTENTS option in the [OPTIONS] section of the help project file. If no Contents topic is defined, the Contents topic defaults to the first topic in the first topic file specified in the [FILES] section of the help project file.

語法	Contents()


CopyDialog

用途	Displays the Copy dialog box. Copies the text from the current topic into the Copy dialog box where portions of the text may be selected and copied to the Windows Clipboard. Executing this macro is the same as selecting Copy from the Edit menu.

語法	CopyDialog()


CopyTopic

用途	Copies all of the text in the currently displayed topic to the Clipboard. Executing this macro is the same as pressing Ctrl+Ins in the main help window.

語法	CopyTopic()


CreateButton

用途	Creates a button and adds it to the button bar.

語法	CreateButton(`button-id', `name', `macro')


DeleteItem

用途	Removes an item from a WinHelp menu.

語法	DeleteItem(`item-id')


DeleteMark

用途	Removes a text marker that was previously added with the SaveMark macro.

語法	DeleteMark(`marker-text')


DestroyButton

用途	Removes a button that was previously added with the CreateButton macro.

語法	DestroyButton(`button-id')


DisableButton (DB)

用途	Disables (grays-out) a button on the WinHelp button bar. The disabled button will remain inoperative until it is re-enabled with the EnableButton macro.

語法	DisableButton(`button-id')


DisableItem (DI)

用途	Disables (grays out) a WinHelp menu item. The item will remain disabled until it is re-activated with EnableItem or ExtAbleItem, or until the menu is reset using ResetMenu.

語法	DisableItem(`item-id')


EnableButton (EB)

用途	Re-enables a button that was previously disabled with the DisableButton macro.

語法	EnableButton(`button-id')


EnableItem (EI)

用途	Re-enables a menu item that was previously disabled with DisableItem or ExtAbleItem.

語法	EnableItem(`item-id')


ExecProgram (EP)

用途	Executes an application.

語法	ExecProgram(`command-line', display-state)


Exit

用途	Exits the WinHelp application. The action of this macro is identical to selecting Exit on the File menu.

語法	Exit()


ExtAbleItem

用途	Enables or disables a specified menu item.

語法	ExtAbleItem(`item-id', enabled-state)


ExtInsertItem

用途	Inserts an item into a WinHelp menu and allows the initial enabled state (enabled or disabled) to be specified.

語法	ExtInsertItem(`menu-id',`item-id', `item-name',`macro',position,enabled-state)


ExtInsertMenu

用途	Inserts a sub-menu as an item in a previously-defined menu, and allows the initial enabled state (enabled or disabled) to be specified.

語法	ExtInsertMenu(`parent-id',`menu-id',`menu-name',position,enabled-state)


FileOpen

用途	Displays the Open dialog box from the File menu.

語法	FileOpen()


FloatingMenu

用途	Displays the floating menu at the current mouse cursor position.

語法	FloatingMenu()


FocusWindow

用途	Changes the focus to the specified window - either the main help window, or a secondary window.

語法	FocusWindow(`window-name')


GotoMark

用途	Jumps to a text marker that was previously set with the SaveMark macro.

語法	GotoMark(`marker-text')


HelpOn

用途	Displays the help file for the WinHelp application. Executing this macro is the same as selecting How to Use Help from the Help menu.

語法	HelpOn()


HelpOnTop

用途	Toggles the on-top state of WinHelp, checking or un-checking the Always on Top menu item as required. Executing this macro is equivalent to selecting Always on Top from the Help menu.

語法	HelpOnTop()


History

用途	Displays the WinHelp History window, which shows the titles of the last 40 topics that have been displayed since WinHelp was started. Executing this macro is the same as selecting the History button.

語法	History()


IfThen

用途	Executes the specified macro if the condition is true.

語法	IfThen(condition, `macro')


IfThenElse

用途	Executes the specified macro1 if the condition is true, and macro2 if the condition is false.

語法	IfThenElse(condition, `macro1', `macro2')


InsertItem

用途	Inserts an item in a specified position in a WinHelp menu.

語法	InsertItem(`menu-id',`item-id', `item-name',`macro',position)


InsertMenu

用途	Inserts a menu in a specified position on the WinHelp menu bar.

語法	InsertMenu(`menu-id',`menu-name',position)


IsMark

用途	Determines whether or not a particular text marker exists. Returns 1 if it does, or 0 if it does not.

語法	IsMark(`marker-text')


JumpContents

用途	Executes a jump to the Contents topic of the specified help file. Executing this macro is equivalent to opening a new help file by choosing Open from the File menu.

語法	JumpContents(`filename')


JumpContext (JC)

用途	Executes a jump to the topic in the specified help file that corresponds to the specified context number. Context numbers are assigned in the [MAP] section of the help project file.

語法	JumpContext(`filename', context-number)


JumpHash

用途	Executes a jump to the topic in the specified help file that corresponds to the specified hash code.

語法	JumpHash(`filename', hash-code)


JumpHelpOn

用途	Displays the help file for the WinHelp application. Executing this macro is the same as selecting How to Use Help from the Help menu.

語法	JumpHelpOn()


JumpId (JI)

用途	Executes a jump to the topic in the specified help file that has the specified context string.

語法	JumpId(`filename', `context-string')


JumpKeyword (JK)

用途	Searches the keyword table of the specified help file and displays the first topic that matches the specified keyword.

語法	JumpKeyword(`filename', `keyword')


Next

用途	Displays the next topic in the current browse sequence. Executing this macro is the same as selecting the forward browse button (>>).

語法	Next()


Not

用途	Reverses the result (non-zero or zero) returned by a conditional macro such as IsMark.

語法	Not(`condition')


PopupContext (PC)

用途	Displays, in a popup window, the topic in the specified help file that corresponds to the specified context number. Context numbers are assigned in the [MAP] section of the help project file.

語法	PopupContext(`filename', context-number)


PopupHash

用途	Displays, in a popup window, the topic in the specified help file that corresponds to the specified hash code.

語法	PopupHash(`filename', hash-code)


PopupId (PI)

用途	Displays, in a popup window, the topic in the specified help file that has the specified context string.

語法	PopupId(`filename', `context-string')


PositionWindow (PW)

用途	Sets the size, position, and display state of either the main help window, or a secondary window.

語法	PositionWindow(x, y, width, height, state, `name')


Prev

用途	Displays the previous topic in the current browse sequence. Executing this macro is the same as selecting the backward browse button (<<).

語法	Prev()


Print

用途	Prints the currently displayed topic to the printer. Executing this macro is equivalent to selecting Print Topic from the File menu.

語法	Print()


PrinterSetup

用途	Displays the Print Setup dialog box. Executing this macro is equivalent to selecting Print Setup from the File menu.

語法	PrinterSetup()


RegisterRoutine (RR)

用途	Registers a function within a DLL as a custom help macro. The custom help macro may then be used as are the standard Windows help macros.

語法	RegisterRoutine(`DLL-name', `function-name', `format-spec')


RemoveAccelerator (RA)

用途	Removes an accelerator key or key combination that was previously assigned with the AddAccelerator macro.

語法	RemoveAccelerator(key, shift-state)


ResetMenu

用途	Returns the WinHelp menu bar and all popup menus to their defaults.

語法	ResetMenu()


SaveMark

用途	Saves the location of the currently displayed topic and file, and associates a text marker with that location. Text markers are used by the GoToMark and IsMark macros.

語法	SaveMark(`marker-text')


Search

用途	Displays the Search dialog box. Executing this macro is equivalent to selecting the Search button on the WinHelp button bar.

語法	Search()


SetContents

用途	Designates a specific topic as the Contents topic in the specified help file.

語法	SetContents(filename, context-number)


SetHelpOnFile

用途	Specifies the name of the replacement How to Use Help file

語法	SetHelpOnFile(filename)


UncheckItem (UI)

用途	Removes the check-mark that was previously placed beside a help menu item by the CheckItem macro.

語法	UncheckItem(`menu-id')


bmc

用途	插入位元映設圖檔（Bitmap file or Shed file）。

語法	bmc filename.bmp or bmc filename.shg


bml

用途	插入位元映設圖檔（Bitmap file or Shed file）。

語法	bml filename.bmp or bml filename.shg


BMROOT
WHAT_TopicHAT_TopicBMROOT

用途	Displays the WinHelp application's About topic.

語法	About()

WHAT_Topic

Syntax

BMROOT=pathname[, pathname]...

The BMROOT option designates the bitmap root directory, which tells the Help

compiler where to find the bitmap files to include in the build.

If the bitmap files reside in the root directory of the project, you don't need to

include a BMROOT directory; use the ROOT option instead. However, if you set

up your Help project so that bitmap files are not stored in the project root

directory, you may want to designate one or more bitmap root directories in the

BMROOT option.

Parameter

pathname

Specifies a drive and full path to each bitmap directory or to a path relative to the project directory. If you give more than one path for this option, use a comma (,) to separate the paths. The entire BMROOT entry in the Help project file can be up to 128 characters long. If the path is invalid or too long, the compiler reports an error.

Comments

If the Help project file has a BMROOT option, you don't need to list bitmap files in

the [BITMAPS] section.

If the Help project file does not have a BMROOT option, the Help compiler looks

for bitmaps in the directories specified by the ROOT option. If the Help project file

doesn't have a ROOT option, or if none of the ROOT directories contain the bitmap

files, you can:

List the bitmap filenames in the [BITMAPS] section of the Help project file.

or

Place all bitmap files in the same directory as the Help project file.

Example

The following entry specifies that bitmap files reside in the \HELP\BMP1 and

\HELP\BMP2 directories on drive C and in the \GRAPHICS\ART directory on drive

D:

[OPTIONS]

BMROOT=C:\HELP\BMP1, C:\HELP\BMP2, D:\GRAPHICS\ART

See Also

[BITMAPS] Section, [OPTIONS] Section, ROOT Option

HAT_Topic


Help Project File Reference

The Help Project File Reference describes the different sections and options in a

Help project file in alphabetic order and gives examples of their use. Reference

descriptions provide the following information.

Heading	Information

Syntax	Syntax for the section or option. For information about the typographic conventions used in syntax descriptions, see the "Document Conventions" section in the Introduction to this guide.

Parameters	Describes the parameters that the section or option requires.

Comments	Notes about using the section or option, including any restrictions.

Example	Example of the section or option.

See Also	Cross-references to similar sections and options.

[ALIAS] Section

Syntax

[ALIAS]

context_string=alias context string

   .

   .

   .

The [ALIAS] section associates one set of context strings with an alternate set of

context strings. The alias strings correspond to context strings assigned to topics

in the # footnotes of the Help file. This section is optional; however, if it is

included, it must precede the [MAP] section in the Help project file.

Parameters

context_string

Specifies the application ID or other context ID that you want to reassign.

alias context string

Specifies the context string that appears in the # footnote of the topic you want Help to recognize. An alias context string has the same form and follows the same conventions as standard context string. That is, it is not case-sensitive and may contain the alphabetic characters A through Z, the numeric characters 0 through 9, and the period (.) and underscore (_) characters.

Comments

Because context strings must be unique for each topic and cannot be used for

any other topic in the Help project, the [ALIAS] section provides a way to remap

context strings that are no longer used or invalid. For example, suppose the

application defines a context ID for each field in a dialog box, but your Help file

only provides one topic for all the fields. You can use the [ALIAS] section to map

all the application context IDs to your one Help topic. In this way, no matter which

field the user has selected in the dialog box, Help will display your Help topic

when the user requests context-sensitive Help.

You can also use the [ALIAS] section to combine Help topics without recoding

your files. For example, if you create a topic that replaces the information in three

other topics, you could manually search through your files for invalid

cross-references to the deleted topics. The easier approach, however, would be to

use the [ALIAS] section to assign the name of the new topic to the deleted topics.

You can use alias names in the [MAP] section of the Help project file. If you do,

however, the [ALIAS] section must precede the [MAP] section.

Example

The following example creates several aliases within an [ALIAS] section:

[ALIAS]

sm_key=key_shrtcuts

cc_key=key_shrtcuts

st_key=key_shrtcuts	;combined into keyboard shortcuts topic

clskey=us_dlog_bxs

maakey=us_dlog_bxs	;covered in using dialog boxes topic

chk_key=dlogprts

drp_key=dlogprts

lst_key=dlogprts

opt_key=dlogprts

tbx_key=dlogprts	;combined into parts of dialog box topic

frmtxt=edittxt

wrptxt=edittxt

seltxt=edittxt	;covered in editing text topic

See Also

[MAP] Section

[BAGGAGE] Section

Syntax

[BAGGAGE]

filename

   .

   .

   .

The [BAGGAGE] section lists files that the Windows Help compiler stores within

the .HLP file's internal file system. Windows Help can access data files stored in

the Help file system more efficiently than it can access files stored in the normal

MS-DOS file system because it doesn't have to read the file allocation table from

CD-ROM when it accesses the files. Any type of DOS file can be stored in

baggage.

In some circumstances, a Help file may use many DLLs or execute several

programs that use external data elements, such as graphics, animations, or audio

files. In those situations, the Help file will benefit if it can include all the data

elements needed by those programs in one MS-DOS file. To store Help-related

data files within the Help file, Help authors can include a [BAGGAGE] section in

the Help project file.

Parameter

filename

Specifies the full path of a baggage file. If a file cannot be found, the compiler reports an error.

Comments

The Help compiler stores all files listed in the [BAGGAGE] section exactly as

they are typed. In other words, baggage filenames are case sensitive. To retrieve a

baggage file, Help uses the MS-DOS filename without the path. This means that

the Help author must specify the filename exactly as it appears in the

[BAGGAGE] section, as in the following example.

Help does not limit the number of baggage files that you can define; however,

adding too many baggage files will waste disk space and decrease performance

when building and displaying the Help file. For that reason, you should define no

more than 1000 baggage files. If you have more than 1000 files to include, you

should store the data outside the .HLP file or concatenate the files into a few

baggage files that you list in the [BAGGAGE] section.

To access the data from the Help file's internal file system, Windows Help

provides specialized source code. This source code can be built into an

application or custom DLL so that it can retrieve the appropriate data file from the

Help file's [BAGGAGE] section. For more information and the baggage include file,

see Appendix C, "Baggage Access Functions."

To avoid having to specify a full path, use the ROOT option in the [OPTIONS]

section to specify the path. Then all filenames that you give in the topic file are

relative to the ROOT path.

Example

The following [BAGGAGE] section stores multimedia files in the Help file:

[BAGGAGE]

\.\ANIM\ASTER.AMF

\.\AUDIO\APATO.WAV

\.\AUDIO\PACHY.WAV

\.\AUDIO\STAR.WAV

\.\AUDIO\TREX.WAV

\.\AVI\APATO.AVI

\.\AVI\PACHY.AVI

\.\AVI\TREX.AVI

See Also

ROOT Option

[BITMAPS] Section

Syntax

[BITMAPS]

filename

   .

   .

   .

The [BITMAPS] section tells the Help compiler where to find bitmaps placed using

the bmc, bml, or bmr reference.

Parameter

filename

Specifies the full path of a bitmap file. If a file cannot be found, the compiler reports an error.

Comments

The [BITMAPS] section is not required if the bitmaps are located in the Help

project directory or if the path containing the bitmaps is listed in the BMROOT or

ROOT option. If the Help project file does not include either of these options, each

bitmap filename must be listed in the [BITMAPS] section of the Help project file.

Example

The following example specifies three bitmaps:

[BITMAPS]

BMP01.BMP

BMP02.BMP

BMP03.BMP

See Also

BMROOT Option, ROOT Option

BMROOT Option

Syntax

BMROOT=pathname[, pathname]...

The BMROOT option designates the bitmap root directory, which tells the Help

compiler where to find the bitmap files to include in the build.

If the bitmap files reside in the root directory of the project, you don't need to

include a BMROOT directory; use the ROOT option instead. However, if you set

up your Help project so that bitmap files are not stored in the project root

directory, you may want to designate one or more bitmap root directories in the

BMROOT option.

Parameter

pathname

Specifies a drive and full path to each bitmap directory or to a path relative to the project directory. If you give more than one path for this option, use a comma (,) to separate the paths. The entire BMROOT entry in the Help project file can be up to 128 characters long. If the path is invalid or too long, the compiler reports an error.

Comments

If the Help project file has a BMROOT option, you don't need to list bitmap files in

the [BITMAPS] section.

If the Help project file does not have a BMROOT option, the Help compiler looks

for bitmaps in the directories specified by the ROOT option. If the Help project file

doesn't have a ROOT option, or if none of the ROOT directories contain the bitmap

files, you can:

List the bitmap filenames in the [BITMAPS] section of the Help project file.

or

Place all bitmap files in the same directory as the Help project file.

Example

The following entry specifies that bitmap files reside in the \HELP\BMP1 and

\HELP\BMP2 directories on drive C and in the \GRAPHICS\ART directory on drive

D:

[OPTIONS]

BMROOT=C:\HELP\BMP1, C:\HELP\BMP2, D:\GRAPHICS\ART

See Also

[BITMAPS] Section, [OPTIONS] Section, ROOT Option

BUILD Option

Syntax

BUILD=expression

The BUILD option specifies which topics containing build tags are included in or

excluded from a build. Use this option only if the RTF topic files have build tags.

A topic contains a build tag if it includes a build tag footnote (*). Topics without

build tags are always compiled, regardless of the current build expression.

Parameter

expression

A logical statement that specifies which topics to include in or exclude from the build. This parameter consists of a combination of build tags (specified in the [BUILDTAGS] section) and the following logical operators.

Operator	Description

~	Applies the NOT operator to a single build tag. The Help compiler compiles a topic only if the tag is not present. This operator has the highest precedence; the compiler applies it before any other operator.

&	Combines two build tags by using the AND operator. The Help compiler compiles a topic only if it contains both build tags used in the expression. The compiler applies this operator only after the ~ operator has been applied.

|	Combines two build tags by using the OR operator. The Help compiler compiles a topic if it has at least one of the build tags used in the expression. This operator has the lowest precedence; the compiler applies it only after all other operators have been applied.

Parentheses may be used to override operator precedence. Expressions

enclosed within parentheses are always evaluated first.

Comments

Only one BUILD option can be given per Help project file.

The Help compiler evaluates all build expressions from left to right, using the

specified precedence rules.

Example

The following examples assume that the [BUILDTAGS] section in the Help project

defines the build tags DEMO, MASTER, and TEST_BUILD. Although the following

examples show several BUILD options on consecutive lines using these build

tags, only one BUILD option would be allowed in the Help project file.

Example	Compile all topics

BUILD=DEMO	That have the DEMO tag

BUILD=DEMO & MASTER	With both the DEMO and MASTER tag

BUILD=DEMO | MASTER	With either the DEMO or MASTER tag

BUILD=(DEMO | MASTER) & TEST_BUILD	That have either the DEMO or MASTER tag and also the TEST_BUILD tag

BUILD=~ MASTER	That do not have the MASTER tag

See Also

[BUILDTAGS] Section, [OPTIONS] Section

[BUILDTAGS] Section

Syntax

[BUILDTAGS]

tag

   .

   .

   .

The [BUILDTAGS] section defines the valid build tags for a Help file. The Help

compiler uses the build tags to determine which topics to include when building

the Help file.

This section is used in conjunction with the build tag footnote (*) and the BUILD

option. The build tag footnote associates a particular build tag with a given topic. If

the build tag is included in the [BUILDTAGS] section and defined in the BUILD

expression, the Help compiler compiles the topic; otherwise, it excludes the topic

from the build.

Parameter

tag

Specifies a build tag consisting of any combination of characters except spaces. The Help compiler strips any spaces it finds between the start of the build tag and the end of the tag. Build tags are case insensitive, so the compiler treats uppercase and lowercase characters as the same. Each build tag can have as many as 32 characters.

Comments

The [BUILDTAGS] section is optional. If used, it can include as many as 30 build

tags.

Example

The following example defines four build tags in a sample Help project file:

[BUILDTAGS]

DEMO	;topics to include in demo build

MASTER	;topics to include in master Help file

DEBUGBUILD	;topics to include in debugging build

TESTBUILD	;topics to include in a mini-build for testing

See Also

BUILD Option

CITATION Option

Syntax

CITATION=copyright-notice

The CITATION option appends a custom copyright notice to the end of any

information that is copied from the Help file using the Copy command. You can

use this option if a publisher owns some material in your Help file and requires

that you attach a copyright notice to that material.

Parameter

copyright-notice

Specifies the copyright information you want to append to copied material. The notice appears at the end of text displayed in the Copy dialog box (the notice is appended whenever the user copies text from the original Help file).

Comments

The CITATION option differs from the COPYRIGHT option in two ways: a citation

does not appear in the About dialog box, and a citation can be much larger than

the standard copyright notice. The maximum size of the citation copyright notice

is about 2K (compared to 50 characters for COPYRIGHT).

Example

The following shows a sample citation:

CITATION=Information in this document is subject to change without notice and does not represent a commitment on the part of Microsoft Corporation. The software, which includes information contained in any databases, described in this document is furnished under a license agreement or nondisclosure agreement and may be used or copied only in accordance with the terms of that agreement. It is against the law to copy the software except as specifically allowed in the license or nondisclosure agreement. No part of this document may be reproduced in any form or by any means, electronic or mechanical, for any purpose without the express written permission of Microsoft Corporation.

See Also

COPYRIGHT Option, [OPTIONS] Section

COMPRESS Option

Syntax

COMPRESS=compression-level

The COMPRESS option specifies the level of compression to be used when

building the Help file. Compression levels indicate either no compression, medium

compression (approximately 40 percent), or high compression (approximately 50

percent). The higher the compression level, the smaller the Help file. However, the

higher the compression, the longer the file takes to build.

Parameter

compression-level

Specifies the level of compression. This parameter can be one of the following values.

Value	Meaning

OFF	The Help compiler does not compress the Help file.

MEDIUM	The compiler uses a medium level of compression (block compression).

HIGH	The compiler uses high compression (block and key-phrase compression).

Comments

Depending on the level of compression requested, the Help compiler uses either

block compression or a combination of block and key-phrase compression:

Block compression compresses the topic data into predefined units known as

blocks.

Key-phrase compression combines repeated phrases found within the source

file(s).

The Help compiler creates a phrase-table file with a .PH extension if it doesn't find

one in the project root directory. If the Help compiler finds a file with a .PH

extension, it uses the file for the current build. Because the .PH file speeds up the

compression process when little text has changed since the last build, you might

want to keep the phrase file around if you compile the same Help file several times

with compression. However, you get maximum compression if you delete the .PH

file before starting each build.

Because of these improvements to Help compression, the resulting Help files you

build will take up less space on users' disks, but your setup program may not be

able to compress the smaller Help files as much as version 3.0 files. Therefore,

when estimating disk-space requirements, you should use sizes relatively close to

those achieved with high compression.

Key-phrase compression is the only compression method supported by the

version 3.0 Help compiler.

Example

The following shows a typical compression entry in the Help project file:

COMPRESS=off

See Also

[OPTIONS] Section

[CONFIG] Section

Syntax

[CONFIG]

macro

   .

   .

   .

The [CONFIG] section contains one or more Windows Help macros that carry out

actions, such as creating buttons or menus. This section can also contain macros

that register routines in external DLLs as Windows Help macros. These routines

can then be used the same as Windows Help macros. Windows Help executes

the macros when it opens the Help file.

Parameter

macro

Specifies a Windows Help macro or a DLL function registered as a Help macro. For descriptions of the standard Help macros and the RegisterRoutine macro, see Chapter 15, "Help Macro Reference."

Comments

The [CONFIG] section can include any number of lines, and each line can have as

many as 512 characters. When listing macros in the [CONFIG] section, include

only one macro per line, instead of stringing them together and separating them

with semicolons as you do in macro hot spots and macro footnotes.

When opening a Help file, Help does not necessarily execute the macros listed in

the [CONFIG] section in the same order.

Example

The following example registers two DLLs, creates a button, enables the browse

buttons, and sets the name of the How To Use Help file:

[CONFIG]

RegisterRoutine("bmp","HDisplayBmp","USSS")

RegisterRoutine("bmp","CopyBmp", "v=USS")

CreateButton("btn_up", "&Up", "JumpContents(`HOME.HLP')")

BrowseButtons()

SetHelpOnFile("APPHELP.HLP")

CONTENTS Option

Syntax

CONTENTS=context-string

The CONTENTS option identifies the context string of the highest-level or "home"

topic (usually a Table of Contents or index within the Help file). Windows Help

displays the Contents whenever a user chooses Contents from the Help menu,

clicks the Contents button, or presses F1 in the application without a specific

context.

Parameter

context-string

Specifies the context string of a topic in the Help file. The string can be any combination of characters, except spaces, and must also be specified in a context string footnote (#) in some topic in the Help file.

Comments

If the [OPTIONS] section does not include a CONTENTS option, the compiler

assumes that the first topic it encounters in the first listed topic file in the [FILES]

section of the Help project file is the contents topic.

Example

The following example sets the topic containing the "main_contents" context

string as the Contents topic for this Help file:

CONTENTS=main_contents

See Also

[FILES] Section, [OPTIONS] Section

COPYRIGHT Option

Syntax

COPYRIGHT=copyright-notice

The COPYRIGHT option places a custom copyright notice in the About dialog box

of Windows Help. Help displays the notice immediately below the Microsoft

copyright notice. You can use this option to copyright the material found in your

Help file.

Parameter

copyright-notice

Specifies the copyright notice you want to display for users of your Help file. The notice can be any combination of characters, and can have from 35 to 75 characters depending on the characters you use. A notice of 50 characters generally fits in the dialog box.

Comments

The copyright notice also appears at the end of text displayed in the Copy dialog

box. The notice is appended whenever the user copies text from the original Help

file using the Copy command.

If you need to display a longer copyright notice, use the CITATION option.

Example

The following example adds a short copyright notice to the Help file:

COPYRIGHT="Copyright (C) 1992,  Microsoft Corporation."

See Also

CITATION Option, [OPTIONS] Section

ERRORLOG Option

Syntax

ERRORLOG=error-filename

The ERRORLOG option directs the compiler to write all error messages generated

during the build to an error file. The compiler also displays the error messages on

the screen.

Parameter

error-filename

Specifies the name of the file to which the compiler will write the error messages. The filename can be any valid MS-DOS filename. This parameter can be a full or partial path if you want the file to be written to a directory other than the Help project root directory.

Comments

If you use the ERRORLOG option, it should be the first line in the [OPTIONS]

section.

The error file contains the Windows Help copyright notice and the name of the

Help project file at the top of the file, followed by any build errors that occurred.

Error messages are listed on separate lines. The periods representing compiler

progress are included only in the screen display, not in the written file.

If the Help compiler cannot create or open the error file, it displays an error

message on the screen and continues the build.

Example

The following example writes all errors during the build to the HLPBUGS.TXT file in

the Help project root directory:

ERRORLOG=HLPBUGS.TXT

See Also

[OPTIONS] Section, REPORT Option, WARNING Option

[FILES] Section

Syntax

[FILES]

filename

   .

   .

   .

The [FILES] section lists all RTF topic files used to build the Help file. A Help

project file must have a [FILES] section.

Parameter

filename

Specifies the full or partial path of a topic file. If a partial path is given, the help compiler uses the directories specified by the ROOT option to construct a full path. If a file is not on the defined path and cannot be found, the compiler reports an error.

Comments

You can use the #include directive in the [FILES] section to specify the topic files

indirectly by designating a file that contains a list of the topic files that are to be

included in the build.

The #include directive has the following syntax:

#include <filename>

The filename must reside in the Help project directory, or it must include a

complete path specification. The Help compiler does not use the INCLUDE

environment variable to search for files.

Example

The following example specifies four topic files:

[FILES]

\.\rtftxt\COMMANDS.RTF	;comment 1

\.\rtftxt\HOWTO.RTF	;comment 2

\.\rtftxt\KEYS.RTF	;comment 3

\.\rtftxt\GLOSSARY.RTF	;comment 4

The following example uses the #include directive to specify the topic files

indirectly:

[FILES]

#include <rtffiles.h>

See Also

ROOT Option

FORCEFONT Option

Syntax

FORCEFONT=fontname

The FORCEFONT option forces the Help file to substitute the specified font for all

requested fonts. Use this option to create Help files that can be viewed on

systems that do not have all fonts available.

Parameter

fontname

Specifies the name of an available font. Font names must be spelled the same as they are in the Fonts dialog box in Control Panel. Font names cannot exceed 20 characters. If an invalid font name is given, the Help compiler uses the MS Sans Serif font as the default.

Comments

The fontname can be any of the following standard fonts installed in Windows

version 3.1:

Courier 10,12,15

Modern

MS Sans Serif 8,10,12,14,18,24

MS Serif 8,10,12,14,18,24

Roman

Script

Small

Symbol 8,10,12,14,18,24

Windows version 3.1 also includes the following scalable TrueTypeTM fonts;

however, you cannot use this option to specify a TrueType font:

Arial�

Arial Bold

Arial Bold Italic

Arial Italic

Courier

Courier Bold

Courier Bold Italic

Courier Italic

Times New Roman�

Times New Roman Bold

Times New Roman Bold Italic

Times New Roman Italic

Symbol

Example

The following example forces all fonts to be displayed in the MS Serif font:

FORCEFONT=MS SERIF

See Also

MAPFONTSIZE Option, [OPTIONS] Section

ICON Option

Syntax

ICON=icon-file

The ICON option identifies the icon file to display when the user minimizes the

Windows Help application.

Parameter

icon-file

Specifies the name of the icon file. This file must have the standard Windows icon-file format (.ICO file). You must create this file in an application such as Microsoft Windows Image Editor (IMAGEDIT.EXE) or other application that generates the .ICO file format. You can specify either an absolute or relative path if the file resides in a directory other than the Help project root directory.

Comments

If you do not include the ICON option in your Help project file, Help will use the

standard question-mark icon when the user minimizes the Help file.

If the icon file is in an invalid format, or if Help cannot find the icon file, the Help

compiler displays an error message on the screen during the build and ignores

this option. In that case, Help will display the standard question-mark icon.

The ICON option only appears when the user minimizes Help. To have your

custom icon appear in a Program Manager group, you must provide users with the

icon file and then instruct them to use the Properties command in Program

Manager to change the standard Help icon to your custom icon.

Example

The following example creates a custom icon for the Help file:

ICON=HYPER.ICO

See Also

[OPTIONS] Section

LANGUAGE Option

Syntax

LANGUAGE=language-name

The LANGUAGE option sets the sort order for keywords in the Search dialog box.

Parameter

language-name

Specifies the language on which to base sorting. This parameter can have only one value.

Value	Meaning

scandinavian	Sets the sorting order to the Scandinavian-language order.

Comments

The default sorting order is the English-language order.

Microsoft Windows Help version 3.1 supports only English and Scandinavian

sorting.

Example

The following example changes the sorting order to Scandinavian:

LANGUAGE=SCANDINAVIAN

See Also

[OPTIONS] Section

[MAP] Section

Syntax

[MAP]

context_string          context number

   .

   .

   .

The [MAP] section associates context strings (or aliases) to context numbers for

context-sensitive Help. The context number corresponds to a value the parent

application passes to Windows Help to display a particular topic. This section is

optional.

Parameters

context-string

Specifies the context string of a topic in the Help file. The string can be any combination of characters, except spaces, and must also be specified in a context string footnote (#) in some topic in the Help file.

context-number

Specifes the context number to associate with the context string. The number can be in either decimal or standard C hexadecimal format.

Comments

Only one context number may be assigned to a context string or alias. Assigning

the same number to more than one context string generates a compiler error.

You can separate context numbers and context strings by an arbitrary amount of

white space using space characters or tabs, but there must be at least one space

between the context number and the context string.

If you do not explicitly assign context numbers to topics, the Help compiler

generates default values by converting topic context strings into context numbers.

You can define the context strings listed in the [MAP] section either in a Help

topic or in the [ALIAS] section. The compiler generates a warning message if a

context string appearing in the [MAP] section is not defined in any of the topic

files or in the [ALIAS] section.

If you use an alias, the [ALIAS] section must precede the [MAP] section in the

Help project file.

If you remove a Help topic that the application defines as context sensitive, users

will get a "Topic does not exist" error message when they request Help on the

item. To prevent the error from occurring, you must either change the application

so that it no longer sends the context number to Help or map that context number

to an existing topic.

The [MAP] section supports two additional statements for specifying context

strings and their associated context numbers: #include and #define.

The #include statement has the following form:

#include <filename>

The filename parameter, which can be enclosed in either angle brackets (<>) or

double quotation marks, specifies the name of a file containing one or more

#define statements. The file may contain additional #include statements as well,

but files may not be nested in this way more than five deep.

The #define statement has the following form:

#define  context-string  context-number

The context-string and context-number parameters are the same as those

described in the "Parameters" section above.

If context numbers use the #define directive and the file containing the #define

statements is included in both the application code and the Help file, updates

made to the context numbers by the application programmers are reflected in the

next Help build.

When using the #define statement in the [MAP] section, observe these rules:

You can use C-style comments (/* open comment and */ close comment) with

the #define directive. The comments can occur anywhere in the line.

#define context_string    context_number     /* comment */

The Help compiler supports 32-bit constants in #define statements. It also

accepts (as 32-bit constants) numbers that end with L and are accepted by the

C compiler for a long constant:

#define vscroll      1234000L

The Help compiler does not perform arithmetic on the object of the #define

statement. It does not support the following forms of #define:

#define A  1

#define B  (A+1)

#define C  (A+2)

The Help compiler only accepts #define statements; it does not support other

forms such as #ifdef and #endif.

Examples

The following example uses a decimal number to specify the context number:

dtb_scr           34      ;document title bar

The following example uses a hexadecimal number to specify the context number:

Minimize_Icon      0x0004

The following example uses an #include directive to point to another file

containing the context strings and context numbers:

#include <sample.h>

The following example uses a #define statement to specify the mapping:

#define up_scroll    0x0112   /* up scroll arrow */

See Also

[ALIAS] Section

MAPFONTSIZE

Syntax

MAPFONTSIZE=m[-n]:p

The MAPFONTSIZE option maps font sizes specified in topic files to different

sizes when displayed in the Help window. You can use one font size in your topic

files and have the compiler change them to an appropriate size for the actual Help

file display.

This option is especially useful if there is a significant size difference between the

authoring display and the intended user display, as there is if the RTF file is

created using Word for the Macintosh.

Parameters

m[-n]

Specifies the size of the source font. This parameter is either a single point size or a range of point sizes, as indicated by the optional parameter n, which specifies a font range to be mapped. A range of point sizes consists of the low and high point sizes separated by a hyphen (-). If a range is specified, all fonts in the range are changed to the size specified by the p parameter.

p

Specifies the size of the desired font for the Help file.

Comments

Although you can specify as many as five font ranges in the [OPTIONS] section of

the Help project file, you can map only one font size or range with each

MAPFONTSIZE statement. If you include more than one MAPFONTSIZE

statement, the source font size or range specified in subsequent statements

cannot overlap previous mappings.

Examples

The following examples illustrate the use of the MAPFONTSIZE option:

MAPFONTSIZE=8:12            ; display all 8 pt. fonts as 12 pt.

MAPFONTSIZE=12-24:16     ; display fonts from 12 to 24 pts. as 16 pt.

The following two statements show an incorrect use of the MAPFONTSIZE option

because the second statement contains a point size already mapped in the

preceding statement (14 falls in the 12-24 range):

MAPFONTSIZE=12-24:16

MAPFONTSIZE=14:20

See Also

FORCEFONT Option, [OPTIONS] Section

MULTIKEY Option

Syntax

MULTIKEY=footnote-character

The MULTIKEY option specifies the footnote character to use for an alternate

keyword table. This option is intended to be used in conjunction with topic files

that contain keyword footnotes for alternative keyword tables.

Parameter

footnote-character

Specifies the case-sensitive letter to be used for the keyword footnote.

Comments

Multiple keyword tables enable Help authors to differentiate terminology from

different sources. For example, the standard keyword table can be used to define

search queries for the parent application, and a second keyword table can map

commands in an auxiliary application. Users can then look up topics using both

sets of keywords.

Because keyword footnotes are case sensitive, you should limit your

keyword-table footnotes to one case, usually uppercase. If an uppercase letter is

specified, the compiler will not include footnotes with the lowercase form of the

same letter in the keyword table.

You may use any alphanumeric character for a keyword table except K and k,

which are reserved for Help's standard keyword table. There is an absolute limit of

five keyword tables, including the standard table. However, depending upon

system configuration and the structure of your Help system, a practical limit of

only two or three tables may be more realistic. If the compiler cannot create an

additional keyword table, the additional table is ignored in the build.

Example

The following example illustrates how to enable the letter L for a keyword-table

footnote:

MULTIKEY=L

See Also

[OPTIONS] Section

OLDKEYPHRASE Option

Syntax

OLDKEYPHRASE=yes/no

The OLDKEYPHRASE option specifies whether to use an existing key-phrase file

for the current build.

Parameters

yes/no

Specifies whether the existing file should be used.

Comments

The Help compiler creates a phrase-table file with a .PH extension if it doesn't find

one in the project root directory. If the Help compiler finds a file with a .PH

extension, it uses the file for the current build. Because the .PH file speeds up the

compression process when little text has changed since the last build, you might

want to keep the phrase file around if you compile the same Help file several times

with compression. However, you get maximum compression if you delete the .PH

file before starting each build.

If you do not include this option in the Help project file, the Help compiler will use

the old keyphrase file by default.

Example

The following example illustrates this option:

OLDKEYPHRASE=NO

See Also

[OPTIONS] Section

OPTCDROM Option

Syntax

OPTCDROM=yes/no

The OPTCDROM option optimizes a Help file for CD-ROM display by aligning

topic files on predefined 2K block boundaries.

Parameters

yes/no

Specifies whether the file should be optimized for CD-ROM.

Comments

The CD-ROM optimization allows Windows Help to read data from the CD-ROM

drive faster and more efficiently. On average, sequential reads from the CD are

twice as fast when the topics are aligned using the OPTCDROM option.

The disadvantage to using the OPTCDROM option is that it slightly increases the

size of the built Help file (approximately 10K). If you are delivering your Help file on

CD-ROM, the extra file size should not be significant, given the large storage

capacity of a CD-ROM disc.

Using the OPTCDROM option will also improve performance when Help files are

read from a standard hard disk; however, because of the size increase you may

not want to use this option if you are shipping your Help file on floppy disks. Help

authors must evaluate the size difference and performance improvement of their

individual files to decide whether to use this option.

Example

The following example illustrates this option:

OPTCDROM=YES

See Also

[OPTIONS] Section

[OPTIONS] Section

Syntax

[OPTIONS]

option

   .

   .

   .

The [OPTIONS] section includes options that control how a Help file is built and

what feedback the build process displays. If you include this section in the Help

project file, list it first so that the options apply during the entire build process.

Parameters

option

Specifies one of the following project-file options.

Option	Description

BMROOT	Specifies the directory containing the bitmap files named in bmc, bml, and bmr references in the Help topic files.

BUILD	Determines which topics to include in the build.

CITATION	Adds a unique copyright message whenever users copy information in the Help file using the Copy command.

COMPRESS	Specifies the type of compression to use during the build.

CONTENTS	Specifies the context string of the Help file's Contents topic.

COPYRIGHT	Adds a unique copyright message for the Help file to the About dialog box.

ERRORLOG	Puts compilation errors in a file during the build.

FORCEFONT	Forces all authored fonts in the topic files to appear in a different font when displayed in the Help file.

ICON	Specifies the icon file to be displayed when the Help file is minimized.

LANGUAGE	Specifies a different sorting order for Help files authored in a Scandinavian language.

MAPFONTSIZE	Maps a font size in the topic file to a different font size in the compiled Help file.

MULTIKEY	Specifies an alternate keyword table to use for mapping topics.

OLDKEYPHRASE	Specifies whether the compiler should use the existing key phrase table or create a new one during the build.

OPTCDROM	Optimizes the Help file for CD-ROM use.

REPORT	Controls the display of messages during the build process.

ROOT	Specifies the directories containing the topic and data files listed in the Help project file.

TITLE	Specifies the text that is displayed in the title bar of the Help window when the file is open.

WARNING	Indicates the level of error-message reporting the compiler is to display during the build.

Comments

These options can appear in any order within the [OPTIONS] section. The

[OPTIONS] section is not required.

Example

The following shows the [OPTIONS] section in a sample Help project file:

[OPTIONS]

ERRORLOG=CARD.LOG

ROOT=C:\HELP\PROJECT

BMROOT=C:\HELP\PROJECT\BMP1;C:\HELP\PROJECT\BMP2;C:\HELP\PROJECT\BMP3;

TITLE=My Help File

CONTENTS=IDX_CONTENTS

COMPRESS=HIGH

OLDKEYPHRASE=NO

ICON=C:\HELP\PROJECT\BMP2\HLPFILE.ICO

WARNING=3

REPORT=ON

This sample [OPTIONS] section indicates the following to the Help compiler:

Write messages displayed during the build to the CARD.LOG file.

The project directory is C:\HELP\PROJECT.

Bitmap files reside in three subdirectories off of the project root directory:

\BMP1, \BMP2, and \BMP3.

The title bar caption for the Help file is My Help File.

The context string of the Help file's Contents topic is IDX_CONTENTS.

Use high compression during the build.

Do not use the old key-phrase table during compression.

Use HLPFILE.ICO as the minimized Help icon.

Report all errors and warnings.

Display messages throughout the build to indicate when processes are

occurring.

See Also

BMROOT Option, BUILD Option, CITATION Option, COMPRESS Option,

CONTENTS Option, COPYRIGHT Option, ERRORLOG Option, FORCEFONT

Option, ICON Option, LANGUAGE Option, MAPFONTSIZE Option, MULTIKEY

Option, OLDKEYPHRASE Option, OPTCDROM Option, REPORT Option,

ROOT Option, TITLE Option, WARNING Option

REPORT Option

Syntax

REPORT=on/off

The REPORT option displays messages on the screen during the build. These

messages indicate when the compiler is performing the different phases of the

build, including scanning the file for compression, compiling the file, verifying

context strings, and resolving jumps, keywords, and browse sequences.

Parameters

on/off

Specifies whether the compiler should display messages on the screen during the build.

Comments

Unlike the ERRORLOG option, messages displayed by using the REPORT option

are not written to a file.

Example

The following example illustrates this option:

REPORT=ON

See Also

[OPTIONS] Section, WARNING Option

ROOT Option

Syntax

ROOT=pathname[, pathname]...

The ROOT option specifies the project root directory where the Help compiler

looks for the source files to include in the build.

Parameter

pathname

Specifies either a drive and full path or a relative path from the project directory. If you specify more than one project directory, a comma (,) separates each path. The entire ROOT entry can be up to 128 characters long. If the path is invalid or too long, the compiler reports an error.If the Help project file has a ROOT option, all relative paths in the Help project file refer to one of these paths. If the Help project file does not have a ROOT option, all paths are relative to the directory containing the Help project file.

Comments

If the Help project file does not have a BMROOT option, the compiler looks in the

directories specified in the ROOT option to find bitmaps positioned by using the

bmc, bml, and bmr references. If the Help project file doesn't have a ROOT

option or if none of the ROOT directories contain the bitmaps, the bitmap

filenames must be listed in the [BITMAPS] section of the Help project file.

Example

The following entry specifies that the project root directory is C:\HELP\PROJECT

and is found on drive C:

[OPTIONS]

ROOT=C:\HELP\PROJECT

Given this root directory, topic files can be listed relative to the project root

directory in the [FILES] section:

[FILES]

.\RTF\TOPICS1.RTF

.\RTF\TOPICS2.RTF

.\RTF\TOPICS3.RTF

.\RTF\TOPICS4.RTF

.\RTF\TOPICS5.RTF

The full path for a topic file is C:\HELP\PROJECT\RTF\TOPICS1.RTF.

See Also

[BITMAPS] Section, BMROOT Option, [OPTIONS] Section

TITLE Option

Syntax

TITLE=titlename

The TITLE option assigns a title to the Help file. Windows Help displays this title

in the title bar of the Help window whenever it displays the Help file.

Parameter

titlename

Specifies the title displayed in the title bar of the Help window. The title can have as many as 50 characters.

Comments

If you do not specify a title using the TITLE option, the title bar displays Microsoft

Help.

Example

The following example sets the Help file title to Cardfile Help:

[OPTIONS]

TITLE=Cardfile Help

See Also

[OPTIONS] Section

WARNING Option

Syntax

WARNING=level

The WARNING option specifies the amount of debugging information that the

compiler is to report during the build.

Parameter

level

Specifies the warning level. This parameter may be any one of the following values.

Value	Meaning

1	Report only the most severe errors.

2	Report an intermediate number of errors.

3	Report all fatal errors and warnings.

Comments

This option only specifies the amount of information to report. It should be used in

conjunction with the REPORT option and the ERRORLOG option if you want to

see the error messages on the screen and save them in a file.

Example

The following example specifies an intermediate level of error reporting:

[OPTIONS]

WARNING=2

See Also

ERRORLOG Option, [OPTIONS] Section, REPORT Option

[WINDOWS] Section

Syntax

[WINDOWS]

window-name="caption", (x-coord, y-coord, width, height), window-state,

(scrolling-RGB), (nonscrolling-RGB), ontop-state

   .

   .

   .

The [WINDOWS] section defines the size, location, and colors for the primary

Help window and any secondary window types used in a Help file. You can define

as many as five secondary window types.

Parameters

window-name

Specifies the name of the window that uses the defined attributes. For the primary Help window, this parameter is main. For a secondary window, this parameter may be any unique name (other than main) with as many as eight characters. Any jumps that display a topic in a secondary window give this window name as part of the jump.

caption

Specifies the text that appears in the title bar of the window. The caption can have as many as 50 characters. If no caption is specified, Windows Help is displayed. Generally, to set the caption of the main window, you use the TITLE option in the [OPTIONS] section of the Help project file. If the caption specified here differs from the TITLE option, the [WINDOWS] caption determines the title displayed in the title bar.

x-coord

Specifies the x-coordinate, in Help units, of the window's upper-left corner. The horizontal position is defined in terms of Windows Help's 0-1023 coordinate system. (Help always assumes the screen is 1024 units wide, regardless of resolution. For information about how to determine actual coordinates for different video resolutions, see the "Comments" section.) The x-coordinate is relative to the upper-left corner of the screen, which is 0,0.

y-coord

Specifies the y-coordinate, in Help units, of the window's upper-left corner. The vertical position is defined in terms of Help's 0-1023 coordinate system. (Help always assumes the screen is 1024 units wide, regardless of resolution. For information about how to determine actual coordinates for different video resolutions, see the "Comments" section.) The y-coordinate is relative to the upper-left corner of the screen, which is 0,0.

width

Specifies the window's default width in Help's 0-1023 coordinate system.

height

Specifies the window's default height in Help's 0-1023 coordinate system.

window-state

Specifies how the window is sized when Windows Help first opens it. This parameter can be one of the following values.

Value	Meaning

0	Size the window according to the values specified in the x-coord, y-coord, width, and height parameters. The default is 0 or normal size.

1	Maximize the window, and ignore the x-coord, y-coord, width, height, and ontop-state parameters given in the type definition.

scrolling-RGB

Specifies the background color for the window's scrolling region. Colors are given as standard RGB valueswhere RRR, GGG, and BBB are three-digit numbers in the range 0 to 255 representing the red, green, and blue components of the color. If this parameter is not given, Help uses the default Windows system color specified by the end-user in Control Panel.

nonscrolling-RGB

Specifies the background color for the window's nonscrolling region (if any). Colors are given as standard RGB valueswhere RRR, GGG, and BBB are three-digit numbers in the range 0 to 255 representing the red, green, and blue components of the color. If this parameter is not given, Help uses the default Windows system color specified by the end-user in Control Panel.

ontop-state

Specifies whether a secondary window type stays on top of other windows. The main Help window cannot be authored as a topmost window. This parameter can be one of the following values.

Value	Meaning

0	Display the window normally, not on top of other windows. The default is 0 or normal behavior.

1	Display the window on top of other windows. If this value is given, the user cannot change the window behavior using the Always On Top command in Help.

Comments

Window attributes defined in the [WINDOWS] section follow these rules:

A single comma may be substituted for an entry or a group of entries enclosed

by parentheses. Preceding commas are required if you want to use the default

settings. Trailing commas are optional. (See the "main" example below.)

Windows attributes are set for the Help windows whenever a file containing

predefined attributes is opened.

If a user performs an operation, such as an interfile jump, that opens a file with

predefined window attributes, the Help windows will adjust to the new settings,

change size or location, for example.

When an application requests Help using the WinHelp function, Help uses the

values defined in the [WINDOWS] section to determine window attributes. If the

Help file does not include settings in the Help project file, Help uses the default

settings.

When Help is closed, the window settings are updated in the [Windows Help]

section of the WIN.INI file.

The Help coordinate system ranges from 0 through 1023 in both directions, so the

vertical position plus the height must be less than or equal to 1023. Similarly, the

horizontal position plus the width must be less than or equal to 1023. This

1024-by-1024 coordinate system is mapped to the horizontal and vertical

resolutions of the video card. To convert from pixels to Windows Help coordinates,

you invert the ratio between Help's resolution and the video resolution. Assuming

the video card resolution is horiz by vert pixels, and the horizontal and vertical

locations (or dimensions) you want are in pixels, the x-coordinate (or width), in

Help coordinates, is as follows:

x-coord = pixel location * (1024/horiz)

width = number of pixels * (1024/horiz)

The y-coordinate (or height), in Help coordinates, is:

y-coord = pixel location* (1024/vert)

height = number of pixels * (1024/horiz)

For example, if you want the window's upper-left corner to appear at horizontal

pixel 320 and at vertical pixel 120, and the Help file is being displayed on a

standard VGA monitor with 640 by 480 resolution, the x-coord is (320 *

(1024/640)) = 512, and y-coord is (120 * (1024/480)) = 256.

Example

The following example defines two windows, the main Help window and a

secondary window named "picture." The main window definition sets the

background color to magenta (128, 0, 128) and leaves the other values empty (for

which Help will supply its default values). The secondary window definition sets

the caption to Samples, positions it in the upper-left part of the screen (123, 123),

and sets the window's width and height to about one-quarter of the screen's width

and height (256). The window will not be maximized (0). The window's background

colors are set to cyan (0, 255, 255) for the scrolling region and light gray (192,

192, 192) for the nonscrolling region. The secondary window will appear on top of

other windows when it is open (1).

[WINDOWS]

main=, , , (128, 0, 128)

picture="Samples", (123, 123, 256, 256), 0, (0, 255, 255), (192, 192, 192), 1

See Also

[OPTIONS] Section, TITLE Option