2011-06-25 18 views
1

我想爲我使用Kohana框架構建的應用程序創建一個用戶指南,我想知道是否有一種方法可以將Kohana用戶指南模塊用於此目的。我可以使用/修改Kohana userguide模塊爲我的應用程序創建幫助頁面嗎?

我知道如何爲我創建的新模塊添加用戶指南信息,以及如何將我的類包含在API中,但我想爲實際應用程序用戶構建第二個單獨的用戶指南,而不是應用程序開發人員。

起初,我想我只是想嘗試在APPPATH/guide的主用戶指南中添加應用程序幫助頁面。我嘗試添加一個「應用程序/指南」目錄,並在其中放置一個名爲menu.md的文件,但最終取代了用戶指南中的Kohana菜單。將文件重命名爲menu.myapp.md後,它完全不顯示。

因此,然後它發生在我身上,我可以簡單地編輯modules/userguide/guide/menu.md爲我的應用程序添加部分,並同樣爲每個應用程序組件添加降價文件。但是真的,爲應用程序用戶提供完全獨立的用戶指南會更好,因爲Kohana文檔與他們無關。

這是什麼最好的方法呢?我應該創建整個用戶指南模塊的副本並修改路由,& c。?或者有什麼方法可以使用一個版本的模塊來設置兩個用戶指南?或者我完全吠叫錯誤的樹?有沒有其他模塊/方法可以更好地爲應用程序構建「幫助」頁面?

在此先感謝您的幫助!

回答

0

是的,你可以用你的指南爲你的應用程序提供文檔。如果你想要的例子,請查看以下鏈接:

注意,你仍然會得到「API文檔」和其他一切,除非你改變了配置隱藏起來。

+0

我明白爲用戶指南添加模塊的模型,但希望有一個替代方案。您的答案表明唯一的解決方案是創建一個新的「幫助」模塊。有沒有辦法建立一個完全獨立的用戶指南,最好位於應用程序文件夾? – codebird

+0

應用程序中的文件和模塊下的文件沒有區別。它們都在運行時在文件系統中組合在一起。就像我所說的,你必須改變配置來關閉所有kohana幫助文件的鏈接。 – zombor

+0

是的,但重點是:如果我想要兩者呢?就像我上面所說的,我不想擺脫kohana用戶指南文件和api瀏覽器,因爲這些對於應用程序開發人員很有幫助。 – codebird

相關問題