ドキュメントの記法

ドキュメントは Markdown と Texy の記法に、いくつかの拡張を加えたものを使います。

リンク

内部のリンクには角かっこの書き方 [link] を使います。これは縦棒を使う形 [リンクの文 |リンクの行き先]、あるいは行き先が文と同じ場合（小文字とハイフンへ変換したうえで）の短い形 [リンクの文] です。

• [Page name] → <a href="/en/page-name">Page name</a>
• [link text |Page name] → <a href="/en/page-name">link text</a>

別の言語版や別の区画へもリンクできます。区画とは Nette のライブラリ（たとえば forms、latte など）や、best-practices、quickstart などの特別な区画のことです。

• [cs:Page name] → <a href="/cs/page-name">Page name</a>（同じ区画、違う言語）
• [tracy:Page name] → <a href="//tracy.nette.org/en/page-name">Page name</a>（違う区画、同じ言語）
• [tracy:cs:Page name] → <a href="//tracy.nette.org/cs/page-name">Page name</a>（違う区画と言語）

# を使ってページの特定の見出しを指すこともできます。

• [#Heading] → <a href="#toc-heading">Heading</a>（今のページの見出し）
• [Page name#Heading] → <a href="/en/page-name#toc-heading">Page name</a>

区画のトップページへのリンクです（@home は区画のトップページを表す特別な語です）。

• [link text |@home] → <a href="/en/">link text</a>
• [link text |tracy:] → <a href="//tracy.nette.org/en/">link text</a>

API のドキュメントへのリンク

いつも次の書き方を使ってください。

• [api:Nette\SmartObject] → Nette\SmartObject
• [api:Nette\Forms\Form::setTranslator()] → Nette\Forms\Form::setTranslator()
• [api:Nette\Forms\Form::$onSubmit] → Nette\Forms\Form::$onSubmit
• [api:Nette\Forms\Form::Required] → Nette\Forms\Form::Required

完全修飾の名前は最初に触れるときだけ使ってください。そのあとのリンクには短くした名前を使います。

• [Form::setTranslator() |api:Nette\Forms\Form::setTranslator()] → Form::setTranslator()

PHP のドキュメントへのリンク

• [php:substr] → substr

ソースコード

コードのかたまりは ```lang で始まり ``` で終わります。対応している言語は php、latte、neon、html、css、js、sql です。字下げにはいつもタブを使ってください。

 ```php
	public function renderPage($id)
	{
	}
 ```

```php .{file: ArrayTest.php} のようにファイル名も指定でき、そのコードのかたまりは次のように描かれます。

public function renderPage($id)
{
}

見出し

いちばん上の見出し（ページの名前）はアスタリスク（*）で下線を引きます。節を分けるには等号（=）を使います。見出しはまず等号（=）で、次にハイフン（-）で下線を引きます。

MVC Applications & Presenters
*****************************
...


Link Creation
=============
...


Links in Templates
------------------
...

囲みとスタイル

クラス .[perex] で印を付けた perex

クラス .[note] で印を付けた note

クラス .[tip] で印を付けた tip

クラス .[caution] で印を付けた caution

クラス .[warning] で印を付けた強い警告

バージョン番号 .{data-version:2.4.10}

クラスは、それが当たる行の前に書くべきです。

.[perex]
これが perex です。

.[tip] のような囲みは目を引くので、大事な情報を強調するのに使うべきで、あまり重要でない細部には使わないでください。控えめに使ってください。

目次

目次（右の欄のリンク）は、大きさが 4,000 バイトを超えるすべてのページに自動的に作られます。この既定の振る舞いは {{toc}} のメタタグで変えられます。目次の文は既定では見出しからそのまま取られますが、.{toc} の修飾子で違う文を表示させられます。長い見出しに便利です。

Long and Intelligent Heading .{toc: A Different Text for TOC}
=============================================================

メタタグ

• ページの題名を独自に決めます（<title> とパンくずで）。{{title: Another name}}
• リダイレクト。{{redirect: pla:cs}} – リンクをご覧ください
• 自動の目次（見出しへのリンクの囲み）を強いる {{toc}} か、切る {{toc: no}}。
• 左のメニューを設定する {{leftbar: utils:@left-menu}} か、切る {{leftbar: no}}。