Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HTML Help 中のリンクを GitHub のものに変える #383

Merged
merged 1 commit into from
Sep 4, 2018

Conversation

m-tmatma
Copy link
Member

#380: HTML Help 中のリンクを GitHub のものに変える

  • web サイトのリンクを https://sakura-editor.github.io/ に変更する
  • オンラインヘルプの URL は過去の履歴なので変更しない
  • <h2>ヘルプファイル更新履歴</h2>
    下記より新しい更新は、<a href="http://sourceforge.net/" target="_blank">sourceforge.net</a> 上のSubversionで管理されています。<br>
    helpのコンパイル前の最新は <a href="http://sourceforge.net/p/sakura-editor/code/" target="_blank" rel="nofollow">http://sourceforge.net/p/sakura-editor/code/</a> help/trunk2より閲覧できます。<br>
    は変更していない

@m-tmatma m-tmatma added the document ドキュメント label Aug 31, 2018
@m-tmatma m-tmatma added this to the next release milestone Aug 31, 2018
@beru
Copy link
Contributor

beru commented Aug 31, 2018

下記のソースコード中にリンクがある事に気付きました。

_stprintf( buf, _T("http://sakura-editor.sourceforge.net/cgi-bin/hid2.cgi?%Id"), dwData );

https://sakura-editor.github.io/help/
以下のURLに変更した方が良いのでしょうか?

ヘルプIDは、https://github.com/sakura-editor/sakura/blob/master/sakura_core/sakura.hh
にあるIDと内容が一致しているようなのでURLは作れそうです。

sakura-editor/sakura-editor.github.io#5 (comment)
で言及されてますね。

@m-tmatma
Copy link
Member Author

この PR とは別件なので、別の issue で議論したほうがいいと思います
こう PR はローカルのヘルプ中のリンクに対する修正です。

@beru
Copy link
Contributor

beru commented Sep 1, 2018

@m-tmatma 確認ありがとうございます。別PR #392 を作成しました。

@m-tmatma
Copy link
Member Author

m-tmatma commented Sep 2, 2018

レビューお願いします

@berryzplus
Copy link
Contributor

berryzplus commented Sep 3, 2018

どうしたいのかがよく分っていないです。
何が対象で、何が除外なのかがイマイチ。

除外理由に挙げられている内容で「履歴だから」というのは、ニュアンスというか、分からなくないんですが、「過去そうだった」という理由で現在は消滅したリンクを残す意味があるのかないのか、です。

たとえば
~~~旧ページ名(旧アドレス) ~~~ ← markdownでは取消線が付く
[新ページ名](新アドレス) ← markdownではリンクになる
のように「履歴を残しつつ修正」という方法も取れる気がします。

#383 を適用した状態で sakura っぽい Web ページアドレスを検索した結果が以下になります。

□検索条件  "\bhttps?://.*sakura"
検索対象   *.*;#.git;#.vs
フォルダ   C:\gitroot\sakura\help
    (サブフォルダも検索)
    (英大文字小文字を区別しない)
    (正規表現:bregonig.dll Ver.3.06 with Onigmo 5.15.0)
    (文字コードセットの自動判別)
    (一致した行を出力)


C:\gitroot\sakura\help\plugin\Text\index.html(20,18)  [SJIS]: <center><a href="https://sakura-editor.github.io/" target=_blank>https://sakura-editor.github.io/</a></center>
C:\gitroot\sakura\help\plugin\Text\index.html(21,18)  [SJIS]: <center><a href="http://sakura.qp.land.to/?Plugin" target=_blank>http://sakura.qp.land.to/?Plugin</a></center>
C:\gitroot\sakura\help\plugin\Text\overview.html(23,33)  [SJIS]: <strong>プラグイン</strong>は<a href="http://sakura.qp.land.to/?Plugin%2F%C5%EA%B9%C6">SakuraEditorWiki</a>で公開されています。
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000001.html(20,18)  [SJIS]: <center><a href="https://sakura-editor.github.io/" target=_blank>https://sakura-editor.github.io/</a></center>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000003.html(24,12)  [SJIS]: <a href = "http://sourceforge.net/p/sakura-editor/wiki/64bit/" target = "_blank">開発者Wiki/64bit</a>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000010.html(36,16)  [SJIS]: <li><a href = "http://sakura.qp.land.to/?Customize%2FToolIconMaker" target = "_blank">http://sakura.qp.land.to/?Customize%2FToolIconMaker</a></li>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000104.html(30,4)  [SJIS]: 			https://sakura-editor.github.io/<br />
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000110.html(41,22)  [SJIS]: プラグインに関する情報:<a href="http://sakura.qp.land.to/?Plugin">http://sakura.qp.land.to/?Plugin</a><br />
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000112.html(17,34)  [SJIS]: &nbsp;&nbsp;&nbsp;&nbsp;<a href="https://sakura-editor.github.io/" target=_blank>https://sakura-editor.github.io/</a><br>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_HISTORY.html(15,26)  [SJIS]: helpのコンパイル前の最新は <a href="http://sourceforge.net/p/sakura-editor/code/" target="_blank" rel="nofollow">http://sourceforge.net/p/sakura-editor/code/</a> help/trunk2より閲覧できます。<br>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_HISTORY.html(49,21)  [SJIS]: ・テキストエディタ非公式版の紹介ページ(http://members.at.infoseek.co.jp/sakura_editor/intro.html)の内容を機能概要に追加<br>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_HISTORY.html(50,18)  [SJIS]: ・ダイレクトタグジャンプの使い方(http://members.at.infoseek.co.jp/sakura_editor/doc/direct_tagjump.html)のページを追加<br>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_UR000.html(18,34)  [SJIS]: &nbsp;&nbsp;&nbsp;&nbsp;<a href="https://sakura-editor.github.io/" target=_blank>https://sakura-editor.github.io/</a><br>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_UR015.html(275,16)  [SJIS]: 	<li>オンラインヘルプは http://sakura-editor.sourceforge.net/htmlhelp2/ を参照する (svn:1943 unicode:1621 ryoji)</li>
14 個が検索されました。

旧サイト sourceforge のアドレスが結構残ってます。
いくつかは明示的に「対象外」とされてるので納得してますが、
いくつかについて何故除外されてるのか分かっていないです。

@m-tmatma
Copy link
Member Author

m-tmatma commented Sep 3, 2018

http://sakura.qp.land.to に関しては代替のコンテンツが github にないため対象にしていません。
履歴にある http://sourceforge.net/p/sakura-editor/code/ に関しても履歴に関して過去にさかのぼって検証が必要になるため対象にしていません。

@beru
Copy link
Contributor

beru commented Sep 4, 2018

HLP000003.html64bit版のバイナリも公開しています。 以降の記述と 開発者Wiki/64bit への リンクについては思い切って削除してしまっても良いと思います。

少し分かりにくいですが、 ビルド成果物のダウンロード(バイナリ、インストーラなど) から辿れると思うのでその記述を無くしても良いのではないかと。

@beru
Copy link
Contributor

beru commented Sep 4, 2018

HLP_HISTORY.html の冒頭のリンクのURLは sourceforge から github の方に変えてしまって良いのではないかと思います。

Copy link
Contributor

@berryzplus berryzplus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTMです。

追加説明のあった除外条件を元に変更が漏れなく行われているかチェックしました。
問題なく変更できているという判断です。


修正済み(5箇所)

C:\gitroot\sakura\help\plugin\Text\index.html(20,18)  [SJIS]: <center><a href="https://sakura-editor.github.io/" target=_blank>https://sakura-editor.github.io/</a></center>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000001.html(20,18)  [SJIS]: <center><a href="https://sakura-editor.github.io/" target=_blank>https://sakura-editor.github.io/</a></center>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000104.html(30,4)  [SJIS]: 			https://sakura-editor.github.io/<br />
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000112.html(17,34)  [SJIS]: &nbsp;&nbsp;&nbsp;&nbsp;<a href="https://sakura-editor.github.io/" target=_blank>https://sakura-editor.github.io/</a><br>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_UR000.html(18,34)  [SJIS]: &nbsp;&nbsp;&nbsp;&nbsp;<a href="https://sakura-editor.github.io/" target=_blank>https://sakura-editor.github.io/</a><br>

除外条件を満たすもの(8箇所)

C:\gitroot\sakura\help\plugin\Text\index.html(21,18)  [SJIS]: <center><a href="http://sakura.qp.land.to/?Plugin" target=_blank>http://sakura.qp.land.to/?Plugin</a></center>
C:\gitroot\sakura\help\plugin\Text\overview.html(23,33)  [SJIS]: <strong>プラグイン</strong>は<a href="http://sakura.qp.land.to/?Plugin%2F%C5%EA%B9%C6">SakuraEditorWiki</a>で公開されています。
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000003.html(24,12)  [SJIS]: <a href = "http://sourceforge.net/p/sakura-editor/wiki/64bit/" target = "_blank">開発者Wiki/64bit</a>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000010.html(36,16)  [SJIS]: <li><a href = "http://sakura.qp.land.to/?Customize%2FToolIconMaker" target = "_blank">http://sakura.qp.land.to/?Customize%2FToolIconMaker</a></li>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP000110.html(41,22)  [SJIS]: プラグインに関する情報:<a href="http://sakura.qp.land.to/?Plugin">http://sakura.qp.land.to/?Plugin</a><br />
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_HISTORY.html(15,26)  [SJIS]: helpのコンパイル前の最新は <a href="http://sourceforge.net/p/sakura-editor/code/" target="_blank" rel="nofollow">http://sourceforge.net/p/sakura-editor/code/</a> help/trunk2より閲覧できます。<br>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_HISTORY.html(49,21)  [SJIS]: ・テキストエディタ非公式版の紹介ページ(http://members.at.infoseek.co.jp/sakura_editor/intro.html)の内容を機能概要に追加<br>
C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_HISTORY.html(50,18)  [SJIS]: ・ダイレクトタグジャンプの使い方(http://members.at.infoseek.co.jp/sakura_editor/doc/direct_tagjump.html)のページを追加<br>

除外条件を満たさない疑いがあるもの(1箇所)

C:\gitroot\sakura\help\sakura\_RESOURCE\HLP_UR015.html(275,16)  [SJIS]: 	<li>オンラインヘルプは http://sakura-editor.sourceforge.net/htmlhelp2/ を参照する (svn:1943 unicode:1621 ryoji)</li>

 → 変更履歴(リリースノート)の一部なので、除外条件を満たしていると判断して良さそう。

@beru beru merged commit 71d1b1f into sakura-editor:master Sep 4, 2018
@m-tmatma m-tmatma deleted the feature/update-link-in-help branch September 5, 2018 12:14
@ds14050 ds14050 added the document ドキュメント label Sep 18, 2018
HoppingTappy pushed a commit to HoppingTappy/sakura that referenced this pull request Jun 11, 2019
…k-in-help

HTML Help 中のリンクを GitHub のものに変える
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document ドキュメント
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants