## page was copied from ROS/Tutorials/NavigatingTheWiki ## For instruction on writing tutorials ## http://www.ros.org/wiki/WritingTutorials #################################### ##FILL ME IN #################################### ## for a custom note with links: ## note = This tutorials assumes you have read the [[ROS/Introduction|Introduction to ROS]] ## for the canned note of "This tutorial assumes that you have completed the previous tutorials:" just add the links ## note.0= ## descriptive title for the tutorial ## title = Navigating the ROS wiki ## multi-line description to be displayed in search ## description = This tutorial discusses the layout of the ROS wiki ([[Documentation|ros.org]]) and talks about how to find what you want to know. ## the next tutorial description (optional) ## next = ## links to next tutorial (optional) ## next.0.link=[[ROS/Tutorials/WhereNext|Where Next?]] ## next.1.link= ## what level user is this tutorial for ## level= BeginnerCategory ## keywords = wiki #################################### <<IncludeCSTemplate(TutorialCSHeaderTemplate)>> <<TOC(4)>> ##pagestart 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. <<BR>> {{attachment:descriptive_ros_header.png||width=100%}} 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|tf (www.ros.org/wiki/tf)]]. The package header for each package is auto generated from the stack and package manifest. <<BR>> <<BR>> {{attachment:tf_package_detail.png||width=100%}} === ROS Stack Pages === Let's look at ''ros'' stack wiki page for [[ROS|ROS (www.ros.org/wiki/ROS)]]. The stack header for each stack is auto generated from the stack manifest. <<BR>> <<BR>> {{attachment:stack_header_detail.png||width=100%}} 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 created your package page, open a URL plus `/tutorials` at the tail of the URL of your package. Eg. suppose your package is located at `http://wiki.ros.org/foo_pkg`, you should open `http://wiki.ros.org/foo_pkg/tutorials`. This way wiki creates a new page. 2. You're said `This page does not exist yet. What type of page are you trying to create?`. Yeah wiki is right, because there's no (hopefully) such page. ROS wiki now shows a list of template so choose `TutorialIndexTemplate`. 3. Now you're navigated to 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 macro that does 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/Tutorials|ROS' basic tutorial top page]] does. To do so you use `TutorialChain` macro. See the example in [[http://wiki.ros.org/ROS/Tutorials?action=diff&rev2=153&rev1=152|ROS basic tutorials]]. ##pageend ## AUTOGENERATED DO NOT DELETE ## TutorialCategory ## ROSTutorialCategory