ヘルプメンテナー向け

http://sakura.qp.land.to/?%A5%D8%A5%EB%A5%D7%A5%E1%A5%F3%A5%C6%A5%CA%A1%BC%B8%FE%A4%B1


Top > ヘルプメンテナー向け

ヘルプメンテナンスガイドライン

ヘルプファイルのメンテに参加いただける人向けに,ガイドライン案をまとめました.

ヘルプファイルソースについて

  • ヘルプのソースは次の理由により,ヘルプましん(うな氏)の形式で管理します.
    • MicrosoftのHTML Help Workshopで作成するHHPファイルにはバグがある.
    • ヘルプましん以外に使いやすいヘルプ作成ツールを見かけない.

修正や変更の配布

ファイル単位で差し替え

  • 更新が頻繁に発生するファイルは一部に限られているので,ファイル単位で差し替える運用でも,ほとんど問題は発生しないと思います.そもそもsakura.XHC*1や画像ファイルは差分配布できませんし.
    編集元ソースは http://sakura-editor.sourceforge.net/htmlhelp/ から持ってくるだけなので,お手軽です.

差分ファイルで配布

  • help/trunkの作業コピーをローカルに用意できる方なら,svn差分は簡単に作成できるでしょう.もしくはDiff差分とか.ただしバイナリの変更を伴う修正の場合は,無理に差分ファイルにこだわる必要はないと思います.

Subversion(コミット権限のある人)

  • サクラエディタ本体の開発と違い,ドキュメントのバグがクリティカルな障害を招くことも少ないでしょうから,いきなりコミットしても良いと思います.
    むしろ更新停滞するほうがデメリット (^^;
  • TortoiseSVNを使う人のためのconfig例です.

    [auto-props]

    *.hh = svn:eol-style=native;svn:mime-type=text/plain

    *.txt = svn:eol-style=native;svn:mime-type=text/plain

    *.png = svn:mime-type=image/png

    *.html = svn:eol-style=native;svn:mime-type=text/html

    *.css = svn:eol-style=native;svn:mime-type=text/css

    *.XHP = svn:eol-style=CRLF;svn:mime-type=text/plain

    *.XHC = svn:mime-type=application/octet-stream

配布方法

  • wikiのDocument
    • 編集したhtmlファイルやpngファイルをそのまま添付して頂いて結構です.もちろん差分ファイルも可です.
    • 画像ファイル,コンパイル済みサンプルなどでもOKです.とくに制限は考えておりません.
    • 新機能対応時のコンテンツのみの提供(wiki形式など)でも構いません.動作を確認して説明文をまとめていただけるだけでも,ずいぶん助かります.ついでに新機能レビューとしていち早くユーザーに紹介できるので,何かと便利.
  • sourceforge.netのpatches
    • 差分ファイルを投稿する場所ですから,あまりヘルプ開発向きではありませんが,修正の内容次第で各自判断とします.
    • 最低限ヘルプの修正であることが分かるようSummaryに明示してください.エディタ本体のソースコードの修正と紛らわしいので.

その他注意事項

  • いまのところ,画像ファイルは次のように統一しています.
    • ファイル形式:png
    • 色数:4bit(16色)
    • ウィンドウとボタン:Windows クラシック スタイル
    • 配色: Windows クラシック
    • フォントサイズ:標準
    • タイトルバーは"RGB=(0,0,128),グラデーションなし" でキャプチャする
  • ヘルプましんのプロジェクトファイル(*.XHP)は,開くだけで内容が書き換わります.プロジェクトファイル(*.XHP)やコンテンツファイル(*.XHC)のフルパスを記録しているためです.公開時は該当行を削除することをお勧めします.

*1 ヘルプマシンが取り扱うメニュー構造を保存するためのバイナリファイルです

リロード   新規 編集 凍結 差分 添付 複製 名前変更   ホーム 一覧 単語検索 最終更新 バックアップ リンク元   ヘルプ   最終更新のRSS
Last-modified: 2011-07-31 (日) 13:59:45 (2486d)