summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2014-04-23 21:34:05 +0200
committermathieui <mathieui@mathieui.net>2014-04-23 21:34:05 +0200
commit4fec08879e2dbc57a2b42c8ebf80e114ab37d78f (patch)
treecb98ab88d2ffbf77a973d96369d755e160b22585 /doc/source
parent3bfe93824c374b8c91aad177ff3e29b20c023030 (diff)
downloadpoezio-4fec08879e2dbc57a2b42c8ebf80e114ab37d78f.tar.gz
poezio-4fec08879e2dbc57a2b42c8ebf80e114ab37d78f.tar.bz2
poezio-4fec08879e2dbc57a2b42c8ebf80e114ab37d78f.tar.xz
poezio-4fec08879e2dbc57a2b42c8ebf80e114ab37d78f.zip
Documentation update
- add some formatting and links (also, typos) - link the Theme class from the theming page
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/configuration.rst2
-rw-r--r--doc/source/themes.rst42
-rw-r--r--doc/source/usage.rst11
3 files changed, 32 insertions, 23 deletions
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index 7c0af9c9..50b9fc71 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -1,3 +1,5 @@
+.. _config:
+
Configuration
=============
diff --git a/doc/source/themes.rst b/doc/source/themes.rst
index 2a12d8c4..a674c915 100644
--- a/doc/source/themes.rst
+++ b/doc/source/themes.rst
@@ -33,8 +33,8 @@ Create a theme
--------------
To create a theme named foo, create a file named foo.py into the theme
-directory (by default it’s _~/.local/share/poezio/themes/_) and insert
-into it:
+directory (by default it’s :file:`~/.local/share/poezio/themes/`) and
+add:
.. code-block:: python
@@ -58,16 +58,16 @@ one will just have the default value (from the default theme).
Colors and attributes
~~~~~~~~~~~~~~~~~~~~~
A color pair defines how the text will be displayed on the screen. It
-has a *foreground color* (fg_color), a *background color* (bg_color)
-and an **optional** *attribute* (opt_attr).
+has a **foreground color** (``fg_color``), a **background color**
+(``bg_color``) and an **optional attribute** (``opt_attr``).
Colors
^^^^^^
-A color is a number between -1 and 255. If it -1, this is the default
-color defined by your terminal (for example if your terminal displays
-text white on black by default, a fg_color of -1 is white, and a bg_color
-of -1 is black). If it’s between 0 and 256 it represents one of the colors
-on the image:
+A color is a number between ``-1`` and ``255``. If it is ``-1``, this is
+the default color defined by your terminal (for example if your terminal
+displays white text on black by default, a ``fg_color`` of ``-1`` is white,
+and a ``bg_color`` of ``-1`` is black). If it’s between 0 and 256 it
+represents one of the colors on this image:
.. figure:: ./images/theme_256_colors.png
:alt: The list of all 256 colors
@@ -77,25 +77,27 @@ on the image:
Attributes
^^^^^^^^^^
An attribute is a python string (so, it has to be surrounded by
-*" "* or *' '*). It can be one of the following:
+simple or double quotes). It can be one of the following:
-- *'b'*: bold text
-- *'u'*: underlined text
+- ``'b'``: bold text
+- ``'u'``: underlined text
Use a theme
-----------
-To use a theme, just define the **theme** option into the
-*configuration file* to the name of the theme you want
+To use a theme, just define the :term:`theme` option into the
+:ref:`configuration file <config>` to the name of the theme you want
to use. If that theme is not found, the default theme will be used instead.
+
Note that the default theme is defined directly into poezio’s source code,
and not in a theme file.
Change the theme directory
--------------------------
-To change the default theme directory (**~/.local/share/poezio/themes/** by
-default), you have to change the *themes_dir* option in the
-*configuration file* to the directory that contains your
-theme files.
+To change the default theme directory
+(:file:`~/.local/share/poezio/themes/` by default),
+you have to change the :term:`themes_dir` option in the
+:ref:`configuration file <config>` to the directory that
+contains your theme files.
.. _available-options:
@@ -106,3 +108,7 @@ Available options
All available options can be found into the default theme, which is into the
**theming.py** file from the poezio’s source code.
+
+
+.. autoclass:: theming.Theme
+
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index 65dae4ff..c4d49fde 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -194,9 +194,9 @@ status message of the contact. Plugins may add some elements to the status line.
Dataforms tab
~~~~~~~~~~~~~
-This tab lets you view a form receive from a remote entity, edit the values and
-send everything back. It is mostly used to configure MUCs with the :term:`/configure`
-command but can actually be used for almost anything.
+This tab lets you view a form received from a remote entity, edit the values and
+send everything back. It is mostly used to configure MUCs with the
+:term:`/configure` command but can actually be used for almost anything.
.. figure:: ./images/data_forms.png
:alt: The dataform tab
@@ -211,8 +211,9 @@ You can then send the completed form using ``Ctrl+y`` or cancel using ``Ctrl+g``
List tab
~~~~~~~~
-This tab lists all public rooms on a MUC service. It is currently very limited
-but will be improved in the future. There currently is no way to search a room.
+This tab lists all public rooms on a MUC service (with the :term:`/list` command).
+It is currently very limited but will be improved in the future. There currently
+is no way to search a room.
.. figure:: ./images/list.png
:alt: The list tab