Shape UP! Conversion to gobook format

[foe]

That editor looks great! I've been doing it all from vim and found it a bit tedious to set up the stones by coordinates. I should see if this works better for me. Thanks for the video!

[oca]

That editor looks great! I've been doing it all from vim and found it a bit tedious to set up the stones by coordinates. I should see if this works better for me. Thanks for the video!

Thanks, feel free to create your own account if you wish

(PS : I just saw there where a bug in the account page... I fixed it so that you should be able to create your own account now if you wish)

[oca]

Part 3 - How to add a diagram

Well, this is really the fun part is it ? so, there are several way to add a diagram, so let's start with the '::go' tag.

Basicly the '::go' tags let you enter some preplaced stones, and a sequence of moves. let's see an example :

Code: Select all

::go 
   ab=D4
   aw=F3
   mv="H3 C3"

The "ab" properties, like in the sgf format, is for black pre-placed stones, "aw" is for white pre-placed stones, and "mv" is a sequence of moves.
in this case H3 is a black move, and C3 is a white moves.

so if your whole book looks like that :

Code: Select all

::book 

::go 
   ab=D4
   aw=F3
   mv="H3 C3"

You should see... nothing... that's because the '::go' doesn't render anything... it just setup a kind of game state...

to see something, we need to add another tag.. either '::fig' or '::dia', but let's use '::fig' here

Code: Select all

::book 

::go 
   ab=D4
   aw=F3
   mv="H3 C3"
   
::fig 
   at=1 
   to=end
   

That should now render like that :

$$Bc
$$ +---------------------------------------+
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . , . . . . . , . . . . . , . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . , . . . . . , . . . . . , . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . X . . . . . , . . . . . , . . . |
$$ | . . 2 . . O . 1 . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ +---------------------------------------+

Click Here To Show Diagram Code

[go]$$Bc
$$ +---------------------------------------+
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . , . . . . . , . . . . . , . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . , . . . . . , . . . . . , . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . X . . . . . , . . . . . , . . . |
$$ | . . 2 . . O . 1 . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ | . . . . . . . . . . . . . . . . . . . |
$$ +---------------------------------------+[/go]

More to come soon...

[oca]

You can can choose the part that is displayed using the "vw" (VieW) attribute, so adding "vw=A1K10"
will clip the goban like this :

$$Bc
$$ | . . . , . . . . . ,
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ | . . . X . . . . . ,
$$ | . . 2 . . O . 1 . .
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ +--------------------

Click Here To Show Diagram Code

[go]$$Bc
$$ | . . . , . . . . . ,
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ | . . . X . . . . . ,
$$ | . . 2 . . O . 1 . .
$$ | . . . . . . . . . .
$$ | . . . . . . . . . .
$$ +--------------------[/go]

In the previous example, we used 'at' and 'to' to choose the moves that are displayed, which
is a good way to split a game by 10 moves for example.

You van also specify 'at', and then place a sequence with 'mv', that will start at the specified position,
like this :

Code: Select all

::fig ca="Using 'at' and 'mv'"
   vw=A1K10
   at=end
   mv=D3C4D5D2E2C2E3C6

I just put an online a quick 'sandbox' editor that doesn't requier a login, so you can give it a try here :

capture.jpg (14.22 KiB) Viewed 17816 times

http://www.gocdf.ch/gobook/learn/diagram-1.html


You can try for example to change the 'view' and replace the current view 'A1L8' by 'A1K10'.
there are a few shortcut for that :

for bottom/left corner, try :
vw=1[TAB]

1 is the bottom/left key on the numeric keypad...
you can try 9[TAB] to have the top/right corner, or 7 or 3 for the 2 other corners.

[Claint]

I don't want to rain on your parade here but even though "Shape Up" is known to be a free book, it is not actually free for distribution and is copyrighted. I had to register a gobase account to read the book some years ago, so I remember.

Searching the forums here, Charles Matthews confirms this on here:
http://www.lifein19x19.com/forum/viewtopic.php?f=11&t=5825&start=22

Therefore, you need to contact Charles Matthews and get his approval as well.

I hope the project continues regardless, since I do want a "free" (as in freedom) smartgobook reader. I don't know how you are going the licence the software though.

[oca]

...
Therefore, you need to contact Charles Matthews and get his approval as well.

Hi Claint,

Sure I did contact Charles Matthews. http://www.lifein19x19.com/forum/viewto ... 30#p181230

[edit] and this two for the whole story...
http://www.lifein19x19.com/forum/viewto ... 31#p181231
http://www.lifein19x19.com/forum/viewto ... 78#p181278
[/edit]

(See the whole topic, the link to the full book is also available in that topic)

I started that project after "Shape UP!" went into a "Creative Commons" license.

So my project will continue !

[Claint]

Oh, it was nice to learn "Shape Up" is CC-SA now. Cool beans.

[Bonobo]

Oca, I think it might be a good idea to edit some info about the recent CC-SA licensing of this book into your opening post so that people who stumble over this thread can see it right at the beginning

Great project, BTW!

Regards, Tom

[oca]

Oca, I think it might be a good idea to edit some info about the recent CC-SA licensing of this book into your opening post so that people who stumble over this thread can see it right at the beginning

Great project, BTW!

Regards, Tom

Good Idea , I just did that in the first post.

[YeGO]

Nice project!

Also, nice GoBook editor! It seems like it would be a very useful tool for many. Thank you for making it available as a web service.

Is your GoBook editor an open source project?

[oca]

Hi YeGO,

Thank you for your interst in this project !

My priority in this project is to complete the translation of "Shape UP !".
I know there are still bugs in my javascript engine, especially with the "::var" tags which isn't 100%, but I won't fix it before I completed the translation of the book.
I know I can easly fall in the trap to spend all my time writing code... while what I want is the gobook...

That said, once I will have completed the translation, I will take time to fix the issues I found in the javascript engine.
I wrote that engine in a way that it is easy to unit-test.

For whose who like code :

Code: Select all

testBook ("F001",                           // test number
   '::fig mv="A1 A2 A3" mn=2 ca="F001"',          // what we want to test
   "F001:[ab:,aw:]-[A1:b:2, A2:w:3, A3:b:4]"      // the expected result, as a text string, 
// "A1:b:2" means position A1, black, move number 2

);

so every thing is in place to make it more robust... I just need a bit more time

Once the engine would be fixed, I will clean a bit the MyOwnGoBook app and create git-hub projects for both the app and the engine, so that anyone can use/modify the code the way they want to.

So next steps are :

First :focus on the translation, where I can spend something like 2 hours per week on Thursday night.

Then : Think about distribution...

The best will be to have the book available both on "the official" gobook app, and online aside with the pdf version

I allready had a first contact with Anders Kierulf of smartGo, I will come back to him when the book will be completed
to see what is possible.

While I'm not intending in making any money with this project, that may still be an option to sell the gobook for a few dollar.
That may help SmartGo, an app that I really like, and *IF* I recieve any money with this book, I can then use it to help some "go club" and/or this forum which I really love too.

however my preference will still be to have the book free for every one...

Anyway, that's just a few guess and in french we say that "Il ne faut pas vendre la peau de l'ours avant de l'avoir tué", which translate to "to sell the bear's skin before killing it"
but I think in english it's more " to count one's chickens (before they're hatched)" so once again, I should complete the book first...

That said, if anyone has a preference or idea about the distribution of the book... just let me know...

[oca]

While I just said that I don't want to spend my time coding, I just saw there where a bug with the "send book by email" feature and also with the "password reset procedure" of MyOwnGoBook.
As these are main features, I just fixed them

[oca]

I'm converting the last problem set... till now, I really followed the layout of the pdf.
but here (and also for the first two problem set also) I think that it would be better to have the problem "one by one"

So instead of having a first page with the four problems, and then a second page with their solutions, I think I will better to have the first problem, then its solution, then the next problem and so on...

This will break my rule to be as close as possible to the pdf, but that would also be more readable on small display I think ...

What do you think of that ? any preference ?

[Bonobo]

I'm converting the last problem set... [..]

Wow …

This will break my rule to be as close as possible to the pdf, but that would also be more readable on small display I think ...

What do you think of that ? any preference ?

I like your preference of staying as close to the definitive PDF (for reasons of respect towards the original), but I think the CC SA license also gives you the option to change resp. build upon the original, as long as the CC SA license’s requirements are respected. And I think you are a responsible editor, so I’d trust your judgement here

But that’s just me. Adnd Charles Matthews also is a member of this forum, as you know … what about asking for his opinion? I assume he’ll welcome anything that improves readability.

Looking forward to the final product …

Tom

[smartgo]

So instead of having a first page with the four problems, and then a second page with their solutions, I think I will better to have the first problem, then its solution, then the next problem and so on...

I'd definitely vote for having the problems one-by-one; having multiple problems per page is an artifact of print publication.