Template:Docinfo/doc

From open-support.info

---

Revision as of 02:00, 15 April 2011

This is a documentation subpage for Template:Docinfo (see that page for the template itself). It contains usage information, categories, interlanguage links and other content that is not part of the original template page.

Contents 1 Function 2 Usage 3 Parameters 4 Examples 4.1 Demonstration pages 4.2 Query 5 Related templates 6 Related pages

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. {{documentation paramlist	name= return	desc= determins parameter name which is used as return value of this template.	def= 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

• Docinfo Demo1 – No description.
• Docinfo Demo1 draft – No description.
• Docinfo Demo1 in-sync – No description.
• Docinfo Demo1 out-of-sync – No description.
• Docinfo Demo1 nowarn – No description.
• Docinfo Demo1 obsolete – No description.
• Docinfo Demo1 other – No description.
• Docinfo Demo2 not-exist – No description.
• Docinfo Demo3 – No description.
• Docinfo Demo3 not-ready – No description.
• Docinfo Demo4 external – No description.
• Docinfo Demo5 interwiki – No description.

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

• Template:Docinfo/draft – No description.
• Template:Docinfo/effective – No description.
• Template:Docinfo/obsolete – No description.
• Template:Docinfo/others – No description.
• Template:Docinfo/null – No description.
• Template:Docinfo/unknown-master – No description.
• Template:Docinfo/unknown-rev – No description.
• Template:Docinfo/updated – No description.
• Template:Docinfo/query/example1 – No description.
• Template:Docinfo/query/example2 – No description.

Related pages

• Property:Docinfo master page – describes the master page information of a document.
• Property:Docinfo master rev – describes the revision id information of the master page of a document.
• Property:Docinfo status – describes the status information of a document.
• Property:Docinfo progress – describes the completeness information of a document.
• Property:Docinfo category – describes the category information of a document.
• Property:Docinfo priority – describes the priority information of a document.
• Property:Docinfo language – describes the language code for what language the page is prepared.
• Property:Docinfo author – describes the author information of a document.
• Property:Docinfo editor – describes the editor information of a document.
• Property:Docinfo support – describes the support staff information of a document.
• Property:Revision id – describes the revision id of the page itself.
• Property:Namespace – describes the namespace information of the page itself.
• Property:Worn by – describes a source of warning.
• Property:Warning – describes a warning message.

• Category:Documentation – No description.
• Category:Documentation by status – No description.
• Category:Draft pages – No description.
• Category:Draft templates – No description.
• Category:Effective pages – No description.
• Category:Effective templates – No description.
• Category:Obsolete pages – No description.
• Category:Obsolete templates – No description.
• Category:Other pages – No description.
• Category:Other templates – No description.
• Category:Demo pages – No description.
• Category:Docinfo demo pages – No description.