Not logged inRybka Chess Community Forum
Up Topic Rybka Support & Discussion / Aquarium / Writing Aquarium i-Books: First Steps
- - By Zruty (*****) [ru] Date 2009-03-04 15:25 Edited 2009-03-04 15:29
1. Aquarium i-Book structure.
Each Aquarium i-Book is based on a DSN database. It comprises the following items:
1) Games. Since any i-Book is based on a database, it may contain any number of games. These games are NOT directly availalble to the reader, however.

2) Pages. The i-Book pages are similar to Web-pages: they may contain text, images, diagrams, hyperlinks to another pages, HTTP hyperlinks. The page text is Wiki-formatted: you can easily define headers, bold and italic text. Each page may or may not contain its board and notation.

3) Optional: classifier. The classifier in i-Book can be used as a book contents. Its aim is to organize the book pages in the way the book author wants. The classifier itself is a tree structure, where each tree node is linked to one (and only one) i-Book page. Note that different classifier nodes may point to the same i-Book page though.

4) Optional: tree. The author can add one tree configuration that is visible to the reader when the book is browsed.

2. Creating an i-Book.
To create an i-Book from a DSN database, click the Options button on the Database tab of the Ribbon:

Then check the 'This database has an i-book...' box and click OK.
After this, the i-Book is created. You can open it by opening the <your database name>.ahb file (located next to the DSN file).

3. Editing an i-Book page.
Newly created i-Book consists of one page, called the 'Root page'. You can edit the page contents by using the 'Edit page' button on the Ribbon, entering the page text in the edit window and clicking 'Apply changes'.
The 'Page options' dialog allows you to change the page title (from 'Root page' to something you prefer), define whether this page has board and notation or not:

Each Aquarium i-Book page has a unique ID. For example, the root page has ID=1. You can see the page ID in the 'Page options' dialog.
If you want to add a new page, you should press Ctrl+Shift+N (or enter 'new' in the console). You'll see the 'Page options' dialog for a new page. Specify the page title and click OK: the page is created.

Once you have several i-Book pages you can switch between them using the Page List button:

Note that any changes to the page text are lost if you don't click 'Apply changes' before switching to another page!

4. Creating a sample chess-related page.
Aquarium i-Books have a number of ways to represent the data. I'll cover them in more details in further postings, now I'll just give a little sample. Open the 'Page Options' dialog and check 'Board and notation present' for the current page. Click OK.
Then paste the following text in the edit window:

= Aquarium i-Book Example =
This page is an example of *some* Aquarium i-Book page editing ''possibilities''.

[line(1.e4 e5 2.Nf3 Nc6 3.Bb5, 0)]
This opening is one of the most ancient ones: it was played by Ruy Lopez hundreds of years before Aquarium i-Books were introduced.
The most popular continuation here is [line(3...a6)]

This opening is covered by ["", Jeroen's Opening Book] in much more details than here.

After you press 'Apply Changes', you will get the following text:

Here, I introduced several items of the page markup:

= Header =

*bold text*

''italic text''

["", HTTP hyperlink]
Note that you can only insert hyperlinks to, other ones are not supported! Kidding, of course :)

[line(...)] - insert moves as hyperlinks. When you click these links, the moves are automatically entered into the notation.
There is a second argument of [line()] command. If it's 0, the line is considered 'main' and displayed in bold. If it's 1 (default) or 2 the links are not bold and are considered variations.

{d} - insert a diagram for current position.
You can also use {d:<MOVENUMBER>} to insert a diagram with a position after the MOVENUMBER move. For example {d:1...} will display diagram after 1. e4 e5.

OK, that's about it for today, since I'm in a hurry. More to come tomorrow.
Parent - By GoVegan (**) [pr] Date 2009-03-04 16:05
Good info!!! Thank you very much!!
Parent - By Gordon (**) [gb] Date 2009-03-04 16:43
Thank you Zruty - very nice!!
Parent - By icebox (**) [it] Date 2009-03-04 17:42
Thanks for the guide.

I don't know if you have been following any standard, but for wiki tags the reference is Creole 1.0 specs:

My two cents,
Parent - By buffos (Silver) [gr] Date 2009-03-04 18:16
I did a small video tutorial for the basic steps in i-book creation.
Only some basic stuff (in editing). Since there was no scenario behind the video, dont expect much.
I hope you get some motivation to try and create your own i-books.

You can download the video from here
Unzip it and then play open the web page with the flash video.
Parent - - By Ricky (***) [us] Date 2009-03-04 22:27

Great Job!

Question, Can you print an i-book without saving it as an html first and them print it from explorer?
Parent - - By Zruty (*****) [ru] Date 2009-03-04 23:30
No. You can save to RTF first though.
Parent - By Ricky (***) [us] Date 2009-03-05 02:50
Parent - - By Rowlando (***) Date 2009-03-23 00:58
I've looked for a way to export to RTF but for some reason I can't seem to find it.  Can you point me in the right direction?  The only i-book export option I see is to export to HTML.  I remember reading in the chesscafe article that export to a word processor would be available but perhaps it's not been released yet?
Parent - - By Felix Kling (Gold) [de] Date 2009-03-23 03:11
right click on the text, there you find the export options for pages. You can export it to rtf this way.
Parent - By Rowlando (***) Date 2009-03-23 03:41
Perfect, thanks!
Up Topic Rybka Support & Discussion / Aquarium / Writing Aquarium i-Books: First Steps

Powered by mwForum 2.27.4 © 1999-2012 Markus Wichitill