artasparks / gpub

GPub: Go Publishing for Glift
MIT License
16 stars 3 forks source link

SGF numbering is ignored/overwritten by GPub #15

Closed dormerod closed 8 years ago

dormerod commented 8 years ago

If the diagrams in an SGF are already numbered, GPub ignores these numbers and overwrites them with its own numbering.

I don't think this is really a bug (in my mind it's a feature which corrects for human error), but it could be unexpected for the user in some cases, so we should be explicit that this is the default behavior.

An option to disable auto-numbering and use the numbering from the SGF could be a 'nice to have' (low priority) feature for later.

(Note: the author of a book probably wants to number the moves in the SGF anyway when working on it, otherwise it's incredibly hard to write comments referring to specific move numbers.)

dormerod commented 8 years ago

One practical example of where this behavior can be slightly problematic is in commentary of the early opening. Sometimes you want to refer back to moves which were already played in the previous diagram, but you can't refer to them by number because they've already been 'spent' in the auto-numbering logic.

The workaround is to just number the moves as A, B, C... instead of 1, 2, 3... so it's really just that the behavior may be unexpected to the author and they'll have to change their book a little after running it through GPub for the first time and seeing what happens.

artasparks commented 8 years ago

I don't think I'll ever fix this, sorry. I would call this a feature rather than a bug. I've added some notes to the README.