Wiki Syntax

http://code.google.com/p/support/wiki/WikiSyntax

Wiki シンタックス(文法、構文)

紹介

各wikiページはプロジェクトリポジトリの/wikiディレクトリ下の.wikiファイルに格納されます。
各ファイルの名前はwikiページの名前と同じです。
そしてwikiファイルはオプションのプラグマ行の後にページの内容を含みます。

プラグマ

オプションのプラグマ行はページとページがどのように表示されるべきかについてのメタデータを提供します。 
これらのラインはファイルの一番最初の行に出現した場合のみ処理されます。
各プラグマ行はpound-sign(ポンド記号 #)とプラグマネームで始まり、後に値が続きます。
プラグマ
#summary ページの一行サマリー
#labels カンマ区切りのラベルのリスト(web UI経由で自動的に満たされる)
#sidebar サイドナビゲーションを見てください。

Wiki-style マークアップ

パラグラフ(節、段落)

パラグラフを分離するためには一行以上の空白行を使用します。

タイプフェイス(書体)

名前/サンプル マークアップ
italic _italic_
bold *bold*
code `code`
code {{{code}}}
superscript ^super^script
subscript ,,sub,,script
strikeout ~~strikeout~~
これらの書体はいくつかの点で混ぜて使うことが出来ます:
マークアップ 結果
_*bold* in italics_ bold in italics
*_italics_ in bold* italics in bold
*~~strike~~ works too* strike works too
~~as well as _this_ way round~~ as well as this way round

コード

原文通りに複数行のコードブロックを表示したい場合には、複数行のコードデリミタ(区切り文字)を使用します:
{{{
def fib(n):
 
if n == 0 or n == 1:
   
return n
 
else:
   
# This recursion is not good for large numbers.
   
return fib(n-1) + fib(n-2)
}}}
結果はこうなります:
def fib(n):
 
if n == 0 or n == 1:
   
return n
 
else:
   
# This recursion is not good for large numbers.
   
return fib(n-1) + fib(n-2)

ヘディング(見出し)

= Heading =
== Subheading ==
=== Level 3 ===
==== Level 4 ====
===== Level 5 =====
====== Level 6 ======

ディバイダー(区切り線)

同一行上の4つ以上のダッシュは水平の罫線になります。

リスト

Google コード wikiはbulleted(中黒、中点”・”)リストと番号付きリストの両方をサポートします。
リストはそのように認識されるために少なくともスペース1つ分インデントされていなければなりません。
さらに適切なインデントの使用により、他のリスト内でネスト出来ます:
The following is:
 
* A list
 
* Of bulleted items
   
# This is a numbered sublist
   
# Which is done by indenting further
 
* And back to the main bulleted list

 
* This is also a list
 
* With a single leading space
 
* Notice that it is rendered
 
# At the same levels
 
# As the above lists.
 
* Despite the different indentation levels.
以下のようになります:
  • A list
  • Of bulleted items
    1. This is a numbered sublist
    2. Which is done by indenting further
  • And back to the main bulleted list
  • This is also a list
  • With a single leading space
  • Notice that it is rendered
    1. At the same levels
    2. As the above lists.
  • Despite the different indentation levels.

クォーティング(クォート、囲い)

ブロッククォートはあなたのページ内の抜粋を強調します?
ブロッククォートは一つ以上のスペースによってパラグラフをインデントすることによって作成されます:
Someone once said:

 
This sentence will be quoted in the future as the canonical example
  of a quote that
is so important that it should be visually separate
 
from the rest of the text in which it appears.
Someone once said:

This sentence will be quoted in the future as the canonical example of a quote that is so important that it should be visually separate from the rest of the text in which it appears.

リンク

リンクはwebの内容を作成するので、wikiプリンシプル(主義、原則)の中心です?

Gogole Code wikiは内部(wiki内)と外部へのリンクの両方を許可し、場合によっては、
WikiWorld(※Wiki内のページ?)かURLと認識した時、自動的にリンクを作成します。

内部wikiリンク

wiki内の内部リンクは以下のシンタックスを使用して作成します。
存在しないページをwikiリンクに追加した場合、 コミッターとオーナーに伝える?ためにリンクはLittleLink?
(※リンク先はその名前をセットしたNew pageの編集画面)を伴って現れます。

そのリンクをクリックするとそのページの内容を入力できるページ作成フォームへ移動します。
ログインしていない場合、存在していないページを指しているwikiリンクはページ作成フォームへの
リンクは伴わない、プレーンテキストを表示します。

対象となるページを作成した場合、リンクはそのページの全ての閲覧者に対しての通常のハイパーリンクになります。
WikiSyntax is identified and linked automatically
Wikipage is not identified, so if you have a page named [Wikipage] you
need to link it explicitly
.
If the WikiSyntax page is actually about reindeers, you can provide a
description
, so that people know you are actually linking to a page on[WikiSyntax reindeer flotillas].
If you want to mention !WikiSyntax without it being autolinked, use an
exclamation mark to prevent linking
.
WikiSyntax is identified and linked automatically
Wikipage is not identified, so if you have a page named Wikipage you need to link it explicitly.
If the WikiSyntax page is actually about reindeers, you can provide a description, so that people know you are actually linking to a page onreindeer flotillas.
If you want to mention WikiSyntax without it being autolinked, use an exclamation mark to prevent linking.

ページ内のアンカーへのリンク

各見出しは見出しと同じHTMLアンカーを定義しますが、スペースはアンダースコアに置換されます。
以下のようなページ上の特定の見出しへのリンクを作成することが出来ます:
[WikiSyntax#Wiki-style_markup]
これは次のように描画されます: WikiSyntax#Wiki-style_markup.

issuesとrevisionsへのリンク

以下のシンタックスを使用してissueとrevisionsへ簡単にリンク出来ます。
  • issue 123 はカレントプロジェクト(※このwikiが含まれるプロジェクト)のissueナンバー123へ自動リンクされます。
    #を含んでも含まなくても構いません。issueがクローズされた場合、リンクはアンダーラインではなく
    クロスアウト(打ち消し線) を伴います。 リンクの上にマウスカーソルをホバー(重ねる)すると
    issueの概要を表示します。 
  • issue PROJECTNAME:122 はしていしたプロジェクトのissueナンバーへ自動リンクされます。
    これはプロジェクトが関係のあるプロジェクトで行われてる作業に依存している場合に便利です。
  • r123 はカレントプロジェクトのrevisionのリビジョン詳細ページへ自動リンクされます。
現在のところ、この自動リンク(の型)は無効にする方法はありません。issue 996を見てください。
For example: Please add a comment on issue 123 rather than adding more review comments to r456. 
次のように描画されます: Please add a comment on  issue 123  rather than adding more review comments to r456.

外部ページへのリンク

勿論、内部リンクと似たシンタックスを使用して、貴方のwikiページから外部ページへリンク出来ます。
Plain URLs such as http://www.google.com/ or ftp://ftp.kernel.org/ are
automatically made
into links.
You can also provide some descriptive text. For example, the following
link points to the
[http://www.google.com Google home page].
If your link points to an image, it will get inserted as an image taginto the page:

http
://code.google.com/images/code_sm.png
You can also make the image into a link, by setting the image URL as
the description of the URL you want to link
:
[http://code.google.com/ http://code.google.com/images/code_sm.png]
http://www.google.com/ またはftp://ftp.kernel.org/ のようなプレーンURLは自動的にリンクが作られます。
さらに幾らかの説明文章も提供出来ます。例えば、次のリンクはGoogle home pageを指しています。
(※hrefの値と異なる文字列を表示出来る=HTMLでいうところのタグに囲まれた文字列指定と同じことが出来るということ?)
また、リンクしたいURLの説明としてイメージURLを設定することによってイメージリンクも作ることが出来ます。
[http://code.google.com/ http://code.google.com/images/code_sm.png]

イメージへのリンク

イメージ(すなわち.png/.gif/.jpg/.jpegで終わるファイル )へのリンクを指している場合、
ページにイメージとして挿入されます。 
http://code.google.com/images/code_sm.png
サーバサイドスクリプトで産出されたイメージの場合、URLはサポートされているイメージファイルネームの拡張子で
終わるようにURLの最後へnonsenseクエリ文字列パラメータを追加する必要があるかもしれません。
http://chart.apis.google.com/chart?chs=200x125&chd;=t:48.14,33.79,19.77|83.18,18.73,12.04&cht;=bvg&nonsense;=something_that_ends_with.png

テーブル

テーブルは||デリミッタで区切って各セルの内容を入力することによって作成されます。
タイプフェイスフォーマットとリンクを含むことによってテーブルセル内に他のインラインwikiシンタックスを挿入出来ます。
|| *Year* || *Temperature (low)* || *Temperature (high)* ||
|| 1900 || -10 || 25 ||
|| 1910 || -15 || 30 ||
|| 1920 || -10 || 32 ||
|| 1930 || _N/A_ || _N/A_ ||
|| 1940 || -2 || 40 ||
Year Temperature (low) Temperature (high)
1900 -10 25
1910 -15 30
1920 -10 32
1930 N/A N/A
1940 -2 40

HTML サポート

wikiページの表示を助けるために、いくつかのHTMLサポートがあります。
HTMLタグはwikiページ内でのみサポートされますが、ページコメントではサポートされません。
HTMLシンタックスはwikiシンタックスとつなげて使うことが出来ますが、可能な場所ですることを推奨します?
以下のHTMLタグと属性が現在サポートされています:
HTML タグ サポートしている属性
a title dir lang href
b title dir lang
br title dir lang
blockquote title dir lang
code title dir lang language [1]
dd title dir lang
div title dir lang
dl title dir lang
dt title dir lang
em title dir lang
font title dir lang face size color
h1 title dir lang
h2 title dir lang
h3 title dir lang
h4 title dir lang
h5 title dir lang
i title dir lang
img title dir lang src alt border height width align
li title dir lang
ol title dir lang type start
p title dir lang align
pre title dir lang
q title dir lang
s title dir lang
span title dir lang
strike title dir lang
strong title dir lang
sub title dir lang
sup title dir lang
table title dir lang align valign cellspacing cellpadding border width height
tbody title dir lang align valign cellspacing cellpadding border width height
td title dir lang align valign cellspacing cellpadding border width height
tfoot title dir lang align valign cellspacing cellpadding border width height
th title dir lang align valign cellspacing cellpadding border width height
thead title dir lang align valign cellspacing cellpadding border width height colspan rowspan
tr title dir lang align valign cellspacing cellpadding border width height colspan rowspan
tt title dir lang
u title dir lang
ul title dir lang type
var title dir lang
[1] codeタグのlanguage属性はcodeブロック内で使用される(プログラミング)言語のファイル拡張子です。
シンタックスをハイライトするヒントとして使われます。 

HTMLタグのエスケープ

wikiページで(描画ではなく?)直接HTMLタグを表示したい場合、各HTMLタグをエスケープする必要があります。
以下の表で示されているようにHTMLタグをエスケープ出来ます。:
Markup Result
`


`


{{{


}}}


※wiki上でリンク扱いになってしまう[]も{{{[]}}}という表記でエスケープ出来るようです。

コメント

wikiはwikiぺージの内容の説明を助けるために埋め込みコメントをサポートします
コメントブロックの内側のものは全て、描画されたページから除去されますが、
そのページのソースを編集または閲覧する場合は見ることが出来ます。

This text will be removed from the rendered page.
    


ガジェット

次のシンタックスでwikiページへGadgetsを埋め込めます:
 url="http://example.com/gadget.xml" height="200" border="0" /> 
有効な属性は以下の通りです:
  • url: ガジェットのURL
  • width: ガジェットの幅
  • height: ガジェットの高さ
  • title: ガジェット上で表示されるタイトル
  • border: “0” または “1”、ガジェットの周りに枠線を描画するかどうか
  • up_*: ガジェットが使用するプリファレンスパラメータ
  • caja: “0” または “1”、ガジェットを描画するためにCajaを使うかどうか。
    Cajaはサードパーティガジェットの悪意ある、または偶発的なエラーからプロジェクトユーザーを助けます。
WorkingWithGoogleGadgetsはGoogle Code用のガジェットを作成する方法を説明しています。
さらにより簡単にガジェットを発行出来、 iGoogleのような他のGoogle製品と統合するために
役に立つ2,3の提案を提供します。InterestingDeveloperGadgetsはあなたがプロジェクトページに
入れたいと思うかもしれない、いくつかのサンプルガジェットを示します。

動画

次のシンタックスで動画を埋め込むことが出来ます:
 url="http://www.youtube.com/watch?v=3LkNlTNHZzE"/>
有効な属性は以下の通りです:
  • url: 動画のURL
  • width: 埋め込んだ動画の幅
  • height: 埋め込んだ動画の高さ
今現在、YoutubeとGoogle Videoの動画がサポートされていますが他の(動画)コンテナも
我々のopen source gadgets projectへ追加することが出来ます。
※Google Videoはサービス終了?

ナビゲーション

目次

目次の中はwiki pageのページ見出しから生成することが出来ます。
目次が表示されるべき場所のページへ次のシンタックスを追加します:
 max_depth="1" />
有効な属性は以下の通りです。:
  • max_depth: 目次内で表示する見出しの最大深度(階層の深さ)

サイドナビゲーション

サイドナビゲーションを定義した別のwikiページを選択することによってwikiページ用のサイドバーを指定出来ます。

doctype project はそのwiki全体で幅広くサイドバーを使用しています。(※リンク先、403?)

サイドバーを追加する一つの方法は、以下で示すような、#sidebarプラグマを設定することです。
代わりに、サイドナビゲーションが要らない場合はプラグマを空白のままにしておくことが出来ます。
#sidebar TableOfContents
定義されたサイドナビゲーションは、以下に示すような、単純なリストのフォーマットでなければなりません。
  * [Articles HOWTO articles]
   
* [ArticlesXSS Web security]
   
* [ArticlesDom DOM manipulation]
   
* [ArticlesStyle CSS and style]
   
* [ArticlesTips Tips and tricks]
 
* [DOMReference DOM reference]
 
* [HTMLElements HTML reference]
 
* [CSSReference CSS reference]
また、デフォルトサイドバーページはAdministerタブのwiki設定でプロジェクトオーナーによって
すべてのwikiページで指定することも出来ます。
#sidebarプラグマも指定されている場合、そのページでは指定したものが優先されます。

Wikiコンテンツのローカライズ

wikiで使用されるデフォルトの言語(administerタブのWiki設定で設定することが出来る)と共に追加言語もサポートします。
ユーザーの言語プリファレンス(例えば、ブラウザの言語)に基づいて、一つ以上の言語が利用可能な場合、
wikiは適切な言語でページを提供しようと試みます。
その言語でのwikiページがない場合、デフォルトの言語にフォールバックします。
しかしながらコメントはwikiページの全ての翻訳で共有されます。ページの新しい翻訳はwebインターフェイスを通じて
追加することは出来ず、Subversionリポジトリを通じて追加しなければなりません。
ページの翻訳を追加するには、最初にSubversionからwikiをcheckout(※ローカルへのファイル取得)します:
svn checkout https://yourproject.googlecode.com/svn/wiki/ yourdirectory -username yourusername

それから、そのディレクトリの名前としてISO-639コードの二文字を使用して/wiki/の下に新しいディレクトリを作成します。
新しいディレクトリに翻訳した全てのファイルを置き、Subversionリポジトリへこれらの変更を送信します。
以下は有効なwikiディレクトリの例です:
wiki/
   ja
/
     
ProjectHistory.wiki
     
StyleGuide.wiki
   zh
-Hans/
     
ProjectHistory.wiki
     
StyleGuide.wiki
   zh
-Hant/
     
ProjectHistory.wiki
     
StyleGuide.wiki
   
ProjectHistory.wiki
   
StyleGuide.wiki
一旦、プロジェクトのsubversionリポジトリへ送信されたファイルはwikiのwebエディタを通じて編集出来ます。(※been be?)
Mercurialリポジトリのプロセスも、wikiがhttps://wiki.yourproject.googlecode.com/hg/のルートディレクトリ
(wiki/ではない)にあることを除いては同じです。

注意: wikiはISO-639 2レター言語コードのサブセット(2,3のコードはロケール固有コードを含む(zh_Hansのような))を
受け付けます。そういったロケール固有コードはハイフォンセパレータを使わなければなりません。(zhHans)

いくつかの言語の例は以下の表で指定されています?

Language (Locale) Directory Name
Arabic ar
Bulgarian bg
Chinese (China) zh-Hans
Chinese (Taiwan) zh-Hant
Croatian hr
Czech cs
Danish da
Dutch nl
English (United Kingdom) en-GB
English (United States) en-US
Finnish fi
French fr
German de
Greek el
Hebrew he
Hungarian hu
Italian it
Japanese ja
Korean ko
Norwegian no
Polish pl
Portuguese (Brazil) pt-BR
Romanian ro
Russian ru
Slovak sk
Spanish es
Swedish sv
Turkish tr
Googleによって作成されたこのページの内容はCreative Commons Attribution 3.0 License
ライセンスされています。 ユーザーが生成した内容はこのライセンスに含まれません。