home *** CD-ROM | disk | FTP | other *** search
/ Phoenix Heaven Sunny 2 / APPARE2.BIN / oh_towns / taropyon / dos / pghelp.doc < prev    next >
Text File  |  1995-06-20  |  5KB  |  131 lines
  1. ==========================================================================
  2.             PGHELP : テキストマニュアル検索ツール
  3.  
  4.                                                         1994 (C) TaroPYON
  5. ==========================================================================
  6.  
  7. 　テキストマニュアルの中から特定の単語を検索し，説明を表示するプログラムで
  8. す。
  9. 　High C Compiler マルチメディア開発キットに含まれるテキストマニュアルを活
  10. 用るために作成したプログラムです。
  11.  
  12.  
  13. **************************************************************************
  14. ☆  使い方
  15. **************************************************************************
  16.  
  17. ●インデックスファイルを作成する
  18.  
  19. 【書式】
  20.   ┌─────────────────────────────────┐
  21.   │PGHELP [-p<ディクトリ>] [-h] -m                                   │
  22.   └─────────────────────────────────┘
  23.  
  24. 【パラメータ】
  25.     -p<ディレクトリ>  …テキストマニュアルが格納されているディレクトリを指
  26.                         定
  27.     -h                …インデックスファイルのファイル属性にHIDDEN（隠しフ
  28.                         ァイル）を指定
  29.  
  30. 【解説】
  31. 　テキストマニュアルを検索するためのインデックスファイルを作成します。
  32. 　インデックスファイルは，_index.tbl，_index.000～_index.015というファイル
  33. 名で作成されます。
  34. 　また，関数の一覧としてcontents.idx が作成されます。
  35.  
  36. 【使用例】
  37.   カレントディレクトリのテキストマニュアルのインデックスファイルを作成する
  38.  
  39.     PGHELP -m
  40.  
  41. ●関数の説明を表示する
  42.  
  43. 【書式】
  44.   ┌─────────────────────────────────┐
  45.   │PGHELP [-p<ディクトリ>] <関数名>                                  │
  46.   └─────────────────────────────────┘
  47.  
  48. 【パラメータ】
  49.     -p<ディレクトリ>  …テキストマニュアルが格納されているディレクトリを指
  50.                         定
  51.  
  52. 【解説】
  53. 　指定の関数名の説明を表示します。
  54. 　関数名の説明を表示するためには，あらかじめインデックスファイルを作成して
  55. おく必要があります。
  56. 　説明の表示内容をファイルに保存したい場合はリダイレクトを使ってください。
  57.  
  58. 【使用例】
  59.   PGHELP -pF:\HC386\MANUAL EGB_paintMode
  60.  
  61.  
  62. **************************************************************************
  63. ☆  テキストマニュアルについて
  64. **************************************************************************
  65.  
  66. ●テキストマニュアルの書式について
  67.  
  68. 　PGHELPで使えるテキストマニュアルは拡張子.DOCを持ち，おなじディレクトリに
  69. 格納されている必要があります。ファイルサイズの制限はありませんが，ファイル
  70. 数は最大127 個までです。
  71.  
  72. 　関数名と説明の対応は，テキストマニュアル中に決まった書式で書かれている必
  73. 要があります。
  74. 　関数名は行頭にピリオド「. 」を置いて指定します。関数名の後に半角スペース
  75. かタブコードを置いて見出しを付けることができます。見出しは省略することもで
  76. きます。
  77. 　関数の説明は，ピリオドで始まる行で囲まれている範囲となります。
  78.  
  79. 　関数名と説明はひとつのテキストマニュアルの中にいくつでも指定することがで
  80. きます。
  81. 　また，PGHELP では127 個までテキストマニュアルを分割しておくことも可能で
  82. す。
  83.  
  84. 【例】
  85.  
  86.   ┌───────────────┐
  87.   │.func1      func1の見出し     │  ←見出しはなくともよい
  88.   │                              │
  89.   │        ・                    │
  90.   │        ・                    │
  91.   │    func1 の説明              │
  92.   │        ・                    │
  93.   │        ・                    │
  94.   │                              │
  95.   │.func2      func2の見出し     │
  96.   │                              │
  97.   │        ・                    │
  98.   │        ・                    │
  99.   │    func2 の説明              │
  100.   │        ・                    │
  101.   │        ・                    │
  102.   │.                             │  ←関数の説明を打ち切りたい場合はピリ
  103.   └───────────────┘    オド「. 」をおく
  104.  
  105.  
  106. 　複数の関数で同じ説明を共用したい場合は次のようにしてください。
  107.  
  108.   ┌───────────────┐
  109.   │.func1    func1の見出し       │
  110.   │.func2    func2の見出し       │
  111.   │.func3    func2の見出し       │
  112.   │                              │
  113.   │        ・                    │
  114.   │        ・                    │
  115.   │  func1～3 の説明             │
  116.   │        ・                    │
  117.   │        ・                    │
  118.   │.                             │
  119.   └───────────────┘
  120.  
  121. ●High Cに添付されているテキストマニュアルを使う場合の注意点
  122.  
  123. 　High C Compiler マルチメディア開発キットに含まれるテキストマニュアルをPG
  124. HELPで使う場合，ファイルの加工が必要です。
  125. 　High Cのテキストマニュアルは，ピリオド＋関数名という書式が使われています
  126. が，本文の説明以外の場所でもピリオド＋関数名の書式が使われているため，その
  127. ままでは正常に検索できません。
  128. 　PGHELPで正しく検索したいときは，関数の説明以外の場所（索引など）で使われ
  129. ているピリオド＋関数名の箇所を取り除いてください。
  130.  
  131.