misohena
commented
3 months ago (Translated by Google Translate) The reason for using "#+begin_igo" instead of "#+begin_src sgf" is probably because of the following (although it was a long time ago so I don't remember the details):
-
SGF is not a format limited to Go. SGF is used for chess, backgammon and many other games, so we can't make all source blocks in SGF languages into Go boards. Of course, I think this problem can be solved by identifying the type of game (GM property).
-
If we use a source code block in SGF language (#+begin_srg sgf), I couldn't imagine what the following should be:
- Evaluation result of the source code block
- Export output of the source code block
- Should the source code block itself be replaced with an inline board, or should the image of the evaluation result be replaced with an inline board?
In the general use of source code blocks in org-mode, I think that the result of evaluating the source code is often an image (dot, mermaid, plantuml, R, gnuplot, etc.). So it seems good that the evaluation result of an SGF language should be an image of the game board represented by the SGF (preferably the image can be manipulated interactively in Emacs and HTML). In other words, the game board should be displayed after "#+RESULTS:".
For example, suppose you want to write a document explaining the SGF format. In that case, wouldn't you want to display and export the SGF text and the resulting game board side by side?
The following SGF shows black and white players placing stones at the star positions.
#+name: sgf-example1
#+begin_src sgf
(;FF[4]GM[1]SZ[9];B[fd];W[df])
#+end_src sgf
The result is:
#+RESULTS: sgf-example1
(Display the game board here)In this case, we should not replace the source code block with the game board because the text of the SGF language is important. Of course, it's good to be able to edit in a temporary board view by explicit commands.
But I wanted to take notes to study the life and death problems of Go, so I didn't want to see the SGF text.
But at the same time, I'm also a developer, so I might introduce the SGF language on my blog (written in org-mode).
I think the solution would probably be something like this:
- Make it possible to specify an option to replace the inline board for each source code block.
- Add a command to temporarily edit the source code block displayed as text with an inline board state.
- Display the evaluation results and their export results in an interactive board style somehow. The easiest way is to make the evaluation results a "#+begin_igo" block.
- If the evaluation results don't need to be interactive, it would be fine to have an option to simply output them as images (.svg).
This is much more complicated and difficult than what I want for the time being, so I went with "#+begin_igo".
If these problems can be solved, I think source code blocks in the SGF language would be good.
At the moment I have no plans to make any changes to el-igo.
I hope it translates well into English.
(Original Message) 「#+begin_src sgf」ではなく「#+begin_igo」にした理由ですが、次のようなことを考慮したのだと思います(かなり前のことになるので詳しくは覚えていませんが)。
- SGFは囲碁に限った形式では無いこと。SGFはチェスやバックギャモンの他様々なゲームで使われてみたいなので、SGF言語のソースブロックを一律囲碁の盤面にするわけには行きません。もちろんゲームの種類(GMプロパティ)を判別すれば解決する問題だとは思います。
- SGF言語のソースコードブロック(#+begin_srg sgf)にした場合、次のことがどうなるべきなのかうまく想像できませんでした:
- ソースコードブロックの評価結果
- ソースコードブロックのエクスポート出力
- ソースコードブロック自体をインライン盤面に置き換えるべきか、それとも評価結果の画像をインライン盤面に置き換えるべきか
org-modeの一般的なソースコードブロックの使い方では、ソースコードを評価した結果が画像になるものが多いと思います(dot、mermaid、plantuml、R、gnuplot等々)。なのでSGF言語の評価結果はそのSGFが示す盤面画像になっているのが良さそうに思えます(その画像はEmacs上とHTML上でインタラクティブに操作できるのが望ましいでしょう)。つまり、「#+RESULTS:」の後に盤面を表示すべきということになります。
例えばSGF形式についての解説文書を書きたいとします。その場合、SGFのテキストとその結果である盤面を並べて表示・エクスポートしたくならないでしょうか。
次のSGFは黒と白が星の位置に石を置いたところです。
#+name: sgf-example1
#+begin_src sgf
(;FF[4]GM[1]SZ[9];B[fd];W[df])
#+end_src sgf
結果は次のようになります:
#+RESULTS: sgf-example1
(ここに盤面を表示)この場合、ソースコードブロックを盤面に置き換えるべきではありません。SGF言語のテキストが重要だからです。もちろん明示的なコマンドによって一時的に盤面ビューで編集が出来るのは良いことです。
しかし私は囲碁の死活問題の勉強のためのノートを取りたかったので、SGFテキストは見たくありませんでした。
しかし同時に私は開発者でもあるので、SGF言語をブログ(org-modeで書いている)で紹介する可能性があります。
おそらく解決方法は次のようになるのではないかと思います:
- インライン盤面に置き換えるかのオプションをソースコードブロック毎に指定出来るようにする。
- テキストで表示しているソースコードブロックを一時的にインライン盤面で編集するコマンドを追加する。
- 評価結果やそのエクスポート結果を、何らかの方法で、インタラクティブな盤面スタイルで表示する。評価結果を「#+begin_igo」ブロックにしてしまうのが一番簡単。
- 評価結果にインタラクティブ性が必要ないのであれば、単に画像(.svg)で出力するオプションがあっても良い。
これはさしあたって私が欲しいものよりも大分複雑で大変なので、「#+begin_igo」にしたというわけです。
この辺りの問題が解決できるなら、SGF言語のソースコードブロックも良いと思います。
今のところ私の方でel-igoに手を加える予定はありません。
うまく英語に翻訳できていると良いのですが。
RNAer
@misohena , thank you for developing this fantastic Go package for integration with Org-mode. I'm curious about your decision to use a special
#+begin_igoblock instead of a new language#+begin_src sgf. Could you share the considerations behind this choice? Is it challenge to implement all the modes it currently has? For a new language,:tanglecould be nice feature to have.Additionally, do you have any future plans for the development of this package?