Wptscs/Readme.txt

   1 =====================================================================
   2 【タイトル】 Wikipedia 翻訳支援ツール
   3 【ファイル】 wptscs130.msi, wptscs130.zip, wptscs130-src.zip
   4 【作成月日】 2013/3/xx
   5 【制 作 者】 Honeplus
   6 【動作環境】 Windows 8 での動作を確認。要.NET Framework 4.0 Client Profile または 4.5
   7 【配布形態】 修正BSDライセンス
   8 【HomePage】 http://sourceforge.jp/projects/wptscs/
   9 =====================================================================
  10
  11 ・概要
  12 Wikipediaでの言語間翻訳をサポートするためのツールです。
  13 指定されたWikipediaの記事に存在する内部リンク先を確認し、その言語間リンクを取得します。
  14 また、登録されていれば、見出しも変換します。
  15
  16 同じくMediaWikiを使用している Wiktionary, Wikivoyage においても使用可能です。
  17
  18
  19
  20 ・インストール方法
  21 インストーラ版の場合は画面の指示に従いインストールを進めてください。
  22 zip版の場合は、適当なフォルダに展開してください。
  23 展開して出てくる以下のファイルが、最低限必要なファイルです。他は消しても問題ありません。
  24
  25 wptscs.exe              : 実行ファイル
  26 ja/wptscs.resources.dll : 日本語リソースdll
  27 hmlib.dll               : 共通ライブラリdll
  28 wptscs.exe.config       : デフォルト値やプログラム的な設定ファイル
  29 Wikipedia.xml           : Wikipedia用の設定ファイル
  30 Wikivoyage.xml          : Wikivoyage用の設定ファイル
  31 Wiktionary.xml          : Wiktionary用の設定ファイル
  32
  33 アプリケーション上で設定した内容は、上記設定ファイルには反映されません。
  34 ユーザーごとのフォルダに出力されます。
  35 設定ファイルを直接修正、または削除して初期値に戻したい場合は、
  36 下記のようなパスにあるファイルを更新してください（以下はWindows 8の例）。
  37
  38 C:\Users\[ユーザー名]\AppData\Roaming\Honememo\Wikipedia 翻訳支援ツール\[バージョン番号]\config.xml
  39 C:\Users\[ユーザー名]\AppData\Local\Honememo\wptscs.exe_[～]\[バージョン番号]\user.config
  40
  41
  42
  43 ・アンインストール方法
  44 インストーラ版の場合はコントロールパネルからのアンインストールを、
  45 zip版の場合は展開したファイルを削除してください。
  46 また、必要なら上記設定ファイルも削除してください。
  47
  48
  49
  50 ・使い方
  51 翻訳元／先言語と、処理結果の出力先フォルダを指定してから、翻訳したい翻訳元記事名を入力して実行してください。
  52
  53 設定画面については、通常は触る必要はないです。
  54 言語間リンクが貼られていない記事の対応パターン登録や、キャッシュの確認、
  55 言語コードの登録や、見出しの変換パターンの設定ができます。
  56 設定の内容などは、ツールチップと既存の値を見れば概要はつかめるのではないかと思います。
  57
  58 なお、このプログラムはあくまで「翻訳支援ツール」です。
  59 出力された文章は、その後Wikipediaの編集画面やプレビューなりで本格的に修正されることを前提としています。
  60 間違っても、そのままWikipediaに投稿するなどしないでください。
  61 また、当プログラムではWikipediaへの書き込みは一切行いません。
  62
  63 ※ 特にテンプレート等の複雑な書式の記事で使用した場合、一部が正常に処理されない可能性があります。
  64    これらの記事で使用する際は、処理結果に異常が無いか注意しながらご利用ください。
  65
  66
  67
  68 ・処理結果の詳細
  69 処理結果として、実行ログと記事テキストの内部リンク等を置き換えたものを出力します。
  70
  71 記事テキストの置き換えについては、下記のようなルールで実行しています。
  72 （以下、英語版→日本語版で適当な記事を例に）
  73
  74 例）[[Japan]]
  75
  76 言語間リンクがある場合    →  [[日本|Japan]]
  77 言語間リンクがない場合    →  [[:en:Japan|Japan]]
  78 ない場合で仮リンクが有効  →  {{仮リンク|Japan|en|Japan|label=Japan}}
  79 英語版も赤リンクの場合    →  [[Japan]]
  80
  81 例）[[Japan|Nihon]]
  82
  83 言語間リンクがある場合    →  [[日本|Nihon]]
  84 言語間リンクがない場合    →  [[:en:Japan|Nihon]]
  85 ない場合で仮リンクが有効  →  {{仮リンク|Japan|en|Japan|label=Nihon}}
  86 英語版も赤リンクの場合    →  [[Japan|Nihon]]
  87
  88 例）[[Category:Japan|sortkey]]
  89
  90 言語間リンクがある場合    →  [[Category:日本|sortkey]]
  91 言語間リンクがない場合    →  [[:en:Category:Japan]]<!-- [[Category:Japan|sortkey]] -->
  92 英語版も赤リンクの場合    →  [[Category:Japan|sortkey]]
  93
  94 例）{{Citation needed|date=January 2012}}
  95
  96 言語間リンクがある場合    →  {{要出典|date=January 2012}}
  97 言語間リンクがない場合    →  [[:en:Template:Citation needed]]<!-- {{Citation needed|date=January 2012}} -->
  98 英語版も赤リンクの場合    →  {{Citation needed|date=January 2012}}
  99
 100 例）==History==
 101
 102 見出し変換表に登録あり    →  ==歴史==
 103 見出し変換表に登録なし    →  ==History==
 104
 105
 106
 107 ・ソースについて
 108 wptscs130-src.zip としてソースファイル一式を配布しています。
 109 開発環境はVisual Studio 2012 Express for Windows Desktopです。
 110 その他外部ツールとしてコーディングスタイルチェック用のStyleCopを使用しています。
 111 また、インストーラの作成にはWiXを使用しています。
 112
 113
 114
 115 ・ライセンスについて
 116 このプログラムは修正BSDライセンスに基づいたフリーソフトウェアで、無保証です。
 117 このプログラムを利用して何らかの被害をこうむっても、作者は一切責任を負いません。
 118 またサポートする保証もありません。
 119 このプログラムの変更・再配布・流用はご自由にどうぞ。
 120
 121
 122 また、ソース中にテストデータとしてWikipedia/Wiktionaryより取得したXMLを同梱しています。
 123 これらファイル内の著作物の扱いについては、Wikipedia/Wiktionaryのライセンスに従ってください。
 124
 125
 126
 127 ・更新履歴
 128 Ver0.80  2010/09/18 開発環境／言語をVisual Studio 2005のC++/CLI→Visual C# 2010 Expressに移行。
 129                     ソースも全面的に見直し（ただし現在は古いコードが多々残った状態）。
 130                     設定画面を全体的に変更。記事の対応パターンを登録できるよう対応。
 131                     キャッシュ状況も見えるように変更。
 132
 133 Ver0.90  2010/09/27 Template:Documentationが使われているページに対応。
 134                     無駄に遅くなっていた処理を改善。その他細かい部分を改良／修正。
 135
 136 Ver1.00  2011/04/22 Wikipediaのバージョンアップごとに設定ファイルを直さなくて済むよう対処。
 137                     無駄に遅くなっていた処理を改善。
 138                     設定画面のツールチップや入力値チェックを整備。
 139                     [[ファイル:～]]→[[File:～]]も変換するよう対応。
 140                     [[Apollo&nbsp;17]]のように特殊文字が入っているリンクを処理できるよう修正。
 141                     HTMLタグの解析で正規表現の構文エラーになる可能性があったのを修正。
 142                     config.xmlの日英以外の言語の設定を精査・補填。
 143
 144 Ver1.01  2011/10/05 MediaWikiのバージョンアップに伴いAPIの仕様が変わったため対応。
 145
 146 Ver1.10  2012/01/30 ソースの全体的なリファクタリングを実施。
 147                     言語間リンクが無い記事の{{仮リンク}}への置き換えに対応。
 148                     {{Doc}}→{{Documentation}}のリダイレクトとインラインコンテンツに対応。
 149                     .net framework 4 フル版でなく Client Profile で動作するよう改善。
 150                     処理状況をステータスバーに表示するよう変更。
 151                     各種設定の文字列埋め込みを{0}から$1形式に変更。
 152                     [[File:～|]]のコメント部分を処理対象とするよう対応。
 153                     キャッシュ済みテンプレートの処理時に余分な通信をしていたのを修正。
 154                     [[Help:条件文]]の関数をテンプレートとして処理しようとしてしまっていたのを修正。
 155                     初期設定を若干追加。
 156                     配布元をSourceForge.JPに移転。
 157                     ※ 処理の見直しも行っているため、上記以外の細かい部分の動作にも変更が生じているはずです。
 158                     ※ 1.01とは設定ファイルの互換性がありません。
 159
 160 Ver1.11  2012/02/19 英語リソースの追加（ツールチップは除く）。
 161                     表示言語の切り替え機能を追加。
 162                     記事名にコロンを含むページが正しく処理できない問題を修正。
 163                     ..形式の相対リンクのサブページが処理できない問題を修正。
 164                     メイン画面の言語プルダウンに存在しないコードを手入力するとエラーになる問題を修正。
 165                     設定画面をキャンセルした際も言語タブの設定だけ更新されてしまっていたのを修正。
 166                     設定画面で言語を追加する際のインタフェースが分かりにくかったのを改善。
 167                     その他画面表示周りを中心に小不具合を修正。
 168                     変換後テキストの冒頭の元言語を{{Lang}}で囲むよう改善。
 169                     通信エラー時にリトライする仕組みを追加。
 170                     未解決の既知の不具合について、警告等を表示するよう暫定対応。
 171                     トランスレータ周りのソース中心にリファクタリングを実施。
 172                     ※ 1.10とは設定ファイルの互換性がありません。
 173
 174 Ver1.20  2012/03/10 Wiktionary/Wikitravelでの動作に対応。
 175                     設定の切り替え／追加機能を追加。
 176                     言語間リンク取得時に<includeonly>, <noinclude>, <onlyinclude>を考慮するよう修正。
 177                     見出しの置き換えに改行区切りで複数の語句を登録できるよう改良。
 178                     非常に複雑なテンプレートで極端に時間がかかっていたのを改善。
 179                     サーバーへのアクセス時に自動でRefererを設定するよう変更。
 180                     UserAgentを英語アプリ名にあわせたものに変更。
 181                     その他ソースの改善／小不具合を修正。
 182                     ※ 1.11とは設定ファイル名が変化しており、古い設定は自動で読み込まれません。
 183                     ※ Wikitravelは、サーバーにアクセスできる状態でもping失敗でエラーとなることがあります。
 184                        その場合、設定画面で「エラーを可能な限り無視して続行する」をチェックして再実行してください。
 185                     ※ 本バージョンから、インストーラ版での配布を開始しました。
 186                        また、ソースの配布も本体とは別に行うよう変更しています。
 187
 188 Ver1.21  2012/12/09 記事名が空の不正なテンプレート呼び出しで処理が落ちていたのを修正。
 189                     記事名の末尾がハテナマークの場合に警告を出すよう修正。
 190                     テンプレート名の後にコメント等が入っている場合にエラーになるのを修正。
 191                     ※ 本バージョンから、開発環境がVisual Studio 2010→2012へと変化しています。
 192                        特に影響は無いはずですが、何らかの問題が生じた場合はお知らせください。
 193
 194 Ver1.30  2013/03/xx 言語間リンクの取得を自前の解析処理を使わずMediaWikiのAPIを使用して行うよう変更。
 195                     記事名がピリオドやハテナマークで終わるページも扱えるよう対応。
 196                     変数の処理でエラーになるパターンがあったのを修正。
 197                     MediaWiki APIが無効化されていたのでWikitravel対応を取り止め。
 198                     代わりにWikivoyageの対応を追加（ただしまだ日本語版は無し）。
 199                     その他設定ファイルを精査。
 200                     ※ 設定ファイルに互換性はありますが、一部設定項目の変更・追加・削除が発生しています。
 201                        独自の設定を追加している場合、変更が必要になる可能性があります。
 202
 203
 204 ・仕様上の制限
 205 キャッシュの一覧で一度に大量の項目を削除すると、フリーズしたかのように時間がかかります。
 206 上記については、該当する処理に関連する部分に警告メッセージを表示しています。
 207
 208 その他、Wikipedia上言語間リンクが存在しても、現行のアプリでは見つけられないページもあります。
 209 （例、何故かAPIに言語間リンクが反ってこない{{Lang-la}}）
 210 これらについては対応できない特殊ケースとして、設定→記事の置き換えに変換パターンを初期設定しています。