Doc Wizard 1.0.0.1


                    sun,
                    alphasun@etang.com,
                    sun@solid2000.com,
                    sun@urtsoftserver
                    2003-2-21
                    http://www.betajin.com/alphasun/

======================================================
    FORWORD
======================================================

您在寫文檔時是否被數量眾多的類成員函數所煩惱？是否為了形成美觀
的版面、格式而困擾？是否為了做成CHM而不得不進行大量的手工操作？
本軟件可以幫助您

    ●  生成C++的類的HTML格式的文檔，條分縷析，版面美觀而樸實。
        并且可以集成到 HTML Workshop 中，和其他類一起形成CHM。

    ●  而且可以生成 content of topic (.hhc) 文件以及生成
        index (.hhk) 文件。避免您手工編輯生成文件的麻煩。要知
        道在 HTML Workshop 中編輯生成這兩種文件是非常麻煩的。

    ●  在馬上就要推出的新版本中，將提供二次開發接口，您將可以
        操縱文檔生成過程，形成更符合您要求的文檔。當然源代碼的
        解析本軟件已經幫您完成了，您所要做的僅僅是生成您所關心
        的“部分”文檔。


======================================================
SYSTEM REQUERMENTS
======================================================
    本軟件用VC++ 6.0 sp5開發，為了減小壓縮包的大小，所以壓縮包里
    面沒有相關的動態鏈接庫。所以各位需要自己配備。當然啦，大家都
    用VC的，這些東西肯定是有的。


======================================================

1. 基本概念

本工具是用來生成C++類的HTML文檔的，另外還可以生成 HTML Workshop
所需要的hcc，hhk文件，方便你把文檔編譯成CHM。

首先用 HTML Workshop 創建你的工程，你會得到一個工程目錄，
你用 DocWizard 生成的文檔一定要放到工程目錄下面，可以建子目錄。
界面上的 "TechDoc根目錄" 就是你的CHM工程目錄，"存放目錄" 是
工程目錄之下的目錄。

這些用來設定目錄的edit，都是可以接受從資源管理器拖過來的目錄或者
文件的。請先激活你所需要的edit，激活的edit是綠色的。

DocWizard 生成的 hcc, hhk 文件請通過手工編輯的方式加入到
HTML Workshop 生成的 hcc, hhk 文件中去。接下來，編譯你的CHM工程就
可以了。


======================================================

2. 解釋界面上的控件

使用本地路徑 提供文檔存放目錄 (Radio Box)

    選擇這個Radio Box您將可以生成正確的Contents文件和Index
    文件，并且可以將文檔直接生成到Solid2000TechDoc目錄中。

    單擊Edit控件使其獲得焦點，然后拖動目錄到對話框上。

    總共有兩個參數需要設置。設置完畢之后就可以生成content
    文件和index文件需要的如下形式的路徑：
    <param name="Local" value="Solid2000開發\Solid2000系統基礎層\數學庫\SGeomTool\AngleCoincide.htm">

    ###################################
    TechDoc根目錄(d:\\Solid2000TechDoc)
    這個目錄是所有的 Solid2000 Tech Doc 存放的根目錄。請
    使用完整路徑。

    ###################################
    存放目錄(目標目錄) (d:\\Soli...\\SomeTopic)
    存放您所處理的類的文件夾的目錄。請使用完整路徑。


使用CHM虛擬路徑 提供文檔存放目錄(目標目錄) (Radio Box)

    如果選用這個Radio Box，則只能生成Contents文件和Index
    文件，但是不能把文檔生成到Solid2000TechDoc目錄中。

    單擊Edit控件使其獲得焦點，然后拖動目錄到對話框上。

    這個參數將用于生成如下形式的代碼：
    <param name="Local" value="Solid2000開發\Solid2000系統基礎層\數學庫\SGeomTool\AngleCoincide.htm">
    您所提供的路徑可能是
    Solid2000開發\Solid2000系統基礎層\數學庫\


生成index文件 (Check Box)
    選中這個選項將可以生成index文件。類名和所有的函數名
    將作為關鍵字。關鍵字對應的文件形式如下:
    Solid2000開發\Solid2000系統基礎層\數學庫\SGeomTool\AngleCoincide.htm
    所以需要設置相應的路徑，參見上面兩個Radio Box的說明。


生成Contents文件 (Check Box)
    Contents文件的結構是

    [ClassName]
        成員函數
            [function1]
            [function2]
            [function3]
    是否有 “成員函數” 這個節點可以在對話框上設置。


下面有一級ClassMember結點 (Check Box Class)
    見上一條。


生成到 (Radio Box)
    可以選擇生成到目標目錄；可以生成到 Solid2000TechDoc 目錄，
    也可以選擇生成到頭文件所在目錄。

要處理的頭文件 (Edit)
    單擊控件使其獲得焦點，然后拖動文件到對話框上。

覆蓋上次結果 (Check Box)
    選擇這個 Check box，生成的文檔文件 .htm 如果文件已經存在，
    則不提示。如果不 Check，則當有文件已經存在時會出現提示。


快捷菜單功能
    全部選中            全部選中當前激活列表中的項目，將其打勾
    統統不選            當前激活列表中的項目取消選擇
    析構函數不選        取消析構函數的選擇，其他函數不變

    只選擇目標目錄中沒有的
                        這個功能可用于文檔的補充

    反選                選擇狀態取反
    互相See Also        被選中的函數的生成文檔中有自動產生的 See Also。
                        選中的item的See Also函數會在第二列顯示 "S"。

    清除選中的item的see also列表
                        被選中的item的See Also列表將被清除

    清除兩兩之間的See Also
                        被選中的集合中，兩兩之間的See Also關系將被打斷。

    自動See Also        自動產生See Also關系。請在使用此功能之前選擇好
                        那些函數需要產生文檔，因為不產生的文檔將不會被
                        See Also。

    用瀏覽器看文件      設定用于瀏覽的程序
    編輯文件            設定用于編輯網頁的程序
    詳細資料,看個究竟   查看詳細資料，用這個可以看到每一個重載函數以及
                        See Also列表

    設置瀏覽器          設置用于瀏覽的程序，在資源管理器的右鍵菜單
                        中，對于每一種文件類型都有一批程序可用于打開，
                        此處可以選擇一個程序。

    設置編輯器          同上。

===============================================================
    FAQ
===============================================================

1.  Q 這是你的業余時間寫的嗎？
    A 不是，這是為了我們公司的開發工作能夠更方便而寫的小工具。
      現在我們公司的同事都在用這個工具生成 class  的文檔。

2.  Q HTML Workshop 是什么？
    A 他是可以把 HTML 文件編譯成 CHM 的工具，是 MS 開發的。

3.  Q 路徑如果由瀏覽選擇就好了
    A 推薦您從瀏覽器中拖拽到本程序中，這樣比瀏覽更方便。
      推拽的時候請使得目的地的 EDIT 激活變成綠色。不過呢我
      在下個版本中會提供瀏覽的，謝謝您的建議。

4.  Q 生成 html 文件后里面留好了函數的參數說明，不知道你打算怎么讓用戶填進去？
    A 請使用 HTML 編輯工具，比如 Dreamwaver 或者 FrontPage。

5.  Q 生成的時候，讓用戶可以在程序界面中給函數的參數填寫說明
    A 在界面中填寫參數說明等，不如在 HTML 編輯工具中填寫來得方便，
      而且功能更為強大。

6.  Q 這個工具修改我的源代碼嗎？
    A 絕對不可能，本工具只生成 HTML 文檔，不會修改你的原代碼。