From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Girard Subject: [ANN] It's not a bird, it's not a plane, it's... org-icons.el, reloaded ! Date: Mon, 15 Mar 2010 14:17:22 +0100 Message-ID: <51b0095d1003150617g6cb34a87w97a18324ca0625f5@mail.gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Return-path: Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1NrAAj-0005j3-8z for emacs-orgmode@gnu.org; Mon, 15 Mar 2010 09:17:29 -0400 Received: from [140.186.70.92] (port=42411 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1NrAAg-0005iK-Gh for emacs-orgmode@gnu.org; Mon, 15 Mar 2010 09:17:27 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1NrAAf-0002ui-07 for emacs-orgmode@gnu.org; Mon, 15 Mar 2010 09:17:26 -0400 Received: from mail-fx0-f210.google.com ([209.85.220.210]:37654) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1NrAAe-0002uY-Rl for emacs-orgmode@gnu.org; Mon, 15 Mar 2010 09:17:24 -0400 Received: by fxm2 with SMTP id 2so276006fxm.26 for ; Mon, 15 Mar 2010 06:17:23 -0700 (PDT) List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode Hi all, I'm pleased to announce a brand new, shiny release for org-icons. A few minor limitations remain, but I think the code has matured enough to be used on a daily basis. See for yourself ! Grab it at [1] and see the following instructions for installing. I indend to win this year's Most Ridiculous Release Number Contest, so I set the current one to 0.271182363. Wish me luck: I seem to have some quite serious opponents... I dare you, Memoir ! [2]. [1] http://github.com/ngirard/org-icons [2] http://www.ctan.org/tex-archive/macros/latex/contrib/memoir/ * Installation 1. Apply org-icons.patch on the latest org-mode code: cd path/to/org-mode patch -p0 < path/to/org-icons/lisp/org-icons.patch rm org.elc ; make ; sudo make install 2. Add org-icons/lisp to your load-path: (setq load-path (cons "/path/to/org-icons/lisp" load-path)) 3. Restart emacs * Usage - You can turn on `org-icons-mode' on startup by setting the org-startup-with-icons-mode variable to true, (setq org-startup-with-icons-mode t) - You can also enable or disable icon display on a per-buffer level, using M-x org-icons-mode - A key sequence can easily be used for this, like =C-c i= in this example: (add-hook 'org-mode-hook (lambda () (local-set-key "\C-ci" 'org-icons-mode))) * Configuration Conceivably the Org Mode community will agree on how Org icons theme should be defined, if they make sense. Org Mode's philosophy is to be as generic as possible and it's not clear to me how to capture what most people need while keeping in balance with flexibility. Meanwhile, the set of icons that can be used, `org-icons-set', is a little bit hardwired into the code. More flexible are the functions governing which icon to draw, namely `org-todo-state-icon-at', `org-priority-icon-at', `org-drawer-icon-at' and `org-special-keyword-icon-at'. Looking at the source code should be enough for you to redefine these functions to suit your needs. For instance, you'll most probably want to write in your configuration (defun org-todo-state-icon-at (state priority tags) (cond ... ) ) and instead of the dots, a set of (condition icon-name) like ((member "SOMEDAY" tags ) "state-someday") or more complex, like ((equal "NEXT" state) (if (>= priority 2000) "state-next-important" "state-next")) * Bugs and limitations - Documentation is missing. - No themes yet: see the introduction. - When cycling from a TODO keyword to no keyword using S-right, the latest icon remains displayed. - When loading an org buffer, font-lock-fontify-buffer is called twice if org-startup-with-icons-mode is set to t. - The standard icon set isn't visually consistent enough * Please consider... - the code is still beta; - any suggestion / contribution warmly welcome.