Editing Template:Cosmos/doc

'''{{tl|Cosmos}}''' is for use in any article about a cosmological entity in the [[Pathfinder campaign setting]]. Some parameters are ''optional'' and can be left blank; if undefined, these optional parameters will not appear as part of the template.

This template is based upon the {{tl|Nation}} template of [[PathfinderWiki|this wiki]], which, in turn, is based upon the [[frw:Template:Book|Book]] and [[frw:Template:Deity|Deity]] templates on the [[frw:Main_Page|Forgotten Realms Wiki]].
__TOC__
== Template ==

<pre>
{{Cosmos
| image       = 
| name        = 
| titles      = 
| type        = 
| plane       = 
| adjective   = 
| diameter    = 
| mass        = 
| gravity     = 
| atmosphere  = 
| orbit       = 
| inhabitants = 
| satellites  = 
| imagesof    = 
| source      = 
| page        = 
}}
</pre>

== Usage ==

; image ''(optional)'': An image or map of the cosmological entity. Should be given without <code>[[]]</code> or any settings.

; name: The name of the cosmological entity.

; titles ''(optional)'': Titles or alternative names that represent the cosmological entity.

; type ''(optional)'': The type of cosmological entity described, such as Planet, Comet, Constellation, Moon, Star, Asteroid belt, ''etc.''

; plane ''(optional)'': The [[plane]] on which the entity exists.

; adjective ''(optional)'': The adjective used to describe entities of or pertaining or relating to the cosmological entity.

; diameter ''(optional)'': The diameter of the cosmological entity as compared to [[Golarion|Golarion's]], in the form 'xn' where n is a number or fraction. For instance, a diameter of x 2 indicates a diameter twice that of Golarion's.

; mass ''(optional)'': The mass of the cosmological entity as compared to Golarion's, in the form 'xn' (see diameter above for an explanation).

; gravity ''(optional)'': The gravity of the cosmological entity as compared to Golarion's, in the form 'xn' (see diameter above for an explanation).

; atmosphere ''(optional)'': The atmosphere of the cosmological entity as compared to Golarion's.

; orbit ''(optional)'': The length of an orbiting body's year (one complete revolution) measured in Golarion days.

; inhabitants ''(optional)'': The most-commonly encountered inhabitants of the cosmological entity.

; satellites ''(optional)'': The names of the satellites of the cosmological entity linked to their own page on the wiki.

; imagesof ''(optional)'': A link to the category containing images of the realm. If omitted, this automatically links to a <nowiki>[[Category:Images of ...]]</nowiki> category using the page name if one already exists.

; source & page ''(optional)'': The source wherein the settlement was first mentioned, or from which the most information is available. Link the title, and include page number if possible.

== Examples ==

{{Cosmos
| image       = File:Golarion symbol.svg
| name        = Golarion
| titles      = The Cage, the Child
| type        = Planet
| plane       = [[Material Plane]]
| adjective   = Golarian
| diameter    = x 1
| mass        = x 1
| gravity     = x 1
| atmosphere  = Standard
| orbit       = 1 year
| inhabitants = [[Human]]s, [[elf|elves]], [[dwarf|dwarves]], [[gnome]]s, [[halfling]]s, [[orc]]s, [[goblinoid]]s, and countless other races
| satellites  = [[Moon (Golarion)|One moon]]
}}
<pre>
{{Cosmos
| image       = File:Golarion symbol.svg
| name        = Golarion
| titles      = The Cage, the Child
| type        = Planet
| plane       = [[Material Plane]]
| adjective   = Golarian
| diameter    = x 1
| mass        = x 1
| gravity     = x 1
| atmosphere  = Standard
| orbit       = 1 year
| inhabitants = [[Human]]s, [[elf|elves]], [[dwarf|dwarves]], [[gnome]]s, [[halfling]]s, [[orc]]s, [[goblinoid]]s, and countless other races
| satellites  = [[Moon (Golarion)|One moon]]
}}
</pre>

<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>