Help:Script Samples

This help page details the extended functionality on the Support Wikis : specifically for text-display and highlighting.

<code> element

Code tags are used for single lines of script only:

<code>[root@node0-mraid14 /fse]# dd if=/dev/lun2 | od -c |less </code>

<pre> element

Pre tags do not automatically shrink to fit their contents, use the class "inline" for auto fitting, this uses "display: inline-block" in the css:

<pre class="inline">

[root@node0-FS8600 /fse]# system-status

General System Status
-- Section ---- Section ---- Section ---- Section ---- Section ---- Section ---- Section ---- Section ---- Section ---- Section ----
expected status is ON
File system is up

Health Status
-- Section ---- Section ---- Section ---- Section ---- Section ---- Section ---- Section ---- Section ---- Section ---- Section ----
system health ok

[root@node0-FS8600 /fse]#

</pre>

<pre> element (with set-width)

In order to show the scroll bars on a pre element it is necessary to use the class "scroll" and to statically set the width:

<pre class="scroll" style="width: 500px;">

<FluidFS> CLI > system authentication user-database set ldap -ldap_host ldap.furryyoghurt.com -ldap_base_dn "dc=exanet,dc=local"
<FluidFS> CLI >

</pre>

<syntax-highlight class="scroll" lang="bash"> element

The syntaxhighlight tag requires the programming language to be specified in this case bash:

<syntaxhighlight>

   #!/bin/bash
   fileCount=800000
   b=0
   while [ $b -le $fileCount ]
   do
           echo B = $b
           dd if=/dev/urandom of=/mnt/nfs/file$b.txt bs=2k count=1
           ((b++))
   done

</syntaxhighlight>

• For more details on usage, see the Mediawiki SyntaxHighlight Extension

---

If a programming language is not used the language can be specified as text, also the highlight attribute can be set to highlight lines of code:

<syntaxhighlight lang="text" highlight="8-11" class="scroll" style="width: 93%;"> map profile show where ManagementApp FLUIDFS <60756 (?)> [60756] Mapping:MappingProfile 02/15/2013 12:53:34 AM Index Server Server Volume MZ MZ MultiPat LUN Persona Personali Boot Write VM Managemen Admin DebugOu Active Bad Path LUN OS OS ManagementApp Active Name Subsyst VolumeI Max Actual Preferr Actual Volume Protect Connect Status PathCo PathCo DownCo OnlyOne Product Version Controller ======= ======== =================================== ======= ======= ======= ======== ====== ======= ========= ======= ======= ========= ========= ======== ======= ====== ====== ====== ========= ============ ============ ============================== ========== 14 8 8 Cluster FS8600 15 15 15 0 1 0 60756 (0) Fal (0) Fal (3) Both (1) Auto (1) Enab (0) Fal 0 0 0 42949672* Compellent FS8600 1.x FLUIDFS 60756 15 8 8 Cluster FS8600 16 15 16 0 2 0 60757 (0) Fal (0) Fal (3) Both (1) Auto (1) Enab (0) Fal 0 0 0 42949672* Compellent FS8600 1.x FLUIDFS 60757 16 8 8 Cluster FS8600 17 15 17 0 3 0 60756 (0) Fal (0) Fal (3) Both (1) Auto (1) Enab (0) Fal 0 0 0 42949672* Compellent FS8600 1.x FLUIDFS 60756 17 8 8 Cluster FS8600 18 15 18 0 4 0 60757 (0) Fal (0) Fal (3) Both (1) Auto (1) Enab (0) Fal 0 0 0 42949672* Compellent FS8600 1.x FLUIDFS 60757 Walk: Display 4 of 4

</syntaxhighlight>

---

This is the only example where it looks different in IE and the other browsers if the code is longer than the page and width is not set, IE will add scroll bars automatically no other browser will:

<syntaxhighlight lang="text" highlight="8-11">

map profile show where ManagementApp FLUIDFS 
<60756 (?)>
 [60756] Mapping:MappingProfile 02/15/2013 12:53:34 AM

 Index   Server                Server                Volume    MZ      MZ    MultiPat  LUN   Persona Personali  Boot    Write     VM     Managemen  Admin   DebugOu Active  Bad    Path     LUN         OS           OS              ManagementApp            Active
                                Name                         Subsyst VolumeI   Max    Actual Preferr  Actual   Volume  Protect  Connect             Status          PathCo PathCo DownCo  OnlyOne    Product      Version                                   Controller
======= ======== =================================== ======= ======= ======= ======== ====== ======= ========= ======= ======= ========= ========= ======== ======= ====== ====== ====== ========= ============ ============ ============================== ==========
     14        8 8 Cluster FS8600                         15      15      15        0      1       0     60756 (0) Fal (0) Fal (3) Both  (1) Auto  (1) Enab (0) Fal      0      0      0 42949672* Compellent   FS8600 1.x   FLUIDFS                             60756
     15        8 8 Cluster FS8600                         16      15      16        0      2       0     60757 (0) Fal (0) Fal (3) Both  (1) Auto  (1) Enab (0) Fal      0      0      0 42949672* Compellent   FS8600 1.x   FLUIDFS                             60757
     16        8 8 Cluster FS8600                         17      15      17        0      3       0     60756 (0) Fal (0) Fal (3) Both  (1) Auto  (1) Enab (0) Fal      0      0      0 42949672* Compellent   FS8600 1.x   FLUIDFS                             60756
     17        8 8 Cluster FS8600                         18      15      18        0      4       0     60757 (0) Fal (0) Fal (3) Both  (1) Auto  (1) Enab (0) Fal      0      0      0 42949672* Compellent   FS8600 1.x   FLUIDFS                             60757
Walk: Display 4 of 4

</syntaxhighlight>

---

It is also possible to number the lines of code as demonstrated below:

<syntaxhighlight lang="html4strict" line start="100" highlight="5" enclose="div">

<!--This is a comment. Comments are not displayed in the browser-->
<table align=center style="background: ivory;color:maroon;font-style:italic;font-family:arial;font-weight:bold;font-size:10pt;"> 
<tr><th> Heading 1 </th><th> Heading 2 </th></tr>
<tr>
<td style="padding:10px;"> This is cell 1 text </td>
<td style="padding:10px;"> This is cell 2 text </td>
</tr>
</table>

</syntaxhighlight>

Annotate <pre> contents with Pointers / Boxes

Annotations can be added to <pre> elements ( including <syntaxhighlight> using lang="text" and highlight options )

Example

<pre>

disk show 
CA Table Display Request Time: 00.001_536_431
 [10722] DiskManager:Disk 04/29/2012 09:14:25 am
<10722 (?)>
 

Index         Name         ManagementDiscipline OperStatus ParentFolder Class TotalBlockCoun UnallocatedBlo    DiskSize           Health
===== ==================== ==================== ========== ============ ===== ============== ============== ============== ====================
   65                      (1) Managed          (1) Up                3     1      286749488       20124944      136.73 GB Healthy
  105                      (1) Managed          (1) Up                3     1      286749488       20124944      136.73 GB Healthy
  106                      (1) Managed          (<point-here>2) Down              3     1      286749488      286749456      136.73 GB <box>WriteError</box>
  107                      (1) Managed          (1) Up                3     1      286749488       20124944      136.73 GB Healthy

</pre>

Pointer inside the <pre>

To add a pointer, the single <point-here> tag can used like this (use lowercase : UPPERCASE is used here to prevent any JS action! )

106                      (1) Managed          (2) <point-here>Down              3     1

Pointer Direction

To specify pointer direction, use <point-here-tl> for "top left", <point-here-tr> for "top right", <point-here-br> for "bottom right" etc..

106                      (1) Managed          (2) <point-here-br>Down              3     1

Floating Box over Word

• To Box a word, use the <box> tag like this (use lowercase : UPPERCASE is used here to prevent any JS action! )

286749488      286749456      136.73 GB <box>WriteError</box>

Traditional shell colouring

• Use the class "shell" to colour the background of a pre black with green text:

<pre class="shell">
286749488      286749456      136.73 GB <box>WriteError</box>
</pre>

Results in:

286749488      286749456      136.73 GB <box>WriteError</box>

Use links and formatting inside a code block

For this use pre template instead of pre tags ({{pre|code goes here}}):

{{Pre|class=black-white inline|
[caleb_cooper@ola cfd7416402094f6a2b8dcbccb9bad4d439b1d21a]$ egrep -c "0x0000244[57]" node_[ab]/command_output/pmcli/netinfo.txt
{{Color|purple|node_a/command_output/pmcli/netinfo.txt}}{{Color|cyan|:}}{{H|4|red}}
{{Color|purple|node_b/command_output/pmcli/netinfo.txt}}{{Color|cyan|:}}0
[caleb_cooper@ola cfd7416402094f6a2b8dcbccb9bad4d439b1d21a]$
}}

[caleb_cooper@ola cfd7416402094f6a2b8dcbccb9bad4d439b1d21a]$ egrep -c "0x0000244[57]" node_[ab]/command_output/pmcli/netinfo.txt
node_a/command_output/pmcli/netinfo.txt:4
node_b/command_output/pmcli/netinfo.txt:0
[caleb_cooper@ola cfd7416402094f6a2b8dcbccb9bad4d439b1d21a]$

 

Tip:   

in this example {{pre}} was used in conjunction with {{Color}} (to provide a text color change) and {{H}} to change the background color of the font for the number 4

 

Caution:  

Note that = and | always have to be escaped in templates, the templates {{!}} and {{eq}} have been provided for this purpose, example below requiring this. Also it is not possible to use : for indents, use {{Indent}} template instead as below.

{{Indent|{{Pre|class=blue-white|# for i in $(diskview -I s {{!}} awk '/Online/{print $2}'); do echo -e "\n::: ${i} :::"; dd if{{eq}}/dev/rpd${i}d bs{{eq}}512 count{{eq}}1 of{{eq}}/pss/cc/o-dsb-${i}.bin; done}}}}

Or use poem tags instead of pre:

<poem>
In [[Wikipedia:Xanadu|Xanadu]] did Kubla Khan
A stately pleasure-dome decree:
Where Alph, the '''sacred river''', ran
Through caverns measureless to man
Down to a sunless sea.

So twice five miles of fertile ground
With walls and towers were girdled round:
And there were gardens bright with sinuous rills,
Where blossomed many an incense-bearing tree;
And here were <span style="color:green">forests</span> ancient as the hills,
Enfolding sunny spots of greenery.
</poem>

Results in:

In Xanadu did Kubla Khan
A stately pleasure-dome decree:
Where Alph, the sacred river, ran
Through caverns measureless to man
Down to a sunless sea.

So twice five miles of fertile ground
With walls and towers were girdled round:
And there were gardens bright with sinuous rills,
Where blossomed many an incense-bearing tree;
And here were forests ancient as the hills,
Enfolding sunny spots of greenery.