Skip to content
Houman-HM edited this page Aug 29, 2019 · 33 revisions

Welcome to the IMS Robotics tutorials wiki page! Here you can find tutorials for the packages and setups that:

  • are not under IMS Robotics development,
  • have poor, unfit or scattered original documentation,
  • are still used again and again and again
If you want to contribute or modify anything, you are most welcome! BUT, in that case please read also the Conventions.

And most importantly:
  • Always contribute to the tutorial if you can and you see a need for it
  • If you have tested some tutorial on a different platform / operating system, please mark it down in the tutorial's info section
  • If you spot a scripting bug or anything unusual in that matter, write it down in the Remarks section
Cheers!

Table of Contents

Tutorials

Conventions

You are very welcome to add and modify tutorials and in fact, it should be even compulsory. Even if the thing you did was "nothing special," it can still save someone else’s time and frustration, because most likely there will be others who want to do just the same thing. And that "someone else" can easily be You in the near future. But in order to keep things clear, some conventions should be established and this wiki has the following ones:

  1. If the original documentation is well written, do not bother to write a tutorial about it
  2. Each tutorial should have its own sub-page
  3. If you want to modify an existing tutorial, it would be polite if you consult with the author of the tutorial first. You can see who has initiated and edited the page in pages revision history
  4. Try to use the MediaWiki or Markdown scripting language when editing
  5. When writing a tutorial, try to be specific. Write down the ROS distro and specific hardware (e.g. youbot, RealSense R200, etc.) if that applies.

Here is a non ideal example of a tutorial that follows the suggested conventions: EXAMPLE

Adding a new tutorial

Please read the Conventions of writing a tutorial if you haven't done it yet

If you want to add a new tutorial, then just:

  • add a link under the Tutorials section, starting by clicking "edit" in the top-right corner of this wiki page.
  • Type the name of the tutorial in following format
    [[name of the tutorial|name of the tutorial]]
    This creates a blank page that you can start editing
  • Save the page and click on the newly created (should be in red text) link and start editing.

Remarks

MediaWiki issues

MediaWiki scripting is full of bugs and restrictions, so if you copy something from a normal wiki page and paste it in this editor, you might not get the same result.

  • 06.03.2017: Blank "newlines" only appear by including <br> </br> tags
  • 06.03.2017: Having "space" before a line of text renders you a grey background like it supposed to do, but all formating within that line is gone