Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate Ruler documentation from Wiki #43

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions helplink.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"org.sugarlabs.PortfolioActivity": "portfolio.html",
"org.laptop.sugar.ReadActivity": "read.html",
"org.laptop.RecordActivity": "record.html",
"org.laptop.RulerActivity": "ruler.html",
"org.worldwideworkshop.olpc.SliderPuzzle": "Slider.html",
"vu.lux.olpc.Speak": "speak.html",
"org.laptop.StarChart": "starchart.html",
Expand Down
Binary file added images/120px-Ruler-fig1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/120px-Ruler-fig2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/120px-Ruler-fig3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/120px-Ruler-fig4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/300px-Ruler.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/Ruler-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/Ruler-toolbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Activities
portfolio.rst
read.rst
record.rst
ruler.rst
Slider.rst
speak.rst
starchart.rst
Expand Down
60 changes: 60 additions & 0 deletions source/ruler.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
Ruler
=============================

.. figure:: ../images/300px-Ruler.jpg
:alt: 300px-Ruler.jpg

Where to get Ruler
------------------

`Activity <http://activities.sugarlabs.org/en-US/sugar/addon/4192/%5D>`__
\| `Source <https://github.com/sugarlabs/ruler/>`__

About Ruler
-----------

.. figure:: ../images/Ruler-icon.png
:alt: Ruler-icon.png

Ruler is a simple collection of measurement tools that are displayed on
the screen.

+--------------------+--------------------+--------------------+--------------------+
| |120px-Ruler-fig1| | |120px-Ruler-fig2| | |120px-Ruler-fig3| | |120px-Ruler-fig4| |
+--------------------+--------------------+--------------------+--------------------+
| CM and MM scales | CM and MM grid | Angles | Checkerboard |
+--------------------+--------------------+--------------------+--------------------+

Since the OLPC XO computer has a 200 DPI display, the rulers are quite
accurate. One other hardware, where the display resolution is not known,
their is a spinner to let the user set the DPI. Ruler saves this value
to the Journal, so it need not be set on subsequent uses of the
Activity.

Toolbar
~~~~~~~

.. figure:: ../images/Ruler-toolbar.png
:alt: Ruler-toolbar.png

From left to right:

- Activity menu button
- CM and MM ruler
- CM and MM grid
- Angles (protractor)
- Checkerboard
- Dots per inch (DPI) spinner – used to set the display DPI – only
appears when DPI is not known, e.g., non-OLPC-XO hardware
- Stop button (not shown)

Reporting Bugs
~~~~~~~~~~~~~~~~~~

- `Submit an issue here <https://github.com/sugarlabs/ruler/issues/new>`__
- `View all open issues <https://github.com/sugarlabs/ruler/issues/>`__

.. |120px-Ruler-fig1| image:: ../images/120px-Ruler-fig1.png
.. |120px-Ruler-fig2| image:: ../images/120px-Ruler-fig2.png
.. |120px-Ruler-fig3| image:: ../images/120px-Ruler-fig3.png
.. |120px-Ruler-fig4| image:: ../images/120px-Ruler-fig4.png