FreeBASIC FBWikiFaq

- FBWiki とは何 ?

- 誰が、文書に対して責任がありますか？

- 文書に間違いを見つけたとき、誰に連絡すればよいですか？

- 私はどのようにコミュニティの教本に、私の教本を追加できますか？

- 教本にどのような書式スタイルを使う必要がありますか？

- wiki への私の貢献を認識してもらうにはどうすればよいですか？

- 文書を手伝うにはどうすればよいですか？

- 新しい内容は、いつ追加・更新されますか？

- 既存ページの名前を変えるにはどうしますか？

- 予約語の参照ページには何を書きますか？

- プログラマーズ・ガイドには何を書きますか？

- コミュニティ教本には何を書くとよいですか？

- マニュアルは、英語のどの方言で書かれますか？

FB ウィキは、FreeBASIC のマニュアルと関連情報についての、公式のソースです。これは、現在、三つの領域があります：

• FreeBASIC マニュアル - 目次 - この内容は、すべて、ダウンロード版の FreeBASIC マニュアルを作るために使われます。
• いっしょに学ぼう - コミュニティが提供する、プログラミングのヒント、情報、教本
• FB Wiki - Help - ウィキ本体、スタイル、書式設定、およびこの FAQ についてのヘルプ。

wiki と FreeBASIC 文書は、コミュニティ努力です。多くの人々は、これが 2005年に最初につくられた時から、さまざまな方法で貢献しました。コミュニティは、全体として、wikiを改善して、新しい内容を作成する役割を果たします。

貴方が wiki で、誤りや欠損を見つけてくれたら、それを見つけたページにコメントを残すか、自分でページを更新して wiki を改善するのを手伝ってくれると嬉しいです。
FreeBASIC の文書は、コミュニティ努力で、そのメンバーによって改善されるだけです。
それが、あなたが最初に議論すると思う何かならば、それについて FreeBASIC forums に投稿するか、最後の手段として、FreeBASIC developers の1人に連絡することができます。

教本は、すでに書かれている仕事かもしれませんし、また、それは作業中の仕事かもしれません。両方の場合で、あなたは以下のように教本を追加することができます：

• あなたの Wiki アカウントでログインしてください。 注：現在は、過去のスパム攻撃によりログイン/登録フォームは無効になっています。 このウィキのアカウントを作成するには、フォーラムの ウィキ登録 にアクセスしてください。
• Community Tutorials(英文) ページに行きます。
• 教本のページを編集して、適切なセクションにあなたの教本へのリンクを追加します。あなたの教本が、既存のセクションのいずれにも適合しない場合は、新しいセクションを追加します。
• あなたのリンクを追加する方法の事例は、教本のページの既存リンクを見てください。
• 教本ページに名前を付ける場合、名前は "Tut" で始まるようにしてください。事例は、ページ上の他のリンクを見てください。ページを内覧してすべてがよく見えることを確認した上で、保存してください。
• 教本目次ページに戻って、教本目次ページは、あなたの教本へのリンクを含まなければなりません、しかし、それはまだ存在しません。 あなたが今まさに作ったリンクをクリックしてください。すると、ページを作成したいかどうか尋ねられます。 あなたが作ろうとしている新しい wiki ページの名前が、あなたが望むものであることを確認してください。 ページを作成するために、リンクをクリックしてください。
• 必要に応じて内容と形式を追加します。
• 満足するまで、内容を内覧して、編集してください。そして、ページを保存してください。
• 教本が進行中の作業ならば、それが完了するまで待ってください。

教本の全体的なスタイルはあなた次第です。 従うべき 形式についての特定の規則はありませんが、考えられるアイデアについては、FreeBASICマニュアルの他のページの教本を参考にずるのがよいでしょう。
使われる フォーマットコード は、Wiki内のどのページも同じです。
必須のルールは、サンプルコードの部分を、文書コンバータが認識できるように、開始タグ %%( freebasic ) と、終了タグ %% のタグで囲むということだけです。

文書の追加・改変について、経過を追っている特定の人はいません。

コミュニティ教本の認証は、Community Tutorials のページにあります。コミュニティ教本ページ上に、あなたの名前か、あなたのリンクへのハンドルを置くことが、あなた自身の署名になることを覚えておいてください。

あなたが wiki の全体的な改善に大きく貢献していて、そのことを認識されたいと思っているならば、主な貢献者の一覧 に自分自身を追加してください。

いくつかの方法:

• すぐに始められることは、読んだ話題について、何か過失や欠損を見つけたら修正することです。
• MissingDocs ページをチェックしてください。このページには、作業が必要な広範囲の項目一覧が表示されます。これは wiki の TODO リストです。
• WantedPages ページをチェックしてください。これらは、リンクされたが、まだ書かれていないページです。
• 大きな変更をする前や、行うべきことがよくわからない場合は、それを議論したり、コミュニティからより多くの情報を入手するために、FreeBASIC フォーラムにあなたのアイデアを投稿して下さい。

内容は、可能な限り、いつでも追加する必要があります。FreeBASIC が、1.0 のような大きなバージョン更新をするとき、文書は常にコンパイラ開発より遅れています。私たちは、できる限りその遅れを最小限にしたいと思います。 理想的には、コンパイラと同期して、最新の文書を提供していきたいと思います。

先ず最初に、本当にページの名前を変える必要があるかどうか、あなた自身に尋ねて下さい。 ページの名前を変えることは、まさにオンライン文書以上の影響を与えるかもしれません。 wiki は、IDE のような、他のプロジェクトで使われる文書のオフライン書式を生成するためにも用いられます。 文書が最初につくられるとき、我々は正しくページに名前をつけようとします。しかし、時に、間違いは起きえて、デザイン変更やページの名前変更が必要な場合もあります。

• 古いページから内容をコピーします（例：KeyPgOldName）
• 新しいページを作成（例：ProPgNewName ）し、コンテンツに貼り付けます。必要に応じてバックリンクを更新します：例えば {{fbdoc item="back" value="CatPgProgrammer|Programmer's Guide"}} 、そしてページを保存します。
• 古いページ名（例：KeyPgOldName）の検索を行うと、古いページにリンクする全てのページを、新しいページを指すように修正します。
• 古いページ（例：KeyPgOldName）を、"!!! DELETE ME !!!" だけを含むように編集してください。 - こうすると、それは簡単に検索できて、後で掃除できます。 また、古いページに、"Moved to ... " と言うユーザーへのコメントを残してください。こうすると、それが最近コメントされたページだと簡単に気付くことができます。

KeyPg で始まる予約語の参照ページは、コンパイラの予約語とランタイムライブラリ関数のためのものです。 予約語や関数の使用方法については、何もかも、すべて文書化されるべきです。ここで書くべきでない唯一のものは、キーワードが「良い」か「悪い」かについての個人的な意見です。 代替の選択肢を記述するのは OK ですが、選択について何の見解も述べないのは OK ではありません。 それが言語の有効な予約語や構成概念ならば、それを使うか使わないかの選択は、プログラマー次第でなければなりません。 たとえば、Enum, Const, #define は、どれもソースプログラム中に定数を導入する有効な方法です。そして、それぞれ、長所と短所を持っています。

ProPg で始まるプログラマーズ・ガイド・ページは、概念、考え、そして、言語の異なる面を使う方法に関する一般的な情報のためにあります。 たとえば、一つのページで、Enum, Const, #define を使う方法を記載することができました。 これは、キーワードの詳細情報の各ページへリンクしながら、ある予約語と他を使う上での、長所と短所、ヒントや落とし穴を記述するのに最適な場所です。 プログラマーズ・ガイドは、プログラムを記述するために言語を利用する方法に関する情報を提供するだけでなく、最高の実行についてのアドバイスも提供しなければなりません。

コミュニティ教本は、言語参照やプログラマーズ・ガイドにそぐわない何でも書くのに良い場所です。これは、言語、外部ライブラリ、特定のアルゴリズムのいくつかの面を含めることができる "How to" ガイドです。

時々、wiki は、綴りを、GNU Aspell "en_US" 辞書を使ってチェックしています。この方言は、何かを選択しなければならなかったというだけで、選ばれました。そして、書き始めた時点で、伝えられるところ大くのユーザーは U.S.A. からでした。 しかし、wiki に対する貢献は、世界中のユーザーによってなされました。