Tool – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
(Undo revision 78482 by Fred Gandt, incorrect layout in some pages)
m (Add doc)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<includeonly>__NOTOC__ __NOEDITSECTION__ <div class="tool_description">
<includeonly>__NOTOC____NOEDITSECTION__<div class="_description tool">


=== Basic information ===
=== Basic information ===
<dl>
<dl>
<dt>Author:<dd>{{{AUTHOR|}}}
<dt>Author:<dd>{{#if:{{{AUTHOR|}}}|{{{AUTHOR|}}}|[[:Category:Projects|Bohemia Interactive]]}}
{{#if:{{{VERSION|}}}|<dt>Version:<dd>{{{VERSION}}}|}}
{{#if:{{{VERSION|}}}|<dt>Version:<dd>{{{VERSION}}}|}}
{{#if:{{{COMPATIBILITY|}}}|<dt>Compatibility:<dd>{{{COMPATIBILITY}}}|}}
{{#if:{{{COMPATIBILITY|}}}|<dt>Compatibility:<dd>{{{COMPATIBILITY}}}|}}
Line 14: Line 14:
{{#if:{{{NOTES|}}}|<dt>Notes:<dd>{{{NOTES}}}|}}
{{#if:{{{NOTES|}}}|<dt>Notes:<dd>{{{NOTES}}}|}}
</dl>
</dl>
 
{{#if:{{{INSTALL|}}} or {{{COMMAND|}}} or {{{OPTIONS|}}} or {{{EXAMPLE|}}}|


=== Usage ===
=== Usage ===
<dl>
<dl>
{{#if:{{{INSTALL|}}}|<dt>Installation:<dd>{{{INSTALL}}}|}}
{{#if:{{{COMMAND|}}}|<dt>Line call:<dd>{{{COMMAND}}}|}}
{{#if:{{{COMMAND|}}}|<dt>Line call:<dd>{{{COMMAND}}}|}}
{{#if:{{{OPTIONS|}}}|<dt>Options:<dd>{{{OPTIONS}}}|}}
{{#if:{{{OPTIONS|}}}|<dt>Options:<dd>{{{OPTIONS}}}|}}
{{#if:{{{EXAMPLE|}}}|<dt>Examples:<dd>{{{EXAMPLE}}}|}}
{{#if:{{{EXAMPLE|}}}|<dt>Examples:<dd>{{{EXAMPLE}}}|}}
</dl>
</dl>
|}}


=== Licenses ===
=== Licenses ===
Line 28: Line 30:
{{#if:{{{SEEALSO|}}}|<dt>See also:<dd>{{{SEEALSO}}}|}}
{{#if:{{{SEEALSO|}}}|<dt>See also:<dd>{{{SEEALSO}}}|}}
</dl>
</dl>
</includeonly>
</includeonly><noinclude>
Formats a Tool documentation page.
 
== Usage ==
 
{{<nowiki/>Tool|'''''arguments'''''}}
* arguments: see below


<noinclude>
=== Template ===
===Usage===
<pre>
<pre>
{{Tool|=
{{Tool


|AUTHOR=
|AUTHOR=
Line 46: Line 53:


|NOTES=
|NOTES=
|INSTALL=


|COMMAND=
|COMMAND=
Line 58: Line 67:


}}</pre>
}}</pre>
{|
|+ Examples
|- style="background-color: #EEE"
! Code
! style="min-width: 60em" | Result
|-
| <nowiki>{{Tool}}</nowiki>
| {{Tool}}<br><br>
|-
| <nowiki>{{Tool|DESCRIPTION= this is a description.|LICENSING= None.}}</nowiki>
| {{Tool|DESCRIPTION= this is a description.|LICENSING= None.}}<br><br>
|}
[[Category:Templates|{{uc:{{PAGENAME}}}}]]
[[Category:Templates|{{uc:{{PAGENAME}}}}]]
</noinclude>
</noinclude>

Latest revision as of 19:54, 4 February 2021

Formats a Tool documentation page.

Usage

{{Tool|arguments}}

  • arguments: see below

Template

{{Tool

|AUTHOR=

|VERSION=

|COMPATIBILITY=

|DOWNLOAD=

|DESCRIPTION=

|NOTES=

|INSTALL=

|COMMAND=

|OPTIONS=

|EXAMPLE=

|LICENSING=

|SEEALSO=

}}
Examples
Code Result
{{Tool}}

Basic information

Author:
Bohemia Interactive

Description

Description:

Usage

Licenses

Licensing:



{{Tool|DESCRIPTION= this is a description.|LICENSING= None.}}

Basic information

Author:
Bohemia Interactive

Description

Description:
this is a description.

Usage

Licenses

Licensing:
None.