all repos — h3rald @ b26e779a67ddb0e4187d0c75a391b8d5b046f044

The sources of https://h3rald.com

content/articles/redbook-030-released.textile

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
----- 
permalink: redbook-030-released
filters_pre: 
- redcloth
title: "Announcement: RedBook v0.3.0 released"
comments: []

date: 2007-10-25 07:18:00 +02:00
tags: 
- redbook
- ruby
- productivity
- opensource
type: article
toc: true
-----
It's time for a new beta release of RedBook. This was actually going to be a fairly modest release in terms of features, but I actually ended up implementing a lot more than expected, even things which were planned for the first production release 1.0. So, let's see what's new

h3. New operation names _(which break compatibility with previous versions)_

I had a look at the names I choose for the operations and I noticed that they were either not intuitive enough or too verbose. So I decided to change a fair few of them (thus breaking compatibility with previous versions, but after all that's what beta releases are for, right?):

|_. OLD |_. NEW |
| :complete | :finish |
| :load | :select |
| :load_config | :config |
| :load_log | :refresh |
| :timecalc | :calc |
| :stop | :quit |

h3. New Manual/Home Page

A while ago I discovered "TiddlyWiki":http://www.tiddlywiki.com/, but as a matter of fact I never used it for anything practical. From last week though, I started using it a work for taking notes and create short memos, and then I thought of using it to replace RedBook's standard README file (which was made in a hurry and was kinda cryptical). Now a brand new "manual.html" ships with RedBook -- 308 KB (30 of actual docs and 278 of Javascript/HTML/CSS magic) with everything you need to know about it. Additionally, an online version is available at the following address:

p=. *"redbook.h3rald.com":http://redbook.h3rald.com*

h3. Removed Win32::Console Library

OK this is not good news for people (like me) who use RedBook on Windows, but I promise you'll forgive me when you read about the other new features below. I discovered by chance that the Win32::Console library (which was used to get colors working on Windows) seems not to handle international characters properly and also seems to be conflicting in some way with the Readline library I decided to include (see below). I don't know whether this is a problem of the actual library or just of the gem used to pack it.

h3. rbconfig.yml

The @config.yml@ file has been renamed to @rbconfig.yml@. Additionally, if you place a file with this name in your $HOME directory it will override the one in your RedBook folder (This was done in preparation for the RedBook RubyGem).

h3. New operations

The following new operations are available:

* ":relog":http://redbook.h3rald.com/#%3Arelog -- Re-logs a previously-logged message (keeping the same tags and updating the timestamp)
* ":clear":http://redbook.h3rald.com/#%3Aclear -- Clears the screen.
* ":ruby":http://redbook.h3rald.com/#%3Aruby -- Evaluates arbitrary Ruby code outputting the result (use with care...)

h3. Auto-completion

Some Mac users originally complained that the backspace key wasn't working in RedBook (and it didn't in Linux either). Fortunately the solution to this was easy enough: include the GNU "Readline":http://tiswww.case.edu/php/chet/readline/rltop.html library. 
Readline is now being used in RedBook to:

* Provide basic (Emacs-style) bindings
* *Auto-completion* for keywords _and tags_
* Allow the user to automatically customize key bindings via an ".inputrc":http://redbook.h3rald.com/#.inputrc file placed in their $HOME directory (on Windows you'll have to define a %HOME% environment variable pointing to a directory of your choice). An example .inputrc file is distributed with RedBook with some specific key bindings.

h3. Support for international characters

Finally, I decided to implement another feature which was originally planned for the 1.0 release: international characters support. This is possible using the Iconv Ruby extension (requires "GNU libiconv":http://www.gnu.org/software/libiconv/) which can convert strings between different character sets. The character sets needs to be configured via the "rbconfig.yml":http://redbook.h3rald.com/#rbconfig.yml file.

For more information, check out the "ChangeLog":http://redbook.h3rald.com/#ChangeLog

p=. *"Download RedBook":http://www.assembla.com/spaces/files/bWE7NkzCqr3k25abIlDkbG*