Mostly Harmless

Difference between revisions of "Template:Infobox interface/doc"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(New page: <noinclude>{{Documentation subpage}}</noinclude> <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> ==Usage== This template provides an info box for an interface cla...)
 
Line 7: Line 7:
 
<pre>
 
<pre>
 
{{Infobox interface
 
{{Infobox interface
| interface = Interface
+
| interface = UIDataStorePublisher
| package  = Core
+
| package  = UTGame
| engine    = UE3
+
| game      = UT3
 +
| tree      =
 +
+ [[UE3:UIDataStoreSubscriber (UT3)|]]
 +
++ [[UE3:UIDataStorePublisher (UT3)|]]
 
}}
 
}}
 
</pre>
 
</pre>
  
Only '''package''' is mandatory. If '''interface''', '''game''' or '''engine''' are missing, they are derived from the current page name. The parameter '''engine''' is only used if no game could be derived from parameter or page name. The class in the '''within''' parameter is automatically linked, if possible. It's usually better to let the template derive game and/or engine from the page name.
+
Only '''package''' is mandatory. If '''interface''', '''game''' or '''engine''' are missing, they are derived from the current page name. The parameter '''engine''' is only used if no game could be derived from parameter or page name. It's usually better to let the template derive game and/or engine from the page name. A '''tree''' should only be specified if the interface has a parent interface other than Interface, which should not be included in the tree.
  
 
==See also==
 
==See also==

Revision as of 08:23, 4 March 2008

This subpage contains documentation, categories and other content that is not part of the template.
To view the template page itself, see Template:Infobox interface.

Usage

This template provides an info box for an interface class. The info box can contain relevant information like parent interfaces.

Example:

{{Infobox interface
| interface = UIDataStorePublisher
| package   = UTGame
| game      = UT3
| tree      =
+ [[UE3:UIDataStoreSubscriber (UT3)|]]
++ [[UE3:UIDataStorePublisher (UT3)|]]
}}

Only package is mandatory. If interface, game or engine are missing, they are derived from the current page name. The parameter engine is only used if no game could be derived from parameter or page name. It's usually better to let the template derive game and/or engine from the page name. A tree should only be specified if the interface has a parent interface other than Interface, which should not be included in the tree.

See also