<commit_before>.. sikuli documentation master file, created by
   sphinx-quickstart on Thu Dec 23 11:32:37 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

The Complete Guide to Sikuli X
==============================

This document was set up and is being maintained by `RaiMan
<https://launchpad.net/~raimund-hocke>`_ (<NAME>ocke) with the great support
by *Tsung-Hsiang (<NAME>* (one of the Sikuli developers).  If you have any
questions or ideas about this document, you are welcome to directly contact
*RaiMan* using the mail address on his `personal Sikuli Launchpad page
<https://launchpad.net/~raimund-hocke>`_.  For questions regarding the
functions and features of Sikuli itself please use the `Sikuli Questions and
Answers Board <https://answers.launchpad.net/sikuli>`_.  For hints and links of
how to get more information and help, please see [#otherplaces Other places to
get Information] in this document.

How to use this document
------------------------

Since Sikuli Script is built as a Jython (Python for the Java platform)
library, you can use any syntax of the Python language.  If you are new to
programming, you can still enjoy using Sikuli to automate simple repetitive
tasks without learning Python. But if you would like to write more powerful and
complicated scripts, you may want to dive into the `Python Language
<http://jythonpodcast.hostjava.net/jythonbook/en/1.0/ Python language>`_.

The preface of a chapter briefly describes a class or a group of methods. It
contains general usage and hints that apply to all methods in that chapter. We
recommend you to read it before using those methods.

**If you are totally new with Sikuli**, it would be a good idea to just read
through this document sequentially. An alternative may be to jump to the
chapters that you are interested in by scanning the table of contents. In any
case, it’s’‘strongly recommended’’ to carefully read through this entry chapter
**Basics**. A way in the middle would be, going to Class :py:class:`Region`,
then to Class :py:class:`Match` and ending at Class :py:class:`Screen`.

**For the users of previous versions (0.9.x and 0.10.x)** :doc:`What's new in
Sikuli X <new-in-sikulix>` is a good start. After that, you can go to any
places of interest using the table of contents below or use the [#navigator
navigator] to browse all classes, methods and functions in alphabetical order
(as every class shows its methods this way at the beginning of its chapter).


Table of Contents
-----------------

.. toctree::
   :maxdepth: 3

   new-in-sikulix
   tutorials/index
   sikuli-script-index
   devs/index
   FAQ
   changes

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
<commit_msg>separate toc<commit_after>.. sikuli documentation master file, created by
   sphinx-quickstart on Thu Dec 23 11:32:37 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

The Complete Guide to Sikuli X
==============================

This document was set up and is being maintained by `RaiMan
<https://launchpad.net/~raimund-hocke>`_ (Raimund Hocke) with the great support
by *Tsung-Hsiang (<NAME>* (one of the Sikuli developers).  If you have any
questions or ideas about this document, you are welcome to directly contact
*RaiMan* using the mail address on his `personal Sikuli Launchpad page
<https://launchpad.net/~raimund-hocke>`_.  For questions regarding the
functions and features of Sikuli itself please use the `Sikuli Questions and
Answers Board <https://answers.launchpad.net/sikuli>`_.  For hints and links of
how to get more information and help, please see [#otherplaces Other places to
get Information] in this document.

How to use this document
------------------------

Since Sikuli Script is built as a Jython (Python for the Java platform)
library, you can use any syntax of the Python language.  If you are new to
programming, you can still enjoy using Sikuli to automate simple repetitive
tasks without learning Python. But if you would like to write more powerful and
complicated scripts, you may want to dive into the `Python Language
<http://jythonpodcast.hostjava.net/jythonbook/en/1.0/ Python language>`_.

The preface of a chapter briefly describes a class or a group of methods. It
contains general usage and hints that apply to all methods in that chapter. We
recommend you to read it before using those methods.

**If you are totally new with Sikuli**, it would be a good idea to just read
through this document sequentially. An alternative may be to jump to the
chapters that you are interested in by scanning the table of contents. In any
case, it’s’‘strongly recommended’’ to carefully read through this entry chapter
**Basics**. A way in the middle would be, going to Class :py:class:`Region`,
then to Class :py:class:`Match` and ending at Class :py:class:`Screen`.

**For the users of previous versions (0.9.x and 0.10.x)** :doc:`What's new in
Sikuli X <new-in-sikulix>` is a good start. After that, you can go to any
places of interest using the table of contents below or use the [#navigator
navigator] to browse all classes, methods and functions in alphabetical order
(as every class shows its methods this way at the beginning of its chapter).


Table of Contents
-----------------

.. toctree::
   :maxdepth: 3

   new-in-sikulix
   tutorials/index
   sikuli-script-index

.. toctree::
   :maxdepth: 2

   devs/index
   FAQ
   changes

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

{'fraction_non_alphanumeric': 0.09764726693790908, 'fraction_numerical': 0.007252786131257739, 'mean_word_length': 4.030249110320285, 'pattern_counts': {'":': 0, '<': 16, '<?xml version=': 0, '>': 16, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3474800', 'n_tokens_mistral': 1655, 'n_tokens_neox': 1541, 'n_words': 803}