[Documentation] [TitleIndex] [WordIndex

Note: This tutorials assumes you have read the Introduction to ROS.
(!) Please ask about problems and questions regarding this tutorial on answers.ros.org. Don't forget to include in your question the link to this page, the versions of your OS & ROS, and also add appropriate tags.

Navigating the ROS wiki

Description: This tutorial discusses the layout of the ROS wiki (ros.org) and talks about how to find what you want to know.

Keywords: wiki

Tutorial Level: BEGINNER

Next Tutorial: Where Next?

This tutorial will look at the different headers, links, and sidebars through out the wiki to help you understand how ROS.org is laid out.

Basics

ROS.org Landing Page

The landing page is where you are directed to when you type www.ros.org into you browser. Let's look at the ROS wiki header that is displayed at the top of every wiki page.


descriptive_ros_header.png

As you can see each package contains tutorials and troubleshooting specific to the package.

ROS Package Pages

Let's look at ros-pkg package wiki page for tf (wiki/tf). The package header for each package is auto generated from the stack and package manifest.

tf_package_detail.png

ROS Stack Pages

Let's look at ros stack wiki page for ROS (wiki/ROS). The stack header for each stack is auto generated from the stack manifest.

stack_header_detail.png

As you can see each stack contains tutorials and troubleshooting specific to the stack.

Advanced

Beginners can skip this section.

To create tutorial pages under your package

  1. Once you have created your package page, open the URL with /tutorials at the tail of the URL of your package. For example, suppose your package is located at http://wiki.ros.org/foo_pkg. You should open http://wiki.ros.org/foo_pkg/tutorials. This way the wiki will create a new page.

  2. The page will say This page does not exist yet. What type of page are you trying to create?. The wiki is correct, because there's no (hopefully) such page. ROS wiki now shows a list of templates, choose TutorialIndexTemplate.

  3. Now you are redirected to the wiki page editor. Add whatever change you think you need, and save it at the end. Using Preview often to check how it looks is a great idea. Notice that, however, there are some ROS wiki macros that do not get activated until you save the page (in that case you just have to pray that your edition works, but it's okay to try and error!).

Sort the tutorial

By default, TutorialIndexTemplate uses a macro FullSearchWithDescriptionsCS, which searches all available tutorials under the URL hierarchy you chose (http://wiki.ros.org/foo_pkg/tutorials in this case). There the order of tutorials are based on the "links" between tutorials (next.0 attribute in each page's tutorial header).

Often, you want to sort the tutorial in your own way, like ROS' basic tutorial top page does. To do so you use TutorialChain macro. See the example in ROS basic tutorials.


2017-09-16 12:30