2011-06-25 3 views
1

私はKohanaフレームワークを使用して構築しているアプリケーション用のユーザーガイドを作成したいと思います。この目的のためにKohanaユーザーガイドモジュールを使用できる方法があるかどうかは疑問です。私のアプリケーションのヘルプページを作成するのにKohanaのuserguideモジュールを使用/適応できますか?

私が作成した新しいモジュールのユーザーガイド情報を追加する方法と、APIにクラスを含める方法を理解していますが、アプリ開発者ではなく、実際のアプリケーションユーザー用に別の2番目のユーザーガイドを作成したい。

最初は、APPPATH/guideのメインユーザーガイドにアプリヘルプページを追加しようとしました。私は "application/guide"ディレクトリを追加しようとしましたが、そこにmenu.mdと呼ばれるファイルを置いていましたが、それはちょうどuserguideのKohanaメニューを置き換えてしまいました。 menu.myapp.mdにファイルの名前を変更した後、それはまったく表示されません。

それで、モジュール/ userguide/guide/menu.mdを簡単に編集して、自分のアプリケーション用のセクションを追加し、同様に各アプリケーションコンポーネントのマークダウンファイルを追加することができます。しかし、実際には、Kohanaのドキュメントは関連性がないので、アプリユーザーのための完全に別個のユーザーガイドを持つ方がずっと良いでしょう。

これについてはどのような方法が最適ですか?ユーザーガイドモジュール全体の複製を作成し、ルーティングを変更する必要がありますか?& c。?または、モジュールの1つのバージョンを使用して両方のユーザーガイドを設定する方法はありますか?それとも、間違った木全体を吠えるか?アプリの "ヘルプ"ページを作成するのに適している他のモジュール/アプローチがありますか?

ご協力いただきありがとうございます。

答えて

0

はい、ユーザーガイドでアプリケーション用のドキュメントを作成できます。あなたが例をしたい場合は、これらのリンクをチェックアウト:あなたがそれらを非表示にする設定を変更しない限り、あなたはまだ、他の「APIドキュメント」とすべてを取得します

  • https://github.com/zombor/Auto-Modeler/tree/master/guide/auto-modeler
  • +0

    私は、モジュールをユーザーガイドに追加するためのモデルを理解していますが、代替策が望まれていました。あなたの答えは、唯一の解決策は、新しい "ヘルプ"モジュールを作成することです。できればアプリケーションフォルダにある完全に別のユーザーガイドを作成する方法はありませんか? – codebird

    +0

    application /のファイルとモジュールの下のファイルには違いはありません。これらはすべて実行時にファイルシステム内で結合されます。私が言ったように、すべてのkohanaヘルプファイルへのリンクを無効にするには、設定を変更する必要があります。 – zombor

    +0

    はい、しかし、ポイントは次のようなものです。上記のように、私はKohanaのユーザーガイドファイルとAPIブラウザを取り除きたいとは思わない。なぜなら、それらはアプリ開発者に役立つからだ。 – codebird

    関連する問題