Difference between revisions of "Template:PrecisImage"

From OrbiterWiki
Jump to navigation Jump to search
m (default description = image name)
(documented)
 
Line 1: Line 1:
 +
<noinclude>
 +
The '''PrecisImage''' template should be used to display an image in an article's precis. It helps ensure that the image style is consistent.
 +
 +
Here are some usage examples:
 +
 +
{| class="centeredCells"
 +
|-
 +
! What you type !! &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; What it looks like
 +
|-
 +
| <tt><nowiki>{{PrecisImage | img=MyImage.jpg | desc=This is my image}}</nowiki></tt><br/>(hover the mouse over image to see the <tt>desc</tt>ription) || {{PrecisImage | img=MyImage.jpg | desc=This is my image}}
 +
|-
 +
| <tt><nowiki>{{PrecisImage | img=MyImage.jpg | border=red}}</nowiki></tt> || {{PrecisImage | img=MyImage.jpg | border=red}}
 +
|-
 +
| <tt><nowiki>{{PrecisImage | img=MyImage.jpg | border=#08f}}</nowiki></tt> || {{PrecisImage | img=MyImage.jpg | border=#08f}}
 +
|-
 +
| <tt><nowiki>{{PrecisImage | img=MyImage.jpg | border=none}}</nowiki></tt> || {{PrecisImage | img=MyImage.jpg | border=none}}
 +
|-
 +
| <tt><nowiki>{{PrecisImage | img=MyImage.jpg | size=50px}}</nowiki></tt> || {{PrecisImage | img=MyImage.jpg | size=50px}}
 +
|}
 +
 +
==Usage notes==
 +
The use of the '''desc''' parameter is highly '''encouraged''' - make it descriptive!
 +
 +
The use of the '''border''' and especially the '''size''' parameter is '''discouraged''' - only do so if you really need to! (Example of justified use of <tt>size</tt>: [[Ariane 5/precis]]; <tt>border</tt>: [[LEO-lunar_transfer/precis]])
 +
 +
==Precis==
 +
A ''precis'' is a short introduction which can be randomly displayed on the Main Page to "advertise" the article. Here is an example of a random precis - if you reload this page (F5) you will see it change:
 +
 +
{|
 +
|-
 +
| {{OrbiterWiki:Random addon}}
 +
|}
 +
 +
<!--================================================-->
 +
<!--====Be careful when editing below this line=====-->
 +
<!--================================================-->
 +
<div style="display:none">
 +
</noinclude>
 
<div style="float:left;margin-right:0.9em;border:1px solid {{{border|black}}}">
 
<div style="float:left;margin-right:0.9em;border:1px solid {{{border|black}}}">
 
[[Image:{{{img}}}|none|{{{size|100px}}}|{{{desc|{{{img}}}}}}]]
 
[[Image:{{{img}}}|none|{{{size|100px}}}|{{{desc|{{{img}}}}}}]]
 
</div>
 
</div>
 +
<noinclude>
 +
</div>
 +
</noinclude>

Latest revision as of 12:09, 14 February 2008

The PrecisImage template should be used to display an image in an article's precis. It helps ensure that the image style is consistent.

Here are some usage examples:

What you type           What it looks like
{{PrecisImage | img=MyImage.jpg | desc=This is my image}}
(hover the mouse over image to see the description)
This is my image
{{PrecisImage | img=MyImage.jpg | border=red}}
MyImage.jpg
{{PrecisImage | img=MyImage.jpg | border=#08f}}
MyImage.jpg
{{PrecisImage | img=MyImage.jpg | border=none}}
MyImage.jpg
{{PrecisImage | img=MyImage.jpg | size=50px}}
MyImage.jpg

Usage notes[edit]

The use of the desc parameter is highly encouraged - make it descriptive!

The use of the border and especially the size parameter is discouraged - only do so if you really need to! (Example of justified use of size: Ariane 5/precis; border: LEO-lunar_transfer/precis)

Precis[edit]

A precis is a short introduction which can be randomly displayed on the Main Page to "advertise" the article. Here is an example of a random precis - if you reload this page (F5) you will see it change:

Building a payload hierarchy with CVEL/GPDS

CVE-lite (abridged Common Vessel Extensions) is a programming library to aid developers of add-on vessels for Orbiter 2003-2006. It extends the native Orbiter VESSEL class with additional functionality for multiple payloads, enhanced mesh handling or scenario-file based multistage support. It implements the Generic Payload Description System (GPDS) scenario syntax to allow the end user to express via simple lines in the scenario file any payload and, if using another CVEL vessel, any additional upper stages. (More...)


[[Image:{{{img}}}|none|100px|{{{img}}}]]