SourceForge の htmlhelp2 を GitHub Pages に移行

kobake commented 6 years ago

概要

SourceForge 上にホストされていた htmlhelp2 (http://sakura-editor.sourceforge.net/htmlhelp2/) を GitHub Pages 側 (https://sakura-editor.github.io/help/) に移行する。

移行理由

SourceForge の Web サーバがしばしば重いor不安定であるという声が多いため、SourceForge 上の Web リソースを順次 GitHub Pages に移行していく。今回は htmlhelp2 を移行。

見た目のレビュー

ここで見れるようにしてあります。 https://kobake.github.io/sakura-editor.github.io/help/

SourceForge Web 領域のバックアップ置き場

量が多いので全てを配置しているわけではないですが、SourceForge の Web 領域の一部のバックアップ（今のところは htmlhelp, htmlhelp2 のみ）を以下に配置しました。

https://sakura-editor.osdn.jp/

注記

sakura リポジトリ側の .chm ヘルプのリソースに同内容のファイル群がある (https://github.com/sakura-editor/sakura/tree/master/help/sakura/_RESOURCE) ため、そこへの参照方式 (submodule 等) にする選択もありましたが、まだ sakura リポジトリ側の help のファイル構成が変わる可能性を考え、今回は参照方式をとっていません。
ファイルのコピー元は上記ファイル群ではなく http://sakura-editor.sourceforge.net/htmlhelp2/ に配置されていたファイル群です。
https://github.com/sakura-editor/sakura/tree/master/help/sakura/_RESOURCE と http://sakura-editor.sourceforge.net/htmlhelp2/ のファイル群の内容を WinMerge で比較してみましたが、差異は一箇所 (※) 以外無かったです。
- ※その一箇所とは 6f12504 における HLP000075.html の1行です。実装内容から sakura リポジトリ側の記載が正しいと判断し、そのように修正しました。詳細は 6f12504 のコミットメッセージを参照。
GitHub Pages では .htaccess が使えないため、削除してあります。
SourceForge での htmlhelp2 では .htaccess による DirectoryIndex で HLP000001.html が指定されていましたが、GitHub Pages では .htaccess が使えないため、代わりに HLP000001.html から index.html へシンボリックリンクを張る形で DirectoryIndex と同等の挙動を果たすようにしました。
GitHub Pages ではファイルのエンコーディングを UTF-8 にしておかないと文字化けするため、エンコーディングを Shift_JIS から UTF-8 に変更しました（Jekyll を使う場合はエンコーディング指定もできるようだが、今の時点では Jekyll は使っていないため、エンコーディング変更の対処とした）。

事後の予定

サクラエディタから HTML ヘルプを開くときの URL を GitHub Pages 側に変更する。
- 対象コード: https://github.com/sakura-editor/sakura/blob/master/sakura_core/util/shell.cpp#L610
- ここでの指定は hid2.cgi?%d のようになっているが、ここは CGI を使わずに単純に HLP%06d.html のような指定で良いはず。
SourceForge 側の htmlhelp2 へのアクセスは GitHub Pages のほうへリダイレクトするように設定する。

検討保留事項

htmlhelp2 は移行するが、htmlhtlp (ANSI版ヘルプ) をどうするかについては今のところは検討を保留する。

kobake commented 6 years ago

@sakura-editor/sakura-developers レビュー＆問題なければマージお願いします。

KageShiron commented 6 years ago

シンボリックリンクはおそらくindex.htmlとHLP000001.htmlが独立して存在してしまい、SEOやブックマークで混乱しそう。meta refreshにした方が良さそうです。
chmと2重メンテになるのは避けたいところですね・・・。イマイチchmのコンパイル方法がわかってないんですが、ヘルプましんとかHTML Help Workshopでコンパイルするんでしょうか・・・？
マクロやプラグインヘルプも別々に配らず、統合してしまっても良い気がします
sourceforge.netとかになってるリンクは後で修正してpull request投げてみたいと思います。

kobake commented 6 years ago

シンボリックリンクはおそらくindex.htmlとHLP000001.htmlが独立して存在してしまい、SEOやブックマークで混乱しそう。meta refreshにした方が良さそうです。

元々のヘルプページでも DirectoryIndex の機能によって http://sakura-editor.sourceforge.net/htmlhelp2/ http://sakura-editor.sourceforge.net/htmlhelp2/HLP000001.html の両者が同じものを指していたので問題ないんじゃないかな、と思っていました。

内部的に DirectoryIndex を用いているかシンボリックリンクを用いているかは閲覧側（エンドユーザおよび検索エンジン）から見ると区別できない＝別名の URL があること自体は構わないと思っているのですがどうでしょう。

meta refresh するとしたら index.html アクセス時に HLP000001.html に飛ばすか HLP000001.html アクセス時に index.html (というか / かな) に飛ばすかだと思いますが、やるとしたら後者、、ですかね。 / をブックマークしたい人のほうが多いと思うので。

chmと2重メンテになるのは避けたいところですね・・・。

そですね。今回の対応はあくまでも不安定な SourceForge から暫定で避難することを目的としていて、今後のメンテナンスの仕方については避難後にじっくり考えたいです。

イマイチchmのコンパイル方法がわかってないんですが、ヘルプましんとかHTML Help Workshopでコンパイルするんでしょうか・・・？

これは・・・僕もわかってません！おそらくですけど現状のアクティブなメンバーの中でわかってる人いないのでは・・・と思っています。なので誰かががんばって調べる or SourceForge時代のメンテナンス担当の人の降臨を待つ、という感じで考えてます。

マクロやプラグインヘルプも別々に配らず、統合してしまっても良い気がします

僕もそう思っています。

ただ、現状ヘルプファイルのコンパイルの仕方さえ分からないところなので、そのあたりの情報整理できてからマクロとプラグインのファイル群の設置方式（ディレクトリ構成とか）を考えたいところです。Web 上への公開についてはそれらの整理が済んでからで良いかな、と考えています。

sourceforge.netとかになってるリンクは後で修正してpull request投げてみたいと思います。

ありがとうございます～

kobake commented 6 years ago

いろいろ改善の検討事項はあるのですが、現状 SourceForge がすごく不安定（今もメンテに入ってしまって Web が見れない）なので、まずはこの PR で避難だけ済ませてから別件として細かい調整を検討したいです。

kobake commented 6 years ago

レビュー＆マージありがとうございます！

ちょっとバタバタしてして確認が今になってしまいましたが、マージにより https://sakura-editor.github.io/help/ が見れるようになったことが確認できました。

sakura-editor / sakura-editor.github.io