ブック・ツール

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search
This page is a translated version of the page Book tool and the translation is 100% complete.
Other languages:
British English • ‎Deutsch • ‎English • ‎Esperanto • ‎Lëtzebuergesch • ‎Nederlands • ‎Türkçe • ‎Zazaki • ‎asturianu • ‎azərbaycanca • ‎dansk • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎occitan • ‎polski • ‎português • ‎português do Brasil • ‎svenska • ‎čeština • ‎български • ‎русский • ‎العربية • ‎سرائیکی • ‎فارسی • ‎مصرى • ‎پښتو • ‎नेपाली • ‎বাংলা • ‎தமிழ் • ‎മലയാളം • ‎ၽႃႇသႃႇတႆး  • ‎中文 • ‎日本語
Printed Wikipedia-books

複数の記事をまとめてPDFへ変換できるCollection Extension拡張機能)を、さらに多くのウィキメディア財団によるプロジェクト群で実装する計画が進んでいます。このページはコミュニティの皆さんのガイドとして拡張機能の導入成功を目指し、またそのため多言語のウィキペディアに焦点を合わせています。ツールの使い方の感触を得るには、en.wikipedia.org(ウィキペディアの英語版サイト)を開き、サイドバーにある印刷機能の「Print/export」から「create a book」(ブックの生成)を選んでください。

はじめに

ユーザーはこのツールを使い、自分が選んだページをブックの形にまとめることができます。ここで言うブックの例とは。

  • ページから節を取り出して構成し直したもの
  • 保存して読み込んだりシェアしたもの
  • PDF形式として生成

()

  • ODFテキストドキュメントとしてエクスポートしたもの
  • PediaPressに印刷本として注文する

()

このプロジェクトの詳細については、プレスリリースWikis Go Printableをご覧ください。 この拡張機能のテストは2008年10月より wikibooks.org 群で始まり、ドイツ語版ウィキペディアでは2009年1月27日より実装してきました。その他の展開も予定しています。

ガイド

ご利用のウィキペディアで、まもなくこの機能を展開するという告知を受けて、このページを開いたのではありませんか。まず設定を済ませるべき箇所について、下記のページで案内をしています(こちらを参照) 。

  • ヘルプページの翻訳をお願いします。4件のヘルプページが翻訳対象で、ご利用のウィキのどこにページを新設するか、「この拡張機能が使うページ群」の項目をヒントにしてください。
  • ブックツールの翻訳のクイックガイド
    フィードバックのページには、書き込みが多すぎる可能性があり、何らかの方法で翻訳対象を整理し、メタの英語版Feedbackページへ翻訳をコピーする必要が出てくるかもしれません。詳細は「バグ報告、フィードバック収集、支援の求め方」の項目を参照してください。また別件ですが、人によってはツールに関するコメントを、ヘルプページではなく、その議論のページに書き込んでいます。
    議論のページの最上部に「フィードバックのページ」へのリンクを置くと、この問題を解消できます。
    翻訳者の方へ (ヒント):この拡張機能に伴う機能や概念を理解するには、実際にhttp://simple.wikipedia.org で試用してみることをお奨めします。あるいは、「page」という単語の訳出に当たり、「ウィキページ」(記事) を示すのか、PDFもしくはブック形式の印刷物の特定のページなのか、注意が必要です。
  • このページ以外に関連項目やカテゴリ、テンプレートを作成。この拡張機能が展開した以降に「この拡張機能が使うページ群」の項目を処理するべきです。
  • PDFに書き出さないコンテンツに関するテンプレートを集め、リスト化してください。詳細は「オフライン出力で除外するテンプレート」の項目を参照。

これらの基本が完了したら、他にも改善できる項目があります。

概念

ブック
通常は複数ページをまとめたもののこと(章や表題、副題を伴う場合もある)で、またPDF出力や印刷した書籍あるいは保存ブックを指す。
一時的なブック(transient book)
ブラウザの現時点のセッションで記録された記事の集合体。一時的なブックの記事の一覧は[[Special:Book]]参照。
保存ブック
複数の記事のまとまりを保存したもの。保存先は標準のウィキページで、ユーザーの名前空間 ([[User:Name/Books/Bookname]]) もしくはグローバルな名前空間 ([[Wikipedia:Books/Bookname]])のいずれか。保存ブックは後であらためて読み込みが可能。言い換えるならば、一時的なブックとは保存ブックの複製。
ブックのページ
通常は[[Special:Book]]を指し、一時的なブック内の記事はすべてリスト化できる。ブックは内容の変更や保存、注文や書き出しができる。保存したブックを意味することもある。
(ブックの) ポートレット
サイドバーにある「create book」というラベル付きのボックス。〈add/remove article〉〈Show book (N件の記事)〉〈Load book〉 〈remove book〉〈Books help〉の各リンクをカプセル化したもの。
ブックのヘルプ
ポートレットからリンクしたメインの[[Help:Books]]ページ。
「offline でエクスポート」「エクスポート」「印刷中」「印刷バージョン」他...
ブックをデジタル出力する (PDF、ODF) あるいは物理的に印刷すること (印刷物のブック)。
「お勧め」「お勧めのページ」
関連ページのお勧め機能。現在のブックに含まれる記事一式に関連のある、他のページを提示。

地域化の変更

概念を正しく把握すること。一例として「演劇のブック (19 ページ)」と書いてあると、19ページ構成の PDF と誤解しがちですが、19本の記事から構成される PDF もしくは印刷物のブックで、総ページ数はもっと多いこともありえます。では保存ブックを読み込んだ直後の一時的なブックでもある状態では、ブックをクリアとは何を指すでしょうか?

メッセージの変更を行うには、translatewiki.net (ext-collection) (次回のソフトウェア更新以降に有効) もしくは[[Special:Allmessages]]を開き、関連メッセージをフィルターの「coll-*」ですべて抽出して一覧し、ウィキで変更します。確実に処理するにはsourceを縦覧し、正しいメッセージ識別子を探す方法があります。

注記:ブックという例え方はほぼすべてのウィキでうまく使えるのですが、例外は一連の「.wikibooks.org」で、独自のブックの概念と相いれません。もし translatewiki.net で「book」の対訳を変更する場合は、同じ言語のすべてのプロジェクト群で告知することをお奨めします(例えば wikibook)。

生成した PDF で使うメッセージの地域化は、translatewiki.net (mwlibrl)で変更することもできます。

translatewiki.netをダブルクリックして、この拡張機能で使われるシステムメッセージをすべてご利用の言語に翻訳終了したと確認してください。

この拡張機能が使うページ群

作成が必要なページやカテゴリ、テンプレートをすべて一覧。

ページ

[[Special:Book?bookcmd=book_creator]] (requires no creation)
専用の導入ページ (「ブックを作成」ボタンを押した利用者に示すページ) を用意、ブック作成機能「Book creator」を有効にして短いヘルプページを参照読み込みします。このヘルプページの命名はcoll-book_creator_text_articleを使うと、既定の記述は次のとおりです。Help:Books/Book creator text つまり「Book creator text」は設定したヘルプページの下位ページという位置付けになります。
[[Special:Book]] (作成は不要)
特別ページを作り、未完成のブック 上の大がかりな処理を1カ所で実行する。
[[Special:Book/rendering]] (作成は不要)
rendering page には文書作成の進行状態を示します。終了時に文書のダウンロード用リンクを表示します。レンダリングに失敗したというメッセージが表示される場合もあります。表示する文の設定は次の各種があります。

coll-rendering_textcoll-rendering_articlecoll-rendering_statuscoll-rendering_pagecoll-rendering_finished_textcoll-is_cachedcoll-excluded_templatescoll-blacklisted_templates

[[Special:Book/load_collection]] (作成は不要)
使用場面は保存ブック の読み込み時。利用者が目にするのは、セッション中にすでにブックが読み込んであるのに、別のブックを処理しようとした時です。文章の設定はcoll-load_overwrite_textcoll-overwritecoll-appendcoll-cancelで行います。
[[Help:Books]]
このツールのヘルプページのメイン (example) はポートレットからリンク。位置はシステムメッセージ内coll-helppageに設定します。
このページがリンク元のテンプレートは出力時にまとめて除去されます。この機能は個別事例に対応せず集中制御されるため使わないことをお勧めします。代わりに[[Category:Exclude in print]]を使ってください (下記参照。) 位置の変更はcoll-template_blacklist_titleで指定します。

カテゴリ

[[Category:Wikipedia:Book tool]]
説明文書類、関連のページやテンプレートを全て保存する場所です。
[[Category:Wikipedia:Books]]
保存ブック を追跡するカテゴリ。このカテゴリのページを開くと、ポートレットに「ブックを読み込む」リンクが表示され、カテゴリ配下のページをブックとして「読み込み」ができます。その上で 保存ブック は作成日時順に追加され、また保存ブック 以外のページはこのカテゴリに混入させないでください。設定はcoll-bookscategoryで行います。このメッセージを変更して「Wikipedia:ブック」に変えることができます (既定は「ブック」のカテゴリ)。
[[Category:Exclude in print]]
エクスポート時に無益もしくは支障になる情報を導入するテンプレートを全て追跡します。 (誘因は以下を参照)。coll-exclusion_category_titleで設定できます。

テンプレート

[[Template:Saved book]]
保存ブック の上部に必ず自動表示されるテンプレート (example) です。カスタマイズすると保存ブック ページの見た目を魅力的に整え、メタデータを保持させることができます。配置はcoll-savedbook_templateを使って設定します。
[[Template:Hide in print]]
このテンプレート ([[/Templates/Hide in print|example]]) は最初のパラメータで未処理だったマークアップ全てを返します (読むだけで処理はしません)。[[Category:Exclude in print]]に入れるとブックや PDF の印刷時にコンテンツを選択的に除外できて、とても便利なのです。どんな名前で呼んでもかまいませんが、必ずカテゴリに入れ、上級者向けのヘルプページに説明を記載するかリンクしてください。
注記:このテンプレートは公開したとたんに受け入れられ、たちまち最も人気が高いテンプレートに仲間入りしました。そのため保護する方が賢明と言えます。
[[Template:Only in print]][[Template:PrintOnly in print]]
none

このテンプレート ([[/Templates/Only in print|example]]) は最初のパラメータで処理したマークアップを一つも返しませんが、対応する[[/Template/Only in print/Print]] ([[/Templates/PrintOnly in print|example]]) は通したマークアップを返します。印刷でテンプレートを substitute する */Print-subpage の詳細は上級者向けのヘルプを参照してください。印刷でテンプレートを substitute する接頭辞は coll-print_template_prefixで設定します。

特別なライセンスの起源を設定

コミュニティによっては PDF 内にライセンス条項の加筆を望むかもしれません。

PDF に含まれるライセンスの設定には、MediaWiki:Coll-license_urlを用いてレンダリング対象の生のウィキテキストを指定します。公開のウィキメディアサイトの既定は、https://creativecommons.org/licenses/by-sa/3.0/.

オフライン出力で除外するテンプレート

多くのテンプレートは印刷版では除去すべき内容を含んでいます。大きく分けて少なくとも3種類あります。

管理メッセージ
オフラインのエクスポートでは無益で、オフラインでは貢献が不可能なため利用者を混乱させます。サンプル:メンテナンス問題のある記事など。
警告、ヒントのメッセージ
They are useless and distracting in offline exports as users noticed them when selecting the content and choose to add it anyway. Examples: Sources of articles, Disputes, Deletion, General...A special introduction page (the page shown when a user clicks on "Create a book") which allows to enable the "book creator" and transcludes a short help page. The name of this help page can be set in coll-book_creator_text_article The default is: Help:Books/Book creator text i.e. a subpage of the configured help page named "Book creator text".
ナビゲーション用の内容
ナビゲーション用のリンクはむしろ不便で、エクスポートの時に邪魔になります。サンプル:縮小版目次 (en)、姉妹プロジェクト (en)など。

そういうテンプレートはnoprintのCSSクラスを指定してください。

このカテゴリに該当もしくは関連するテンプレートを探してまとめる作業は早期に - できれば実装前に実施するよう推奨されます。 ドイツ語版ウィキペディアでは関連のカテゴリを調べてテンプレート130件を短時間に選び出しました。単一ページに一覧を作り、ボットでカテゴリを割り当ててあります。すると手動で追加が必要なものは14件に絞り込めました。 ヒント:テンプレートのためのテンプレートもあります。そういう場合はこの (親) テンプレートをカテゴリに加えるだけで十分な可能性も ある一方で、その結果、特定のテンプレートのクラスがそっくり全部、除外される結果を招くこともあり得ます。

ブッククリエーターの存在とブックの印刷手配ができることを広報する

PDF のレンダリングページ に特定のページを参照読み込みさせ、利用者がPDFとしてダウンロード ボタンを押した時に表示させることもできます。このページで (明らかにオフラインが適切な国にいる) 利用者はブッククリエータ とブックの印刷手配のオプションを知ることになります。

英語版ウィキペディアでこのページがどう表示されるか、サンプルはページ情報の文章 (enzo) をご参照ください。またPDF レンダリングページ上の 見た目はこちら

Coll-rendering_page_info_text_article というシステムメッセージの指定した場所にページが存在するなら (英語版ウィキペディアのサンプル) PDF レンダリングページ に表示されます。

保存ブックの整理

自分専用のブックを作りたい人は多いし、人によっては特定の話題のブックを直接、開きたいかもしれません。

[[Wikipedia:Books]]ページを使ってどんな「保存ブック」があるか、利用できるか宣伝するためにも使えます。この課題はまだそれほど浸透していませんが、以下の小見出しにいくつかアイデアをまとめました。

ブック作成を普及させる

  • 「秀逸なブック」作成のガイドを提供する:
    • 適切な題名の選び方。
    • 序文を追加するには。
    • 記事の選択基準。
    • 推奨される記事の件数。
  • グローバル名前空間に置いてよいブックのガイドラインを作る。その必須条件をあげます (サンプル)。
    • 適切な件数の記事を掲載 (最低5件、上限200件)。
    • 有意義な題名、副題を付ける。
    • 話題から外れない。
    • 適切な品質の記事を掲載 (論議を巻き起こしていない記事で、スタブや削除候補は除外するなど)
  • 話題を相互に関連づける。

誰でも鑑賞できるユニバーサル化

  • 週間、月間、年間のブックリストを作る。
  • 秀逸なブックにラベルを貼り、ブックページやメインページなどで告知。
  • 関連の記事やカテゴリ、ポータルのページに「この話題にはブックがあります」というメッセージボックスを貼る。
  • 本棚の一部をABC順にリンクまたは参照読み込み

本棚

保存ブックは[[Category:Wikipedia:Books]]に分類されて追跡が可能ですが、すぐに情報過多になります (ドイツ語版ウィキペディアはたった10日で作成数は約1000件 - ほとんどが利用者名前空間。) しかもカテゴリではメタデータの表示、トピックごとのブックへのアクセスができません。ブックをカテゴリ分けできても、メインカテゴリがブックで煩雑になるか、他の名前空間にカテゴリツリーを複製する需要を生む、もしくは実行されてしまいます。

自動的に本棚を作成するボットを使うと、題名 (アルファベット順A-Z) もしくはキーワードでブックを検索できます。もちろん手動でも本棚は作れます。ボット作業の詳細はブックシェルフのページをご参照ください。

メインページの準備

メインページはしばしばウェブで複数段のレイアウトを採用する点から、ポータルに次いで重視しました。レンダリングしたPDFではそういうページの見た目が非常に劣ります (用紙を縦置きにしたレイアウトで固定幅の制限が影響)。ただしこの場合も、新しいツールを初めて使ったユーザーはほぼ全員、こういうページをブックに追加しています。

未完成段階で早くも失望させないためには、PDF上で見た目が整うようにメインページを準備する対応ができます。[[Hide in print]] テンプレートを適用し、あたかも(出力する)メインページに表あるいは段組がない状態に処理します。 (FIXME:example)

もうひとつ、portlet(ポートレット)の見せ方も課題です。ウィキペディアの一般の訪問者 (あなた以外の人) はサイドバーを気にとめません。もしメインページの「ウィキペディア・ニュース」のボックス(特設した場合)を使って、期間限定で新しい機能の告知とヘルプページへのリンクを設けたら、自体の改善に役立つかもしれません。

バグ報告、フィードバック収集、支援の求め方

ウィキページ上の場合

英語版メタにあるFeedback pageで機能の要望、アドバイス、バグ報告あるいは質問他を集約して受け付けます。英語以外の言語版ウィキにも同様のページを新設する場合 (サンプル) には、問題を翻訳し英語版メタのフィードバック用ページに載せる場合と方法の基準を決めておきましょう。

バグトラッカー

Bugzillaの 「Collection」の構成要素を使用。

IRC

ブックツールに関する問題や話題はすべて IRC チャンネル#pediapress で受付。

過去の展開で得た教訓

ドイツ語版ウィキペディア

有効だった点: ツールはおおむね肯定的に受け止められました。保管したブック (stored books) は短期間に多数作成されました。ドイツ支部が記者発表をした直後から報道で急速に取り上げられています。

効果がなかった点:第1週には新しいツールをログイン利用者限定にする計画はなぜか実行されませんでした。その結果、説明文書も地域化も未完成のうちに機能を展開したのです。利用者によって、このポートレット portlet が表示されないページがあり、原因はおそらくキャッシュです。メインページは印刷バージョンに不適合でした (上記を参照)。ドイツ語のウェブ版情報サイト 「magazin Heise」が記事を掲載、スラッシュドット効果の影響を受けました。レンダリングのサーバがクラッシュ (ロード数は約300に到達) し訪問者を受付できませんでした。

更新

更新のうち、特にコミュニティの対応が求められる案件をここで告知します。

  • September 2014: statistics for sales have been updated till the end of 2013, at [1].
  • 3 Mar 2009 - PDF-server update & ColExt update
    • Important Change: The template substitution was changed from a prefix to a suffix */Print. The license to be included in the PDF is now configurable by setting MediaWiki:Coll-license_url
    • updated to mwlib release 0.9.11 (changelog)
    • updated to mwlib.rl release 0.9.8 (changelog)
    • Collection-Extension was updated to trunk (changelog)

mwlib + mwlib.rl are used for rendering documents, Collection-Extension implements the UI in Mediawiki