Template:Docinfo

From open-support.info

(Difference between revisions)
Jump to: navigation, search
m
m
 
(7 intermediate revisions not shown)
Line 55: Line 55:
|docinfo priority ={{#switch:{{{priority|}}}<!--
|docinfo priority ={{#switch:{{{priority|}}}<!--
       en    de      fr      es      it      ru        ja  zh-hans -->
       en    de      fr      es      it      ru        ja  zh-hans -->
-
  |0|u|urgent|dringend|urgent |urgente |urgente|срочный  |緊急|紧急
+
  |0|u|urgent|dringend|urgent |urgente |urgente|срочный  |緊急|?急
  |1|t|top  |oben    |top    |arriba  |top    |Лучшие    |最高|最高的 =1
  |1|t|top  |oben    |top    |arriba  |top    |Лучшие    |最高|最高的 =1
  |2|h|high  |hoch    |haute  |alta    |alto  |высокая  |高  |高    =2
  |2|h|high  |hoch    |haute  |alta    |alto  |высокая  |高  |高    =2
-
  |3|n|normal|normal  |normale|normales|normale|нормальный|通常|常态   =3
+
  |3|n|normal|normal  |normale|normales|normale|нормальный|通常|常?   =3
  |4|l|low  |niedrig |faible |baja    |basso  |низкая    |低  |低    =4
  |4|l|low  |niedrig |faible |baja    |basso  |низкая    |低  |低    =4
  |#default=3
  |#default=3
  }}
  }}
-
}}{{#if:{{{master page|}}}|{{#set:docinfo master page={{{master page}}} }}
+
|docinfo master page={{#if:{{{master page|}}}|{{{master page}}}|{{FULLPAGENAME}}}}
}}{{#if:{{{master rev|}}} |{{#set:docinfo master rev ={{{master rev}}} }}
}}{{#if:{{{master rev|}}} |{{#set:docinfo master rev ={{{master rev}}} }}
-
}}{{#if:{{{category|}}}
+
}}{{#if:{{#ifeq:{{{category|}}}|-||{{{category|}}} }}
-
|{{#arraymap:{{{category|}}}|,|x|{{#set:docinfo category=Category:x}}[[Category:x|{{PAGENAME}}]]}}
+
|{{#arraymap:{{{category|}}}|,|x|{{#set:docinfo category=Category:{{PAGENAME:x}}}}[[Category:{{PAGENAME:x}}|{{PAGENAME:x}}]]}}
|{{#set:docinfo category=-}}
|{{#set:docinfo category=-}}
-
}}{{#if:{{{author|}}}
+
}}{{#if:{{#ifeq:{{{author|}}}|-||{{{author|}}} }}
-
|{{#arraymap:{{{author|}}}  |,|x|{{#set:docinfo author=User:x}}}}
+
|{{#arraymap:{{{author|}}}  |,|x|{{#set:docinfo author=User:{{PAGENAME:x}}}}}}
|{{#set:docinfo author=-}}
|{{#set:docinfo author=-}}
-
}}{{#if:{{{editor|}}}
+
}}{{#if:{{#ifeq:{{{editor|}}}|-||{{{editor|}}} }}
-
|{{#arraymap:{{{editor|}}}  |,|x|{{#set:docinfo editor=User:x}}}}
+
|{{#arraymap:{{{editor|}}}  |,|x|{{#set:docinfo editor=User:{{PAGENAME:x}}}}}}
|{{#set:docinfo editor=-}}
|{{#set:docinfo editor=-}}
-
}}{{#if:{{{support|}}}
+
}}{{#if:{{#ifeq:{{{support|}}}|-||{{{support|}}} }}
-
|{{#arraymap:{{{support}}} |,|x|{{#set:docinfo support=User:x}}}}
+
|{{#arraymap:{{{support}}} |,|x|{{#set:docinfo support=User:{{PAGENAME:x}}}}}}
|{{#set:docinfo support=-}}
|{{#set:docinfo support=-}}
}}{{#if:{{{lang|}}}
}}{{#if:{{{lang|}}}
Line 80: Line 80:
|{{#set:docinfo language=en}}
|{{#set:docinfo language=en}}
}}{{{ {{{return|}}}| }}}</includeonly></onlyinclude>
}}{{{ {{{return|}}}| }}}</includeonly></onlyinclude>
-
{{#set:
 
-
|Docinfo author  = User:Dick6809
 
-
|Docinfo category = -
 
-
|Docinfo editor  = -
 
-
|Docinfo language = en
 
-
|Docinfo priority = 3
 
-
|Docinfo progress = 95
 
-
|Docinfo status  = effective
 
-
|Docinfo support  = -
 
-
|Namespace        = {{NAMESPACE}}
 
-
|Revision id      = {{REVISIONID}}
 
-
|Description      = specifies page information for documentation management.
 
-
}}
 
{{documentation includeonly}}
{{documentation includeonly}}
{{documentation}}
{{documentation}}

Latest revision as of 21:10, 21 April 2011

The results of this template are not shown here.

[edit] [purge] Template documentation

Template:Docinfo – specifies page information for documentation management.

Contents

Function

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, inline queies and predefined templates such as {{docinfo/query/example1}} for users' documentation managements, translation works and page updates, etc.

Usage 

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

Parameters

All parameters of this template are optional.

  • master page 
 –  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.
  • master rev 
 –  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.
  • master link 
 –  The type of link to the primary page, avialable values internal, external and interwiki. If the value is external, the parameter "master page" is regarded as url. And if the value is external or interwiki, 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 page.
Default value: internal

  • status 
 –  The documentation status descriptor, available values draft, effective and obsolete.
Default value: draft if parameter "master page" specified, otherwise effective.
  • progress 
 –  Arbitrary string to determin the completeness of the document.
  • priority 
 –  Arbitrary string to determine the priority of the document.
  • category 
 –  Category or list of categories separated with camma (,). The document will be annotated and categorised with the value.
  • author 
 –  User or list of users separated with comma (,) to determine the author(s) of the document.
  • editor 
 –  User or list of users separated with comma (,) to determine the editor(s) of the document.
  • support 
 –  User or list of users separated with comma (,) to determine other resources involved in the document, e.g. checker(s), administrator(s), etc.
  • lang 
 –  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.
Default value: en
  • desc 
 –  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.
  • return 
 –  determins parameter name which is used as return value of this template.
Default value: blank (no return value)
  • nowarn 
 –  To supress visual annunciations for readers, still there is annotaions and categories to call attention to users who are involved in the document.

Examples

Demonstration pages

Query 

{{#ask:[[Category:Docinfo demo pages]]
|?docinfo status = Status
|?docinfo author = Author
|?docinfo editor = Editor
|?warning        = Warning
|?description    = Description
}}



{{docinfo/query/example1|User1}}

All documents in which User1 involved:


Related templates

Related pages


Retrieved from "http://open-support.sakura.ne.jp/wiki/index.php?title=Template:Docinfo"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox