Differences

This shows you the differences between two versions of the page.

jp:faq:editing_hints [2008/02/08 19:49] (current)
Line 1: Line 1:
 +====== 編集する際のヒント =====
 +
 +以下はこの wiki を編集する際のヒントです。
 +
 +ほとんどの場合、最も簡単な方法はページを編集する際に表示されるツールバーを使うことです。ほとんどのアイコンは見た目でわかるようになっているはずですが、マウスカーソルを上に乗せればツールティップを確認することができるでしょう。
 +
 +===== ソースコード、シェルを使った例、など =====
 +
 +コードの断片を %%<code>%% タグの中に入れるだけです。特定のプログラミング言語で書かれたコードを含める場合には、単純にタグの中に言語の名前を入れてください。以下は %%<code perl>%% タグの中に入れられたコードです。
 +
 +<code perl>
 +#!/usr/bin/perl
 +use strict;
 +
 +print "Hello, World!\n";
 +</code>
 +
 +専用のブロックに入れることがふさわしくないような短いコード例を掲載する場合、2 重の引用符で囲むことができます。%%''/usr/bin/perl''' は ''/usr/bin/perl'' となります。
 +
 +===== 解釈を止める =====
 +
 +あまり頻繁には起こらないでしょうが、もし(Wiki の)解釈を止めたいときには、2 重のパーセント記号でテキストを囲むことができます。''<nowiki>%%</nowiki>'' のように。
 +
 +===== リンク =====
 +
 +古い wiki にはキャメルケース(複数の単語で構成される単語を、それぞれの単語の頭を大文字にしたものをつなげて表現したもの。CamelCase のような)をリンクとして扱う機能がありました。お分かりのとおり、新しい wiki にもこの機能があります。しかしキャメルケースのキーワードを使ってリンクをするのはもうお勧めできません。私たちはできるだけ早くこの機能を無効にしたいと考えています。キャメルケースは読みにくいですし、この機能は、リンクするべきでない、例えば「PowerBook」といった単語をリンクとして扱ってしまうことがよくあります。ページへのリンクを設定するには、単純にページの名称を 2 重の括弧でくくります。%%[[Perl programming]]%% とか、単純に %%[[Perl]]%% といったように。
 +
 +===== 名前空間(ネームスペース) =====
 +
 +dokuwiki のエンジンには「名前空間」と呼ばれる機能があります。これはディスクにおけるディレクトリのようなもので、情報を整理しておくのに役に立ちます。例えば、私たちは現在日本語のドキュメントを [[:jp|jp]] ネームスペースに置いています。通常、他のページへのリンクはいつも現在のネームスペースからの相対リンクとなります。ですから、[[:faq]] ネームスペースに属するページを編集していて %%[[test]]%% というリンクを作成した場合、このリンクは faq ネームスペースの中にあるページを指すことになります。
 +
 +全体のネームスペースへのリンクを貼りたい(貼る必要がある)場合は、ページのタイトルの前にコロンをつける必要があります。%%[[:test]]%% のように。
 +
 +また、ネームスペースを入れ子にすることもできます。例えば、新しい [[:jp|jp]] ネームスペースの中に、[[:jp::faq|jp:faq]] という別の新しいネームスペースを作成することができます。
 +
 +[[:faq:editing_hints|原文]]
 +
 +[[:jp:FAQ | FAQ 初学者向けの Q&A 集]]
 +
 +[[:jp | POPFile ドキュメンテーションプロジェクト]]
 
jp/faq/editing_hints.txt · Last modified: 2008/02/08 19:49 (external edit)

Should you find anything in the documentation that is incomplete, unclear, outdated or just plain wrong, please let us know and leave a note in the Documentation Forum.

Recent changes RSS feed Donate Driven by DokuWiki
The content of this wiki is protected by the GNU Fee Documentation License