◀ドキュメントトップへ
  • 353 ヘルプソースの管理・運用変更案
    • 369 Re:ヘルプソースの管理・運用変更案
    • 371 Re:ヘルプソースの管理・運用変更案
      • 374 Re2:ヘルプソースの管理・運用変更案
        • 375 Re3:ヘルプソースの管理・運用変更案
          • 376 Re4:ヘルプソースの管理・運用変更案
            • 377 Re5:ヘルプソースの管理・運用変更案
              • 378 Re6:ヘルプソースの管理・運用変更案
              • 379 Re6:ヘルプソースの管理・運用変更案
                • 381 Re7:ヘルプソースの管理・運用変更案
                  • 384 Re8:ヘルプソースの管理・運用変更案
                    • 385 Re9:ヘルプソースの管理・運用変更案
                    • 391 Re9:ヘルプソースの管理・運用変更案
                      • 393 Re10:ヘルプソースの管理・運用変更案
      • 386 インストーラのソース

  • [353] ヘルプソースの管理・運用変更案 maru 2007年09月30日 22:47

    今回はヘルプソースにHTML workshopのプロジェクト形式である*.hhp, *.hhc, *.hhkを含めました。(従来は中間ファイルの扱いでした)
    いままで使っていたヘルプましんのUIは何かと便利ですが、機能上の制限が運用方針に適さないところがいくつかあり、メンテナンスが面倒です。

    今後、ヘルプソースの取り扱いをHTML workshopの形式に変更したいと考えておりますので、ご意見などあればお願いします。期限は1.6.0.1リリースまでとします。

    HTML workshopでの管理への変更にあたり
    ■メリット
    ・画像以外はすべてテキストなので変更を管理しやすい
    ・特にヘルプのメニューツリーの変更もhhcの差分を見れば分かる
    ・HTML workshopだけあればコンパイルできる
    ・CHMの持つ機能のすべてを活用できる
    ・ヘルプマシンがもつ相対パスなどの問題に対するローカルルールは基本的に不要

    ■デメリット
    ・hhcを編集保存するとマージファイル指定の記述が壊れる
    ・英語

    *.hhcはHTML workshopから編集保存してはいけない、という前提ルールを守ることとして、*.hhcファイルはエディタで編集する方針で進めたいと思っています。
    特にご指摘など無ければ次回より*.XHPと*.XHCを削除します。

    • [369] Re:ヘルプソースの管理・運用変更案 novice 2007年10月07日 03:07

      ▼ maruさん
      > 今後、ヘルプソースの取り扱いをHTML workshopの形式に変更したいと考えておりますので、ご意見などあればお願いします。期限は1.6.0.1リリースまでとします。

      昔のことなのであまり記憶にないのですが、
      WinHelp→HTML Helpへ移行するときに
      ヘルプましんを導入したような気がします。

      たぶん、ヘルプましんが生成する中間ファイルを
      何もないところから作るのが大変だったから
      というのが理由のような気がします。

      ということで、HTML workshopの管理で
      問題ないと思います。

    • [371] Re:ヘルプソースの管理・運用変更案 じゅうじ 2007年10月07日 14:29

      ▼ maruさん
      > 今回はヘルプソースにHTML workshopのプロジェクト形式である*.hhp, *.hhc, *.hhkを含めました。(従来は中間ファイルの扱いでした)
      > いままで使っていたヘルプましんのUIは何かと便利ですが、機能上の制限が運用方針に適さないところがいくつかあり、メンテナンスが面倒です。
      >
      > 今後、ヘルプソースの取り扱いをHTML workshopの形式に変更したいと考えておりますので、ご意見などあればお願いします。期限は1.6.0.1リリースまでとします。
      >
      > *.hhcはHTML workshopから編集保存してはいけない、という前提ルールを守ることとして、*.hhcファイルはエディタで編集する方針で進めたいと思っています。
      > 特にご指摘など無ければ次回より*.XHPと*.XHCを削除します。

      hhp,hhc,hhkを追加するのは賛成です、削除するのは反対です。
      中間ファイルをメインにすると、前以上に面倒にならないか、の問題です。
      ・ヘルプマシンを使う場合で、SAKURA.HHPの[HERGE]指定での、絶対パスを削除する以外の手間には何が有りますか？
      　それから、SAKURA.XHPのパス指定を削除する手間。
      ・HTML WorkShop のUIを使うと駄目なら、ヘルプましんで修正しても駄目なのではないですか？しかし、現行では修正出来ますが、それは、HTML WorkShop だけの問題では。

      所で、インストーラ(sinst*.exe)のソースは公開されてませんね。

      • [374] Re2:ヘルプソースの管理・運用変更案 maru 2007年10月07日 18:39

        ▼ じゅうじさん
        念のための確認ですが、中間ファイルと表現しているのは、ヘルプましんから見れば中間ファイルですが、本来の姿（HTML Workshop）ではプロジェクトファイル本体や目次ファイルなど（hhp,hhc,hhk）のことを指しているつもりです。
        そして、hhp,hhc,hhkの追加の件は「HTML Workshopだけのユーザーでもコンパイルできるように」の意味よりは、「ヘルプましんは管理しにくいから離脱したい」の意味が強く、どちらかというとヘルプ作成者側の都合です。
        作業感覚的には、これまでHTMLWorkshopのフロントエンドがヘルプましんだったものを、今度からテキストエディタ(普通はサクラエディタ)に変更しよう、という話です。
        ここまでは、お互いの認識は合っていますよね？

        さて本題ですが、以前の書き込みではWorkshop側のメリット・デメリットだけを列挙したので、主張が分かりにくかったかもしれません。

        ■ヘルプましんで管理するデメリット
        １．コンパイルにはHTMLWorkshopとヘルプましんの２つのソフトが必要。
        ２．HTMLWorkshopに比べて、インストールされた環境が限定される。
        ３．コンテンツツリーがバイナリで保存されているので、変更点がわかりにくい。
        ４．コンテンツツリーがバイナリで保存されているので、パッチ配布できない。
        ５．コンテンツツリーがバイナリで保存されているので、別々の修正をマージできない。
        ６．コンパイル前には、hhp内のパス指定を修正しなければならない
        ７．６の理由により、リリースファイルのコンパイルは２段階の作業になってしまう。
        ８．ソース配布前には、XHP内のパス指定を修正しなければならない
        ９．７と８の理由により、７の作業でコンパイルの動作確認済みのソースはそのまま配布できず、コンパイル実施前の状態を別途保持しておかなければならない。
        10．９の理由からリリース直前の細かい修正にはバージョン管理が煩雑になるが、６や８の作業が抜けても気が付きにくい。

        ■ヘルプましんで管理するメリット
        １．UIが日本語
        ２．ヘルプましんからコンテンツツリー構造を変更・保存してもmerge指定が壊れない

        といった状況です。
        ヘルプましんの方がリリースにいたるまでのローカルルールが多くて、SVNでの管理にも不向き、というのが主な提案理由です。

        > hhp,hhc,hhkを追加するのは賛成です、削除するのは反対です。
        ヘルプましんとWorkshopの両サポートという意味でしょうか。これは間違いなく前以上に面倒だと思うのですが。
        いずれの結論の場合も、最終的にはどちらか一方にさせてください(^^;;

        • [375] Re3:ヘルプソースの管理・運用変更案 じゅうじ 2007年10月07日 20:09

          ▼ maruさん
          > > hhp,hhc,hhkを追加するのは賛成です、削除するのは反対です。
          > ヘルプましんとWorkshopの両サポートという意味でしょうか。これは間違いなく前以上に面倒だと思うのですが。
          > いずれの結論の場合も、最終的にはどちらか一方にさせてください(^^;;

          いいえ、これは、コンパイル後の中間ファイルも公開しましょうと言うことで、そうすればヘルプましんの出力が変わっても分かるという意味です。
          バイナリーファイルでもヘルプましんでUI出来る訳ですから、SVNで管理出来ないと言う訳は無いと思ったのですが。
          HELP WorkShopのUIが使用できないと言うのが主な理由です。

          • [376] Re4:ヘルプソースの管理・運用変更案 maru 2007年10月07日 21:51

            >いいえ、これは、コンパイル後の中間ファイルも公開しましょうと言うことで、そうすればヘルプましんの出力が変わっても分かるという意味です。
            >バイナリーファイルでもヘルプましんでUI出来る訳ですから、SVNで管理出来ないと言う訳は無いと思ったのですが。
            う～ん、おっしゃることは理解できましたが、これだけでは私的には旨みがないですね・・・。

            >HELP WorkShopのUIが使用できないと言うのが主な理由です。
            えっと、まったく使えないわけではなく、一番最後の</UL>が変なところに挿入されてしまうのです。mergeの指定が<UL></UL>の内側に入ってしまいます。
            もしコンテンツツリーの編集をWorkshopで行う場合は、最後の<UL>を修正する作業を追加すれば解決します。
            そういうことであれば、Workshopでの編集＋UL修正、という運用でも私は構いませんので、やはりヘルプましんからの離脱を推進したいのですが、いかがですか。

            理由は前回書き込みのデメリット４～９のためです。

            • [377] Re5:ヘルプソースの管理・運用変更案 じゅうじ 2007年10月08日 12:26

              ▼ maruさん
              > ■ヘルプましんで管理するデメリット
              > ３．コンテンツツリーがバイナリで保存されているので、変更点がわかりにくい。
              > ４．コンテンツツリーがバイナリで保存されているので、パッチ配布できない。
              > ５．コンテンツツリーがバイナリで保存されているので、別々の修正をマージできない。
              > ６．コンパイル前には、hhp内のパス指定を修正しなければならない
              > ８．ソース配布前には、XHP内のパス指定を修正しなければならない
              >
              > ■ヘルプましんで管理するメリット
              > １．UIが日本語
              > ２．ヘルプましんからコンテンツツリー構造を変更・保存してもmerge指定が壊れない

              Ａ. HTML HELP Workshop で管理するメリット
              １．Wikiサイトの管理との関連で、ヘルプましんのGUIは使いたくない、3と4が主な理由。
              ２．リリース時の手間の問題で、ヘルプましんのXHP,HHPは使いたくない、6と8が主な理由。

              Ｂ. HTML HELP Workshopで管理するデメリット
              １．GUIからCUIに移行する(GUIが英語で使い方が難しい)
              ２．GUIからコンテンツツリー構造を変更・保存するとmerge指定が壊れる

              まとめるとこんな感じでしょうか、私はテキストのXHPも,バイナリーのXHCも更新出来れば更新を続けて欲しいと思います。

              さて、HHPについてです。
              リリースや、パッチにXHP,XHCは含めないという事でしたら、
              毎回ヘルプましんのGUI出力ファイルを使う、Ｂ２の問題の為、HTML HELP Workshop のGUI出力ファイルは使わない。
              （提供は出来ないが、XHP,XHCは何時でも手元に有るという状態）
              Ａ２以外、テキストファイルを直接編集しなくても良くなります。

              • [378] Re6:ヘルプソースの管理・運用変更案 maru 2007年10月08日 19:43

                >リリースや、パッチにXHP,XHCは含めないという事でしたら、
                ちょっと違います。「（サクラエディタのヘルプ作成において）ヘルプましんは作業性が悪いから使いたくない」です。

                >（提供は出来ないが、XHP,XHCは何時でも手元に有るという状態）
                これまた厳しいリクエストで・・・(^^;;
                別件で Document/コンテンツツリー にパッチをアップされていらっしゃいますが、これをXHCに反映するのはかなり面倒なはずです。
                手順としては
                １．XHP,XHCからhhcを作成
                ２．hhcにパッチをあてる
                ３．新しいhhc「Workshopプロジェクトの取り込み」でXHCに吸い上げる
                ４．ヘルプましんが解釈できない部分(アンカーネームなど)を元ファイルを見ながら目視・手修正
                のようなプロセスになるかと思います。
                「XHP,XHCは何時でも手元に有る」というのは、そういう意味（パッチ提供を受けたらXHCを更新できることを保証する）ですよね？

                >テキストファイルを直接編集しなくても良くなります。
                あれ？直接テキストを編集したほうが手軽だと思うのですが。
                ちょっとした修正のためだけに、いちいち関連ファイルを改変されると、それを元に戻すオーバーヘッドがものすごく無駄に思えてくるのです。
                まあ、これは個人の好みに左右されますが。ヘルプましんではグラフィカルなインターフェィスしか利用できないのに対して、Workshopではグラフィカルなインターフェィスまたはテキストの直接編集どちらでもユーザーは好きなほうを選べるのです。これって素敵だと思いませんか？

              • [379] Re6:ヘルプソースの管理・運用変更案 AC 2007年10月08日 20:10

                全部管理するのが理想。
                そんなリソースはないというのが現実。

                • [381] Re7:ヘルプソースの管理・運用変更案 じゅうじ 2007年10月08日 23:36

                  ▼ ACさん
                  > 全部管理するのが理想。
                  > そんなリソースはないというのが現実。

                  　ツールを何にするかで揉めています。
                  この様子だと、ヘルプましんは使えなく（サクラエディタでは使用禁止）なりそうです。
                  しかし、よく見ると、ヘルプリリース1.6.0.0のhhcがHTML Workshopの出力と微妙に異なります。
                  新規作成は、HTML Workshop以外の何かのツールで、既に終わってるようなのです。

                  #このHELP Documentスレって上がらないですね。

                  • [384] Re8:ヘルプソースの管理・運用変更案 AC 2007年10月09日 19:48

                    ヘルプましんに固執する理由がわかりません。

                    今は問題があるけど、改善されれば使えるというのであれ
                    ば、ヘルプましん作者に改善要望を出してみてはいかがで
                    しょうか。

                    • [385] Re9:ヘルプソースの管理・運用変更案 じゅうじ 2007年10月09日 21:03

                      ▼ ACさん
                      > ヘルプましんに固執する理由がわかりません。

                      ヘルプましんを使った場合、具体的には出力されるHHPファイルにフルパスが含まれる事です。
                      HHPファイルは、HELP Workshopの入力となる、テキストファイルですから、エディタでそのフルパスを削除すれば使えます。
                      後、ヘルプましんは操作がGUIのみで、使い方を覚えなければいけないんですが...。
                      私は、HELP WorkshopのGUIが日本語でも全然分からないので、後残るは hhp,hhc,hhk をエディタで直接編集するしか無い訳で、それはかなり面倒だと思います。
                      HTML Workshopにするという事であれば、固執していません。

                    • [391] Re9:ヘルプソースの管理・運用変更案 AC 2007年10月10日 21:15

                      ヘルプましんのHP見てきたんですけど、
                      放置プレー状態ですね。
                      （改善要望は無理っぽい

                      • [393] Re10:ヘルプソースの管理・運用変更案 maru 2007年10月10日 23:29

                        >ヘルプましんのHP見てきたんですけど、
                        >放置プレー状態ですね。
                        そうなんですよ(涙)
                        いくつかの要望に対しては前向きなコメントをいただいたのですが、更新される気配の無いまま１年が経過・・・。
                        良いソフトなのに、ほぼ開発休止中といった感じで残念です。

      • [386] インストーラのソース げんた 2007年10月09日 21:46

        ▼じゅうじさん
        >インストーラ(sinst*.exe)のソースは公開されてませんね。
        次回インストーラ用に見直した物は，こちらにあります．
        http://sakura-editor.wiki.sourceforge.net/Installer

        昔の物はこちらにあります．
        http://groups.yahoo.co.jp/group/sakura-editor/files/Developer/installer/