[openrtm-users 01512] Re: Experimental documentation tool

[Yosuke Matsusaka]

ジェフさん

松坂です。

pull requestを送っておきました。

昨晩ひらめいて

"doc_introduction",   "全般的な説明",
"doc_requirements",   "ライブラリなどの依存環境や動作環境の説明",
"doc_install",   "インストール方法の説明",
"doc_usage",   "コンポーネントの起動方法や使い方",
"doc_misc",   "その他の情報",
"doc_changelog",   "更新履歴",

などもコンポーネントに埋め込めるようにしようかと実装を書いておいたのですが
まだうまく動いていません。

こんな感じで埋め込んでいるのですが、RTCのextended propertiesには出てこず、、、。

https://github.com/yosuke/OpenHRIWeb/blob/master/openhriweb/JabberRTC.py

何か理由は分かりますでしょうか？ > RTM開発者の皆様
＃そもそもこんな埋め込み方はできないのかな？

2010/12/7 Geoffrey Biggs <geoffrey.biggs ＠ aist.go.jp>:
> 松坂様
>
> ジェフです。
>
> いつも素晴らしいツールを作っていただいて、ありがとうございます。
>
> rtshellは今テストとドキュメンテーションの作成中で、できたら3.0をリリース
> します。rtdocを3.0に入れたいなら、pull requestをお願い致します。
>
> よろしくお願いいたします。
>
>
> On 07/12/10 12:45, Yosuke Matsusaka wrote:
>> 産総研の松坂です。
>>
>> RTCに埋め込まれた情報から各種フォーマットでドキュメントを出力するユーティリティを作りました。
>> https://github.com/yosuke/rtshell/blob/master/rtshell/rtdoc.py
>>
>> 使用例（latex形式でドキュメントを出力）：
>> rtdoc -f latex /localhost/hostname.host_cxt/Compname0.rtc
>>
>> 後半部分はrtshellのパス名です。
>> ＃ある程度完成したらジェフさんのrtshellに取り込んでもらおうと思っています。
>>
>> latex以外にもhtmlやreStructuredText形式で出力ができます。
>>
>> RTC.xmlが付属していないコンポーネントでもそれなりのドキュメントが生成できるので、ドキュメント
>> 作成の労力を減らしたい場合に有効です。
>>
>> コンフィギュレーションパラメータの説明欄はそのまま生成すると空欄ですが、例えば以下のようにして
>> プログラム内に埋め込むことができます。
>>
>> "conf.default.id",   "[your id]@example.com",
>> "conf.__description__.id",   "アカウントのIDを入力してください",
>>
>> ポートの説明欄は同様に以下のようにして埋め込んでください（Pythonの例です）。
>>
>> self._indata = RTC.TimedString(RTC.Time(0,0), "")
>> self._inport = OpenRTM_aist.InPort("text", self._indata)
>> self._inport.appendProperty("description", "音声合成するテキストデータです")
>>
>> まだ出力がいまいち美しくありませんがコツコツ改良していきたいと思います。
>> こんな機能が欲しい、などのご意見ありましたら教えてください。
>>
>
>



-- 
Yosuke Matsusaka, Ph.D  <yosuke.matsusaka ＠ aist.go.jp>
  Interaction Modeling Group /
  National Institute of Advanced Industrial Science and Technology (AIST)
  Tel: 029-862-6726  Web: http://staff.aist.go.jp/yosuke.matsusaka/