[openrtm-users 02722] プロジェクトページ(その他)の書き方

1 つの投稿 / 0 new
Ando Noriaki
オフライン
Last seen: 1年 9ヶ月 前
登録日: 2011-09-04 17:20
[openrtm-users 02722] プロジェクトページ(その他)の書き方

皆様

産総研 安藤です

現在、RTミドルウエアコンテストのため応募者の方はプロジェクトページを
作成いただいていると思います。プロジェクトページを含め、openrtm.orgでの
ページ作成についてのTipsをご紹介します。

1.表記方法はpukiwiki形式がお勧めです
ページ入力時に「入力書式」が選択できますが、pukiwiki形式が便利です。
pukiwiki の文法については、pukiwiki のページをご覧ください。

一部 openrtm.org で利用しているCMS (Drupal) 用に独自拡張した部分が
ありますので、詳細な機能についてはopenrtm.org の pukiwiki マニュアルをご覧ください。

http://www.openrtm.org/openrtm/ja/content/pukiwiki%E3%83%9E%E3%83%8B%E3%83%A5%E3%82%A2%E3%83%AB

2. 多言語化について
openrtm.org 上のページは簡単に多言語化できます。他の言語のページを
作成する場合、ページの「編集」タブの右のほうに「翻訳」タブがありますので、
これを押して他の言語のページを追加してください。

こうしてできた、例えば日本語のページと英語のページは関連付けられます。
日本語のページを表示している状態で、ページ上方にある英国国旗のアイコンを
クリックすると、対応する英語ページに切り替わります。

3.ティーザーによる分離(いわゆる「続きを読む」に対応させる)
プロジェクトページなどでは、一覧表示される際にページの上部だけ表示させて
#上部の「概要」の部分をティーザーと呼びます。
「続きを読む」をクリックすることで、全体を表示するように設定することが可能です。
一覧表示の際に、無用に長いプロジェクトページがあると、スクロール量が多く
なって見づらくなりますので、適当な長さで区切ることをお勧めします。

切りたい部分にカーソルを置いて「カーソル位置でティーザーを分離」ボタンを
押すと、区切ることができます。

4.その他
今回コンテストのためにプロジェクトに登録されているページでいくつか気になった点を挙げます。

・行頭に不要なスペースが入っているため、本文がそのまま「整形済みテキスト」
http://www.openrtm.org/openrtm/ja/content/%E3%83%96%E3%83%AD%E3%83%83%E3%82%AF%E3%83%BB%E6%AE%B5%E8%90%BD%E6%93%8D%E4%BD%9C#toc9
になっているページがいくつかあります。

・外部からアクセス不可能(またはパスワードが必要)な領域にリンクや画像が
 あるためリンクに飛べない、画像が表示されない、などのページがある。
 画像はページに添付して、参照することができます。

・リンクを張る際に二重大かっこ[[]]ではなく、単一の大かっこ [] を
 使用しているため正しくリンクが張れていない。

・「概要」や「特長」などでセクション表示 「*」 を使っていない
 なお、セクションは2階層目「**」から使用するときれいに見えます。
 #1階層目 「*」 はページのタイトルに使われているため。

以下に、見本としてプロジェクトページのpukiwikiソースの一例を示します。

** 概要

ATDE3 for OpenRTM-aist はアットマークテクノ社が販売する小型組み込みCPUボード
Armadillo-400シリーズ上で動作するRTミドルウエアおよびコンポーネントを開発するための開発環境です。

ATDE3 for OpenRTM-aist
にはコンパイル済みのOpenRTM-aist-1.1.0および、ArmadilloでRTCを動作させる環境を作るための各種ツールが同梱されています。

Armadillo-400シリーズでは、SDメモリカードが利用可能です。これを利用して、ユーザランドを書き換えることなくArmadillo上でSDメモリに格納されたRTCを実行することができます。

** ドキュメント

- ATDE for OpenRTM ドキュメント

未定義

ダウンロード

最新バージョン : 2.0.1-RELESE

統計

Webサイト統計
ユーザ数:2209
プロジェクト統計
RTコンポーネント307
RTミドルウエア35
ツール22
文書・仕様書2

Choreonoid

モーションエディタ/シミュレータ

OpenHRP3

動力学シミュレータ

OpenRTP

統合開発プラットフォーム

産総研RTC集

産総研が提供するRTC集

TORK

東京オープンソースロボティクス協会

DAQ-Middleware

ネットワーク分散環境でデータ収集用ソフトウェアを容易に構築するためのソフトウェア・フレームワーク