Fix several typos in the docs.
Thanks Mopi!
This commit is contained in:
parent
5d07a27e1d
commit
7d6cd69511
7 changed files with 17 additions and 17 deletions
|
@ -14,7 +14,7 @@ You can get the same help as below from inside poezio with the :term:`/help` com
|
|||
.. note:: Use command parameters like this:
|
||||
|
||||
- Do not use quotes if they are unnecessary (words without special chars or spaces)
|
||||
- If the command takes several agrguments, you need to put quotes around arguments containing special chars such as backslashes or quotes
|
||||
- If the command takes several arguments, you need to put quotes around arguments containing special chars such as backslashes or quotes
|
||||
- If the command always takes only one argument, then do not use quotes even for words containing special chars
|
||||
|
||||
.. _global-commands:
|
||||
|
@ -97,7 +97,7 @@ These commands work in *any* tab.
|
|||
**Usage:** ``/status <availability> [status message]``
|
||||
|
||||
Set your availability and
|
||||
(optionaly) your status message. The <availability> argument is one of
|
||||
(optionally) your status message. The <availability> argument is one of
|
||||
"available, chat, away, afk, dnd, busy, xa" and the optional [status] argument
|
||||
will be your status message.'
|
||||
|
||||
|
@ -387,7 +387,7 @@ MultiUserChat tab commands
|
|||
|
||||
Using the auto-completion of this command writes the current topic
|
||||
in the input, to help the user make a small change to the topic
|
||||
whithout having to rewrite it all by hand.
|
||||
without having to rewrite it all by hand.
|
||||
|
||||
If no subject is specified as an argument, the current topic is
|
||||
displayed, unchanged.
|
||||
|
@ -421,7 +421,7 @@ MultiUserChat tab commands
|
|||
/cycle
|
||||
**Usage:** ``/cycle [message]``
|
||||
|
||||
Leave the current room an rejoint it immediatly. You can
|
||||
Leave the current room an rejoint it immediately. You can
|
||||
specify an optional quit message.
|
||||
|
||||
/info
|
||||
|
|
|
@ -154,7 +154,7 @@ Options related to account configuration, nickname…
|
|||
**Default value:** ``anon.jeproteste.info``
|
||||
|
||||
The server to use for anonymous authentication;
|
||||
make sure it supports anonymous authentification.
|
||||
make sure it supports anonymous authentication.
|
||||
|
||||
Note that this option doesn’t do anything at all if you’re using your own JID.
|
||||
|
||||
|
@ -440,7 +440,7 @@ to understand what is :ref:`carbons <carbons-details>` or
|
|||
**Default value:** ``true``
|
||||
|
||||
XHTML-IM is an XMPP extension letting users send messages containing
|
||||
XHTML and CSS formating. We can use this to make colored text for example.
|
||||
XHTML and CSS formatting. We can use this to make colored text for example.
|
||||
Set to ``true`` if you want to see colored (and otherwise formatted) messages.
|
||||
|
||||
enable_css_parsing
|
||||
|
@ -602,7 +602,7 @@ or the way messages are displayed.
|
|||
**Default value:** ``[empty]``
|
||||
|
||||
A list of words or sentences separated by colons (":"). All the
|
||||
informational mesages (described above) containing at least one of those
|
||||
informational messages (described above) containing at least one of those
|
||||
values will not be shown.
|
||||
|
||||
hide_exit_join
|
||||
|
@ -778,7 +778,7 @@ or the way messages are displayed.
|
|||
|
||||
show_roster_subscriptions
|
||||
|
||||
**Defalt value:** ``[empty]``
|
||||
**Default value:** ``[empty]``
|
||||
|
||||
Select the level of display of subscriptions with a char in the contact list.
|
||||
|
||||
|
@ -912,7 +912,7 @@ Options related to logging.
|
|||
|
||||
**Default value:** ``true``
|
||||
|
||||
Logs all the tracebacks and erors of poezio/slixmpp in
|
||||
Logs all the tracebacks and errors of poezio/slixmpp in
|
||||
:term:`log_dir`/errors.log by default. ``false`` disables this option.
|
||||
|
||||
use_log
|
||||
|
|
|
@ -5,7 +5,7 @@ Conventions
|
|||
-----------
|
||||
|
||||
We don’t have a strict set of conventions, but you should respect PEP8 mostly
|
||||
(e.g. 4 spaces, class names in CamelCase and methods lowercased with
|
||||
(e.g. 4 spaces, class names in CamelCase and methods lowercase with
|
||||
underscores) except if it means less-readable code (80 chars is often a hassle,
|
||||
and if you look inside poezio you’ll see lots of long lines, mostly because of
|
||||
strings).
|
||||
|
@ -18,7 +18,7 @@ for the application as a whole.
|
|||
Commit guidelines
|
||||
-----------------
|
||||
|
||||
Commits **should** have a meaninful title (first line), and *may* have a detailed
|
||||
Commits **should** have a meaningful title (first line), and *may* have a detailed
|
||||
description below. There are of course exceptions (for example, a single-line
|
||||
commit that takes care of a typo right behind a big commit does not need to
|
||||
say ``fix a typo ("azre" → "are") in toto.py line 45454``, since the metainfos
|
||||
|
|
|
@ -40,7 +40,7 @@ method (inherited empty from the Tab class), call a scrolling method from the
|
|||
appropriate **window**.
|
||||
|
||||
All tabs types inherit from the class **Tab**, and the tabs featuring
|
||||
chat functionnality will inherit from **ChatTab** (which inherits from **Tab**).
|
||||
chat functionality will inherit from **ChatTab** (which inherits from **Tab**).
|
||||
|
||||
Examples of **tabs**: MUCTab, XMLTab, RosterTab, MUCListTab, etc…
|
||||
|
||||
|
@ -80,9 +80,9 @@ or
|
|||
|
||||
/command "arg1 with spaces" arg2
|
||||
|
||||
However, when creating a command, you wil deal with _one_ str, no matter what.
|
||||
However, when creating a command, you will deal with _one_ str, no matter what.
|
||||
There are utilities to deal with it (common.shell_split), but it is not always
|
||||
necessary. Commands are registered in the **commands** dictionnary of a tab
|
||||
necessary. Commands are registered in the **commands** dictionary of a tab
|
||||
structured as key (command name) -> tuple(command function, help string, completion).
|
||||
|
||||
Completions are a bit tricky, but it’s easy once you get used to it:
|
||||
|
|
|
@ -91,7 +91,7 @@ Table of all XEPs implemented in poezio.
|
|||
+----------+-------------------------+---------------------+
|
||||
|0270 |Compliance Suites 2010 |Advanced Client |
|
||||
+----------+-------------------------+---------------------+
|
||||
|0280 |Messsage Carbons |100% |
|
||||
|0280 |Message Carbons |100% |
|
||||
+----------+-------------------------+---------------------+
|
||||
|0296 |Best Practices for |0% |
|
||||
| |Resource Locking | |
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
Using client certificates to login
|
||||
==================================
|
||||
|
||||
Passwordless authentication is possible in XMPP through the use of mecanisms
|
||||
Passwordless authentication is possible in XMPP through the use of mechanisms
|
||||
such as `SASL External`_. This mechanism has to be supported by both the client
|
||||
and the server. This page does not cover the server setup, but prosody has a
|
||||
`mod_client_certs`_ module which can perform this kind of authentication, and
|
||||
|
|
|
@ -3,7 +3,7 @@ Using several accounts
|
|||
|
||||
Poezio does not support multi-accounts, and we do not plan to do so in a
|
||||
foreseeable future. However, you can run several poezio instances (e.g. with
|
||||
tmux or screen) to have similar functionnality.
|
||||
tmux or screen) to have similar functionality.
|
||||
|
||||
You can specify a different configuration file than the default with:
|
||||
|
||||
|
|
Loading…
Reference in a new issue