README update:

- Sortilège shorcuts have been replaced by Primitivus shortcuts
- Credits updated
This commit is contained in:
Goffi 2010-08-16 21:59:52 +08:00
commit fded7958f4
3 changed files with 52 additions and 17 deletions

66
README
View file

@ -36,7 +36,7 @@ SàT is a XMPP (Jabber) client, made on a daemon/frontend architecture. Its aim
For the moment, the frontends are:
* wix: a wxwidget frontend, the main graphical frontend
* sortilège: a ncurses client, for screen lovers
* primitivus: a console interface client, for screen lovers
* jp: the command line toolkit. The tool for geeks by geeks
other frontends planed in the near future:
@ -61,18 +61,42 @@ There will probably be a wiki doc in the future.
** Misc **
-- Shortcuts for sortilège (temporary):
C-L: access contact list (enter to valid)
F2: Show/Hide contact list
C-S: Short representation of contacts in chat window
C-C: Use colors... or not
C-T: Timestamp
C-X: Leave
-- Shortcuts for Primitivus (temporary):
C stands for "Ctrl"
M stands for Meta wich is usually the "Alt" key
S stands for "Shift"
##GENERAL##
[tab] and/or arrows: change focus
C-x: Quit
M-m: (un)hide menu
C-n: see next notification
C-s: temporarly (un)hide popup window
F2: (un)hide the contact list
##CHAT WINDOW##
M-p: (un)hide presents panel in group chat
M-t: (un)hide timestamp
M-n: (not) use short nicks
M-l: (un)hide window's decoration
M-s: change apperance of subject, switch between:
- one line (subject is clipped if too long)
- full subject displayed
- subject hidden
##EDITION ZONE##
C-a or [home]: place the cursor at the begining of the line
C-e or [end]: place the cursor at the end of the line
C-k: kill (delete) everything at the right of the cursor
C-w: delete the last word
S-[tab]: Do context completion
Note that the mouse can be used
--
SàT is the acronym (yes another one :( ) in tribute to the song Salut à Toi from the Bérurier Noir band. I recommand also the excelent cover from Les Ogres de Barback.
jp stands for Jabber coPy or JumP. If you look well, you can also find my initials ;)
sortilège means "spell" in french, and it is ncurses based...
jp stands for "Jabber coPy" or "JumP". If you look well, you can also find my initials ;)
Primitivus is based on Urwid, and, according to their FAQ, "ur" is a german prefix for "ancestral or primal" (primitivus is latin word)
wix come of course from the WX of wxwidgets and just sound cool :).
@ -84,28 +108,38 @@ The IP are not collected. Future releases will probably come with a warning abou
** Credit **
A big big thank to the authors/contributors of...
proxy65:
SàT (plugin_xep_0065) use nearly all the code from proxy65 (http://code.google.com/p/proxy65/) wich was coded by Dave Smith (2002-2004) and maintained by Fabio Forno (2007-2008).
As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code. Thanks a lot to them !
As the original MIT license allow, the code is reused and sublicensed until GPL v3 to follow the rest of the code.
progressbar:
SàT (jp) use ProgressBar (http://pypi.python.org/pypi/progressbar/2.2), a class coded by Nilton Volpato which allow the textual representation of progression. thanks to him
SàT (jp) use ProgressBar (http://pypi.python.org/pypi/progressbar/2.2), a class coded by Nilton Volpato which allow the textual representation of progression.
twisted:
SàT is based on the twisted framework (http://twistedmatrix.com/trac/), a very great tools which offer a lot of protocols management. There are too many contributors to name them here, so take a look on the website :). Again, thanks to them
SàT is based on the twisted framework (http://twistedmatrix.com/trac/), a very great tools which offer a lot of protocols management. There are too many contributors to name them here, so take a look on the website :).
wokkel:
SàT use a library with high level enhancements on top of twisted, which is called wokkel (http://wokkel.ik.nu). Lot of thanks to Ralph Meijer and all other contributors.
wxWidgets & wxPython:
The Wix frontend is made with wxWidgets (www.wxwidgets.org) and its python version wxPython (wxPython), which is a really handy UI toolkit who works on most popular platforms. It can be found on probably all major Gnu/Linux distributions. as usual, thanks to the authors.
The Wix frontend is made with wxWidgets (www.wxwidgets.org) and its python version wxPython (wxPython), which is a really handy UI toolkit who works on most popular platforms. It can be found on probably all major Gnu/Linux distributions.
Urwid:
Primitivus is based on Urwid (http://excess.org/urwid/) which saved me a lot of time. It's really a great library to easily make a sophisticated interface.
pictures found in frontends/wix/images/crystal/:
These pictures come from Crystal clear, were made by Everaldo Coelho (www.everaldo.com) and YellowIcon (www.yellowicon.com). They are under LGPL V3 licence (see frontends/wix/images/COPYING.LESSER). Thanks to them.
These pictures come from Crystal clear, were made by Everaldo Coelho (www.everaldo.com) and YellowIcon (www.yellowicon.com). They are under LGPL V3 licence (see frontends/wix/images/COPYING.LESSER).
Found on http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_browser.png and http://commons.wikimedia.org/wiki/File:Crystal_Clear_app_cache.png
pictures found in frontend/wix/images/...:
The Tarot cards pictures come from the deck found on wikicommons (the script used to cut them is available at frontend/wix/images/split_card.sh), and available at http://upload.wikimedia.org/wikipedia/commons/8/8d/Tarotcards.jpg under Creative Commons BY-SA. The authors shown on the site are Piast and Svick. The splitted cards are, according to the license, available under the same conditions.
the powerfull ImageMagick (http://www.imagemagick.org/) is used by the script written to split the previously named picture.
and the others:
and of course, nothing would be possible without Python (http://www.python.org/), Gnu and the Free Software Foundation (http://www.gnu.org, http://www.fsf.org/), the Linux Kernel (http://www.kernel.org/), and the coder of the tools I use like Vim (http://www.vim.org/), Mercurial (http://www.selenic.com/mercurial/wiki/), or all the KDE stuff (http://www.kde.org/ and of course http://amarok.kde.org/), etc. Thanks thanks thanks, thank to everybody in the Free (Libre) chain for making a part of the dream.
and of course, nothing would be possible without Python (http://www.python.org/), Gnu and the Free Software Foundation (http://www.gnu.org, http://www.fsf.org/), the Linux Kernel (http://www.kernel.org/), and the coder of the tools I use like Vim (http://www.vim.org/), Mercurial (http://www.selenic.com/mercurial/wiki/), or all the KDE stuff (http://www.kde.org/ and of course http://amarok.kde.org/), and also XFCE (http://www.xfce.org), etc. Thanks thanks thanks, thank to everybody in the Free (Libre) chain for making a part of the dream.
If I forgot any credit (and I probably have), please contact me (mail below) to fix it.

View file

@ -112,7 +112,7 @@ class Chat(urwid.WidgetWrap, QuickChat):
show = not isinstance(self._w, custom_widgets.LabelLine)
self.showDecoration(show)
self._invalidate()
elif key == "meta s": #user wants to (un)hide group's subject
elif key == "meta s": #user wants to (un)hide group's subject or change its apperance
if self.subject:
self.show_title = (self.show_title + 1) % 3
if self.show_title == 0:

View file

@ -142,6 +142,7 @@ class PrimitivusApp(QuickApp):
def keyHandler(self, input):
if input == 'meta m':
"""User want to (un)hide the menu roller"""
try:
if self.main_widget.header == None:
self.main_widget.header = self.menu_roller