Template:Docinfo/doc

{{documentation subpage}}
== {{message|Function|anchor}} ==

{{LangSwitch
|en = This is a semantic template which stores some basic attributes for documentation managemet.

This template also provides visual annunciations for readers on each pages when they are required, in parallel with semantic annotations and MediaWiki categories which make document relations (e.g. authors, editors, and other support staffs) aware of its various status.

These annotations can be queried at any time with [[special:ask]], [[Help:Inline queries|inline queies]] and predefined templates such as &#123;&#123;[[Template:Docinfo/query/example1|docinfo/query/example1]]&#125;&#125; for users' documentation managements, translation works and page updates, etc.
|ja = 文書管理用の各種基本属性を記事に記録するセマンティックテンプレートです。

このテンプレートはまた、状況に応じて読者への視覚警告をページ上に表示するとともに、意味的注釈や MediwWiki カテゴリにより、文書の関係者 （作成者、編集者、その他の協力者等） への注意喚起を行います。 

これらの注釈はいつでも、[[Special:Ask|意味的検索]] や [[Help:Inline queries (ja)|インラインクエリ]]、あらかじめ定義されたテンプレート （例: &#123;&#123;[[Template:Docinfo/query/test1|docinfo/query/example1]]&#125;&#125;） を使用して問い合わせて、ユーザの文書管理や翻訳作業、更新作業等に役立てることができます。
}}

== {{message|Usage|anchor}} ==

 <nowiki>{{</nowiki>docinfo
 | master page =
 | master rev  =
 | master link = internal / external / interwiki
 | status   = draft / effective / obsolete
 | progress =
 | priority =
 | category =
 | author =
 | editor =
 | support =
 | lang =
 | desc =
 | return =
 | nowarn
 <nowiki>}}</nowiki>

== {{message|Parameters|anchor}} ==

{{LangSwitch
|en= All parameters of this template are optional.
|ja= このテンプレートのパラメータは、全て省略可能です。
}}

{{documentation paramlist/begin}}
{{documentation paramlist
|name= master page
|desc= {{LangSwitch
 |en= Primary page name or url, e.g. an original page in translation, an effective version of draft page, etc.  It is similar to 'master page' parameter in [[Template:Docu]] or [[Template:Language]], yet this parameter is not mandatory when the document is the primary one itself.
 |ja= 主ページ名もしくは URL （例: 翻訳文書の翻訳元ページ、ドラフト文書の発効中ページ、等）。 このパラメータは [[Template:Docu]] や [[Template:Language]] の 'master page' パラメータと似ていますが、このページ自体が主文書である場合は省略できます。
 }}
}}
{{documentation paramlist
|name= master rev
|desc= {{LangSwitch
 |en= Revision id of the primary page.  This parameter causes users to keep their documents in sync with its primary page, with visual annunciation, semantic annotations and page categories to notify users when the primary page is updated.
 |ja= 主ページのリビジョン ID。 このパラメータに基づいた、主ページが更新された際の視覚警告表示や意味的注釈、カテゴリ化によって、ユーザは文書と主文書間の同期を保つことができます。
 }}
}}
{{documentation paramlist
|name= master link
|def=  <tt>internal</tt>
|desc= {{LangSwitch
 |en= The type of link to the primary page, avialable values <tt>internal</tt>, <tt>external</tt> and <tt>interwiki</tt>.  If the value is <tt>external</tt>, the parameter "master page" is regarded as url.  And if the value is <tt>external</tt> or <tt>interwiki</tt>, The parameter "master rev" is ignored.

Note: Please do not use the value "external" for a moment, because it has a potential problem to store URL value into [[Property:Docinfo master rev]] which data type is [[Type:Page|page]]. 
 |ja= 主ページへのリンクの種類。 <tt>internal</tt>、<tt>external</tt>、<tt>interwiki</tt> から指定します。 この値が <tt>external</tt> の場合、パラメータ "master page" は URL と見なされます。 またこの値が <tt>external</tt> または <tt>interwiki</tt> の場合、パラメータ "master rev" は無視されます。

備考: 当面の間、このパラメータに "external" を使用しないでください。データ型が [[Type:Page|Page]] であるプロパティ [[Property:Docinfo master rev|Docinfo master rev]] に URL 値を保存すると、問題が発生する恐れがあります。
 }}
}}
{{documentation paramlist
|name= status
|desc= {{LangSwitch
 |en= The documentation status descriptor, available values <tt>draft</tt>, <tt>effective</tt> and <tt>obsolete</tt>.
 |ja= 文書状態指定子。 <tt>draft</tt>、<tt>effective</tt>、<tt>obsolete</tt> から指定します。
 }}
|def=  {{LangSwitch
 |en= <tt>draft</tt> if parameter "master page" specified, otherwise <tt>effective</tt>.
 |ja= パラメータ "master page" が指定されている場合は <tt>draft</tt>、それ以外は <tt>effective</tt>。
 }}
}}
{{documentation paramlist
|name= progress
|desc= {{LangSwitch
 |en= Arbitrary string to determin the completeness of the document.
 |ja= 文書の完成度・作業進捗度を表す任意の文字列。
 }}
}}
{{documentation paramlist
|name= priority
|desc= {{LangSwitch
 |en= Arbitrary string to determine the priority of the document.
 |ja= 文書の重要度・作業優先度を表す任意の文字列。
 }}
}}
{{documentation paramlist
|name= category
|desc= {{LangSwitch
 |en= Category or list of categories separated with camma (,).  The document will be annotated and categorised with the value.
 |ja= カテゴリ、またはカンマ （,） 区切りで表記されたカテゴリ一覧。 この値により、文書が注釈およびカテゴリ化されます。
 }}
}}
{{documentation paramlist
|name= author
|desc= {{LangSwitch
 |en= User or list of users separated with comma (,) to determine the author(s) of the document.
 |ja= 文書の作成者を、ユーザ名、またはカンマ区切りで表記されたユーザ名一覧で指定します。
 }}
}}
{{documentation paramlist
|name = editor
|desc = {{LangSwitch
 |en= User or list of users separated with comma (,) to determine the editor(s) of the document.
 |ja= 文書の編集者を、ユーザ名、またはカンマ区切りで表記されたユーザ名一覧で指定します。
 }}
}}
{{documentation paramlist
|name= support
|desc= {{LangSwitch
 |en= User or list of users separated with comma (,) to determine other resources involved in the document, e.g. checker(s), administrator(s), etc.
 |ja= 文書のその他の関係者 （校閲者、文書管理者等） を、ユーザ名、またはカンマ区切りで表記されたユーザ名一覧で指定します。
 }}
}}
{{documentation paramlist
|name= lang
|def=  en
|desc= {{LangSwitch
 |en= Language code which determes for what language the page is prepared.  If a page is plurilingual, you may specify more than one language code seperated with comma. 
 |ja= 言語コード。 ページがどの言語のために作成されているかを示します。 文書が複数の言語に対応している場合は、複数の言語コードをカンマ区切りで指定できます。
 }}
}}
{{documentation paramlist
|name= desc
|desc= {{LangSwitch
 |en= Arbitrary text to determine the document description.  The value is optional, but recommended in all documents.  If the value is nothing, the document will be annotated and categorised with "No description" warning, without visual annunciation.
 |ja= 文書の概要を説明するテキスト。 この値はオプションですが、全ての文書で設定することを推奨します。 この値が設定されない場合は、"概要説明がない" 旨で注釈およびカテゴリ化されます。 ただし視覚警告は表示されません。
 }}
}}
{{documentation paramlist
|name= return
|desc= {{LangSwitch
 |en= determins parameter name which is used as return value of this template.
 |ja= テンプレートが返す値としてどのパラメータを使用するか指定します。
 }}
|def= {{LangSwitch
 |en= ''blank'' (no return value)
 |ja= ''空白'' （値を返しません）
 }}
}}
{{documentation paramlist
|name= nowarn
|desc= {{LangSwitch
 |en= To supress visual annunciations for readers, still there is annotaions and categories to call attention to users who are involved in the document.
 |ja= 読者への各種の視覚警告を表示しません。 ただし、注釈やカテゴリ化による、文書の関係者への注意喚起は行われます。
 }}
}}
{{documentation paramlist/end}}

== {{message|Examples|anchor}} ==

=== {{LangSwitch
|en= Demonstration pages
|ja= デモページ
|anchor
|nocat
}} ===

* {{documentation desc|Docinfo Demo1}}
* {{documentation desc|Docinfo Demo1 draft}}
* {{documentation desc|Docinfo Demo1 in-sync}}
* {{documentation desc|Docinfo Demo1 out-of-sync}}
* {{documentation desc|Docinfo Demo1 nowarn}}
* {{documentation desc|Docinfo Demo1 obsolete}}
* {{documentation desc|Docinfo Demo1 other}}
* {{documentation desc|Docinfo Demo2 not-exist}}
* {{documentation desc|Docinfo Demo3}}
* {{documentation desc|Docinfo Demo3 not-ready}}
* {{documentation desc|Docinfo Demo4 external}}
* {{documentation desc|Docinfo Demo5 interwiki}}

=== {{message|Query|anchor}} ===
<pre>
{{#ask:[[Category:Docinfo demo pages]]
|?docinfo status = Status
|?docinfo author = Author
|?docinfo editor = Editor
|?warning        = Warning
|?description    = Description
}}
</pre>
{{#ask:[[Category:Docinfo demo pages]]
|?docinfo status = <br />&nbsp;Status
|?docinfo author = <br />&nbsp;Author
|?docinfo editor = <br />&nbsp;Editor
|?warning        = <br />&nbsp;Warning
|?description    = <br />&nbsp;Description
}}

<pre>
{{docinfo/query/example1|User1}}
</pre>
{{docinfo/query/example1|User1}}

== {{message|Related templates|anchor}} ==
* {{documentation desc|Template:Docinfo/draft}}
* {{documentation desc|Template:Docinfo/effective}}
* {{documentation desc|Template:Docinfo/obsolete}}
* {{documentation desc|Template:Docinfo/others}}
* {{documentation desc|Template:Docinfo/null}}
* {{documentation desc|Template:Docinfo/unknown-master}}
* {{documentation desc|Template:Docinfo/unknown-rev}}
* {{documentation desc|Template:Docinfo/updated}}
* {{documentation desc|Template:Docinfo/query/example1}}
* {{documentation desc|Template:Docinfo/query/example2}}

== {{message|Related pages}} ==
* {{documentation desc|Property:Docinfo master page}}
* {{documentation desc|Property:Docinfo master rev}}
* {{documentation desc|Property:Docinfo status}}
* {{documentation desc|Property:Docinfo progress}}
* {{documentation desc|Property:Docinfo category}}
* {{documentation desc|Property:Docinfo priority}}
* {{documentation desc|Property:Docinfo language}}
* {{documentation desc|Property:Docinfo author}}
* {{documentation desc|Property:Docinfo editor}}
* {{documentation desc|Property:Docinfo support}}
* {{documentation desc|Property:Description}}
* {{documentation desc|Property:Revision id}}
* {{documentation desc|Property:Namespace}}
* {{documentation desc|Property:Worn by}}
* {{documentation desc|Property:Warning}}


* {{documentation desc|Category:Documentation}}
* {{documentation desc|Category:Documentation by status}}
* {{documentation desc|Category:Draft pages}}
* {{documentation desc|Category:Draft templates}}
* {{documentation desc|Category:Effective pages}}
* {{documentation desc|Category:Effective templates}}
* {{documentation desc|Category:Obsolete pages}}
* {{documentation desc|Category:Obsolete templates}}
* {{documentation desc|Category:Other pages}}
* {{documentation desc|Category:Other templates}}
* {{documentation desc|Category:Demo pages}}
* {{documentation desc|Category:Docinfo demo pages}}

<includeonly>
[[Category:Documentation templates|{{PAGENAME}}]]
</includeonly>