サクラエディタドキュメント開発掲示板

[382] ヘルプ運用変更案その２

▽ 2007/10/9 (火) 03:02:49 ▽ maru

▼ じゅうじさん
>#このHELP Documentスレって上がらないですね。
あげました(笑)
というか深くなってきたので、そのついでに。

>新規作成は、HTML Workshop以外の何かのツールで、既に終わってるようなのです。
そんなことないですよ。svn#1129以降にコミットしたhhcはすべて、一旦ヘルプましんを通したものですから。
なので、現時点でのソースマスターは正真正銘ヘルプましんです。

ただし、ヘルプましんの生成するhhcは、HTML workshopの出力とかなり似ていますが微妙に異なっていて、ネストの深さに対してインデントの深さが一致しないという問題があります。
それらをすべて修正し、ついでにテキストベースで管理しやすいように<UL></UL>内の構造を変えています。
タイトルとファイル名が１行に表示されたほうがGrepで追いかけやすいので便利でしょ？
変更点を漏れなく反映させるために、こういった手段は欲しかったりします。

関連事項 >>help:345

>ヘルプリリース1.6.0.0のhhcがHTML Workshopの出力と微妙に異なります。
前述の説明にありますが、確かにこれはご指摘の通りです。
よって、ヘルプましんの出力とWorkshopの出力のいずれとも異なる第３のファイル形式です。
metaタグのGENERATORをsakura editorに変更して地味に主張しています(^^)

ところで、自分でヘルプをコンパイルして自家製ヘルプを作成する人ってどのくらいいるのでしょうか。
パッチの交換が難しいヘルプましんにおいては、共同作業に起因する運用統一の問題はあまり気にしなくて良いでしょうから、運用を変更して問題が出るのは自家製ヘルプを作っている人だけだと思うのです。
なんとなく大昔の記憶を含めて推察すると、じゅうじさんは自家製ヘルプを作ってそうですが、もし自家製ヘルプを作っていらっしゃるなら、参考までに何を変えているのか教えていただけませんか？

[383] Re:ヘルプ運用変更案その２

▽ 2007/10/9 (火) 07:16:46 ▽ じゅうじ

▼ maruさん
> パッチの交換が難しいヘルプましんにおいては、共同作業に起因する運用統一の問題はあまり気にしなくて良いでしょうから、運用を変更して問題が出るのは自家製ヘルプを作っている人だけだと思うのです。
> なんとなく大昔の記憶を含めて推察すると、じゅうじさんは自家製ヘルプを作ってそうですが、もし自家製ヘルプを作っていらっしゃるなら、参考までに何を変えているのか教えていただけませんか？

hhcについてです。
maruさんのなさろうとしている事が分からなくなってます。
また、ヘルプましんに話が戻って恐縮ですが、
ヘルプましんの出力hhcも、HTML Workshopの出力hhcも要するに
(編集が必要なので)使わないのですか？
私は、noviceさんの発言ではヘルプましんの出力hhcだと受け取っていました。
ヘルプましん出力とのdiff,HELP Workshop出力とのdiff,最新SVNとのdiff、合計3種類のdiffが作れます。
XHP,XHCを削除した場合でも、2種類です。
編集：HHPファイルのフルパス削除、hhcファイル最後の</UL>削除の事。

私が持っている、sakura.chm との事ですが、特に有りません。
> 別件で Document/コンテンツツリーにパッチをアップされていらっしゃいますが、これをXHCに反映するのはかなり面倒なはずです。
> 手順としては
>>help:373

svn#1129は、私全く見ていませんが、1.6.0.0 svn#1137のXHPは、Wiki Document/の方に書きましたが、１カ所逆になっています。

[388] Re2:ヘルプ運用変更案その２

▽ 2007/10/10 (水) 01:58:54 ▽ maru

▼ じゅうじさん
>maruさんのなさろうとしている事が分からなくなってます。
>ヘルプましんの出力hhcも、HTML Workshopの出力hhcも要するに
>(編集が必要なので)使わないのですか？

はじめの書き込みから一貫してそう主張しているつもりですが、分かりにくい？

>>help:353
>>*.hhcファイルはエディタで編集する方針で進めたいと思っています。

>>help:374
>>これまでHTMLWorkshopのフロントエンドがヘルプましんだったものを、今度からテキストエディタ(普通はサクラエディタ)に変更しよう、という話です。

>>help:378
>>直接テキストを編集したほうが手軽だと思うのですが。

>>help:382
>>ヘルプましんの出力とWorkshopの出力のいずれとも異なる第３のファイル形式です。metaタグのGENERATORをsakura editorに変更して地味に主張しています(^^)

>>help:345
>>ただ、hhcをエディタで編集してしまえば何の問題も起こらないので

で、妥協案が>>help:376のULの修正のみテキストエディタ、という話です。
>>Workshopで編集＋UL修正、という運用でも私は構いませんので、やはりヘルプましんからの離脱を推進したい

>私が持っている、sakura.chm との事ですが、特に有りません。
>> 別件で Document/コンテンツツリーにパッチをアップされていらっしゃいますが、これをXHCに反映するのはかなり面倒なはずです。
>> 手順としては
> >>help:373
それは分かっています。私が言いたいのは、ヘルプのバグを発見した人が自分の修正内容を提供する手段がないということです。
せっかくじゅうじさんが修正されても、その成果物を本流にフィードバックできないのはデメリットだと思いませんか？

>1.6.0.0 svn#1137のXHPは、～(略)～１カ所逆になっています。
リンク先との関係は合っているので、このくらいは許してあげて(^^;;

>もし自家製ヘルプを作っていらっしゃるなら、参考までに何を変えているのか教えていただけませんか？
じゅうじさんが自家製ヘルプをつくっていらっしゃるなら、その変更点を本流のヘルプに吸収すれば皆幸せかと思ったのですが、そういう次元ではない？

>エディタで直接編集するしか無い訳で、それはかなり面倒だと思います。
今回の提案の目的はメンテナンスの軽量化であり、私の場合直接編集するのが一番軽いので直接編集の運用を最初に希望したわけですが、かえって面倒だとする意見が出たため、それを標準化するのはあきらめます。

～続く～

[389] Re3:ヘルプ運用変更案その２

▽ 2007/10/10 (水) 02:00:01 ▽ maru

>>help:376の妥協案をベースに運用ルール案をまとめました。
コミット前の新機能なパッチが並んできたので、そろそろ1.6.0.1に照準を合わせたい(汗)

１．ヘルプのリリースにあたり、リリース担当者はヘルプましん or Workshopのどちらの形式を使っても良いものとする。

２．workshopでリリースする者は、ヘルプましん形式のファイルを保持・保証する責務を負わない。

３．workshopでの作業の場合、HTML helpの仕様の範囲内でその機能を利用することに制限はないものとする。(ヘルプましんがサポートしている機能かどうかを確認しなくてよい。)

４．workshopでの作業の場合、テキストの直接編集 or Workshopでの編集のどちらで行っても良いこととする。

５．リリース担当者がworkshopの利用者とは限らないので、差分の提供を受け付けるかどうかはリリース担当者の判断とする。

６．リリース担当者が差分の提供を受け付ける場合、提供者はSVN差分(推奨)もしくはdiff差分により行うものとする。

７．差分以外の提供方式(ファイル丸ごとなど)の場合は、当人同士の了解で適宜対応のこと。

８．Workshop編集でのUL位置や、ヘルプましんでの絶対パスについては、リリース担当者の責任で修正のこと。

９．ヘルプのコミットにあたり、上記１～４に準ずる。

[390] ngはヘルプましん形式のXHP,XHCですよね？

▽ 2007/10/10 (水) 19:31:01 ▽ じゅうじ

▼ maruさん
話をまとめると、ファイル形式には、次の種類が有りますね。
1.ヘルプましん入力 XHP,XHC
2.ヘルプましん出力 HHP,hhc,hhk
3.HTML Workshop出力 hhp,hhc,hhk
4.svnエディタ修正 hhp,hhc,hhk

提供するのは、最初は1.が駄目という話でしたが、結論は2.が駄目でした？
理由は、2.を作る為には1.の入力ファイルが不可欠であり、1.の提供とイコールな為。

4.が受け入れられる理由は、HTML Workshopに入力して、3.と差分比較出来る為。
あれ？ 2.であっても、HTML Workshopに入力して、3.と差分比較出来ますね？直接比較は出来ませんが。

Document/「カスタムメニュー」... の diff_20071009.txt は差分ですが、全体のファイル3個と、削除する_RESOURCEの一覧ではない方が良いですね。

>>もし自家製ヘルプを作っていらっしゃるなら、参考までに何を変えているのか教えていただけませんか？
>じゅうじさんが自家製ヘルプをつくっていらっしゃるなら、その変更点を本流のヘルプに吸収すれば皆幸せかと思ったのですが、そういう次元ではない？
maruさん、ここに一緒に書いてしまいますが、私の使っているヘルプへのリンクです。
http://groups.yahoo.co.jp/group/sakura-editor/files/Developer/Help/

[392] RE: ngはヘルプましん形式のXHP,XHCですよね？

▽ 2007/10/10 (水) 23:16:18 ▽ maru

▼ じゅうじさん
>提供するのは、最初は1.が駄目という話でしたが、結論は2.が駄目でした？
結論から言えば、１～４すべてＯＫです。ただしこれは、あくまでルール上の話で、実際には運用上の自然な流れを経て、そこそこ一定の手段に絞られていくと予想しています。「1.の提供とイコールな為」などのような背景が、そのときのベクトルに大きく影響するからです。

また、そのように自然発生した暗黙のルール(のようなもの)は流動的であって良く、例えば、途中から別のタイプの出力に変遷していく可能性もあるでしょう。

ルール自体は、従来よりも大幅に制限が少なくなったと思っていただければ結構です。細かいところは運用を積み重ねながら・・・。

>・・・全体のファイル3個と、削除する_RESOURCEの一覧ではない方が良いですね。
すいません、ここは意味が分かりませんでした。

>maruさん、ここに一緒に書いてしまいますが、私の使っているヘルプへのリンクです。
>http://groups.yahoo.co.jp/group/sakura-editor/files/Developer/Help/
今もSakuraMacro.chmをお使いなのでしょうか。>>help:324に関連の書き込みがありますね・・・。
最新版(と言っても１年も前ですが)の http://sakura.qp.land.to/?Macro%2Fchm じゃ駄目なの？とも思いましたが、もしかしたら>>help:253を見過ごされているだけなのかも知れないので、一度ご確認いただけますか。

[394] Re2: ngはヘルプましん形式のXHP,XHCですよね？

▽ 2007/10/11 (木) 11:45:59 ▽ じゅうじ

▼ maruさん
[merge]指定に関して、macro.chm から ppa.chm を、改めて、過去削除されていたんですね。
こうゆう提案はどうでしょう？（私のPCでしているだけの話の可能性も）
sakura.chm →sakura.exeと同じフォルダ
+macro.chm →外部HTMLで指定
++ppa.chm →外部HTMLで指定したフォルダ
++script56.chm

#sakura.chmからppa.chmを削除して、macro.chmにppa.chmを戻す。
#メリットは、sakura.chm の画面表示がすっきりする。
#同じフォルダに全部のchmを置く場合でも、ppa.chm が二重にならない。

[395] Re3: ngはヘルプましん形式のXHP,XHCですよね？

▽ 2007/10/12 (金) 03:41:28 ▽ maru

>#sakura.chmからppa.chmを削除して、macro.chmにppa.chmを戻す。
>#メリットは、sakura.chm の画面表示がすっきりする。
>#同じフォルダに全部のchmを置く場合でも、ppa.chm が二重にならない。

なるほど。
確かにそういう方法もありかもしれませんが、「ppa.chm が二重にならない。」はすでに対策済みですから、それをわざわざ元に戻して、さらに設定も変更してまで「画面表示がすっきりする」を追求するほどのメリットには思えないのですが・・・。
ppa.chmを使っている全ユーザーに影響を与えるので、今になって変更するのは控えたほうがよいのでは？

[▼次のスレッド]

INCM/CMT
Cyclamen v3.81