OSDN Git Service

#30840 不要になっていたTemplate:Documentation絡みの処理も除去,
[wptscs/wpts.git] / Wptscs / Readme.txt
index 2e601d5..6cf5de0 100644 (file)
@@ -1,9 +1,9 @@
 =====================================================================
 【タイトル】 Wikipedia 翻訳支援ツール
-【ファイル】 wptscs111.zip
-【作成月日】 2012/2/xx
+【ファイル】 wptscs130.msi, wptscs130.zip, wptscs130-src.zip
+【作成月日】 2013/3/xx
 【制 作 者】 Honeplus
-【動作環境】 Windows Vista/7 での動作を確認。要.NET Framework 4.0 Client Profile
+【動作環境】 Windows 8 での動作を確認。要.NET Framework 4.0 Client Profile または 4.5
 【配布形態】 修正BSDライセンス
 【HomePage】 http://sourceforge.jp/projects/wptscs/
 =====================================================================
@@ -13,21 +13,27 @@ Wikipediaでの言語間翻訳をサポートするためのツールです。
 指定されたWikipediaの記事に存在する内部リンク先を確認し、その言語間リンクを取得します。
 また、登録されていれば、見出しも変換します。
 
+同じくMediaWikiを使用している Wiktionary, Wikivoyage においても使用可能です。
+
 
 
 ・インストール方法
-適当なフォルダに展開してください。
+インストーラ版の場合は画面の指示に従いインストールを進めてください。
+zip版の場合は、適当なフォルダに展開してください。
 展開して出てくる以下のファイルが、最低限必要なファイルです。他は消しても問題ありません。
 
-wptscs.exe        : 実行ファイル
-hmlib.dll         : 実行に必要なdll
-wptscs.exe.config : デフォルト値やプログラム的な設定ファイル
-config.xml        : Wikipediaの各サーバーに関する設定ファイル
+wptscs.exe              : 実行ファイル
+ja/wptscs.resources.dll : 日本語リソースdll
+hmlib.dll               : 共通ライブラリdll
+wptscs.exe.config       : デフォルト値やプログラム的な設定ファイル
+Wikipedia.xml           : Wikipedia用の設定ファイル
+Wikivoyage.xml          : Wikivoyage用の設定ファイル
+Wiktionary.xml          : Wiktionary用の設定ファイル
 
 アプリケーション上で設定した内容は、上記設定ファイルには反映されません。
 ユーザーごとのフォルダに出力されます。
 設定ファイルを直接修正、または削除して初期値に戻したい場合は、
-下記のようなパスにあるファイルを更新してください(以下はVistaの例)。
+下記のようなパスにあるファイルを更新してください(以下はWindows 8の例)。
 
 C:\Users\[ユーザー名]\AppData\Roaming\Honememo\Wikipedia 翻訳支援ツール\[バージョン番号]\config.xml
 C:\Users\[ユーザー名]\AppData\Local\Honememo\wptscs.exe_[~]\[バージョン番号]\user.config
@@ -35,7 +41,9 @@ C:\Users\[ユーザー名]\AppData\Local\Honememo\wptscs.exe_[~]\[バージョ
 
 
 ・アンインストール方法
-展開したファイルと必要なら上記設定ファイルを削除してください。レジストリ等は一切いじりません。
+インストーラ版の場合はコントロールパネルからのアンインストールを、
+zip版の場合は展開したファイルを削除してください。
+また、必要なら上記設定ファイルも削除してください。
 
 
 
@@ -97,8 +105,10 @@ C:\Users\[ユーザー名]\AppData\Local\Honememo\wptscs.exe_[~]\[バージョ
 
 
 ・ソースについて
-src.zipにソースファイルをまとめています。開発環境はVisual C# 2010 Expressです。
-その他外部ツールとしてテスト自動化ツールのNUnitと、コーディングスタイルチェック用のStyleCopを使用しています。
+wptscs130-src.zip としてソースファイル一式を配布しています。
+開発環境はVisual Studio 2012 Express for Windows Desktopです。
+その他外部ツールとしてコーディングスタイルチェック用のStyleCopを使用しています。
+また、インストーラの作成にはWiXを使用しています。
 
 
 
@@ -109,8 +119,8 @@ src.zipにソースファイルをまとめています。開発環境はVisual
 このプログラムの変更・再配布・流用はご自由にどうぞ。
 
 
-また、ソース中にNUnitのテストデータとしてWikipediaより取得したXMLを同梱しています。
-これらファイル内の著作物の扱いについては、日本語版/英語版の各Wikipediaのライセンスに従ってください。
+また、ソース中にテストデータとしてWikipedia/Wiktionaryより取得したXMLを同梱しています。
+これらファイル内の著作物の扱いについては、Wikipedia/Wiktionaryのライセンスに従ってください。
 
 
 
@@ -147,29 +157,54 @@ Ver1.10  2012/01/30 ソースの全体的なリファクタリングを実施。
                     ※ 処理の見直しも行っているため、上記以外の細かい部分の動作にも変更が生じているはずです。
                     ※ 1.01とは設定ファイルの互換性がありません。
 
-Ver1.11  2012/02/xx メイン画面の言語プルダウンに存在しないコードを手入力するとエラーになる問題を修正。
+Ver1.11  2012/02/19 英語リソースの追加(ツールチップは除く)。
+                    表示言語の切り替え機能を追加。
+                    記事名にコロンを含むページが正しく処理できない問題を修正。
+                    ..形式の相対リンクのサブページが処理できない問題を修正。
+                    メイン画面の言語プルダウンに存在しないコードを手入力するとエラーになる問題を修正。
                     設定画面をキャンセルした際も言語タブの設定だけ更新されてしまっていたのを修正。
                     設定画面で言語を追加する際のインタフェースが分かりにくかったのを改善。
-                    その他画面表示関係の不具合を修正。
+                    その他画面表示周りを中心に小不具合を修正。
                     変換後テキストの冒頭の元言語を{{Lang}}で囲むよう改善。
                     通信エラー時にリトライする仕組みを追加。
                     未解決の既知の不具合について、警告等を表示するよう暫定対応。
                     トランスレータ周りのソース中心にリファクタリングを実施。
-
-
-
-・既知の不具合
-ピリオドで終わるページが取得できず、存在しないものとして扱われる。
-(例、[[Vulcan Inc.]])
-
-記事名にコロンを含むページが正しく処理できない。
-(例、[[Marathon 2: Durandal]])
-
-..形式の相対リンクのサブページが正しく処理できない。
-(例、[[../../サブページ]])
-
-キャッシュの一覧で一度に大量の項目を削除すると、フリーズしたかのように時間がかかる。
+                    ※ 1.10とは設定ファイルの互換性がありません。
+
+Ver1.20  2012/03/10 Wiktionary/Wikitravelでの動作に対応。
+                    設定の切り替え/追加機能を追加。
+                    言語間リンク取得時に<includeonly>, <noinclude>, <onlyinclude>を考慮するよう修正。
+                    見出しの置き換えに改行区切りで複数の語句を登録できるよう改良。
+                    非常に複雑なテンプレートで極端に時間がかかっていたのを改善。
+                    サーバーへのアクセス時に自動でRefererを設定するよう変更。
+                    UserAgentを英語アプリ名にあわせたものに変更。
+                    その他ソースの改善/小不具合を修正。
+                    ※ 1.11とは設定ファイル名が変化しており、古い設定は自動で読み込まれません。
+                    ※ Wikitravelは、サーバーにアクセスできる状態でもping失敗でエラーとなることがあります。
+                       その場合、設定画面で「エラーを可能な限り無視して続行する」をチェックして再実行してください。
+                    ※ 本バージョンから、インストーラ版での配布を開始しました。
+                       また、ソースの配布も本体とは別に行うよう変更しています。
+
+Ver1.21  2012/12/09 記事名が空の不正なテンプレート呼び出しで処理が落ちていたのを修正。
+                    記事名の末尾がハテナマークの場合に警告を出すよう修正。
+                    テンプレート名の後にコメント等が入っている場合にエラーになるのを修正。
+                    ※ 本バージョンから、開発環境がVisual Studio 2010→2012へと変化しています。
+                       特に影響は無いはずですが、何らかの問題が生じた場合はお知らせください。
+
+Ver1.30  2013/03/xx 言語間リンクの取得を自前の解析処理を使わずMediaWikiのAPIを使用して行うよう変更。
+                    記事名がピリオドやハテナマークで終わるページも扱えるよう対応。
+                    変数の処理でエラーになるパターンがあったのを修正。
+                    MediaWiki APIが無効化されていたのでWikitravel対応を取り止め。
+                    代わりにWikivoyageの対応を追加(ただしまだ日本語版は無し)。
+                    その他設定ファイルを精査。
+                    ※ 設定ファイルに互換性はありますが、一部設定項目の変更・追加・削除が発生しています。
+                       独自の設定を追加している場合、変更が必要になる可能性があります。
+
+
+・仕様上の制限
+キャッシュの一覧で一度に大量の項目を削除すると、フリーズしたかのように時間がかかります。
+上記については、該当する処理に関連する部分に警告メッセージを表示しています。
 
 その他、Wikipedia上言語間リンクが存在しても、現行のアプリでは見つけられないページもあります。
-(例、{{Refbegin}}と条件文で出し分けている{{Refend}}, どうやってるかよく分からない {{Documentation}})
+(例、何故かAPIに言語間リンクが反ってこない{{Lang-la}})
 これらについては対応できない特殊ケースとして、設定→記事の置き換えに変換パターンを初期設定しています。