OpenCASCADE6.8.0 Reference Manual Serach Problem
eryar@163.com
1. Problem
有網(wǎng)友反映OpenCASCADE6.8.0的Reference Manual的搜索功能不好用，以前沒注意，自己試了下，的確在本機上不能正確搜索出給出的關鍵字相關的內(nèi)容。如下圖所示，在搜索框中輸入gp_Pnt：
Figure 1. Search class gp_Pnt
結(jié)果沒有出來想要的內(nèi)容，如下圖所示：
Figure 2. Search Result in the Reference Manual
從上圖可以看出，搜索使用了search.php來執(zhí)行搜索功能，所以得出結(jié)論這個搜索功能需要放在支持php的服務器上才能正確執(zhí)行搜索功能。即在OpenCASCADE的官網(wǎng)上是正確的，如下所示：
http://dev.opencascade.org/doc/refman/html/search.php?query=gp_Pnt
2. Solution
OpenCASCADE是使用Doxygen來根據(jù)源程序自動生成這個參考文檔的，所以從源頭上來分析，找出原因。若想生成些文檔，需要如下圖所示的第三方程序：
Figure 3. Documentation System Prerequistes
下載好這些第三方程序后，只需要運行g(shù)endoc.bat批處理，即可自動生成這個Reference Manual了。如下圖所示：
Figure 4. Use gendoc.bat file to generate document automatically
其實主要還是依賴了Tcl腳本的強大功能來查找及設置那些第三方程序，從而使文檔生成自動化。從中可以看出，Tcl/Tk腳本在OpenCASCADE中的又一應用，除了Draw Test Harness以外。所以，熟悉Tcl/Tk腳本不僅有利于對OpenCASCADE程序的Draw模塊的理解，及其自動化測試的實現(xiàn)；還有利于平時為程序開發(fā)提供一些自動化的腳本，來減輕程序開發(fā)過程中的一些機械勞動。運行g(shù)endoc.bat可以看到有如下選項：
Figure 5. The options of gendoc.bat
從上面的選項可以看出，生成文檔時可以指定生成的格式，如html, pdf, chm；還可以指定生成OCCT的哪些模塊需要生成Reference Manual；其中導致搜索有問題的是指定搜索模式，其中有4種模式可供選擇：none/local/server/external，從中可以看出OpenCASCADE的安裝包中提供的是Server模式，所以在本機上不好用了。如果要在本機使用搜索功能，可以自己來生成這些文檔，但是要指定搜索模式為local。
3. Conclusion
OpenCASCADE使用Doxygen及一些第三方程序來自動生成文檔，簡化程序開發(fā)過程中的文檔工作。尤其是Tcl/Tk腳本的使用，讓重復機械的勞動由電腦來自動完成，提高工作效率及編程的樂趣。
如果想使用搜索功能，可以自己運行g(shù)endoc.bat并指定搜索模式為local即可解決問題。
4. References
1. OpenCASCADE Documentation System.