ja/WikiMacrosについて、ここに記述してください。

このページはros.orgであなたが使える便利なマクロを決められます. これらのマクロのソースコードはroswikiパッケージの中で見られます.

PackageHeader(パッケージヘッダー)

これは自動的にすべてのパッケージのページで見られるパッケージヘッダーを生成します.

これは http://www.ros.org/distro/doc/ に生成されるmanifest.yamlファイルに依存してます。

使い方:

<<PackageHeader(PACKAGE)>>

{{{#!wiki version fuerte
A fuerte specific note here.
}}}

{{{#!wiki version groovy
A groovy specific note here.
}}}

例: roscpp

デフォルトでは, このパッケージヘッダーマクロは現在サポートされているROSの各ディストリビューションのためタブを生成します. またそれは自動的に、各wikiのページに含まれるべきヴァージョンによる特別なテキストのサポートも含みます. また、もしあなたが、あるディストリビューションのみのためだけのヘッダーがほしければ、あなたはマクロに対して、以下のようにしてオプションとしてディストリビューションの引数を与えることもできます。

<<PackageHeader(PACKAGE DISTRO)>>

StackHeader(スタックヘッダー)

これは自動的にすべてのスタックのページで見られるスタックヘッダーを生成します.

これは http://www.ros.org/doc/ に生成されるstack.yamlファイルに依存してます。

使い方:

<<StackHeader(STACK)>>

{{{#!wiki version fuerte
A fuerte specific note here.
}}}

{{{#!wiki version groovy
A groovy specific note here.
}}}

例: geometry

デフォルトでは, このパッケージヘッダーマクロは現在サポートされているROSの各ディストリビューションのためタブを生成します. またそれは自動的に、各wikiのページに含まれるべきヴァージョンによる特別なテキストのサポートも含みます. また、もしあなたが、あるディストリビューションのみのためだけのヘッダーがほしければ、あなたはマクロに対して、以下のようにしてオプションとしてディストリビューションの引数を与えることもできます。

使い方

<<StackHeader(STACK DISTRO)>>

RepoHeader(レポヘッダー)

これは自動的に、レポジトリの中に含まれるスタックのリストを生成します。

これは、http://www.ros.org/doc/ に生成されるrepo.yamlに依存します。

パッケージのリストもまたオプションとして含むこともできます. 例: alufr-ros-pkg, gt-ros-pkg.

使い方:

<<RepoHeader(repo-name)>>
<<RepoHeader(repo-name packages)>>

例:

<<RepoHeader(wg-ros-pkg)>>

MsgLink(メッセージリンク)

これは自動的にROSコードAPIドキュメントの中のメッセージへのリンクを生成します。

使い方:

<<MsgLink(package/name)>>

例:

<<MsgLink(nav_msgs/OccupancyGrid)>>

nav_msgs/OccupancyGrid

SrvLink(サービスリンク)

これは自動的にROSコードAPIドキュメントの中のメッセージへのリンクを生成します。

使い方:

<<SrvLink(package/name)>>

例:

<<SrvLink(nav_msgs/GetMap)>>

nav_msgs/GetMap

TracLinkマクロはページを訪れた人が簡単にチケットを記録するできるようにするために、Tracへのリンクをします。例えば: 使い方:

<<TracLink(REPO PACKAGE)>>

例:

<<TracLink(ros-pkg geometry)>> 

Use trac to report bugs or request features. [View active tickets]

KforgeTracLinkマクロはページを訪れた人が簡単にチケットを記録するできるようにするために、Tracへのリンクをします。例えば:

使い方:

<<KforgeTracLink(REPO PACKAGE)>>

例:

<<KforgeTracLink(turtlebot turtlebot)>> 

Use trac to report bugs or request features. [View active tickets]

Ticket(チケット)

チケットマクロは特定のTracのチケットにリンクを張ります。例えば:

使い方:

<<Ticket(REPO NUM)>>

例:

<<Ticket(ros 2571)>> 

#2571

Stack Navi(スタックナビ)

このマクロはスタックの説明を表示してスタックのパッケージの中へナビゲーションのバーを作るためにstack.xmlを使っています。

使い方:

<<StackNavi(stack)>>

例:

<<StackNavi(foote_photo_management)>> 

以下は実際に打つと表示されるもの Newly proposed, mistyped, or obsolete stack. Could not find stack "foote_photo_management" in rosdoc

FullSearchWithDescriptionsCS

FullSearchWithDescriptionsCSはチュートリアルのインデックスの自動生成に使われ、異なるキーワードから探すこともできます。

<<FullSearchWithDescriptionsCS(title:WritingTutorials BeginnerCategory)>>

以下は、そのタイトルと、WriteingTutorialsとキーワードbeginnerCategoryを用いて、チュートリアルの説明を表示する。もし、そのカテゴリーがAdvancedCategoryであった場合は、以下には何も表示されなかったであろう。

  1. How to Write a Tutorial

    This tutorial covers useful template and macros for writing tutorials, along with example tutorials that are available for guidance on ros.org

  2. 如何编写教程

    (概述:)本教程介绍在编辑ros.org维基时可以用到的模板和宏定义,并附有示例以供参考。

  3. チュートリアルの書き方

    このチュートリアルはros.orgに関するガイダンスのために利用できるサンプルチュートリアルにそってチュートリアルを記述するための便利なテンプレートとマクロを押さえます。

  4. 튜토리얼 작성하기

    이 튜토리얼은 튜토리얼 작성을 위한 튜토리얼입니다.

IncludeCSTemplate

This macro takes the keys at the top of the page and turns them into clearsilver variables that can be operated on using the clearsilver templating commands. In the case of tutorials the keys are used in the TutorialCSHeaderTemplate.

<<IncludeCSTemplate(TutorialCSHeaderTemplate)>>

Youtube

このマクロは、ウィキにビデオのキーを用いることでyoutubeのビデオを埋め込むことができる。

使い方:

<<Youtube(key)>>

例:

<<Youtube(bNtm6_FBJp8)>>

動画の最後で表示される関連動画を非表示にするには、以下のようにしてください。:

<<Youtube(bNtm6_FBJp8&rel=0)>>

以下が使用例:

Version

このマクロは、矛盾なく特定のパッケージ、スタック、APIまたはそのほかに対するバージョンの番号を知らせることができる。もし、マクロが引数を与えられたなら、ハイライトされたタグが見えるであろう。もし、なにも引数を与えないのなら、wikiの中でバージョンのテキスト間を切り替えるための3つのバージョンボタンが現れるのがわかると思います.

Version使い方

Arguments:

<<Version(ROS Boxturtle)>>

my_api() New in ROS Boxturtle

No arguments:

<<Version()>>

Welcome to a demo of a cool API tool

{{{#!wiki version boxturtle

This is my boxturtle API.  It's old

}}}

{{{#!wiki version cturtle

This is my cturtle API.  It's new and awesome

It has wiki formatting and '''everything'''!!!
}}}

This text is relevant to everyone

{{{#!wiki version cturtle unstable

cturtle/unstable specific stuff.  
}}}

以下が実際に使った例

Welcome to a demo of a cool API tool

This is my boxturtle API. It's old

This is my cturtle API. It's new and awesome

It has wiki formatting and everything!!!

This text is relevant to everyone

cturtle/unstable specific stuff.

ページを丸々Versionで切り替える

Versionのマクロで単一テキスト以上のブロックを持つために、サブページにそのwikiページ全体をおき、Include()のマクロを使ってそれらを切り替えることができる。例えば、もしmy_package/Tutorials/Tut1というようなページを持っているとし、それとは違うチュートリアルを違うバーyジョンに対して持ちたいなら、以下のようなことをすればよい。:

<<Version()>>

{{{#!wiki version cturtle
<<Include(my_package/Tutorials/Tut1/cturtle)>>
}}}

{{{#!wiki version diamondback
<<Include(my_package/Tutorials/Tut1/diamondback)>>
}}}

{{{#!wiki version electric
<<Include(my_package/Tutorials/Tut1/electric)>>
}}}

Buildsystem

このマクロでcatkinとrosbuildのセクションを切り替える事ができます。

以下の様にセクションを立てられます。

<<Buildsystem(catkin)>>
{{{
catkin_make
}}}

<<Buildsystem(rosbuild)>>
{{{
rosmake
}}}

これらは実際には以下の様に表示されます。

catkin specific

catkin_make

rosbuild specific

rosmake

また、切り替えのできるセクションおよびまたはページ全体を持たせることも可能です。

<<Buildsystem()>>

{{{{#!wiki buildsystem catkin
{{{
catkin_make
}}}
}}}}

{{{{#!wiki buildsystem rosbuild
{{{
rosmake
}}}
}}}}

上記は以下の様に実際は表示されます。

catkin_make

rosmake

もし複数のセクションを持つのならボタンは同時にすべてのセクションを管理することがわかりますが、たとえ複数のセクションがあったとしても、1ページに一つの<<Buildsystem()>>の指令のみを持たせるのがよいと思われます。

TutorialChain

このマクロは番号付きチュートリアルのリストを表示します。もしA,B,Cのチュートリアルが存在して、Aの次がB,Bの次がCとなっているとすると、以下の様に読んでみてほしい。

<<TutorialChain(path/to/TutorialA)>>

上記はチュートリアルのリストを生成します。このマクロは、チュートリアルの開始のページの際に便利です。これは、wiki上でパフォーマンスの問題を引き起こしていた古いFullSearch... Tutorialマクロの代わりとして作られました。

ROS/Tutorials catkin/Tutorials

CodeRef

よくファイル全体とそれからのちょっとした断片でできた初めのチュートリアルのリストを見ると思います。この列をコピペの失敗を避けて正しく表示するには、コードは一度だけリストされ、後ほど参照されるべきです。そうするために、あなたのコードブロックを以下の様にしてください。

{{{
#!foo block=myblockname

some more text
on several lines
and even more
...

初めの{{{の後の改行が大切です。myblocknameにあなたのつけたい名前を実際にはつけてください。そうすれば、wikiの中で後ほど、あなたはそのコードの一部を使いまわす事が可能です。

使い方:

<<CodeRef(myblockname,3,5)>>

実際:

some more text
on several lines

codeblock(コードブロック)が機能するには少なくとも一度プレビューでセーブされる必要があります! wikiに認識される言語を用いたときのみ行番号が表示されます。

AnswersSearch

このマクロはanwsers.ros.orgにあるタグのリストの検索に使ってください。

<<AnswersSearch(text to display, drivers, hardware)>>

実際: text to display

Wiki: ja/WikiMacros (last edited 2013-11-15 23:38:40 by DirkThomas)