Tool – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Tool template - based on Command template)
 
m (Add doc)
 
(34 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<includeonly>__NOTOC__ __NOEDITSECTION__ <div class="command_description">
<includeonly>__NOTOC____NOEDITSECTION__<div class="_description tool">


=== Basic informations ===
=== Basic information ===
<dl>
<dl>
<dt>Author:</dt><dd>{{{1|}}}</dd>
<dt>Author:<dd>{{#if:{{{AUTHOR|}}}|{{{AUTHOR|}}}|[[:Category:Projects|Bohemia Interactive]]}}
{{if defined call|{{{2|}}}|echo|<dt>Version:</dt><dd>{{{2}}}</dd>}}
{{#if:{{{VERSION|}}}|<dt>Version:<dd>{{{VERSION}}}|}}
{{if defined call|{{{3|}}}|echo|<dt>Compatibility:</dt><dd>{{{3}}}</dd>}}
{{#if:{{{COMPATIBILITY|}}}|<dt>Compatibility:<dd>{{{COMPATIBILITY}}}|}}
{{if defined call|{{{4|}}}|echo|<dt>Download:</dt><dd>{{{4}}}</dd>}}
{{#if:{{{DOWNLOAD|}}}|<dt>Download:<dd>{{{DOWNLOAD}}}|}}
</dl>
</dl>


=== Description ===
=== Description ===
<dl>
<dl>
<dt>Description:</dt><dd>{{{5|}}}</dd>
<dt>Description:<dd>{{{DESCRIPTION|}}}
{{if defined call|{{{6|}}}|echo|<dt>Notes:</dt><dd>{{{6|}}}</dd>}}
{{#if:{{{NOTES|}}}|<dt>Notes:<dd>{{{NOTES}}}|}}
</dl>
</dl>
{{#if:{{{INSTALL|}}} or {{{COMMAND|}}} or {{{OPTIONS|}}} or {{{EXAMPLE|}}}|


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


=== Additional informations ===
=== Licenses ===
<dl>
<dl>
<dt>Licensing:</dt><dd>{{{7|}}}</dd>
<dt>Licensing:<dd>{{{LICENSING|}}}
{{if defined call|{{{8|}}}|echo|<dt>See also:</dt><dd>{{{8|}}}</dd>}}
{{#if:{{{SEEALSO|}}}|<dt>See also:<dd>{{{SEEALSO}}}|}}
</dl>
</dl>
</includeonly><noinclude>
Formats a Tool documentation page.
== Usage ==
{{<nowiki/>Tool|'''''arguments'''''}}
* arguments: see below
=== Template ===
<pre>
{{Tool
|AUTHOR=
|VERSION=
|COMPATIBILITY=
|DOWNLOAD=
|DESCRIPTION=
|NOTES=
|INSTALL=
|COMMAND=
|OPTIONS=
|EXAMPLE=
|LICENSING=
|SEEALSO=
}}</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>
|}


</includeonly>
[[Category:Templates|{{uc:{{PAGENAME}}}}]]
<noinclude>
No info yet.
[[Category:Templates|{{PAGENAME}}]]
</noinclude>
</noinclude>

Latest revision as of 20: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.