diff --git a/doc/sources/gettingstarted/examples.rst b/doc/sources/gettingstarted/examples.rst index f2d44d9ce..f378a056c 100644 --- a/doc/sources/gettingstarted/examples.rst +++ b/doc/sources/gettingstarted/examples.rst @@ -7,7 +7,7 @@ Examples .. |ani_dir| replace:: ./examples/animation .. |ani_file| replace:: animate.py -.. |ani_desc| replace:: Widget animation using :class:`Animation ` . +.. |ani_desc| replace:: Widget animation using :class:`Animation ` .. |app_dir| replace:: ./examples/application @@ -48,12 +48,12 @@ Examples .. |sho_dir| replace:: ../examples/demo/showcase .. |sho_file| replace:: main.py -.. |sho_desc| replace:: Showcase of **widgets and layouts** used in kivy. +.. |sho_desc| replace:: Showcase of **widgets and layouts** used in kivy .. |tch_dir| replace:: ./examples/demo/touchtracer .. |tch_file| replace:: main.py -.. |tch_desc| replace:: Draw lines under every detected touch. -.. |tch_desc2| replace:: A good place to understand **how touch events work in kivy**. +.. |tch_desc| replace:: Draw lines under every detected touch +.. |tch_desc2| replace:: A good place to understand **how touch events work in kivy** .. |tws_dir| replace:: ./examples/frameworks/twisted .. |tws_file| replace:: echo_client_app.py @@ -62,11 +62,11 @@ Examples .. |gst_dir| replace:: ./examples/gestures .. |gst_file| replace:: gesture_board.py -.. |gst_desc| replace:: A clean board to try out **gestures**. +.. |gst_desc| replace:: A clean board to try out **gestures** .. |kv_dir| replace:: ./examples/guide/designwithkv .. |kv_file| replace:: main.py -.. |kv_desc| replace:: Programming Guide examples on how to :doc:`design with kv lang ` +.. |kv_desc| replace:: Programming Guide examples about how to :doc:`design with kv lang ` .. |fwd_dir| replace:: ./examples/tutorials/firstwidget .. |fwd_file| replace:: 1_skeleton.py @@ -75,81 +75,81 @@ Examples .. |fwd_file4| replace:: 4_draw_line.py .. |fwd_file5| replace:: 5_random_colors.py .. |fwd_file6| replace:: 6_button.py -.. |fwd_desc| replace:: Programming Guide examples :doc:`Your first widget ` +.. |fwd_desc| replace:: Programming Guide example: :doc:`Your first widget ` .. |qst_dir| replace:: ./examples/guide/quickstart .. |qst_file| replace:: main.py -.. |qst_desc| replace:: Programming Guide example. +.. |qst_desc| replace:: Programming Guide example .. |kin_dir| replace:: ./examples/kinect .. |kin_file| replace:: main.py -.. |kin_desc| replace:: Howto use **kinect** for input. +.. |kin_desc| replace:: How to use **kinect** for input .. |kvd_dir| replace:: ./examples/kv .. |kvd_file| replace:: kvrun.py -.. |kvd_desc| replace:: Load kv files, use **kv lang to load different widgets**. +.. |kvd_desc| replace:: Load kv files, use **kv lang to load different widgets** .. |rst_dir| replace:: ./examples/RST_Editor .. |rst_file| replace:: main.py -.. |rst_desc| replace:: An RST editor for the :class:`RstDocument ` Widget. +.. |rst_desc| replace:: An RST editor for the :class:`RstDocument ` Widget .. |sdr_dir| replace:: ./examples/shader .. |sdr_file| replace:: plasma.py .. |sdr_file1| replace:: shadertree.py -.. |sdr_desc| replace:: How to use different **Shaders**. +.. |sdr_desc| replace:: How to use different **Shaders** .. |png_dir| replace:: ./examples/tutorials/pong .. |png_file| replace:: main.py -.. |png_desc| replace:: :doc:`/tutorials/pong`. Your first step in kivy programming. +.. |png_desc| replace:: :doc:`/tutorials/pong`. Your first step in kivy programming .. |wdg_dir| replace:: ./examples/widgets .. |wdg_file1| replace:: accordion_1.py -.. |wdg_desc1| replace:: Usage and Showcase of :class:`Accordion ` Widget. +.. |wdg_desc1| replace:: Usage and showcase of :class:`Accordion ` Widget .. |wdg_file2| replace:: asyncimage.py -.. |wdg_desc2| replace:: Usage and Showcase of :class:`AsyncImage ` Widget. +.. |wdg_desc2| replace:: Usage and showcase of :class:`AsyncImage ` Widget .. |wdg_file25| replace:: boxlayout_pos_hint.py -.. |wdg_desc25| replace:: Showcase of pos_hint under BoxLayout :class:`BoxLayout ` +.. |wdg_desc25| replace:: Showcase of pos_hint under :class:`BoxLayout ` .. |wdg_file3| replace:: bubble_test.py -.. |wdg_desc3| replace:: Usage and Showcase of :class:`Bubble ` Widget. +.. |wdg_desc3| replace:: Usage and Showcase of :class:`Bubble ` Widget .. |wdg_file4| replace:: customcollide.py .. |wdg_desc4| replace:: Test for **collision** with custom shaped widget .. |wdg_file5| replace:: fbowidget.py -.. |wdg_desc5| replace:: Usage of :class:`FBO ` to speed up graphics. +.. |wdg_desc5| replace:: Usage of :class:`FBO ` to speed up graphics .. |wdg_file6| replace:: image_mipmap.py -.. |wdg_desc6| replace:: How to use :class:`Image ` widget with mipmap. +.. |wdg_desc6| replace:: How to use :class:`Image ` widget with mipmap .. |wdg_file7| replace:: keyboardlistener.py -.. |wdg_desc7| replace:: Listen to the keyboard input and spew result to console. +.. |wdg_desc7| replace:: Listen to the keyboard input and spew result to console .. |wdg_file8| replace:: label_mipmap.py .. |wdg_desc8| replace:: How to use :class:`Label ` widget with .. |wdg_file81| replace:: label_with_markup.py -.. |wdg_desc81| replace:: Useage of :class:`Label ` widget with markup. +.. |wdg_desc81| replace:: Usage of :class:`Label ` widget with markup .. |wdg_file82| replace:: popup_with_kv.py -.. |wdg_desc82| replace:: Useage of :class:`Popup ` widget with ``kv`` language +.. |wdg_desc82| replace:: Usage of :class:`Popup ` widget with ``kv`` language .. |wdg_file9| replace:: rstexample.py -.. |wdg_desc9| replace:: Usage and Showcase of :class:`RstDocument ` Widget. +.. |wdg_desc9| replace:: Usage and showcase of :class:`RstDocument ` Widget .. |wdg_file10| replace:: scatter.py -.. |wdg_desc10| replace:: Usage and Showcase of :class:`Scatter ` Widget. +.. |wdg_desc10| replace:: Usage and showcase of :class:`Scatter ` Widget .. |wdg_file11| replace:: screenmanager.py -.. |wdg_desc11| replace:: Usage and showase of :mod:`ScreenManager ` Module. +.. |wdg_desc11| replace:: Usage and showcase of :mod:`ScreenManager ` Module .. |wdg_file12| replace:: scrollview.py -.. |wdg_desc12| replace:: Usage and Showcase of :class:`ScrollView ` Widget. +.. |wdg_desc12| replace:: Usage and showcase of :class:`ScrollView ` Widget .. |wdg_file14| replace:: spinner.py -.. |wdg_desc14| replace:: Usage and Showcase of :class:`Spinner ` Widget. +.. |wdg_desc14| replace:: Usage and showcase of :class:`Spinner ` Widget .. |wdg_file15| replace:: tabbedpanel.py .. |wdg_desc15| replace:: Usage of a simple :class:`TabbedPanel ` .. |wdg_file16| replace:: tabbed_panel_showcase.py -.. |wdg_desc16| replace:: Advanced Showcase of :class:`TabbedPanel ` +.. |wdg_desc16| replace:: Advanced showcase of :class:`TabbedPanel ` .. |wdg_file17| replace:: textalign.py -.. |wdg_desc17| replace:: Usage of text alignment in :class:`Label ` widget. +.. |wdg_desc17| replace:: Usage of text alignment in :class:`Label ` widget .. |wdg_file18| replace:: textinput.py -.. |wdg_desc18| replace:: Usage and Showcase of :class:`TextInput ` Widget. +.. |wdg_desc18| replace:: Usage and Showcase of :class:`TextInput ` Widget .. |wdg_file19| replace:: unicode_textinput.py -.. |wdg_desc19| replace:: Showcase of unicode text in :class:`TextInput ` Widget. +.. |wdg_desc19| replace:: Showcase of unicode text in :class:`TextInput ` Widget .. |wdg_file20| replace:: videoplayer.py -.. |wdg_desc20| replace:: Usage and options of :class:`VideoPlayer ` Widget. +.. |wdg_desc20| replace:: Usage and options of :class:`VideoPlayer ` Widget .. |seq_dir| replace:: ./examples/widgets/sequenced_images: .. |seq_file| replace:: main.py -.. |seq_desc| replace:: Showcase usage of **sequenced images**: gif, images in .zip. +.. |seq_desc| replace:: Showcase usage of **sequenced images**: gif, images in .zip +------------+---------------+------------------------+ | Directory | Filename/s | Example Description |