Template:HPC-Examples-Dir/doc: Difference between revisions

From HPC Wiki
Jump to:navigation Jump to:search
(Created page with "{{Template}} Use this template to specify the path to HPC examples. == Parameters == ; none. == Usage == See the template's [[Template:HPC-Examples-Dir/testcases|testcases]...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:


== Parameters ==
== Parameters ==
; none.
{{Template Parameter Table|1=
 
{{Template Parameter|1|Hostname|required=yes}}
}}


== Usage ==
== Usage ==
Line 11: Line 12:


<includeonly>
<includeonly>
<!-- Categories go here: -->
[[Category:HPC templates]]
</includeonly>
</includeonly>
<noinclude>
<noinclude>
[[Category:Template documentation]]
[[Category:Template documentation]]
</noinclude>
</noinclude>

Latest revision as of 00:58, 28 December 2016

Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.

As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

Use this template to specify the path to HPC examples.

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 Yes (n/a) Hostname

Usage

See the template's testcases:

No parameter
Wiki code {{HPC-Examples-Dir}}
Main version
{{HPC-Examples-Dir}}
Parameter unnamed not defined. For correct usage see template's documention.
Sandbox version Template:HPC-Examples-Dir/sandbox
1. parameter
Wiki code {{HPC-Examples-Dir|flory}}
Main version

/home/bgo/shared/examples

Sandbox version Template:HPC-Examples-Dir/sandbox
1. parameter
Wiki code {{HPC-Examples-Dir|magnolia}}
Main version

/home/user/examples/YYYYMMDD-HHMMSS

Sandbox version Template:HPC-Examples-Dir/sandbox