Skip to content
Browse files

tweaked docs and updated website

  • Loading branch information...
1 parent 272fab6 commit 835271b7abff3fb1aa62abf34084a71eae736ba0 rtv committed Jun 7, 2009
Showing with 44 additions and 29 deletions.
  1. +6 −0 AUTHORS.txt
  2. +12 −9 README.txt
  3. +1 −1 docsrc/stage.dox
  4. +2 −2 docsrc/upload.sh
  5. +1 −1 libstage/model_fiducial.cc
  6. +22 −16 libstage/worldgui.cc
View
6 AUTHORS.txt
@@ -18,3 +18,9 @@ terms of the GNU General Public License version 2 or later:
Many patches and bug reports have been contributed by users around the
world. Stage is part of the Player Project (http://playerstage.org),
a community effort to develop free Software tools for robotics research.
+
+Project Lead / Maintainer
+------------------------
+
+- Stage v3. : Richard Vaughan (vaughan@sfu.ca)
+- Stage v2. : Toby Collett (tcollett+player@plan9.net.nz)
View
21 README.txt
@@ -72,7 +72,7 @@ If you use Stage in your work, we'd appreciate a citation. At the time
of writing, the most suitable reference is either:
Richard Vaughan. "Massively Multiple Robot Simulations in Stage", Swarm
-Intelligence (to appear 2008), Springer.
+Intelligence 2(2-4):189-208, 2008. Springer.
Or, if you are using Player/Stage:
@@ -85,14 +85,16 @@ http://www.isr.uc.pt/icar03/ .
[gzipped postscript](http://robotics.stanford.edu/~gerkey/research/final_papers/icar03-player.ps.gz),
[pdf](http://robotics.stanford.edu/~gerkey/research/final_papers/icar03-player.pdf)
-Please help us keep track of what's being used out there by correctly
-naming the Player/Stage components you use. Player used on its own is
-called "Player". Player and Stage used together are referred to as
-"the Player/Stage system" or just "Player/Stage". When libstage is
-used without Player, it's just called "Stage". When Player is used
-with its 3D ODE-based simulation backend, Gazebo, it's called
-Player/Gazebo. Gazebo without Player is just "Gazebo". All this
-software is part of the "Player Project".
+Please help us keep track of what's being used out there by correctly
+naming the Player/Stage components you use. Player used on its own is
+called "Player". Player and Stage used together are referred to as
+"the Player/Stage system" or just "Player/Stage". When Stage is used
+without Player, it's just called "Stage". When the Stage library is
+used to create your own custom simulator, it's called "libstage" or
+"the Stage library". When Player is used with its 3D ODE-based
+simulation backend, Gazebo, it's called Player/Gazebo. Gazebo without
+Player is just "Gazebo". All this software is part of the "Player
+Project".
Support
-------
@@ -101,6 +103,7 @@ Funding for Stage has been provided in part by:
- DARPA (USA)
- NASA (USA)
- NSERC (Canada)
+- DRDC Suffield (Canada)
- NSF (USA)
- Simon Fraser University (Canada)
View
2 docsrc/stage.dox
@@ -1100,7 +1100,7 @@ CLASS_GRAPH = YES
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
-COLLABORATION_GRAPH = YES
+COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies
View
4 docsrc/upload.sh
@@ -26,10 +26,10 @@ ln -s $NAME $DEST
tar chzf $DEST.tgz $DEST
# Copy tarball to website
-scp $DEST.tgz $SFUSER@shell.sourceforge.net:/home/groups/p/pl/playerstage/htdocs/doc/
+scp $DEST.tgz $SFUSER@web.sourceforge.net:/home/groups/p/pl/playerstage/htdocs/doc/
# Untar the file and re-jig the permissions
-ssh $_SFUSER@shell.sourceforge.net 'cd /home/groups/p/pl/playerstage/htdocs/doc/; tar xvzf '$DEST'.tgz --no-overwrite-dir; find '$DEST' -type d | xargs chmod 2775; find '$DEST' -type f | xargs chmod 664'
+ssh $_SFUSER@web.sourceforge.net 'cd /home/groups/p/pl/playerstage/htdocs/doc/; tar xvzf '$DEST'.tgz --no-overwrite-dir; find '$DEST' -type d | xargs chmod 2775; find '$DEST' -type f | xargs chmod 664'
# clean up
rm $DEST $DEST.tgz
View
2 libstage/model_fiducial.cc
@@ -25,7 +25,7 @@ const stg_radians_t DEFAULT_FIDUCIAL_FOV = M_PI;
const stg_watts_t DEFAULT_FIDUCIAL_WATTS = 10.0;
//TODO make instance attempt to register an option (as customvisualizations do)
-Option ModelFiducial::showFiducialData( "Fiducials", "show_fiducial", "", false, NULL );
+Option ModelFiducial::showFiducialData( "Fiducials", "show_fiducial", "", true, NULL );
/**
@ingroup model
View
38 libstage/worldgui.cc
@@ -87,29 +87,35 @@ File/Save menu item. <b>Warning: the saved poses overwrite the currentworld file
want to keep the old poses. Alternatively the File/Save As menu item
can be used to save to a new world file.
-<h3>Pausing and resuming the clock</h3>
-<p>The simulation can be paused or resumed by pressing the space key.
-
-<h3>Selecting models</h3>
-<p>Models can be selected by clicking on them with the left mouse button.
-It is possible to select multiple models by holding the shift key and
-clicking on multiple models. Selected models can be moved by dragging or
-rotated by right click dragging. Selections can be cleared by clicking on
-an empty location in the world. After clearing the selection, the last
-single model selected will be saved as the target for several view options
-described below which affect a particular model.
+<h3>Pausing and resuming the clock</h3> <p>The simulation can be
+paused or resumed by pressing the 'p' key. Run one simulation step at
+a time by pressing the '.' (period) key. Hold down the '.' key to step
+repeatedly. Stepping leaves the simulation paused, so press 'p' to
+resume running. The initial paused/unpaused state can be set in the
+worldfile using the "paused" property.
+
+<h3>Selecting models</h3> <p>Models can be selected by clicking on
+them with the left mouse button. It is possible to select multiple
+models by holding the shift key and clicking on multiple models.
+Selected models can be moved by dragging or rotated by holding the
+right mouse button and moving the mouse. Selections can be cleared by
+clicking on an empty location in the world. After clearing the
+selection, the last single model selected will be saved as the target
+for several view options described below which affect a particular
+model.
<h3>View options</h3>
<p>The View menu provides access to a number of features affecting how
the world is rendered. To the right of each option there is usually
a keyboard hotkey which can be pressed to quickly toggle the relevant
option.
-<p>Sensor data visualizations can be toggled by the "Data" option.
-The filter data option opens a dialog which provides the ability
-to turn on and off visualizations of particular sensors. The "Visualize All"
-option in the dialog toggles whether sensor visualizations are enabled
-for all models or only the currently selected ones.
+<p>Sensor data visualizations can be toggled by the "Data" option
+(shortcut 'd'). The filter data option (shortcut shift-'d') opens a
+dialog which enables turning on and off visualizations of particular
+sensors. The "Visualize All" option in the dialog toggles whether
+sensor visualizations are enabled for all models or only the currently
+selected ones.
<p>The "Follow" option keeps the view centered on the last selected model.

0 comments on commit 835271b

Please sign in to comment.
Something went wrong with that request. Please try again.