Cogito, ergo sum

Difference between revisions of "Template:Classname/doc"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m
m
Line 4: Line 4:
 
This utility template extracts the game name from a class page name. Game-specific class pages may have a game name appended in parentheses and due to technical restrictions have spaces instead of underscores.
 
This utility template extracts the game name from a class page name. Game-specific class pages may have a game name appended in parentheses and due to technical restrictions have spaces instead of underscores.
  
For example "UE2:ACTION GotoMenu (UT2003)" is the canonical name of the page about the UT2003 version of the ACTION_GotoMenu class. This template would strip the game name and namespace prefix and replace the space with an underscore to return exactly that: "ACTION_GotoMenu".
+
For example "UE2:ACTION GotoMenu (UT2003)" is the canonical name of the page about the UT2003 version of the ACTION_GotoMenu class. This template would strip the game name and namespace prefix and replace the space with an underscore to return "ACTION_GotoMenu".
  
'''Note:''' This template assumes that the class page is a top-level page and the template is used at most a single level below the actual class page.
+
'''Note:''' This template assumes that it is used on the actual page named after the class. If the page name contains a game name or other information, those should be enclosed in parentheses and separated from the class name by a space, for example "Actor (UT)" or "Vehicle (UT2004)".
  
 
==See also==
 
==See also==

Revision as of 16:14, 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:Classname.

Usage

This utility template extracts the game name from a class page name. Game-specific class pages may have a game name appended in parentheses and due to technical restrictions have spaces instead of underscores.

For example "UE2:ACTION GotoMenu (UT2003)" is the canonical name of the page about the UT2003 version of the ACTION_GotoMenu class. This template would strip the game name and namespace prefix and replace the space with an underscore to return "ACTION_GotoMenu".

Note: This template assumes that it is used on the actual page named after the class. If the page name contains a game name or other information, those should be enclosed in parentheses and separated from the class name by a space, for example "Actor (UT)" or "Vehicle (UT2004)".

See also